Swig TS — API References
    Preparing search index...

    Class Swig

    Index

    Constructors

    constructor

    Properties

    address findRoleById findRoleBySessionKey findRolesByAuthoritySigner findRolesByEd25519SignerPk findRolesBySecp256k1SignerAddress refetch setSwigFetchFn

    Accessors

    id roles

    Methods

    accountAddress accountVersion fromRawAccountData

    Constructors

    Properties

    address: SolPublicKey

    Swig Account Address.

    use Swig.accountAddress() instead

    findRoleById: (id: number) => null | Role

    Find a Role by a Role ID

    Type declaration

      • (id: number): null | Role

      • Parameters

        • id: number

          Role ID

        Returns null | Role

        Role | null

    findRoleBySessionKey: (sessionKey: SolPublicKeyData) => null | Role

    Find a Role by session key

    Type declaration

    findRolesByAuthoritySigner: (signer: Uint8Array) => Role[]

    Find a Role by Authority Signer

    Type declaration

      • (signer: Uint8Array): Role[]

      • Parameters

        • signer: Uint8Array

          Authority signer

        Returns Role[]

        Role[]

    findRolesByEd25519SignerPk: (signerPk: SolPublicKeyData) => Role[]

    Find a Role by Ed25519 Signer Publickey

    Type declaration

    findRolesBySecp256k1SignerAddress: (
        signerAddress: string | Uint8Array<ArrayBufferLike>,
    ) => Role[]

    Find a Role by Authority Signer

    Type declaration

      • (signerAddress: string | Uint8Array<ArrayBufferLike>): Role[]

      • Parameters

        • signerAddress: string | Uint8Array<ArrayBufferLike>

          Secp256k1 Signer Address hex or bytes

        Returns Role[]

        Role[]

    refetch: <T extends { commitment?: Commitment } = { commitment?: Commitment }>(
        config?: T,
    ) => Promise<Swig>
    setSwigFetchFn: (fn: SwigFetchFn) => void

    Accessors

    • get id(): ReadonlyUint8Array

      Swig ID

      Returns ReadonlyUint8Array

    • get roles(): Role[]

      Roles on the swig

      Returns Role[]

    Methods

    • The Address of the Swig PDA Account that holds all details of the Swig. The address is the wallet address of the swig for legacy account

      Returns SolPublicKey

      the swig account address

    • Get a swig from raw swig account data

      Parameters

      • swigAddress: SolPublicKeyData

        Swig address

      • accountData: Uint8Array

        Raw account data

      Returns Swig

      Swig

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods