getPermissionStatus

Compute remaining spend and active status for a Spend Permission

Defined in the Base Account SDK

Validates a permission against current time and revocation state and returns remaining spend and next period start.

Parameters

permission · SpendPermission · required

Signed permission to evaluate. This should be a SpendPermission object returned from requestSpendPermission or fetched via fetchPermissions.

Show SpendPermission properties

permissionHash · string

Deterministic EIP-712 hash of the permission.

signature · string

Signature for the EIP-712 payload.

chainId · number

Target chain ID.

permission · object

Underlying permission fields.

Show permission fields

account · address

spender · address

token · address

allowance · bigint

period · number

Duration in seconds.

start · number

Unix timestamp (seconds).

end · number

Unix timestamp (seconds).

salt · string

extraData · string

Returns

status · GetPermissionStatusResponse

Status details for the permission.

Show GetPermissionStatusResponse properties

remainingSpend · bigint

Remaining allowance in wei for the current period.

nextPeriodStart · Date

When the next allowance period begins.

isActive · boolean

True if approved and not revoked or expired.

Check permission status

import { getPermissionStatus } from "@base-org/account/spend-permission";

const { isActive, remainingSpend } = await getPermissionStatus(permission);

Example response

{
  remainingSpend: 1000000000000000000n,
  nextPeriodStart: new Date("2024-01-31T00:00:00Z"),
  isActive: true
}

Error Handling

Always wrap the call in a try-catch block to handle these errors gracefully.