getPermissionStatus

Gets the current status of a Spend Permission

Defined in the Base Account SDK

This helper method queries the blockchain to retrieve real-time information about a spend permission, including how much can still be spent in the current period, when the next period starts, and whether the permission is still active.

The function automatically uses the appropriate blockchain client based on the permission’s chain ID and calls multiple view functions on the SpendPermissionManager contract to gather comprehensive status information.

Parameters

permission · SpendPermission · required

The spend permission object to check status for. 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 · GetPermissionStatusResponseType

A promise that resolves to an object containing permission status details.

Show GetPermissionStatusResponseType properties

remainingSpend · bigint

Remaining allowance in wei for the current period. Calculated as the difference between the allowance and the amount already spent in the current period.

nextPeriodStart · Date

When the next allowance period begins. This is calculated as one second after the current period ends.

isRevoked · boolean

True if the permission has been revoked on-chain.

isExpired · boolean

True if the current timestamp is past the permission’s end time.

isActive · boolean

True if the permission is not revoked and not expired. A permission is active when it can still be used for spending.

currentPeriod · object

Information about the current spending period.

Show currentPeriod properties

start · number

Unix timestamp (seconds) when the current period started.

end · number

Unix timestamp (seconds) when the current period ends.

spend · bigint

Amount already spent in the current period (in wei).

Check permission status

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

// Check the status of a permission (no client needed)
const status = await getPermissionStatus(permission);

console.log(`Remaining spend: ${status.remainingSpend} wei`);
console.log(`Next period starts: ${status.nextPeriodStart}`);
console.log(`Is revoked: ${status.isRevoked}`);
console.log(`Is expired: ${status.isExpired}`);
console.log(`Is active: ${status.isActive}`);

if (status.isActive && status.remainingSpend > BigInt(0)) {
  console.log('Permission can be used for spending');
}

Example response

{
  remainingSpend: 1000000000000000000n,
  nextPeriodStart: new Date("2024-01-31T00:00:01Z"),
  isRevoked: false,
  isExpired: false,
  isActive: true,
  currentPeriod: {
    start: 1704067200,
    end: 1706659200,
    spend: 0n
  }
}

Error Handling

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