Class StakingPool

Readonly allowedMints

Readonly bump

Readonly collections

Readonly cooldownDuration

Readonly creators

Readonly currency

Readonly endTime

Readonly key

Readonly lockType

Readonly maxRewardsDuration

Readonly minStakeDuration

Readonly name

Readonly project

Readonly resetStakeDuration

Readonly rewardsDuration

Readonly rewardsPerDuration

Readonly startTime

Readonly tempPlaceHolder1

Readonly tempPlaceHolder2

Readonly totalStaked

pretty

• pretty(): {
      allowedMints: boolean;
      bump: number;
      collections: Uint8Array;
      cooldownDuration: bignum;
      creators: Uint8Array;
      currency: string;
      endTime: bignum;
      key: string;
      lockType: string;
      maxRewardsDuration: bignum;
      minStakeDuration: bignum;
      name: string;
      project: string;
      resetStakeDuration: boolean;
      rewardsDuration: number | {
          toNumber: (() => number);
      };
      rewardsPerDuration: number | {
          toNumber: (() => number);
      };
      startTime: bignum;
      tempPlaceHolder1: number;
      tempPlaceHolder2: string;
      totalStaked: number | {
          toNumber: (() => number);
      };
  }

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

  Returns {
      allowedMints: boolean;
      bump: number;
      collections: Uint8Array;
      cooldownDuration: bignum;
      creators: Uint8Array;
      currency: string;
      endTime: bignum;
      key: string;
      lockType: string;
      maxRewardsDuration: bignum;
      minStakeDuration: bignum;
      name: string;
      project: string;
      resetStakeDuration: boolean;
      rewardsDuration: number | {
          toNumber: (() => number);
      };
      rewardsPerDuration: number | {
          toNumber: (() => number);
      };
      startTime: bignum;
      tempPlaceHolder1: number;
      tempPlaceHolder2: string;
      totalStaked: number | {
          toNumber: (() => number);
      };
  }

  • allowedMints: boolean

  • bump: number

  • collections: Uint8Array

  • cooldownDuration: bignum

  • creators: Uint8Array

  • currency: string

  • endTime: bignum

  • key: string

  • lockType: string

  • maxRewardsDuration: bignum

  • minStakeDuration: bignum

  • name: string

  • project: string

  • resetStakeDuration: boolean

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

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

  • startTime: bignum

  • tempPlaceHolder1: number

  • tempPlaceHolder2: string

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

serialize

• serialize(): [Buffer, number]

• Serializes the StakingPool 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 StakingPool for the provided args.

  Parameters

  • args: StakingPoolArgs

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

  Returns number

Static deserialize

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

• Deserializes the StakingPool from the provided data Buffer.

  Parameters

  • buf: Buffer

  • Optional offset: number

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

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

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<StakingPool>

  Throws

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

Static fromAccountInfo

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

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

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • Optional offset: number

  Returns [StakingPool, number]

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

Static fromArgs

• fromArgs(args): StakingPool

• Creates a StakingPool instance from the provided args.

  Parameters

  • args: StakingPoolArgs

  Returns StakingPool

Static getMinimumBalanceForRentExemption

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

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

  Parameters

  • args: StakingPoolArgs

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

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

  Parameters

  • Optional programId: PublicKey

    the program that owns the accounts we are filtering

  Returns GpaBuilder<StakingPoolArgs & {
      accountDiscriminator: number[];
  }>