Class StackingClient

constructor

• new StackingClient(address, network): StackingClient

• Parameters

  • address: string

  • network: StacksNetwork

  Returns StackingClient

address

network

canStack

• canStack(options): Promise<StackingEligibility>

• readonly can-stack-stx

  Check if account can lock stx

  Parameters

  • options: CanLockStxOptions

    a required lock STX options object

  Returns Promise<StackingEligibility>

  that resolves to a StackingEligibility object if the operation succeeds

delegateStackStx

• delegateStackStx(options): Promise<TxBroadcastResult>

• delegate-stack-stx

  As a delegator, generate and broadcast transactions to stack for multiple delegatees. This will lock up tokens owned by the delegatees.

  Parameters

  • options: DelegateStackStxOptions & BaseTxOptions

    a required delegate stack STX options object

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

delegateStx

• delegateStx(options): Promise<TxBroadcastResult>

• delegate-stx

  As a delegatee, generate and broadcast a transaction to create a delegation relationship

  Parameters

  • options: DelegateStxOptions & BaseTxOptions

    a required delegate STX options object

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

getAccountBalance

• getAccountBalance(): Promise<bigint>

• Get account balance

  Returns Promise<bigint>

  resolves to a bigint if the operation succeeds

getAccountBalanceLocked

• getAccountBalanceLocked(): Promise<bigint>

• Get account balance of locked tokens

  Returns Promise<bigint>

  resolves to a bigint if the operation succeeds

getAccountExtendedBalances

• getAccountExtendedBalances(): Promise<AccountExtendedBalances>

• Get extended account balances

  Returns Promise<AccountExtendedBalances>

  resolves to an AccountExtendedBalances response if the operation succeeds

getAccountStatus

• getAccountStatus(): Promise<any>

• Returns Promise<any>

getCoreInfo

• getCoreInfo(): Promise<CoreInfo>

• Get stacks node info

  Returns Promise<CoreInfo>

  that resolves to a CoreInfo response if the operation succeeds

getCycleDuration

• getCycleDuration(): Promise<number>

• Get reward cycle duration in seconds

  Returns Promise<number>

  resolves to a number if the operation succeeds

getDelegateOptions

• getDelegateOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        amountMicroStx: IntegerType;
        contract: string;
        delegateTo: string;
        poxAddress?: string;
        untilBurnBlockHeight?: number;
    }

    • amountMicroStx: IntegerType

    • contract: string

    • delegateTo: string

    • Optional poxAddress?: string

    • Optional untilBurnBlockHeight?: number

  Returns ContractCallOptions

getDelegateStackExtendOptions

• getDelegateStackExtendOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        contract: string;
        extendCount: number;
        poxAddress: string;
        stacker: string;
    }

    • contract: string

    • extendCount: number

    • poxAddress: string

    • stacker: string

  Returns ContractCallOptions

getDelegateStackIncreaseOptions

• getDelegateStackIncreaseOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        contract: string;
        increaseBy: IntegerType;
        poxAddress: string;
        stacker: string;
    }

    • contract: string

    • increaseBy: IntegerType

    • poxAddress: string

    • stacker: string

  Returns ContractCallOptions

getDelegateStackOptions

• getDelegateStackOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        amountMicroStx: IntegerType;
        burnBlockHeight: number;
        contract: string;
        cycles: number;
        poxAddress: string;
        stacker: string;
    }

    • amountMicroStx: IntegerType

    • burnBlockHeight: number

    • contract: string

    • cycles: number

    • poxAddress: string

    • stacker: string

  Returns ContractCallOptions

getDelegationStatus

• getDelegationStatus(): Promise<DelegationInfo>

• Check delegation status

  Returns Promise<DelegationInfo>

  that resolves to a DelegationInfo object if the operation succeeds

getPoxInfo

• getPoxInfo(): Promise<PoxInfo>

• Get stacks node pox info

  Returns Promise<PoxInfo>

  that resolves to a PoxInfo response if the operation succeeds

getPoxOperationInfo

• getPoxOperationInfo(poxInfo?): Promise<PoxOperationInfo>

• Get information on current PoX operation

  Periods:

  • Period 1: This is before the 2.1 fork.
  • Period 2: This is after the 2.1 fork, but before cycle (N+1).
  • Period 3: This is after cycle (N+1) has begun. Original PoX contract state will no longer have any impact on reward sets, account lock status, etc.

  Parameters

  • Optional poxInfo: PoxInfo

  Returns Promise<PoxOperationInfo>

  that resolves to PoX operation info

getRevokeDelegateStxOptions

• getRevokeDelegateStxOptions(contract): ContractCallOptions

• Parameters

  • contract: string

  Returns ContractCallOptions

getRewardHoldersForBtcAddress

• getRewardHoldersForBtcAddress(options?): Promise<RewardsError | BurnchainRewardSlotHolderListResponse>

• Get burnchain rewards holders for the set address

  Parameters

  • Optional options: PaginationOptions

  Returns Promise<RewardsError | BurnchainRewardSlotHolderListResponse>

  that resolves to RewardHoldersResponse or RewardsError

getRewardSet

• getRewardSet(options): Promise<undefined | RewardSetInfo>

• Get PoX address from reward set by index

  Parameters

  • options: RewardSetOptions

  Returns Promise<undefined | RewardSetInfo>

  that resolves to RewardSetInfo if the entry exists

getRewardsForBtcAddress

• getRewardsForBtcAddress(options?): Promise<RewardsError | BurnchainRewardListResponse>

• Get burnchain rewards for the set address

  Parameters

  • Optional options: PaginationOptions

  Returns Promise<RewardsError | BurnchainRewardListResponse>

  that resolves to RewardsResponse or RewardsError

getRewardsTotalForBtcAddress

• getRewardsTotalForBtcAddress(): Promise<RewardsError | BurnchainRewardsTotal>

• Get the total burnchain rewards total for the set address

  Returns Promise<RewardsError | BurnchainRewardsTotal>

  that resolves to TotalRewardsResponse or RewardsError

getSecondsUntilNextCycle

• getSecondsUntilNextCycle(): Promise<number>

• Get number of seconds until next reward cycle

  Returns Promise<number>

  resolves to a number if the operation succeeds

  See also:

  • getSecondsUntilStackingDeadline

getSecondsUntilStackingDeadline

• getSecondsUntilStackingDeadline(): Promise<number>

• Get number of seconds until the end of the stacking deadline. This is the estimated time stackers have to submit their stacking transactions to be included in the upcoming reward cycle.

  Returns Promise<number>

  resolves to a number of seconds if the operation succeeds. ⚠️ Attention: The returned number of seconds can be negative if the deadline has passed and the prepare phase has started.

  See also:

  • getSecondsUntilNextCycle

getStackAggregationCommitOptions

• getStackAggregationCommitOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        authId?: IntegerType;
        contract: string;
        maxAmount?: IntegerType;
        poxAddress: string;
        rewardCycle: number;
        signerKey?: string;
        signerSignature?: string;
    }

    • Optional authId?: IntegerType

    • contract: string

    • Optional maxAmount?: IntegerType

    • poxAddress: string

    • rewardCycle: number

    • Optional signerKey?: string

    • Optional signerSignature?: string

  Returns ContractCallOptions

getStackAggregationCommitOptionsIndexed

• getStackAggregationCommitOptionsIndexed(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        authId?: IntegerType;
        contract: string;
        maxAmount?: IntegerType;
        poxAddress: string;
        rewardCycle: number;
        signerKey?: string;
        signerSignature?: string;
    }

    • Optional authId?: IntegerType

    • contract: string

    • Optional maxAmount?: IntegerType

    • poxAddress: string

    • rewardCycle: number

    • Optional signerKey?: string

    • Optional signerSignature?: string

  Returns ContractCallOptions

getStackAggregationIncreaseOptions

• getStackAggregationIncreaseOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        contract: string;
        poxAddress: string;
        rewardCycle: number;
        rewardCycleIndex: number;
    }

    • contract: string

    • poxAddress: string

    • rewardCycle: number

    • rewardCycleIndex: number

  Returns ContractCallOptions

getStackExtendOptions

• getStackExtendOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        authId?: IntegerType;
        contract: string;
        extendCycles: number;
        maxAmount?: IntegerType;
        poxAddress: string;
        signerKey?: string;
        signerSignature?: string;
    }

    • Optional authId?: IntegerType

    • contract: string

    • extendCycles: number

    • Optional maxAmount?: IntegerType

    • poxAddress: string

    • Optional signerKey?: string

    • Optional signerSignature?: string

  Returns ContractCallOptions

getStackIncreaseOptions

• getStackIncreaseOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        authId?: IntegerType;
        contract: string;
        increaseBy: IntegerType;
        maxAmount?: IntegerType;
        signerKey?: string;
        signerSignature?: string;
    }

    • Optional authId?: IntegerType

    • contract: string

    • increaseBy: IntegerType

    • Optional maxAmount?: IntegerType

    • Optional signerKey?: string

    • Optional signerSignature?: string

  Returns ContractCallOptions

getStackOptions

• getStackOptions(__namedParameters): ContractCallOptions

• Parameters

  • __namedParameters: {
        amountMicroStx: IntegerType;
        authId?: IntegerType;
        burnBlockHeight: number;
        contract: string;
        cycles: number;
        maxAmount?: IntegerType;
        poxAddress: string;
        signerKey?: string;
        signerSignature?: string;
    }

    • amountMicroStx: IntegerType

    • Optional authId?: IntegerType

    • burnBlockHeight: number

    • contract: string

    • cycles: number

    • Optional maxAmount?: IntegerType

    • poxAddress: string

    • Optional signerKey?: string

    • Optional signerSignature?: string

  Returns ContractCallOptions

getStackingContract

• getStackingContract(poxOperationInfo?): Promise<string>

• Parameters

  • Optional poxOperationInfo: PoxOperationInfo

  Returns Promise<string>

  that resolves to the contract id (address and name) to use for stacking

getStatus

• getStatus(): Promise<StackerInfo>

• Check stacking status

  Returns Promise<StackerInfo>

  that resolves to a StackerInfo object if the operation succeeds

getTargetBlockTime

• getTargetBlockTime(): Promise<number>

• Get stacks node target block time

  Returns Promise<number>

  resolves to a number if the operation succeeds

hasMinimumStx

• hasMinimumStx(): Promise<boolean>

• Check if account has minimum require amount of Stacks for stacking

  Returns Promise<boolean>

  that resolves to a bool if the operation succeeds

modifyLockTxFee

• modifyLockTxFee(__namedParameters): StacksTransaction

• Adjust microstacks amount for locking after taking into account transaction fees

  Parameters

  • __namedParameters: {
        amountMicroStx: IntegerType;
        tx: StacksTransaction;
    }

    • amountMicroStx: IntegerType

    • tx: StacksTransaction

  Returns StacksTransaction

  that resolves to a transaction object if the operation succeeds

parseContractId

• parseContractId(contract): string[]

• Parses a contract identifier and ensures it is formatted correctly

  Parameters

  • contract: string

  Returns string[]

  a contract address and name

revokeDelegateStx

• revokeDelegateStx(privateKey): Promise<TxBroadcastResult>

• As a delegatee, generate and broadcast a transaction to terminate the delegation relationship

  Parameters

  • privateKey: string

    the private key to be used for the revoke call

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds
• revokeDelegateStx(txOptions): Promise<TxBroadcastResult>

• As a delegatee, generate and broadcast a transaction to terminate the delegation relationship

  Parameters

  • txOptions: BaseTxOptions

    the private key, fee, and nonce to be used for the revoke call

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

signPoxSignature

• signPoxSignature(__namedParameters): string

• Generates a signer-sig string for the current PoX contract.

  Parameters

  • __namedParameters: {
        authId: number;
        maxAmount: IntegerType;
        period: number;
        poxAddress: string;
        rewardCycle: number;
        signerPrivateKey: StacksPrivateKey;
        topic: "stack-stx" | "agg-commit" | "stack-extend" | "stack-increase";
    }

    • authId: number

    • maxAmount: IntegerType

    • period: number

    • poxAddress: string

    • rewardCycle: number

    • signerPrivateKey: StacksPrivateKey

    • topic: "stack-stx" | "agg-commit" | "stack-extend" | "stack-increase"

  Returns string

stack

• stack(options): Promise<TxBroadcastResult>

• stack-stx

  Generate and broadcast a stacking transaction to lock STX

  Parameters

  • options: LockStxOptions & BaseTxOptions

    a required lock STX options object

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

stackAggregationCommit

• stackAggregationCommit(options): Promise<TxBroadcastResult>

• As a delegator, generate and broadcast a transaction to commit partially committed delegatee tokens

  Parameters

  • options: StackAggregationCommitOptions & BaseTxOptions

    a required stack aggregation commit options object

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

delegateStackExtend

• delegateStackExtend(options): Promise<TxBroadcastResult>

• delegate-stack-extend

  As a delegator, generate and broadcast transactions to extend stack for multiple delegatees.

  Parameters

  • options: DelegateStackExtendOptions & BaseTxOptions

    a required delegate stack extend STX options object

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

delegateStackIncrease

• delegateStackIncrease(-): Promise<TxBroadcastResult>

• As a delegator, generate and broadcast transactions to stack increase for multiple delegatees.

  Parameters

  • -: DelegateStackIncreaseOptions & BaseTxOptions

    a required delegate stack increase STX options object

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

stackAggregationCommitIndexed

• stackAggregationCommitIndexed(options): Promise<TxBroadcastResult>

• As a delegator, generate and broadcast a transaction to commit partially committed delegatee tokens

  Commit partially stacked STX and allocate a new PoX reward address slot. This allows a stacker/delegate to lock fewer STX than the minimal threshold in multiple transactions, so long as: 1. The pox-addr is the same. 2. This "commit" transaction is called before the PoX anchor block. This ensures that each entry in the reward set returned to the stacks-node is greater than the threshold, but does not require it be all locked up within a single transaction

  stack-aggregation-commit-indexed returns (ok uint) on success, where the given uint is the reward address's index in the list of reward addresses allocated in this reward cycle. This index can then be passed to stack-aggregation-increase to later increment the STX this PoX address represents, in amounts less than the stacking minimum.

  Parameters

  • options: StackAggregationCommitOptions & BaseTxOptions

    a required stack aggregation commit options object

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

stackAggregationIncrease

• stackAggregationIncrease(options): Promise<TxBroadcastResult>

• As a delegator, generate and broadcast a transaction to increase partial commitment committed delegatee tokens

  Parameters

  • options: StackAggregationIncreaseOptions & BaseTxOptions

    a required stack aggregation increase options object

  Returns Promise<TxBroadcastResult>

  that resolves to a broadcasted txid if the operation succeeds

stackExtend

• stackExtend(-): Promise<TxBroadcastResult>

• stack-extend

  Generate and broadcast a stacking transaction to extend locked STX (pox-2.stack-extend)

  Parameters

  • -: StackExtendOptions & BaseTxOptions

    a required extend STX options object

  Returns Promise<TxBroadcastResult>

  a broadcasted txid if the operation succeeds

stackIncrease

• stackIncrease(-): Promise<TxBroadcastResult>

• Generate and broadcast a stacking transaction to increase locked STX (pox-2.stack-increase)

  Parameters

  • -: StackIncreaseOptions & BaseTxOptions

    a required increase STX options object

  Returns Promise<TxBroadcastResult>

  a broadcasted txid if the operation succeeds