Class StackingClient

Hierarchy

StackingClient

Constructors

constructor

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

Properties

address

address: string

network

network: StacksNetwork

Methods

canStack

canStack(options: CanLockStxOptions): Promise<StackingEligibility>
Check if account can lock stx

Returns
that resolves to a StackingEligibility object if the operation succeeds
Parameters
- options: CanLockStxOptions
  
  a required lock STX options object
Returns Promise<StackingEligibility>
- Defined in packages/stacking/src/index.ts:321

delegateStackStx

delegateStackStx(options: DelegateStackStxOptions): Promise<TxBroadcastResult>
As a delegator, generate and broadcast transactions to stack for multiple delegatees. This will lock up tokens owned by the delegatees.

Returns
that resolves to a broadcasted txid if the operation succeeds
Parameters
- options: DelegateStackStxOptions
  
  a required delegate stack STX options object
Returns Promise<TxBroadcastResult>
- Defined in packages/stacking/src/index.ts:438

delegateStx

delegateStx(options: DelegateStxOptions): Promise<TxBroadcastResult>
As a delegatee, generate and broadcast a transaction to create a delegation relationship

Returns
that resolves to a broadcasted txid if the operation succeeds
Parameters
- options: DelegateStxOptions
  
  a required delegate STX options object
Returns Promise<TxBroadcastResult>
- Defined in packages/stacking/src/index.ts:405

getAccountBalance

getAccountBalance(): Promise<bigint>
Get account balance

Returns
promise resolves to a bigint if the operation succeeds

Returns Promise<bigint>
- Defined in packages/stacking/src/index.ts:217

getAccountStatus

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

getCoreInfo

getCoreInfo(): Promise<CoreInfo>
Get stacks node info

Returns
that resolves to a CoreInfo response if the operation succeeds

Returns Promise<CoreInfo>
- Defined in packages/stacking/src/index.ts:176

getCycleDuration

getCycleDuration(): Promise<number>
Get reward cycle duration in seconds

Returns
that resolves to a number if the operation succeeds

Returns Promise<number>
- Defined in packages/stacking/src/index.ts:228

getDelegateOptions

getDelegateOptions(__namedParameters: {
    amountMicroStx: IntegerType;
    contract: string;
    delegateTo: string;
    poxAddress?: string;
    untilBurnBlockHeight?: number;
}): 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
- Defined in packages/stacking/src/index.ts:551

getDelegateStackOptions

getDelegateStackOptions(__namedParameters: {
    amountMicroStx: IntegerType;
    burnBlockHeight: number;
    contract: string;
    cycles: number;
    nonce?: IntegerType;
    poxAddress: string;
    stacker: string;
}): ContractCallOptions
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
- Defined in packages/stacking/src/index.ts:597

getPoxInfo

getPoxInfo(): Promise<PoxInfo>
Get stacks node pox info

Returns
that resolves to a PoxInfo response if the operation succeeds

Returns Promise<PoxInfo>
- Defined in packages/stacking/src/index.ts:186

getRevokeDelegateStxOptions

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

getRewardHoldersForBtcAddress

getRewardHoldersForBtcAddress(options?: RewardOptions): Promise<RewardsError | BurnchainRewardSlotHolderListResponse>
Get burnchain rewards holders for the set address

Returns
that resolves to RewardHoldersResponse or RewardsError
Parameters
- Optional options: RewardOptions
Returns Promise<RewardsError | BurnchainRewardSlotHolderListResponse>
- Defined in packages/stacking/src/index.ts:266

getRewardsForBtcAddress

getRewardsForBtcAddress(options?: RewardOptions): Promise<RewardsError | BurnchainRewardListResponse>
Get burnchain rewards for the set address

Returns
that resolves to RewardsResponse or RewardsError
Parameters
- Optional options: RewardOptions
Returns Promise<RewardsError | BurnchainRewardListResponse>
- Defined in packages/stacking/src/index.ts:254

getRewardsTotalForBtcAddress

getRewardsTotalForBtcAddress(): Promise<RewardsError | BurnchainRewardsTotal>
Get the total burnchain rewards total for the set address

Returns
that resolves to TotalRewardsResponse or RewardsError

Returns Promise<RewardsError | BurnchainRewardsTotal>
- Defined in packages/stacking/src/index.ts:244

getSecondsUntilNextCycle

getSecondsUntilNextCycle(): Promise<number>
Get number of seconds until next reward cycle

Returns
that resolves to a number if the operation succeeds

Returns Promise<number>
- Defined in packages/stacking/src/index.ts:278

getStackAggregationCommitOptions

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

getStackOptions

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

getStatus

getStatus(): Promise<StackerInfo>
Check stacking status

Returns
that resolves to a StackerInfo object if the operation succeeds

Returns Promise<StackerInfo>
- Defined in packages/stacking/src/index.ts:698

getTargetBlockTime

getTargetBlockTime(): Promise<number>
Get stacks node target block time

Returns
that resolves to a number if the operation succeeds

Returns Promise<number>
- Defined in packages/stacking/src/index.ts:196

hasMinimumStx

hasMinimumStx(): Promise<boolean>
Check if account has minimum require amount of Stacks for stacking

Returns
that resolves to a bool if the operation succeeds

Returns Promise<boolean>
- Defined in packages/stacking/src/index.ts:308

isStackingEnabledNextCycle

isStackingEnabledNextCycle(): Promise<boolean>
Check if stacking is enabled for next reward cycle

Returns
that resolves to a bool if the operation succeeds

Returns Promise<boolean>
- Defined in packages/stacking/src/index.ts:299

modifyLockTxFee

modifyLockTxFee(__namedParameters: {
amountMicroStx: IntegerType;
tx: StacksTransaction;
}): StacksTransaction
Adjust microstacks amount for locking after taking into account transaction fees

Returns
that resolves to a transaction object if the operation succeeds
Parameters
- __namedParameters: {
  amountMicroStx: IntegerType;
  tx: StacksTransaction;
  }
  - amountMicroStx: IntegerType
  - tx: StacksTransaction
Returns StacksTransaction
- Defined in packages/stacking/src/index.ts:750

parseContractId

parseContractId(contract: string): string[]
Parses a contract identifier and ensures it is formatted correctly

Returns
a contract address and name
Parameters
- contract: string
Returns string[]
- Defined in packages/stacking/src/index.ts:763

revokeDelegateStx

revokeDelegateStx(privateKey: string): Promise<TxBroadcastResult>
As a delegatee, generate and broadcast a transaction to terminate the delegation relationship

Returns
that resolves to a broadcasted txid if the operation succeeds
Parameters
- privateKey: string
  
  the private key to be used for the revoke call
Returns Promise<TxBroadcastResult>
- Defined in packages/stacking/src/index.ts:502

stack

stack(options: LockStxOptions): Promise<TxBroadcastResult>
Generate and broadcast a stacking transaction to lock STX

Returns
that resolves to a broadcasted txid if the operation succeeds
Parameters
- options: LockStxOptions
  
  a required lock STX options object
Returns Promise<TxBroadcastResult>
- Defined in packages/stacking/src/index.ts:373

stackAggregationCommit

stackAggregationCommit(options: StackAggregationCommitOptions): Promise<TxBroadcastResult>
As a delegator, generate and broadcast a transaction to commit partially committed delegatee tokens

Returns
that resolves to a broadcasted txid if the operation succeeds
Parameters
- options: StackAggregationCommitOptions
  
  a required stack aggregation commit options object
Returns Promise<TxBroadcastResult>
- Defined in packages/stacking/src/index.ts:474

Class StackingClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

address: string

network: StacksNetwork

Returns StackingClient

Properties

address

network

Methods

canStack

Returns

Parameters

options: CanLockStxOptions

Returns Promise<StackingEligibility>

delegateStackStx

Returns

Parameters

options: DelegateStackStxOptions

Returns Promise<TxBroadcastResult>

delegateStx

Returns

Parameters

options: DelegateStxOptions

Returns Promise<TxBroadcastResult>

getAccountBalance

Returns

Returns Promise<bigint>

getAccountStatus

Returns Promise<any>

getCoreInfo

Returns

Returns Promise<CoreInfo>

getCycleDuration

Returns

Returns Promise<number>

getDelegateOptions

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

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

Returns

Returns Promise<PoxInfo>

getRevokeDelegateStxOptions

Parameters

contract: string

Returns ContractCallOptions

getRewardHoldersForBtcAddress

Returns

Parameters

Optional options: RewardOptions

Returns Promise<RewardsError | BurnchainRewardSlotHolderListResponse>

getRewardsForBtcAddress

Returns

Parameters

Optional options: RewardOptions

Returns Promise<RewardsError | BurnchainRewardListResponse>

getRewardsTotalForBtcAddress

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

`Optional` poxAddress?: string

`Optional` untilBurnBlockHeight?: number

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

`Optional` nonce?: IntegerType

`Optional` options: RewardOptions

`Optional` options: RewardOptions

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

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

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