aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface PerpetualsAccountCap

    On-chain capability object that grants control over a perpetuals account.

    This represents an "owned" account capability, used to sign and authorize account-level actions.

    interface PerpetualsAccountCap {
        accountId: bigint;
        accountObjectId: string;
        accountObjectInitialSharedVersion: number;
        collateral: number;
        collateralCoinType: string;
        isAgent: boolean;
        objectDigest: string;
        objectId: string;
        objectVersion: number;
        walletAddress: string;
        whitelistedAgentCapIds: string[];
    }
    Index
    accountId accountObjectId accountObjectInitialSharedVersion collateral collateralCoinType isAgent objectDigest objectId objectVersion walletAddress whitelistedAgentCapIds
    accountId: bigint

    Logical ID of the associated perpetuals account.

    accountObjectId: string

    Object ID of the associated PerpetualsAccountObject.

    accountObjectInitialSharedVersion: number

    Initial shared version of the underlying perpetuals Account object. Required when constructing transactions that reference the shared account object.

    collateral: number

    Total collateral (native units) associated with this account.

    collateralCoinType: string

    Collateral coin type backing this account.

    isAgent: boolean

    True if this account cap was allocated to an agent wallet from the admin account cap owner.

    objectDigest: string

    On-chain object digest.

    objectId: string

    Object ID of the account capability on-chain.

    objectVersion: number

    On-chain object version.

    walletAddress: string

    Wallet address that owns this account capability.

    whitelistedAgentCapIds: string[]

    Sui object IDs of agent account caps that have been whitelisted to operate on behalf of this account.

    Settings
    Member Visibility

    On This Page
    Properties