Class StackingClient

Hierarchy

StackingClient

Index

Constructors

constructor

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

Properties

address

address: string

network

network: StacksNetwork

PoX-2 Methods

delegateStackExtend

delegateStackExtend(options: DelegateStackExtendOptions): Promise<TxBroadcastResult>
As a delegator, generate and broadcast transactions to extend stack for multiple delegatees.

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

delegateStackIncrease

delegateStackIncrease(-: DelegateStackIncreaseOptions): Promise<TxBroadcastResult>
As a delegator, generate and broadcast transactions to stack increase for multiple delegatees.

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

stackExtend

stackExtend(-: StackExtendOptions): Promise<TxBroadcastResult>
Generate and broadcast a stacking transaction to extend locked STX (pox-2.stack-extend)

Returns
a broadcasted txid if the operation succeeds
Parameters
- -: StackExtendOptions
  
  a required extend STX options object
Returns Promise<TxBroadcastResult>
- Defined in packages/stacking/src/index.ts:616

stackIncrease

stackIncrease(-: StackIncreaseOptions): Promise<TxBroadcastResult>
Generate and broadcast a stacking transaction to increase locked STX (pox-2.stack-increase)

Returns
a broadcasted txid if the operation succeeds
Parameters
- -: StackIncreaseOptions
  
  a required increase STX options object
Returns Promise<TxBroadcastResult>
- Defined in packages/stacking/src/index.ts:644

Other 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:530

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:713

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:671

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:350

getAccountBalanceLocked

getAccountBalanceLocked(): Promise<bigint>
Get account balance of locked tokens

Returns
promise resolves to a bigint if the operation succeeds

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

getAccountExtendedBalances

getAccountExtendedBalances(): Promise<AccountExtendedBalances>
Get extended account balances

Returns
promise resolves to a bigint if the operation succeeds

Returns Promise<AccountExtendedBalances>
- Defined in packages/stacking/src/index.ts:361

getAccountStatus

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

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:309

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:380

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:931

getDelegateStackExtendOptions

getDelegateStackExtendOptions(__namedParameters: {
    contract: string;
    extendCount: number;
    nonce?: IntegerType;
    poxAddress: string;
    stacker: string;
}): ContractCallOptions
Parameters
- __namedParameters: {
      contract: string;
      extendCount: number;
      nonce?: IntegerType;
      poxAddress: string;
      stacker: string;
  }
  - contract: string
  - extendCount: number
  - Optional nonce?: IntegerType
  - poxAddress: string
  - stacker: string
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:1005

getDelegateStackIncreaseOptions

getDelegateStackIncreaseOptions(__namedParameters: {
    contract: string;
    increaseBy: IntegerType;
    nonce?: IntegerType;
    poxAddress: string;
    stacker: string;
}): ContractCallOptions
Parameters
- __namedParameters: {
      contract: string;
      increaseBy: IntegerType;
      nonce?: IntegerType;
      poxAddress: string;
      stacker: string;
  }
  - contract: string
  - increaseBy: IntegerType
  - Optional nonce?: IntegerType
  - poxAddress: string
  - stacker: string
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:1037

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:963

getDelegationStatus

getDelegationStatus(): Promise<DelegationInfo>
Check delegation status

Returns
that resolves to a DelegationInfo object if the operation succeeds

Returns Promise<DelegationInfo>
- Defined in packages/stacking/src/index.ts:1161

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:319

getPoxOperationInfo

getPoxOperationInfo(poxInfo?: 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.
Returns
that resolves to PoX operation info
Parameters
- Optional poxInfo: PoxInfo
Returns Promise<PoxOperationInfo>
- Defined in packages/stacking/src/index.ts:456

getRevokeDelegateStxOptions

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

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:418

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:406

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:396

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:430

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:1069

getStackExtendOptions

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

getStackIncreaseOptions

getStackIncreaseOptions(__namedParameters: {
contract: string;
increaseBy: IntegerType;
}): ContractCallOptions
Parameters
- __namedParameters: {
  contract: string;
  increaseBy: IntegerType;
  }
  - contract: string
  - increaseBy: IntegerType
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:917

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:866

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:1111

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:329

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:517

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:508

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:1209

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:1222

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:852

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:575

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:822

Class StackingClient

Hierarchy

Index

Constructors

Properties

Methods - PoX-2

Methods - Other

Constructors

constructor

Parameters

address: string

network: StacksNetwork

Returns StackingClient

Properties

address

network

PoX-2 Methods

delegateStackExtend

Returns

Parameters

options: DelegateStackExtendOptions

Returns Promise<TxBroadcastResult>

delegateStackIncrease

Returns

Parameters

-: DelegateStackIncreaseOptions

Returns Promise<TxBroadcastResult>

stackExtend

Returns

Parameters

-: StackExtendOptions

Returns Promise<TxBroadcastResult>

stackIncrease

Returns

Parameters

-: StackIncreaseOptions

Returns Promise<TxBroadcastResult>

Other 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>

getAccountBalanceLocked

Returns

Returns Promise<bigint>

getAccountExtendedBalances

Returns

Returns Promise<AccountExtendedBalances>

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

getDelegateStackExtendOptions

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

`Optional` poxAddress?: string

`Optional` untilBurnBlockHeight?: number

__namedParameters: {
contract: string;
extendCount: number;
nonce?: IntegerType;
poxAddress: string;
stacker: string;
}

`Optional` nonce?: IntegerType

__namedParameters: {
contract: string;
increaseBy: IntegerType;
nonce?: IntegerType;
poxAddress: string;
stacker: string;
}

`Optional` nonce?: IntegerType

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

`Optional` nonce?: IntegerType

`Optional` poxInfo: PoxInfo

`Optional` options: RewardOptions

`Optional` options: RewardOptions

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

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