Class ProgramConfig

Readonly authority

Readonly multisigCreationFee

Readonly reserved

Readonly treasury

Static byteSize

• get byteSize(): number

• Returns the byteSize of a Buffer holding the serialized data of ProgramConfig

  Returns number

pretty

• pretty(): {
      authority: string;
      multisigCreationFee: number | {
          toNumber: (() => number);
      };
      reserved: number[];
      treasury: string;
  }

• Returns a readable version of ProgramConfig properties and can be used to convert to JSON and/or logging

  Returns {
      authority: string;
      multisigCreationFee: number | {
          toNumber: (() => number);
      };
      reserved: number[];
      treasury: string;
  }

  • authority: string

  • multisigCreationFee: number | {
        toNumber: (() => number);
    }

  • reserved: number[]

  • treasury: string

serialize

• serialize(): [Buffer, number]

• Serializes the ProgramConfig into a Buffer.

  Returns [Buffer, number]

  a tuple of the created Buffer and the offset up to which the buffer was written to store it.

Static deserialize

• deserialize(buf, offset?): [ProgramConfig, number]

• Deserializes the ProgramConfig from the provided data Buffer.

  Parameters

  • buf: Buffer

  • offset: number = 0

  Returns [ProgramConfig, number]

  a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromAccountAddress

• fromAccountAddress(connection, address, commitmentOrConfig?): Promise<ProgramConfig>

• Retrieves the account info from the provided address and deserializes the ProgramConfig from its data.

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<ProgramConfig>

  Throws

  Error if no account info is found at the address or if deserialization fails

Static fromAccountInfo

• fromAccountInfo(accountInfo, offset?): [ProgramConfig, number]

• Deserializes the ProgramConfig from the data of the provided web3.AccountInfo.

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • offset: number = 0

  Returns [ProgramConfig, number]

  a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromArgs

• fromArgs(args): ProgramConfig

• Creates a ProgramConfig instance from the provided args.

  Parameters

  • args: ProgramConfigArgs

  Returns ProgramConfig

Static getMinimumBalanceForRentExemption

• getMinimumBalanceForRentExemption(connection, commitment?): Promise<number>

• Fetches the minimum balance needed to exempt an account holding ProgramConfig data from rent

  Parameters

  • connection: Connection

    used to retrieve the rent exemption information

  • Optional commitment: Commitment

  Returns Promise<number>

Static gpaBuilder

• gpaBuilder(programId?): GpaBuilder<{
      accountDiscriminator: any;
      authority: any;
      multisigCreationFee: any;
      reserved: any;
      treasury: any;
  }>

• Provides a web3.Connection.getProgramAccounts config builder, to fetch accounts matching filters that can be specified via that builder.

  Parameters

  • programId: PublicKey = ...

    the program that owns the accounts we are filtering

  Returns GpaBuilder<{
      accountDiscriminator: any;
      authority: any;
      multisigCreationFee: any;
      reserved: any;
      treasury: any;
  }>

Static hasCorrectByteSize

• hasCorrectByteSize(buf, offset?): boolean

• Determines if the provided Buffer has the correct byte size to hold ProgramConfig data.

  Parameters

  • buf: Buffer

  • offset: number = 0

  Returns boolean