Class NectarStakingFetch

Represents the API for fetching data related to staking pools and NFTs.

Hierarchy

  • NectarStakingFetch

Constructors

constructor

Methods

availableNfts multipliers nft nftsByWallet rewards stakedNfts staker

Constructors

constructor

Methods

availableNfts

  • Fetch all available NFTs that can be staked in the staking pool.

    Parameters

    • Optional walletAddress: PublicKey

      The address of the wallet to fetch available NFTs for.

    Returns Promise<AvailableNft[]>

    A Promise that resolves with an array of available NFTs.

multipliers

  • Fetch the multipliers associated with the staking pool.

    Returns Promise<StakingMultipliers>

    A Promise that resolves with the multipliers data.

nft

  • Fetch data for a specific NFT mint.

    Parameters

    • mint: PublicKey

      The address of the NFT mint.

    Returns Promise<{
        address: PublicKey;
        bump: number;
        collection: PublicKey;
        creator: PublicKey;
        lastClaim: bignum;
        lastStakedAt: bignum;
        lastUnstakedAt: bignum;
        mint: PublicKey;
        stakedAt: bignum;
        staker: PublicKey;
        stakingPool: PublicKey;
    }>

    A Promise that resolves with the NFT data.

nftsByWallet

  • Fetch all NFTs staked by a specific wallet in the staking pool.

    Parameters

    • Optional walletAddress: PublicKey

      The address of the wallet to fetch staked NFTs for.

    Returns Promise<NFT[]>

    A Promise that resolves with an array of staked NFTs.

rewards

  • Fetch rewards data for a list of staked NFTs.

    Parameters

    • stakedNfts: StakedNft[]

      An array of staked NFTs for which rewards data is to be fetched.

    Returns Promise<{
        multipliers: number;
        rewards: number;
    }[]>

    A Promise that resolves with an array of rewards data.

stakedNfts

  • Fetch all staked NFTs of a specific wallet in the staking pool.

    Parameters

    • Optional walletAddress: PublicKey

      The address of the wallet to fetch staked NFTs for.

    Returns Promise<StakedNft[]>

    A Promise that resolves with an array of staked NFTs.

staker

  • Fetch a staker's account information.

    Parameters

    • args: {
          wallet: PublicKey;
      } | {
          address: PublicKey;
      }

      The arguments to identify the staker (wallet address or account address).

    Returns Promise<Staker>

    A Promise that resolves with the staker's account information.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc