Class SolanaStakingClient

Index

Constructors

Properties

Methods

claimRewards closeRewardEntry closeStakeEntry createRewardEntry createRewardPool createStakePool decode execute fundPool getCommitment getCurrentProgramId getDefaultFeeValue getDiscriminator getFee getFeeValueIfExists getStakeEntry getStakePool prepareClaimRewardsInstructions prepareCloseRewardEntryInstructions prepareCloseStakeEntryInstructions prepareCreateRewardEntryInstructions prepareCreateRewardPoolInstructions prepareCreateStakePoolInstructions prepareFundPoolInstructions prepareStakeAndCreateEntriesInstructions prepareStakeInstructions prepareUnstakeAndClaimInstructions prepareUnstakeAndCloseInstructions prepareUnstakeInstructions prepareUpdateRewardPoolInstructions searchRewardEntries searchRewardPools searchStakeEntries searchStakePools stake stakeAndCreateEntries unstake unstakeAndClaim unstakeAndClose updateRewardPool

Constructors

constructor

new SolanaStakingClient(__namedParameters: IInitOptions): SolanaStakingClient
Parameters
- __namedParameters: IInitOptions
Returns SolanaStakingClient
- Defined in packages/staking/solana/client.ts:113

Properties

connection

connection: Connection

`Readonly`programs

programs: Programs

Methods

claimRewards

claimRewards(
data: ClaimRewardPoolArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: ClaimRewardPoolArgs
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:577

closeRewardEntry

closeRewardEntry(
data: CreateRewardEntryArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: CreateRewardEntryArgs
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:718

closeStakeEntry

closeStakeEntry(
data: CloseStakeEntryArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[]; txId: string }>
Parameters
- data: CloseStakeEntryArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[]; txId: string }>
- Defined in packages/staking/solana/client.ts:510

createRewardEntry

createRewardEntry(
data: CreateRewardEntryArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: CreateRewardEntryArgs
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:684

createRewardPool

createRewardPool(
data: CreateRewardPoolArgs,
extParams: IInteractSolanaExt,
): Promise<CreationResult>
Parameters
- data: CreateRewardPoolArgs
- extParams: IInteractSolanaExt
Returns Promise<CreationResult>
- Defined in packages/staking/solana/client.ts:535

createStakePool

createStakePool(
data: CreateStakePoolArgs,
extParams: IInteractSolanaExt,
): Promise<CreationResult>
Parameters
- data: CreateStakePoolArgs
- extParams: IInteractSolanaExt
Returns Promise<CreationResult>
- Defined in packages/staking/solana/client.ts:232

decode

decode<
    ProgramName extends keyof Programs = keyof Programs,
    DecodingProgram = Programs[ProgramName],
    DerivedIdl extends
        Idl = DecodingProgram extends Program<IDLType> ? IDLType : never,
    AccountName extends
        string
        | number
        | symbol = keyof IdlAccounts<DerivedIdl>,
    DecodedAccount = IdlAccounts<DerivedIdl>[AccountName],
>(
    programKey: ProgramName,
    accountName: AccountName,
    accInfo: Buffer,
): DecodedAccount
Type Parameters
- ProgramName extends keyof Programs = keyof Programs
- DecodingProgram = Programs[ProgramName]
- DerivedIdl extends Idl = DecodingProgram extends Program<IDLType> ? IDLType : never
- AccountName extends string | number | symbol = keyof IdlAccounts<DerivedIdl>
- DecodedAccount = IdlAccounts<DerivedIdl>[AccountName]
Parameters
- programKey: ProgramName
- accountName: AccountName
- accInfo: Buffer
Returns DecodedAccount
- Defined in packages/staking/solana/client.ts:775

execute

execute(
ixs: TransactionInstruction[],
extParams: IInteractSolanaExt,
): Promise<{ signature: string }>
Parameters
- ixs: TransactionInstruction[]
- extParams: IInteractSolanaExt
Returns Promise<{ signature: string }>
- Defined in packages/staking/solana/client.ts:807

fundPool

fundPool(
data: FundPoolArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: FundPoolArgs
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:629

getCommitment

getCommitment(): Commitment
Returns Commitment
- Defined in packages/staking/solana/client.ts:170

getCurrentProgramId

getCurrentProgramId(programKey: keyof Programs): PublicKey
Parameters
- programKey: keyof Programs
Returns PublicKey
- Defined in packages/staking/solana/client.ts:164

getDefaultFeeValue

getDefaultFeeValue(): Promise<
    {
        authority: PublicKey;
        buffer1: number[];
        buffer2: number[];
        buffer3: number[];
        streamflowFee: BN;
    },
>
Returns Promise<
    {
        authority: PublicKey;
        buffer1: number[];
        buffer2: number[];
        buffer3: number[];
        streamflowFee: BN;
    },
>
- Defined in packages/staking/solana/client.ts:220

getDiscriminator

getDiscriminator<
    ProgramName extends keyof Programs = keyof Programs,
    DecodingProgram = Programs[ProgramName],
    DerivedIdl extends
        Idl = DecodingProgram extends Program<IDLType> ? IDLType : never,
    AccountName extends
        string
        | number
        | symbol = keyof IdlAccounts<DerivedIdl>,
>(
    programKey: ProgramName,
    accountName: AccountName,
): number[]
Type Parameters
- ProgramName extends keyof Programs = keyof Programs
- DecodingProgram = Programs[ProgramName]
- DerivedIdl extends Idl = DecodingProgram extends Program<IDLType> ? IDLType : never
- AccountName extends string | number | symbol = keyof IdlAccounts<DerivedIdl>
Parameters
- programKey: ProgramName
- accountName: AccountName
Returns number[]
- Defined in packages/staking/solana/client.ts:791

getFee

getFee(
    target: string | PublicKey,
): Promise<
    | { buffer: number[]; streamflowFee: BN }
    | {
        authority: PublicKey;
        buffer1: number[];
        buffer2: number[];
        buffer3: number[];
        streamflowFee: BN;
    },
>
Parameters
- target: string | PublicKey
Returns Promise<
    | { buffer: number[]; streamflowFee: BN }
    | {
        authority: PublicKey;
        buffer1: number[];
        buffer2: number[];
        buffer3: number[];
        streamflowFee: BN;
    },
>
- Defined in packages/staking/solana/client.ts:212

getFeeValueIfExists

getFeeValueIfExists(
target: string | PublicKey,
): Promise<{ buffer: number[]; streamflowFee: BN }>
Parameters
- target: string | PublicKey
Returns Promise<{ buffer: number[]; streamflowFee: BN }>
- Defined in packages/staking/solana/client.ts:226

getStakeEntry

getStakeEntry(
    id: string | PublicKey,
): Promise<
    {
        amount: BN;
        authority: PublicKey;
        autoUnstake: boolean;
        buffer: number[];
        closedTs: BN;
        createdTs: BN;
        duration: BN;
        effectiveAmount: BN;
        isSponsored: boolean;
        nonce: number;
        payer: PublicKey;
        priorTotalEffectiveStake: BN;
        stakePool: PublicKey;
        unstakeTs: BN;
    },
>
Parameters
- id: string | PublicKey
Returns Promise<
    {
        amount: BN;
        authority: PublicKey;
        autoUnstake: boolean;
        buffer: number[];
        closedTs: BN;
        createdTs: BN;
        duration: BN;
        effectiveAmount: BN;
        isSponsored: boolean;
        nonce: number;
        payer: PublicKey;
        priorTotalEffectiveStake: BN;
        stakePool: PublicKey;
        unstakeTs: BN;
    },
>
- Defined in packages/staking/solana/client.ts:186

getStakePool

getStakePool(
    id: string | PublicKey,
): Promise<
    {
        authority: PublicKey;
        autoUnstake: boolean;
        buffer: number[];
        bump: number;
        creator: PublicKey;
        expiryTs: BN;
        freezeStakeMint: boolean;
        isTotalStakeCapped: boolean;
        maxDuration: BN;
        maxWeight: BN;
        minDuration: BN;
        mint: PublicKey;
        minWeight: BN;
        nonce: number;
        permissionless: boolean;
        remainingTotalStake: BN;
        stakeMint: PublicKey;
        totalEffectiveStake: BN;
        totalStake: BN;
        unstakePeriod: BN;
        vault: PublicKey;
    },
>
Parameters
- id: string | PublicKey
Returns Promise<
    {
        authority: PublicKey;
        autoUnstake: boolean;
        buffer: number[];
        bump: number;
        creator: PublicKey;
        expiryTs: BN;
        freezeStakeMint: boolean;
        isTotalStakeCapped: boolean;
        maxDuration: BN;
        maxWeight: BN;
        minDuration: BN;
        mint: PublicKey;
        minWeight: BN;
        nonce: number;
        permissionless: boolean;
        remainingTotalStake: BN;
        stakeMint: PublicKey;
        totalEffectiveStake: BN;
        totalStake: BN;
        unstakePeriod: BN;
        vault: PublicKey;
    },
>
- Defined in packages/staking/solana/client.ts:174

prepareClaimRewardsInstructions

prepareClaimRewardsInstructions(
__namedParameters: ClaimRewardPoolArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- __namedParameters: ClaimRewardPoolArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:587

prepareCloseRewardEntryInstructions

prepareCloseRewardEntryInstructions(
__namedParameters: CreateRewardEntryArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- __namedParameters: CreateRewardEntryArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:728

prepareCloseStakeEntryInstructions

prepareCloseStakeEntryInstructions(
__namedParameters: CloseStakeEntryArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- __namedParameters: CloseStakeEntryArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:520

prepareCreateRewardEntryInstructions

prepareCreateRewardEntryInstructions(
__namedParameters: CreateRewardEntryArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- __namedParameters: CreateRewardEntryArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:694

prepareCreateRewardPoolInstructions

prepareCreateRewardPoolInstructions(
__namedParameters: CreateRewardPoolArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[]; publicKey: PublicKey }>
Parameters
- __namedParameters: CreateRewardPoolArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[]; publicKey: PublicKey }>
- Defined in packages/staking/solana/client.ts:546

prepareCreateStakePoolInstructions

prepareCreateStakePoolInstructions(
__namedParameters: CreateStakePoolArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[]; publicKey: PublicKey }>
Parameters
- __namedParameters: CreateStakePoolArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[]; publicKey: PublicKey }>
- Defined in packages/staking/solana/client.ts:243

prepareFundPoolInstructions

prepareFundPoolInstructions(
__namedParameters: FundPoolArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- __namedParameters: FundPoolArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:639

prepareStakeAndCreateEntriesInstructions

prepareStakeAndCreateEntriesInstructions(
data: StakeAndCreateEntriesArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- data: StakeAndCreateEntriesArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:331

prepareStakeInstructions

prepareStakeInstructions(
__namedParameters: StakeArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- __namedParameters: StakeArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:358

prepareUnstakeAndClaimInstructions

prepareUnstakeAndClaimInstructions(
data: UnstakeAndCloseArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- data: UnstakeAndCloseArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:410

prepareUnstakeAndCloseInstructions

prepareUnstakeAndCloseInstructions(
data: UnstakeAndCloseArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- data: UnstakeAndCloseArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:459

prepareUnstakeInstructions

prepareUnstakeInstructions(
__namedParameters: UnstakeArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- __namedParameters: UnstakeArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:486

prepareUpdateRewardPoolInstructions

prepareUpdateRewardPoolInstructions(
__namedParameters: UpdateRewardPoolArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[] }>
Parameters
- __namedParameters: UpdateRewardPoolArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[] }>
- Defined in packages/staking/solana/client.ts:756

searchRewardEntries

searchRewardEntries(
    criteria: Partial<
        Pick<
            {
                accountedAmount: BN;
                buffer: number[];
                claimedAmount: BN;
                createdTs: BN;
                isSponsored: boolean;
                lastAccountedTs: BN;
                lastRewardAmount: BN;
                lastRewardPeriod: BN;
                rewardPool: PublicKey;
                stakeEntry: PublicKey;
            },
            "rewardPool"
            | "stakeEntry",
        >,
    >,
): Promise<
    ProgramAccount<
        {
            accountedAmount: BN;
            buffer: number[];
            claimedAmount: BN;
            createdTs: BN;
            isSponsored: boolean;
            lastAccountedTs: BN;
            lastRewardAmount: BN;
            lastRewardPeriod: BN;
            rewardPool: PublicKey;
            stakeEntry: PublicKey;
        },
    >[],
>
Parameters
- criteria: Partial<
      Pick<
          {
              accountedAmount: BN;
              buffer: number[];
              claimedAmount: BN;
              createdTs: BN;
              isSponsored: boolean;
              lastAccountedTs: BN;
              lastRewardAmount: BN;
              lastRewardPeriod: BN;
              rewardPool: PublicKey;
              stakeEntry: PublicKey;
          },
          "rewardPool"
          | "stakeEntry",
      >,
  >
Returns Promise<
    ProgramAccount<
        {
            accountedAmount: BN;
            buffer: number[];
            claimedAmount: BN;
            createdTs: BN;
            isSponsored: boolean;
            lastAccountedTs: BN;
            lastRewardAmount: BN;
            lastRewardPeriod: BN;
            rewardPool: PublicKey;
            stakeEntry: PublicKey;
        },
    >[],
>
- Defined in packages/staking/solana/client.ts:205

searchRewardPools

searchRewardPools(
    criteria?: Partial<
        Pick<
            {
                authority: PublicKey;
                buffer: number[];
                bump: number;
                claimedAmount: BN;
                clawedBackTs: BN;
                createdTs: BN;
                creator: PublicKey;
                fundedAmount: BN;
                lastAmountUpdateTs: BN;
                lastClaimPeriod: BN;
                lastPeriodUpdateTs: BN;
                lastRewardAmount: BN;
                lastRewardPeriod: BN;
                mint: PublicKey;
                nonce: number;
                permissionless: boolean;
                rewardAmount: BN;
                rewardPeriod: BN;
                stakePool: PublicKey;
                vault: PublicKey;
            },
            "mint"
            | "stakePool",
        >,
    >,
): Promise<
    ProgramAccount<
        {
            authority: PublicKey;
            buffer: number[];
            bump: number;
            claimedAmount: BN;
            clawedBackTs: BN;
            createdTs: BN;
            creator: PublicKey;
            fundedAmount: BN;
            lastAmountUpdateTs: BN;
            lastClaimPeriod: BN;
            lastPeriodUpdateTs: BN;
            lastRewardAmount: BN;
            lastRewardPeriod: BN;
            mint: PublicKey;
            nonce: number;
            permissionless: boolean;
            rewardAmount: BN;
            rewardPeriod: BN;
            stakePool: PublicKey;
            vault: PublicKey;
        },
    >[],
>
Parameters
- criteria: Partial<
      Pick<
          {
              authority: PublicKey;
              buffer: number[];
              bump: number;
              claimedAmount: BN;
              clawedBackTs: BN;
              createdTs: BN;
              creator: PublicKey;
              fundedAmount: BN;
              lastAmountUpdateTs: BN;
              lastClaimPeriod: BN;
              lastPeriodUpdateTs: BN;
              lastRewardAmount: BN;
              lastRewardPeriod: BN;
              mint: PublicKey;
              nonce: number;
              permissionless: boolean;
              rewardAmount: BN;
              rewardPeriod: BN;
              stakePool: PublicKey;
              vault: PublicKey;
          },
          "mint"
          | "stakePool",
      >,
  > = {}
Returns Promise<
    ProgramAccount<
        {
            authority: PublicKey;
            buffer: number[];
            bump: number;
            claimedAmount: BN;
            clawedBackTs: BN;
            createdTs: BN;
            creator: PublicKey;
            fundedAmount: BN;
            lastAmountUpdateTs: BN;
            lastClaimPeriod: BN;
            lastPeriodUpdateTs: BN;
            lastRewardAmount: BN;
            lastRewardPeriod: BN;
            mint: PublicKey;
            nonce: number;
            permissionless: boolean;
            rewardAmount: BN;
            rewardPeriod: BN;
            stakePool: PublicKey;
            vault: PublicKey;
        },
    >[],
>
- Defined in packages/staking/solana/client.ts:198

searchStakeEntries

searchStakeEntries(
    criteria?: Partial<
        Pick<
            {
                amount: BN;
                authority: PublicKey;
                autoUnstake: boolean;
                buffer: number[];
                closedTs: BN;
                createdTs: BN;
                duration: BN;
                effectiveAmount: BN;
                isSponsored: boolean;
                nonce: number;
                payer: PublicKey;
                priorTotalEffectiveStake: BN;
                stakePool: PublicKey;
                unstakeTs: BN;
            },
            "payer"
            | "authority"
            | "stakePool",
        >,
    >,
): Promise<
    ProgramAccount<
        {
            amount: BN;
            authority: PublicKey;
            autoUnstake: boolean;
            buffer: number[];
            closedTs: BN;
            createdTs: BN;
            duration: BN;
            effectiveAmount: BN;
            isSponsored: boolean;
            nonce: number;
            payer: PublicKey;
            priorTotalEffectiveStake: BN;
            stakePool: PublicKey;
            unstakeTs: BN;
        },
    >[],
>
Parameters
- criteria: Partial<
      Pick<
          {
              amount: BN;
              authority: PublicKey;
              autoUnstake: boolean;
              buffer: number[];
              closedTs: BN;
              createdTs: BN;
              duration: BN;
              effectiveAmount: BN;
              isSponsored: boolean;
              nonce: number;
              payer: PublicKey;
              priorTotalEffectiveStake: BN;
              stakePool: PublicKey;
              unstakeTs: BN;
          },
          "payer"
          | "authority"
          | "stakePool",
      >,
  > = {}
Returns Promise<
    ProgramAccount<
        {
            amount: BN;
            authority: PublicKey;
            autoUnstake: boolean;
            buffer: number[];
            closedTs: BN;
            createdTs: BN;
            duration: BN;
            effectiveAmount: BN;
            isSponsored: boolean;
            nonce: number;
            payer: PublicKey;
            priorTotalEffectiveStake: BN;
            stakePool: PublicKey;
            unstakeTs: BN;
        },
    >[],
>
- Defined in packages/staking/solana/client.ts:191

searchStakePools

searchStakePools(
    criteria?: Partial<
        Pick<
            {
                authority: PublicKey;
                autoUnstake: boolean;
                buffer: number[];
                bump: number;
                creator: PublicKey;
                expiryTs: BN;
                freezeStakeMint: boolean;
                isTotalStakeCapped: boolean;
                maxDuration: BN;
                maxWeight: BN;
                minDuration: BN;
                mint: PublicKey;
                minWeight: BN;
                nonce: number;
                permissionless: boolean;
                remainingTotalStake: BN;
                stakeMint: PublicKey;
                totalEffectiveStake: BN;
                totalStake: BN;
                unstakePeriod: BN;
                vault: PublicKey;
            },
            "mint"
            | "creator",
        >,
    >,
): Promise<
    ProgramAccount<
        {
            authority: PublicKey;
            autoUnstake: boolean;
            buffer: number[];
            bump: number;
            creator: PublicKey;
            expiryTs: BN;
            freezeStakeMint: boolean;
            isTotalStakeCapped: boolean;
            maxDuration: BN;
            maxWeight: BN;
            minDuration: BN;
            mint: PublicKey;
            minWeight: BN;
            nonce: number;
            permissionless: boolean;
            remainingTotalStake: BN;
            stakeMint: PublicKey;
            totalEffectiveStake: BN;
            totalStake: BN;
            unstakePeriod: BN;
            vault: PublicKey;
        },
    >[],
>
Parameters
- criteria: Partial<
      Pick<
          {
              authority: PublicKey;
              autoUnstake: boolean;
              buffer: number[];
              bump: number;
              creator: PublicKey;
              expiryTs: BN;
              freezeStakeMint: boolean;
              isTotalStakeCapped: boolean;
              maxDuration: BN;
              maxWeight: BN;
              minDuration: BN;
              mint: PublicKey;
              minWeight: BN;
              nonce: number;
              permissionless: boolean;
              remainingTotalStake: BN;
              stakeMint: PublicKey;
              totalEffectiveStake: BN;
              totalStake: BN;
              unstakePeriod: BN;
              vault: PublicKey;
          },
          "mint"
          | "creator",
      >,
  > = {}
Returns Promise<
    ProgramAccount<
        {
            authority: PublicKey;
            autoUnstake: boolean;
            buffer: number[];
            bump: number;
            creator: PublicKey;
            expiryTs: BN;
            freezeStakeMint: boolean;
            isTotalStakeCapped: boolean;
            maxDuration: BN;
            maxWeight: BN;
            minDuration: BN;
            mint: PublicKey;
            minWeight: BN;
            nonce: number;
            permissionless: boolean;
            remainingTotalStake: BN;
            stakeMint: PublicKey;
            totalEffectiveStake: BN;
            totalStake: BN;
            unstakePeriod: BN;
            vault: PublicKey;
        },
    >[],
>
- Defined in packages/staking/solana/client.ts:179

stake

stake(
data: StakeArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: StakeArgs
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:300

stakeAndCreateEntries

stakeAndCreateEntries(
data: StakeAndCreateEntriesArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Stake into a Pool and creates Reward Entries to track rewards.

Resulting transaction may bee too large for execution if there are too many reward pools.
Parameters
- data: StakeAndCreateEntriesArgs
  enriched stake params with an array of reward pools
- extParams: IInteractSolanaExt
  parameter required for transaction execution
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:318

unstake

unstake(
data: UnstakeArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Parameters
- data: UnstakeArgs
- extParams: IInteractSolanaExt
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:382

unstakeAndClaim

unstakeAndClaim(
data: UnstakeAndCloseArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Unstake from a pool, claiming all rewards prior to that.

Resulting transaction may be too large for execution if there are too many reward pools.
Parameters
- data: UnstakeAndCloseArgs
  enriched unstake args with reward pools
- extParams: IInteractSolanaExt
  parameter required for transaction execution
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:400

unstakeAndClose

unstakeAndClose(
data: UnstakeAndCloseArgs,
extParams: IInteractSolanaExt,
): Promise<ITransactionResult>
Unstake from a pool, closing all related stake and reward entries.

REWARDS WON'T be claimed - use this call only if user can't unstake with rewards claims, i.e. when reward pool is drained.

Resulting transaction may be too large for execution if there are too many reward pools.
Parameters
- data: UnstakeAndCloseArgs
  enriched unstake args with reward pools
- extParams: IInteractSolanaExt
  parameter required for transaction execution
Returns Promise<ITransactionResult>
- Defined in packages/staking/solana/client.ts:449

updateRewardPool

updateRewardPool(
data: UpdateRewardPoolArgs,
extParams: IInteractSolanaExt,
): Promise<{ ixs: TransactionInstruction[]; txId: string }>
Parameters
- data: UpdateRewardPoolArgs
- extParams: IInteractSolanaExt
Returns Promise<{ ixs: TransactionInstruction[]; txId: string }>
- Defined in packages/staking/solana/client.ts:746

Class SolanaStakingClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SolanaStakingClient

Properties

connection

Readonlyprograms

Methods

claimRewards

Parameters

Returns Promise<ITransactionResult>

closeRewardEntry

Parameters

Returns Promise<ITransactionResult>

closeStakeEntry

Parameters

Returns Promise<{ ixs: TransactionInstruction[]; txId: string }>

createRewardEntry

Parameters

Returns Promise<ITransactionResult>

createRewardPool

Parameters

Returns Promise<CreationResult>

createStakePool

Parameters

Returns Promise<CreationResult>

decode

Type Parameters

Parameters

Returns DecodedAccount

execute

Parameters

Returns Promise<{ signature: string }>

fundPool

Parameters

Returns Promise<ITransactionResult>

getCommitment

Returns Commitment

getCurrentProgramId

Parameters

Returns PublicKey

getDefaultFeeValue

Returns Promise< { authority: PublicKey; buffer1: number[]; buffer2: number[]; buffer3: number[]; streamflowFee: BN; },>

getDiscriminator

Type Parameters

Parameters

Returns number[]

getFee

Parameters

Returns Promise< | { buffer: number[]; streamflowFee: BN } | { authority: PublicKey; buffer1: number[]; buffer2: number[]; buffer3: number[]; streamflowFee: BN; },>

getFeeValueIfExists

Parameters

Returns Promise<{ buffer: number[]; streamflowFee: BN }>

getStakeEntry

Parameters

Returns Promise< { amount: BN; authority: PublicKey; autoUnstake: boolean; buffer: number[]; closedTs: BN; createdTs: BN; duration: BN; effectiveAmount: BN; isSponsored: boolean; nonce: number; payer: PublicKey; priorTotalEffectiveStake: BN; stakePool: PublicKey; unstakeTs: BN; },>

getStakePool

Parameters

prepareClaimRewardsInstructions

Parameters

Returns Promise<{ ixs: TransactionInstruction[] }>

prepareCloseRewardEntryInstructions

Parameters

Returns Promise<{ ixs: TransactionInstruction[] }>

prepareCloseStakeEntryInstructions

Parameters

Returns Promise<{ ixs: TransactionInstruction[] }>

prepareCreateRewardEntryInstructions

Parameters

Returns Promise<{ ixs: TransactionInstruction[] }>

prepareCreateRewardPoolInstructions

Parameters

Returns Promise<{ ixs: TransactionInstruction[]; publicKey: PublicKey }>

prepareCreateStakePoolInstructions

Parameters

`Readonly`programs

Returns Promise<
{
authority: PublicKey;
buffer1: number[];
buffer2: number[];
buffer3: number[];
streamflowFee: BN;
},
>

Returns Promise<
| { buffer: number[]; streamflowFee: BN }
| {
authority: PublicKey;
buffer1: number[];
buffer2: number[];
buffer3: number[];
streamflowFee: BN;
},
>

Returns Promise<
{
amount: BN;
authority: PublicKey;
autoUnstake: boolean;
buffer: number[];
closedTs: BN;
createdTs: BN;
duration: BN;
effectiveAmount: BN;
isSponsored: boolean;
nonce: number;
payer: PublicKey;
priorTotalEffectiveStake: BN;
stakePool: PublicKey;
unstakeTs: BN;
},
>

Returns Promise<
ProgramAccount<
{
accountedAmount: BN;
buffer: number[];
claimedAmount: BN;
createdTs: BN;
isSponsored: boolean;
lastAccountedTs: BN;
lastRewardAmount: BN;
lastRewardPeriod: BN;
rewardPool: PublicKey;
stakeEntry: PublicKey;
},
>[],
>