Class Proposal

Readonly approved

Readonly bump

Readonly cancelled

Readonly multisig

Readonly rejected

Readonly status

Readonly transactionIndex

pretty

• pretty(): {
      approved: PublicKey[];
      bump: number;
      cancelled: PublicKey[];
      multisig: string;
      rejected: PublicKey[];
      status: "Draft" | "Active" | "Rejected" | "Approved" | "Executing" | "Executed" | "Cancelled";
      transactionIndex: number | {
          toNumber: (() => number);
      };
  }

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

  Returns {
      approved: PublicKey[];
      bump: number;
      cancelled: PublicKey[];
      multisig: string;
      rejected: PublicKey[];
      status: "Draft" | "Active" | "Rejected" | "Approved" | "Executing" | "Executed" | "Cancelled";
      transactionIndex: number | {
          toNumber: (() => number);
      };
  }

  • approved: PublicKey[]

  • bump: number

  • cancelled: PublicKey[]

  • multisig: string

  • rejected: PublicKey[]

  • status: "Draft" | "Active" | "Rejected" | "Approved" | "Executing" | "Executed" | "Cancelled"

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

serialize

• serialize(): [Buffer, number]

• Serializes the Proposal 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 byteSize

• byteSize(args): number

• Returns the byteSize of a Buffer holding the serialized data of Proposal for the provided args.

  Parameters

  • args: ProposalArgs

    need to be provided since the byte size for this account depends on them

  Returns number

Static deserialize

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

• Deserializes the Proposal from the provided data Buffer.

  Parameters

  • buf: Buffer

  • offset: number = 0

  Returns [Proposal, 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<Proposal>

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

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<Proposal>

  Throws

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

Static fromAccountInfo

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

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

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • offset: number = 0

  Returns [Proposal, number]

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

Static fromArgs

• fromArgs(args): Proposal

• Creates a Proposal instance from the provided args.

  Parameters

  • args: ProposalArgs

  Returns Proposal

Static getMinimumBalanceForRentExemption

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

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

  Parameters

  • args: ProposalArgs

    need to be provided since the byte size for this account depends on them

  • connection: Connection

    used to retrieve the rent exemption information

  • Optional commitment: Commitment

  Returns Promise<number>

Static gpaBuilder

• gpaBuilder(programId?): GpaBuilder<ProposalArgs & {
      accountDiscriminator: number[];
  }>

• 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<ProposalArgs & {
      accountDiscriminator: number[];
  }>