Class Swig

Readonlyaddress

id

• get id(): ReadonlyUint8Array

  Swig ID

  Returns ReadonlyUint8Array

roles

• get roles(): Role[]

  Roles on the swig

  Returns Role[]

findRoleByAuthority

• findRoleByAuthority(authority: Authority): null | Role

  Find a Role by Authority.

  Parameters

  • authority: Authority

    Authority

  Returns null | Role

  Role | null

findRoleById

• findRoleById(id: number): null | Role

  Find a Role by a Role ID

  Parameters

  • id: number

    Role ID

  Returns null | Role

  Role | null

findRoleBySessionKey

• findRoleBySessionKey(sessionKey: PublicKey): null | SessionBasedRole

  Find a Role by session key

  Parameters

  • sessionKey: PublicKey

  Returns null | SessionBasedRole

  Session-based Role

findRolesByAuthoritySigner

• findRolesByAuthoritySigner(signer: Uint8Array): Role[]

  Find a Role by Authority Signer

  Parameters

  • signer: Uint8Array

    Authority signer

  Returns Role[]

  Role[]

findRolesByEd25519SignerPk

• findRolesByEd25519SignerPk(signerPk: PublicKey): Role[]

  Find a Role by Ed25519 Signer Publickey

  Parameters

  • signerPk: PublicKey

    Ed25519 Publickey

  Returns Role[]

  Role[]

findRolesBySecp256k1SignerAddress

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

  Find a Role by Authority Signer

  Parameters

  • signerAddress: string | Uint8Array<ArrayBufferLike>

    Secp256k1 Signer Address hex or bytes

  Returns Role[]

  Role[]

refetch

• refetch(
      connection: Connection,
      config?: Commitment | GetAccountInfoConfig,
  ): Promise<void>

  Refetch the swig to invalidate stale account data. Updates the Swig with the lateset on-chain state

  Parameters

  • connection: Connection

    Connection
  • Optionalconfig: Commitment | GetAccountInfoConfig

    Connection config

  Returns Promise<void>

Staticcreate

• create(
      args: {
          actions: Actions;
          authorityInfo: CreateAuthorityInfo;
          id: Uint8Array;
          payer: PublicKey;
      },
  ): TransactionInstruction

  Get Create instruction for creating a new Swig

  Parameters

  • args: {
        actions: Actions;
        authorityInfo: CreateAuthorityInfo;
        id: Uint8Array;
        payer: PublicKey;
    }

    • actions: Actions

    • authorityInfo: CreateAuthorityInfo

    • id: Uint8Array

      Swig ID

    • payer: PublicKey

      Swig payer

  Returns TransactionInstruction

  Instruction for creating a Swig

Staticfetch

• fetch(
      connection: Connection,
      swigAddress: PublicKey,
      config?: Commitment | GetAccountInfoConfig,
  ): Promise<Swig>

  Fetch a Swig. Throws an error if Swig account has not been created

  Parameters

  • connection: Connection

    Connection
  • swigAddress: PublicKey

    Swig address
  • Optionalconfig: Commitment | GetAccountInfoConfig

    Commitment config

  Returns Promise<Swig>

  Swig | null

StaticfetchNullable

• fetchNullable(
      connection: Connection,
      swigAddress: PublicKey,
      config?: Commitment | GetAccountInfoConfig,
  ): Promise<null | Swig>

  Fetch a Swig. Returns null if Swig account has not been created

  Parameters

  • connection: Connection

    Connection
  • swigAddress: PublicKey

    Swig address
  • Optionalconfig: Commitment | GetAccountInfoConfig

    Commitment config

  Returns Promise<null | Swig>

  Swig | null

StaticfromRawAccountData

• fromRawAccountData(swigAddress: PublicKey, accountData: Uint8Array): Swig

  Get a swig from raw swig account data

  Parameters

  • swigAddress: PublicKey

    Swig address
  • accountData: Uint8Array

    Raw account data

  Returns Swig

  Swig