StackingClient | Stacks.js 1.0.0 Library Reference

Hierarchy

StackingClient

Constructors

constructor

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

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

Properties

address

address: string

network

network: StacksNetwork

Methods

canStack

canStack(__namedParameters: { cycles: number; poxAddress: string }): Promise<StackingEligibility>

- Defined in packages/stacking/src/index.ts:280
Check if account can lock stx

Parameters
- __namedParameters: { cycles: number; poxAddress: string }
  - cycles: number
  - poxAddress: string
Returns Promise<StackingEligibility>

that resolves to a StackingEligibility object if the operation succeeds

delegateStackStx

delegateStackStx(__namedParameters: { amountMicroStx: BN; burnBlockHeight: number; cycles: number; nonce: undefined | BN; poxAddress: string; privateKey: string; stacker: string }): Promise<TxBroadcastResult>

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

Parameters
- __namedParameters: { amountMicroStx: BN; burnBlockHeight: number; cycles: number; nonce: undefined | BN; poxAddress: string; privateKey: string; stacker: string }
  - amountMicroStx: BN
  - burnBlockHeight: number
  - cycles: number
  - nonce: undefined | BN
  - poxAddress: string
  - privateKey: string
  - stacker: string
Returns Promise<TxBroadcastResult>

that resolves to a broadcasted txid if the operation succeeds

delegateStx

delegateStx(__namedParameters: { amountMicroStx: BN; delegateTo: string; poxAddress: undefined | string; privateKey: string; untilBurnBlockHeight: undefined | number }): Promise<TxBroadcastResult>

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

Parameters
- __namedParameters: { amountMicroStx: BN; delegateTo: string; poxAddress: undefined | string; privateKey: string; untilBurnBlockHeight: undefined | number }
  - amountMicroStx: BN
  - delegateTo: string
  - poxAddress: undefined | string
  - privateKey: string
  - untilBurnBlockHeight: undefined | number
Returns Promise<TxBroadcastResult>

that resolves to a broadcasted txid if the operation succeeds

getAccountBalance

getAccountBalance(): Promise<BN>

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

Returns Promise<BN>

that resolves to a BigNum if the operation succeeds

getAccountStatus

getAccountStatus(): Promise<any>

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

getCoreInfo

getCoreInfo(): Promise<CoreInfo>

- Defined in packages/stacking/src/index.ts:164
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:220
Get reward cycle duration in seconds

Returns Promise<number>

that resolves to a number if the operation succeeds

getDelegateOptions

getDelegateOptions(__namedParameters: { amountMicroStx: BN; contract: string; delegateTo: string; poxAddress: undefined | string; untilBurnBlockHeight: undefined | number }): ContractCallOptions

- Defined in packages/stacking/src/index.ts:513
Parameters
- __namedParameters: { amountMicroStx: BN; contract: string; delegateTo: string; poxAddress: undefined | string; untilBurnBlockHeight: undefined | number }
  - amountMicroStx: BN
  - contract: string
  - delegateTo: string
  - poxAddress: undefined | string
  - untilBurnBlockHeight: undefined | number
Returns ContractCallOptions

getDelegateStackOptions

getDelegateStackOptions(__namedParameters: { amountMicroStx: BN; burnBlockHeight: number; contract: string; cycles: number; nonce: undefined | BN; poxAddress: string; stacker: string }): ContractCallOptions

- Defined in packages/stacking/src/index.ts:558
Parameters
- __namedParameters: { amountMicroStx: BN; burnBlockHeight: number; contract: string; cycles: number; nonce: undefined | BN; poxAddress: string; stacker: string }
  - amountMicroStx: BN
  - burnBlockHeight: number
  - contract: string
  - cycles: number
  - nonce: undefined | BN
  - poxAddress: string
  - stacker: string
Returns ContractCallOptions

getPoxInfo

getPoxInfo(): Promise<PoxInfo>

- Defined in packages/stacking/src/index.ts:174
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:637
Parameters
- contract: string
Returns ContractCallOptions

getSecondsUntilNextCycle

getSecondsUntilNextCycle(): Promise<number>

- Defined in packages/stacking/src/index.ts:236
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:607
Parameters
- __namedParameters: { contract: string; poxAddress: string; rewardCycle: number }
  - contract: string
  - poxAddress: string
  - rewardCycle: number
Returns ContractCallOptions

getStackOptions

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

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

getStatus

getStatus(): Promise<StackerInfo>

- Defined in packages/stacking/src/index.ts:656
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:184
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:267
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:258
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: BN; tx: StacksTransaction }): StacksTransaction

- Defined in packages/stacking/src/index.ts:708
Adjust microstacks amount for locking after taking into account transaction fees

Parameters
- __namedParameters: { amountMicroStx: BN; tx: StacksTransaction }
  - amountMicroStx: BN
  - tx: StacksTransaction
Returns StacksTransaction

that resolves to a transaction object if the operation succeeds

parseContractId

parseContractId(contract: string): Array<string>

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

Parameters
- contract: string
Returns Array<string>

a contract address and name

revokeDelegateStx

revokeDelegateStx(privateKey: string): Promise<TxBroadcastResult>

- Defined in packages/stacking/src/index.ts:460
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(__namedParameters: { amountMicroStx: BN; burnBlockHeight: number; cycles: number; poxAddress: string; privateKey: string }): Promise<TxBroadcastResult>

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

Parameters
- __namedParameters: { amountMicroStx: BN; burnBlockHeight: number; cycles: number; poxAddress: string; privateKey: string }
  - amountMicroStx: BN
  - burnBlockHeight: number
  - cycles: number
  - poxAddress: string
  - privateKey: string
Returns Promise<TxBroadcastResult>

that resolves to a broadcasted txid if the operation succeeds

stackAggregationCommit

stackAggregationCommit(__namedParameters: { poxAddress: string; privateKey: string; rewardCycle: number }): Promise<TxBroadcastResult>

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

Parameters
- __namedParameters: { poxAddress: string; privateKey: string; rewardCycle: number }
  - poxAddress: string
  - privateKey: string
  - rewardCycle: number
Returns Promise<TxBroadcastResult>

that resolves to a broadcasted txid if the operation succeeds

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

address: string

network: StacksNetwork

Returns StackingClient

Properties

address

network

Methods

canStack

Parameters

__namedParameters: { cycles: number; poxAddress: string }

cycles: number

poxAddress: string

Returns Promise<StackingEligibility>

delegateStackStx

Parameters

__namedParameters: { amountMicroStx: BN; burnBlockHeight: number; cycles: number; nonce: undefined | BN; poxAddress: string; privateKey: string; stacker: string }

amountMicroStx: BN

burnBlockHeight: number

cycles: number

nonce: undefined | BN

poxAddress: string

privateKey: string

stacker: string

Returns Promise<TxBroadcastResult>

delegateStx

Parameters

__namedParameters: { amountMicroStx: BN; delegateTo: string; poxAddress: undefined | string; privateKey: string; untilBurnBlockHeight: undefined | number }

amountMicroStx: BN

delegateTo: string

poxAddress: undefined | string

privateKey: string

untilBurnBlockHeight: undefined | number

Returns Promise<TxBroadcastResult>

getAccountBalance

Returns Promise<BN>

getAccountStatus

Returns Promise<any>

getCoreInfo

Returns Promise<CoreInfo>

getCycleDuration

Returns Promise<number>

getDelegateOptions

Parameters

__namedParameters: { amountMicroStx: BN; contract: string; delegateTo: string; poxAddress: undefined | string; untilBurnBlockHeight: undefined | number }

amountMicroStx: BN

contract: string

delegateTo: string

poxAddress: undefined | string

untilBurnBlockHeight: undefined | number

Returns ContractCallOptions

getDelegateStackOptions

Parameters

__namedParameters: { amountMicroStx: BN; burnBlockHeight: number; contract: string; cycles: number; nonce: undefined | BN; poxAddress: string; stacker: string }

amountMicroStx: BN

burnBlockHeight: number

contract: string

cycles: number

nonce: undefined | BN

poxAddress: string

stacker: string

Returns ContractCallOptions

getPoxInfo

Returns Promise<PoxInfo>

getRevokeDelegateStxOptions

Parameters

contract: string

Returns ContractCallOptions

getSecondsUntilNextCycle

Returns Promise<number>

getStackAggregationCommitOptions

Parameters

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