@arcium-hq/staking

TypeScript SDK for the Arcium staking program.

Interfaces

Interface	Description
BuildClaimDelegatedStakeRewardsIxParams	Parameters for `claim_delegated_stake_rewards`.
BuildClaimPrimaryStakeRewardsIxParams	Parameters for `claim_primary_stake_rewards`.
BuildCloseDelegatedStakeIxParams	Parameters for `close_delegated_stake`.
BuildDeactivatePrimaryStakeIxParams	Parameters for `deactivate_primary_stake`.
BuildDelegateStakeIxParams	Parameters for `delegate_stake`.
BuildEpochPrimaryStakeIxParams	Parameters for primary stake instructions that take a lockup epoch count.
BuildFinalizeEpochRewardsIxParams	Parameters for `finalize_epoch_rewards`.
BuildFinalizeRecoveryEpochRewardsIxParams	Parameters for `finalize_recovery_epoch_rewards`.
BuildInitClusterStakeStateIxParams	Parameters for `init_cluster_stake_state`.
BuildInitDelegatedStakeAccIxParams	Parameters for `init_delegated_stake_acc`.
BuildInitMxeRecoveryStakeStateIxParams	Parameters for `init_mxe_recovery_stake_state`.
BuildInitPoolIxParams	Parameters for `init`, which creates the staking pool account.
BuildInitPrimaryStakeIxParams	Parameters for `init_primary_stake`, which creates and funds a primary stake account.
BuildInitStakeMasterAccIxParams	Parameters for `init_stake_master_acc`.
BuildMergeDelegatedStakeAccountIxParams	Parameters for `merge_delegated_stake_account`.
BuildModifyPrimaryStakeIxParams	Parameters for `modify_primary_stake`, which changes primary self-stake.
BuildPrimaryStakeIxParams	Parameters shared by single-signer primary stake instructions.
BuildSetAuthorityIxParams	Parameters shared by delegated stake authority transfer instructions.
BuildSetDelegationAuthorityIxParams	Parameters for `set_delegation_authority`.
BuildSetWithdrawalAuthorityIxParams	Parameters for `set_withdrawal_authority`.
BuildSplitDelegatedStakeAccountIxParams	Parameters for `split_delegated_stake_account`.
BuildUndelegateStakeIxParams	Parameters for `undelegate_stake`.
GenerateStakeOffsetOptions	Options for delegated stake offset generation.
UserStakePosition	Delegated stake position owned or controlled by an authority.

Type Aliases

Type Alias	Description
ArciumStaking	Program IDL in camelCase format in order to be used in JS/TS.
ClusterStakeStateAccount	Decoded cluster stake state account.
DelegatedStakeAccount	Decoded delegated staking account.
DelegationMasterAccount	Decoded delegation master account.
Epoch	Staking epoch tuple wrapper.
IntegerInput	Integer input accepted by staking instruction builders.
MTProof	Merkle proof type used by reward claim instructions.
MxeRecoveryStakeStateAccount	Decoded MXE recovery stake state account.
PrimaryStakeAccount	Decoded primary staking account.
RewardBatch	Reward claim batch type.
RewardClaim	Reward claim leaf type.
StakeBinding	Primary stake binding type.
StakingPoolAccount	Decoded staking pool account.
StakingProgram	Anchor program client for the Arcium staking program.

Variables

Variable	Description
ARCIUM_ADDR	Arcium program id, from the staking IDL's cross-program clock PDA metadata.
ARX_TOKEN_MINT_ADDR	ARX token mint, from the staking IDL's token instruction accounts.
ASSOCIATED_TOKEN_PROGRAM_ADDR	Associated token program id, from the staking IDL.
STAKING_ADDR	Staking program id, from the bundled IDL.
STAKING_IDL	Anchor-generated staking IDL JSON.
TOKEN_PROGRAM_ADDR	SPL token program id, from the staking IDL.

Functions

Function	Description
assertValidStakeOffset	Throws if a delegated stake offset is reserved or outside the on-chain `u128` range.
buildActivatePrimaryStakeIx	Builds a primary stake activation instruction.
buildClaimDelegatedStakeRewardsIx	Builds a delegated stake rewards claim instruction.
buildClaimPrimaryStakeRewardsIx	Builds a primary stake rewards claim instruction.
buildCloseDelegatedStakeIx	Builds a delegated stake close instruction.
buildDeactivatePrimaryStakeIx	Builds a primary stake deactivation instruction.
buildDelegateStakeIx	Builds a delegated stake activation/delegation instruction.
buildExtendPrimaryLockupIx	Builds a primary stake lockup extension instruction.
buildFinalizeEpochRewardsIx	Builds a cluster epoch reward finalization instruction.
buildFinalizeRecoveryEpochRewardsIx	Builds an MXE recovery epoch reward finalization instruction.
buildInitClusterStakeStateIx	Builds a cluster stake state initialization instruction.
buildInitDelegatedStakeAccIx	Builds a delegated stake account initialization instruction.
buildInitMxeRecoveryStakeStateIx	Builds an MXE recovery stake state initialization instruction.
buildInitPoolIx	Builds the staking pool initialization instruction.
buildInitPrimaryStakeIx	Builds a primary stake account initialization instruction.
buildInitStakeMasterAccIx	Builds a delegation master account initialization instruction.
buildMergeDelegatedStakeAccountIx	Builds a delegated stake account merge instruction.
buildModifyPrimaryStakeIx	Builds a primary stake modification instruction.
buildSetDelegationAuthorityIx	Builds a delegated stake delegation-authority transfer instruction.
buildSetWithdrawalAuthorityIx	Builds a delegated stake withdrawal-authority transfer instruction.
buildSplitDelegatedStakeAccountIx	Builds a delegated stake account split instruction.
buildUndelegateStakeIx	Builds a delegated stake undelegation instruction.
generateStakeOffset	Generates an unused delegated stake offset by probing the derived PDA.
getArciumClockAccAddress	Derives Arcium's clock account PDA (a cross-program PDA under the Arcium program).
getArxNodeAccAddress	Derives Arcium's ARX node account PDA.
getArxTokenAtaAddress	Derives an owner's associated token account for the ARX token mint.
getClusterAccAddress	Derives Arcium's cluster account PDA.
getClusterStakeStateAccAddress	Derives a cluster stake state PDA.
getClusterStakeStateAccInfo	Fetches a cluster stake state account by cluster offset.
getClusterStakeStateAccInfos	Lists all cluster stake state accounts.
getDelegatedStakeAccAddress	Derives a delegated stake account PDA from its global stake offset.
getDelegatedStakeAccInfo	Fetches a delegated stake account by offset.
getDelegatedStakeAccInfos	Lists all delegated stake accounts.
getDelegationMasterAccInfo	Fetches a delegation master account by authority.
getDelegationMasterAccInfos	Lists all delegation master accounts.
getFeePoolAccAddress	Derives Arcium's fee pool account PDA.
getMxeAccAddress	Derives Arcium's MXE account PDA.
getMxeRecoveryStakeStateAccAddress	Derives an MXE recovery stake state PDA.
getMxeRecoveryStakeStateAccInfo	Fetches an MXE recovery stake state account by MXE program id.
getMxeRecoveryStakeStateAccInfos	Lists all MXE recovery stake state accounts.
getPrimaryStakeAccAddress	Derives a primary stake account PDA for an owner.
getPrimaryStakeAccInfo	Fetches a primary stake account by owner.
getPrimaryStakeAccInfos	Lists all primary stake accounts.
getRecoveryClusterAccAddress	Derives Arcium's recovery cluster account PDA.
getRecoveryPeerAccAddress	Derives Arcium's recovery peer account PDA.
getStakeMasterAccAddress	Derives a delegation master account PDA for an authority.
getStakingPoolAccAddress	Derives the staking pool account PDA.
getStakingPoolAccInfo	Fetches the staking pool account.
getStakingProgram	Constructs an Anchor program client for the Arcium staking program.
getStakingProgramId	Returns the staking program id from the bundled IDL.
getUserStakePositions	Returns delegated stake positions discoverable from an authority's master account.

@arcium-hq/staking

Interfaces

Type Aliases

Variables

Functions

On this page