Class GlobalCleanupLog

ReadonlyamountDeposited

ReadonlyamountDesired

Readonlycleaner

Readonlymaker

StaticbyteSize

• get byteSize(): number

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

  Returns number

pretty

• pretty(): {
      amountDeposited: GlobalAtoms;
      amountDesired: GlobalAtoms;
      cleaner: string;
      maker: string;
  }

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

  Returns {
      amountDeposited: GlobalAtoms;
      amountDesired: GlobalAtoms;
      cleaner: string;
      maker: string;
  }

  • amountDeposited: GlobalAtoms

  • amountDesired: GlobalAtoms

  • cleaner: string

  • maker: string

serialize

• serialize(): [Buffer, number]

• Serializes the GlobalCleanupLog 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.

Staticdeserialize

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

• Deserializes the GlobalCleanupLog from the provided data Buffer.

  Parameters

  • buf: Buffer
  • offset: number = 0

  Returns [GlobalCleanupLog, number]

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

StaticfromAccountAddress

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

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

  Parameters

  • connection: Connection
  • address: PublicKey
  • OptionalcommitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<GlobalCleanupLog>

  Throws

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

StaticfromAccountInfo

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

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

  Parameters

  • accountInfo: AccountInfo<Buffer>
  • offset: number = 0

  Returns [GlobalCleanupLog, number]

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

StaticfromArgs

• fromArgs(args): GlobalCleanupLog

• Creates a GlobalCleanupLog instance from the provided args.

  Parameters

  • args: GlobalCleanupLogArgs

  Returns GlobalCleanupLog

StaticgetMinimumBalanceForRentExemption

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

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

  Parameters

  • connection: Connection

    used to retrieve the rent exemption information
  • Optionalcommitment: Commitment

  Returns Promise<number>

StaticgpaBuilder

• gpaBuilder(programId?): GpaBuilder<{
      amountDeposited: any;
      amountDesired: any;
      cleaner: any;
      maker: 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<{
      amountDeposited: any;
      amountDesired: any;
      cleaner: any;
      maker: any;
  }>

StatichasCorrectByteSize

• hasCorrectByteSize(buf, offset?): boolean

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

  Parameters

  • buf: Buffer
  • offset: number = 0

  Returns boolean