a required lock STX options object
that resolves to a StackingEligibility object if the operation succeeds
delegate-stack-stx
As a delegator, generate and broadcast transactions to stack for multiple delegatees. This will lock up tokens owned by the delegatees.
a required delegate stack STX options object
that resolves to a broadcasted txid if the operation succeeds
delegate-stx
As a delegatee, generate and broadcast a transaction to create a delegation relationship
a required delegate STX options object
that resolves to a broadcasted txid if the operation succeeds
Optional
poxOptional
untilCheck delegation status
that resolves to a DelegationInfo object if the operation succeeds
Get information on current PoX operation
Periods:
Optional
poxInfo: V2PoxInfoResponseGet PoX address from reward set by index (if it exists)
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.
number of seconds ⚠️ Attention: The returned number of seconds can be negative if the deadline has passed and the prepare phase has started.
Optional
authOptional
maxOptional
signerOptional
signerOptional
authOptional
maxOptional
signerOptional
signerOptional
authOptional
maxOptional
signerOptional
signerOptional
authOptional
maxOptional
signerOptional
signerOptional
authOptional
maxOptional
signerOptional
signerOptional
authOptional
maxOptional
signerOptional
signerOptional
poxOperationInfo: PoxOperationInfothat resolves to the contract id (address and name) to use for stacking
Check stacking status
that resolves to a StackerInfo object if the operation succeeds
Adjust microstacks amount for locking after taking into account transaction fees
that resolves to a transaction object if the operation succeeds
As a delegatee, generate and broadcast a transaction to terminate the delegation relationship
the private key to be used for the revoke call
that resolves to a broadcasted txid if the operation succeeds
As a delegatee, generate and broadcast a transaction to terminate the delegation relationship
the private key, fee, and nonce to be used for the revoke call
that resolves to a broadcasted txid if the operation succeeds
Generates a signer-sig
string for the current PoX contract.
stack-stx
Generate and broadcast a stacking transaction to lock STX
a required lock STX options object
that resolves to a broadcasted txid if the operation succeeds
As a delegator, generate and broadcast a transaction to commit partially committed delegatee tokens
a required stack aggregation commit options object
that resolves to a broadcasted txid if the operation succeeds
Call the verify-signer-key-sig
read-only function on the PoX contract.
Optional
signer(async) a boolean indicating if the signature is valid
delegate-stack-extend
As a delegator, generate and broadcast transactions to extend stack for multiple delegatees.
a required delegate stack extend STX options object
that resolves to a broadcasted txid if the operation succeeds
As a delegator, generate and broadcast transactions to stack increase for multiple delegatees.
a required delegate stack increase STX options object
that resolves to a broadcasted txid if the operation succeeds
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.
a required stack aggregation commit options object
that resolves to a broadcasted txid if the operation succeeds
As a delegator, generate and broadcast a transaction to increase partial commitment committed delegatee tokens
a required stack aggregation increase options object
that resolves to a broadcasted txid if the operation succeeds
stack-extend
Generate and broadcast a stacking transaction to extend locked STX (pox-2.stack-extend
)
a required extend STX options object
a broadcasted txid if the operation succeeds
Generate and broadcast a stacking transaction to increase locked STX (pox-2.stack-increase
)
a required increase STX options object
a broadcasted txid if the operation succeeds
Generated using TypeDoc
readonly
can-stack-stx
Check if account can lock stx