Class StackingClient

Hierarchy

StackingClient

Constructors

constructor

new StackingClient(address: string, network: StacksNetwork): StackingClient

- Defined in packages/stacking/src/index.ts:169
Parameters
- address: string
- network: StacksNetwork
Returns StackingClient

Properties

address

address: string

network

network: StacksNetwork

Methods

canStack

canStack(options: CanLockStxOptions): Promise<StackingEligibility>

- Defined in packages/stacking/src/index.ts:321
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: DelegateStackStxOptions): Promise<TxBroadcastResult>

- Defined in packages/stacking/src/index.ts:438
As a delegator, generate and broadcast transactions to stack for multiple delegatees. This will lock up tokens owned by the delegatees.

Parameters
- options: DelegateStackStxOptions
  
  a required delegate stack STX options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds

delegateStx

delegateStx(options: DelegateStxOptions): Promise<TxBroadcastResult>

- Defined in packages/stacking/src/index.ts:405
As a delegatee, generate and broadcast a transaction to create a delegation relationship

Parameters
- options: DelegateStxOptions
  
  a required delegate STX options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds

getAccountBalance

getAccountBalance(): Promise<bigint>

- Defined in packages/stacking/src/index.ts:217
Get account balance

Returns Promise<bigint>
promise resolves to a bigint if the operation succeeds

getAccountStatus

getAccountStatus(): Promise<any>

- Defined in packages/stacking/src/index.ts:207
Returns Promise<any>

getCoreInfo

getCoreInfo(): Promise<CoreInfo>

- Defined in packages/stacking/src/index.ts:176
Get stacks node info

Returns Promise<CoreInfo>
that resolves to a CoreInfo response if the operation succeeds

getCycleDuration

getCycleDuration(): Promise<number>

- Defined in packages/stacking/src/index.ts:228
Get reward cycle duration in seconds

Returns Promise<number>
that resolves to a number if the operation succeeds

getDelegateOptions

getDelegateOptions(__namedParameters: { amountMicroStx: IntegerType; contract: string; delegateTo: string; poxAddress?: string; untilBurnBlockHeight?: number }): ContractCallOptions

- Defined in packages/stacking/src/index.ts:551
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

getDelegateStackOptions

getDelegateStackOptions(__namedParameters: { amountMicroStx: IntegerType; burnBlockHeight: number; contract: string; cycles: number; nonce?: IntegerType; poxAddress: string; stacker: string }): ContractCallOptions

- Defined in packages/stacking/src/index.ts:597
Parameters
- __namedParameters: { amountMicroStx: IntegerType; burnBlockHeight: number; contract: string; cycles: number; nonce?: IntegerType; poxAddress: string; stacker: string }
  - amountMicroStx: IntegerType
  - burnBlockHeight: number
  - contract: string
  - cycles: number
  - Optional nonce?: IntegerType
  - poxAddress: string
  - stacker: string
Returns ContractCallOptions

getPoxInfo

getPoxInfo(): Promise<PoxInfo>

- Defined in packages/stacking/src/index.ts:186
Get stacks node pox info

Returns Promise<PoxInfo>
that resolves to a PoxInfo response if the operation succeeds

getRevokeDelegateStxOptions

getRevokeDelegateStxOptions(contract: string): ContractCallOptions

- Defined in packages/stacking/src/index.ts:678
Parameters
- contract: string
Returns ContractCallOptions

getRewardHoldersForBtcAddress

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

- Defined in packages/stacking/src/index.ts:266
Get burnchain rewards holders for the set address

Parameters
- Optional options: RewardOptions
Returns Promise<RewardsError | BurnchainRewardSlotHolderListResponse>
that resolves to RewardHoldersResponse or RewardsError

getRewardsForBtcAddress

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

- Defined in packages/stacking/src/index.ts:254
Get burnchain rewards for the set address

Parameters
- Optional options: RewardOptions
Returns Promise<RewardsError | BurnchainRewardListResponse>
that resolves to RewardsResponse or RewardsError

getRewardsTotalForBtcAddress

getRewardsTotalForBtcAddress(): Promise<RewardsError | BurnchainRewardsTotal>

- Defined in packages/stacking/src/index.ts:244
Get the total burnchain rewards total for the set address

Returns Promise<RewardsError | BurnchainRewardsTotal>
that resolves to TotalRewardsResponse or RewardsError

getSecondsUntilNextCycle

getSecondsUntilNextCycle(): Promise<number>

- Defined in packages/stacking/src/index.ts:278
Get number of seconds until next reward cycle

Returns Promise<number>
that resolves to a number if the operation succeeds

getStackAggregationCommitOptions

getStackAggregationCommitOptions(__namedParameters: { contract: string; poxAddress: string; rewardCycle: number }): ContractCallOptions

- Defined in packages/stacking/src/index.ts:647
Parameters
- __namedParameters: { contract: string; poxAddress: string; rewardCycle: number }
  - contract: string
  - poxAddress: string
  - rewardCycle: number
Returns ContractCallOptions

getStackOptions

getStackOptions(__namedParameters: { amountMicroStx: IntegerType; burnBlockHeight: number; contract: string; cycles: number; poxAddress: string }): ContractCallOptions

- Defined in packages/stacking/src/index.ts:516
Parameters
- __namedParameters: { amountMicroStx: IntegerType; burnBlockHeight: number; contract: string; cycles: number; poxAddress: string }
  - amountMicroStx: IntegerType
  - burnBlockHeight: number
  - contract: string
  - cycles: number
  - poxAddress: string
Returns ContractCallOptions

getStatus

getStatus(): Promise<StackerInfo>

- Defined in packages/stacking/src/index.ts:698
Check stacking status

Returns Promise<StackerInfo>
that resolves to a StackerInfo object if the operation succeeds

getTargetBlockTime

getTargetBlockTime(): Promise<number>

- Defined in packages/stacking/src/index.ts:196
Get stacks node target block time

Returns Promise<number>
that resolves to a number if the operation succeeds

hasMinimumStx

hasMinimumStx(): Promise<boolean>

- Defined in packages/stacking/src/index.ts:308
Check if account has minimum require amount of Stacks for stacking

Returns Promise<boolean>
that resolves to a bool if the operation succeeds

isStackingEnabledNextCycle

isStackingEnabledNextCycle(): Promise<boolean>

- Defined in packages/stacking/src/index.ts:299
Check if stacking is enabled for next reward cycle

Returns Promise<boolean>
that resolves to a bool if the operation succeeds

modifyLockTxFee

modifyLockTxFee(__namedParameters: { amountMicroStx: IntegerType; tx: StacksTransaction }): StacksTransaction

- Defined in packages/stacking/src/index.ts:750
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): string[]

- Defined in packages/stacking/src/index.ts:763
Parses a contract identifier and ensures it is formatted correctly

Parameters
- contract: string
Returns string[]
a contract address and name

revokeDelegateStx

revokeDelegateStx(privateKey: string): Promise<TxBroadcastResult>

- Defined in packages/stacking/src/index.ts:502
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

stack

stack(options: LockStxOptions): Promise<TxBroadcastResult>

- Defined in packages/stacking/src/index.ts:373
Generate and broadcast a stacking transaction to lock STX

Parameters
- options: LockStxOptions
  
  a required lock STX options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds

stackAggregationCommit

stackAggregationCommit(options: StackAggregationCommitOptions): Promise<TxBroadcastResult>

- Defined in packages/stacking/src/index.ts:474
As a delegator, generate and broadcast a transaction to commit partially committed delegatee tokens

Parameters
- options: StackAggregationCommitOptions
  
  a required stack aggregation commit options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds

Generated using TypeDoc