Class StackingClient

Hierarchy

StackingClient

Index

Constructors

Properties

Methods - Other

canStack delegateStackStx delegateStx getAccountBalance getAccountBalanceLocked getAccountExtendedBalances getAccountStatus getCoreInfo getCycleDuration getDelegateOptions getDelegateStackExtendOptions getDelegateStackIncreaseOptions getDelegateStackOptions getDelegationStatus getPoxInfo getPoxOperationInfo getRevokeDelegateStxOptions getRewardHoldersForBtcAddress getRewardSet getRewardsForBtcAddress getRewardsTotalForBtcAddress getSecondsUntilNextCycle getSecondsUntilStackingDeadline getStackAggregationCommitOptions getStackAggregationCommitOptionsIndexed getStackAggregationIncreaseOptions getStackExtendOptions getStackIncreaseOptions getStackOptions getStackingContract getStatus getTargetBlockTime hasMinimumStx modifyLockTxFee parseContractId revokeDelegateStx signPoxSignature stack stackAggregationCommit verifySignerKeySignature

Methods - PoX-2

delegateStackExtend delegateStackIncrease stackAggregationCommitIndexed stackAggregationIncrease stackExtend stackIncrease

Constructors

constructor

new StackingClient(opts): StackingClient
Parameters
- opts: {
      address: string;
      api?: ApiOpts | StacksNodeApi;
      network: StacksNetwork | "mainnet" | "testnet" | "devnet" | "mocknet";
  }
  - address: string
  - Optional api?: ApiOpts | StacksNodeApi
  - network: StacksNetwork | "mainnet" | "testnet" | "devnet" | "mocknet"
Returns StackingClient
- Defined in packages/stacking/src/index.ts:344

Properties

address

address: string

api

api: StacksNodeApi

network

network: StacksNetwork

Methods - Other

canStack

canStack(options): Promise<StackingEligibility>
readonly can-stack-stx

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

delegateStackStx

delegateStackStx(options): Promise<TxBroadcastResult>
delegate-stack-stx

As a delegator, generate and broadcast transactions to stack for multiple delegatees. This will lock up tokens owned by the delegatees.
Parameters
- options: DelegateStackStxOptions & BaseTxOptions
  
  a required delegate stack STX options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:741

delegateStx

delegateStx(options): Promise<TxBroadcastResult>
delegate-stx

As a delegatee, generate and broadcast a transaction to create a delegation relationship
Parameters
- options: DelegateStxOptions & BaseTxOptions
  
  a required delegate STX options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:704

getAccountBalance

getAccountBalance(): Promise<bigint>
Get account balance

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

getAccountBalanceLocked

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

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

getAccountExtendedBalances

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

Returns Promise<ExtendedAccountBalances>
- Defined in packages/stacking/src/index.ts:382

getAccountStatus

getAccountStatus(): Promise<any>
Get account status

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

getCoreInfo

getCoreInfo(): Promise<V2CoreInfoResponse>
Returns Promise<V2CoreInfoResponse>

Deprecated
alias of StacksNodeApi.getCoreInfo, kept for backwards compatibility
- Defined in packages/stacking/src/index.ts:357

getCycleDuration

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

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

getDelegateOptions

getDelegateOptions(__namedParameters): 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:1111

getDelegateStackExtendOptions

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

getDelegateStackIncreaseOptions

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

getDelegateStackOptions

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

getDelegationStatus

getDelegationStatus(): Promise<DelegationInfo>
Check delegation status

Returns Promise<DelegationInfo>
that resolves to a DelegationInfo object if the operation succeeds
- Defined in packages/stacking/src/index.ts:1427

getPoxInfo

getPoxInfo(): Promise<V2PoxInfoResponse>
Returns Promise<V2PoxInfoResponse>

Deprecated
alias of StacksNodeApi.getPoxInfo, kept for backwards compatibility
- Defined in packages/stacking/src/index.ts:362

getPoxOperationInfo

getPoxOperationInfo(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.
Parameters
- Optional poxInfo: V2PoxInfoResponse
Returns Promise<PoxOperationInfo>
- Defined in packages/stacking/src/index.ts:493

getRevokeDelegateStxOptions

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

getRewardHoldersForBtcAddress

getRewardHoldersForBtcAddress(options?): Promise<BaseErrorResponse | BurnchainRewardSlotHolderListResponse>
Get burnchain rewards holders for the set address
Parameters
- Optional options: PaginationOptions
Returns Promise<BaseErrorResponse | BurnchainRewardSlotHolderListResponse>
- Defined in packages/stacking/src/index.ts:416

getRewardSet

getRewardSet(options): Promise<undefined | RewardSetInfo>
Get PoX address from reward set by index (if it exists)
Parameters
- options: RewardSetOptions
Returns Promise<undefined | RewardSetInfo>
- Defined in packages/stacking/src/index.ts:423

getRewardsForBtcAddress

getRewardsForBtcAddress(options?): Promise<BaseErrorResponse | BurnchainRewardListResponse>
Get burnchain rewards for the set address
Parameters
- Optional options: PaginationOptions
Returns Promise<BaseErrorResponse | BurnchainRewardListResponse>
- Defined in packages/stacking/src/index.ts:409

getRewardsTotalForBtcAddress

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

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

getSecondsUntilNextCycle

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

Returns Promise<number>

See
getSecondsUntilStackingDeadline
- Defined in packages/stacking/src/index.ts:451

getSecondsUntilStackingDeadline

getSecondsUntilStackingDeadline(): Promise<number>
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.

Returns Promise<number>
number of seconds ⚠️ Attention: The returned number of seconds can be negative if the deadline has passed and the prepare phase has started.

See
getSecondsUntilNextCycle
- Defined in packages/stacking/src/index.ts:475

getStackAggregationCommitOptions

getStackAggregationCommitOptions(__namedParameters): ContractCallOptions
Parameters
- __namedParameters: {
      authId?: IntegerType;
      contract: string;
      maxAmount?: IntegerType;
      poxAddress: string;
      rewardCycle: number;
      signerKey?: string;
      signerSignature?: string;
  }
  - Optional authId?: IntegerType
  - contract: string
  - Optional maxAmount?: IntegerType
  - poxAddress: string
  - rewardCycle: number
  - Optional signerKey?: string
  - Optional signerSignature?: string
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:1233

getStackAggregationCommitOptionsIndexed

getStackAggregationCommitOptionsIndexed(__namedParameters): ContractCallOptions
Parameters
- __namedParameters: {
      authId?: IntegerType;
      contract: string;
      maxAmount?: IntegerType;
      poxAddress: string;
      rewardCycle: number;
      signerKey?: string;
      signerSignature?: string;
  }
  - Optional authId?: IntegerType
  - contract: string
  - Optional maxAmount?: IntegerType
  - poxAddress: string
  - rewardCycle: number
  - Optional signerKey?: string
  - Optional signerSignature?: string
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:1317

getStackAggregationIncreaseOptions

getStackAggregationIncreaseOptions(__namedParameters): ContractCallOptions
Parameters
- __namedParameters: {
      authId?: IntegerType;
      contract: string;
      maxAmount?: IntegerType;
      poxAddress: string;
      rewardCycle: number;
      rewardCycleIndex: number;
      signerKey?: string;
      signerSignature?: string;
  }
  - Optional authId?: IntegerType
  - contract: string
  - Optional maxAmount?: IntegerType
  - poxAddress: string
  - rewardCycle: number
  - rewardCycleIndex: number
  - Optional signerKey?: string
  - Optional signerSignature?: string
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:1274

getStackExtendOptions

getStackExtendOptions(__namedParameters): ContractCallOptions
Parameters
- __namedParameters: {
      authId?: IntegerType;
      contract: string;
      extendCycles: number;
      maxAmount?: IntegerType;
      poxAddress: string;
      signerKey?: string;
      signerSignature?: string;
  }
  - Optional authId?: IntegerType
  - contract: string
  - extendCycles: number
  - Optional maxAmount?: IntegerType
  - poxAddress: string
  - Optional signerKey?: string
  - Optional signerSignature?: string
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:1032

getStackIncreaseOptions

getStackIncreaseOptions(__namedParameters): ContractCallOptions
Parameters
- __namedParameters: {
      authId?: IntegerType;
      contract: string;
      increaseBy: IntegerType;
      maxAmount?: IntegerType;
      signerKey?: string;
      signerSignature?: string;
  }
  - Optional authId?: IntegerType
  - contract: string
  - increaseBy: IntegerType
  - Optional maxAmount?: IntegerType
  - Optional signerKey?: string
  - Optional signerSignature?: string
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:1073

getStackOptions

getStackOptions(__namedParameters): ContractCallOptions
Parameters
- __namedParameters: {
      amountMicroStx: IntegerType;
      authId?: IntegerType;
      burnBlockHeight: number;
      contract: string;
      cycles: number;
      maxAmount?: IntegerType;
      poxAddress: string;
      signerKey?: string;
      signerSignature?: string;
  }
  - amountMicroStx: IntegerType
  - Optional authId?: IntegerType
  - burnBlockHeight: number
  - contract: string
  - cycles: number
  - Optional maxAmount?: IntegerType
  - poxAddress: string
  - Optional signerKey?: string
  - Optional signerSignature?: string
Returns ContractCallOptions
- Defined in packages/stacking/src/index.ts:982

getStackingContract

getStackingContract(poxOperationInfo?): Promise<string>
Parameters
- Optional poxOperationInfo: PoxOperationInfo
Returns Promise<string>
that resolves to the contract id (address and name) to use for stacking
- Defined in packages/stacking/src/index.ts:1525

getStatus

getStatus(): Promise<StackerInfo>
Check stacking status

Returns Promise<StackerInfo>
that resolves to a StackerInfo object if the operation succeeds
- Defined in packages/stacking/src/index.ts:1377

getTargetBlockTime

getTargetBlockTime(): Promise<number>
Returns Promise<number>

Deprecated
alias of StacksNodeApi.getTargetBlockTime, kept for backwards compatibility
- Defined in packages/stacking/src/index.ts:367

hasMinimumStx

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

Returns Promise<boolean>
that resolves to a bool if the operation succeeds
- Defined in packages/stacking/src/index.ts:514

modifyLockTxFee

modifyLockTxFee(__namedParameters): StacksTransaction
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
- Defined in packages/stacking/src/index.ts:1545

parseContractId

parseContractId(contract): string[]
Parses a contract identifier and ensures it is formatted correctly
Parameters
- contract: string
Returns string[]
a contract address and name
- Defined in packages/stacking/src/index.ts:1558

revokeDelegateStx

revokeDelegateStx(privateKey): Promise<TxBroadcastResult>
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
- Defined in packages/stacking/src/index.ts:959
revokeDelegateStx(txOptions): Promise<TxBroadcastResult>
As a delegatee, generate and broadcast a transaction to terminate the delegation relationship
Parameters
- txOptions: BaseTxOptions
  
  the private key, fee, and nonce to be used for the revoke call
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:965

signPoxSignature

signPoxSignature(__namedParameters): string
Generates a signer-sig string for the current PoX contract.
Parameters
- __namedParameters: {
      authId: IntegerType;
      maxAmount: IntegerType;
      period: number;
      poxAddress: string;
      rewardCycle: number;
      signerPrivateKey: PrivateKey;
      topic: "stack-stx" | "agg-commit" | "agg-increase" | "stack-extend" | "stack-increase";
  }
  - authId: IntegerType
  - maxAmount: IntegerType
  - period: number
  - poxAddress: string
  - rewardCycle: number
  - signerPrivateKey: PrivateKey
  - topic: "stack-stx" | "agg-commit" | "agg-increase" | "stack-extend" | "stack-increase"
Returns string
- Defined in packages/stacking/src/index.ts:1572

stack

stack(options): Promise<TxBroadcastResult>
stack-stx

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

stackAggregationCommit

stackAggregationCommit(options): Promise<TxBroadcastResult>
As a delegator, generate and broadcast a transaction to commit partially committed delegatee tokens
Parameters
- options: StackAggregationCommitOptions & BaseTxOptions
  
  a required stack aggregation commit options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:837

verifySignerKeySignature

verifySignerKeySignature(__namedParameters): Promise<boolean>
Call the verify-signer-key-sig read-only function on the PoX contract.
Parameters
- __namedParameters: {
      amount: IntegerType;
      authId: IntegerType;
      maxAmount: IntegerType;
      period: number;
      poxAddress: string;
      rewardCycle: number;
      signerKey: string;
      signerSignature?: string;
      topic: string;
  }
  - amount: IntegerType
  - authId: IntegerType
  - maxAmount: IntegerType
  - period: number
  - poxAddress: string
  - rewardCycle: number
  - signerKey: string
  - Optional signerSignature?: string
  - topic: string
Returns Promise<boolean>
(async) a boolean indicating if the signature is valid
- Defined in packages/stacking/src/index.ts:1474

Methods - PoX-2

delegateStackExtend

delegateStackExtend(options): Promise<TxBroadcastResult>
delegate-stack-extend

As a delegator, generate and broadcast transactions to extend stack for multiple delegatees.
Parameters
- options: DelegateStackExtendOptions & BaseTxOptions
  
  a required delegate stack extend STX options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:779

delegateStackIncrease

delegateStackIncrease(-): Promise<TxBroadcastResult>
As a delegator, generate and broadcast transactions to stack increase for multiple delegatees.
Parameters
- -: DelegateStackIncreaseOptions & BaseTxOptions
  
  a required delegate stack increase STX options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:808

stackAggregationCommitIndexed

stackAggregationCommitIndexed(options): Promise<TxBroadcastResult>
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.
Parameters
- options: StackAggregationCommitOptions & BaseTxOptions
  
  a required stack aggregation commit options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:885

stackAggregationIncrease

stackAggregationIncrease(options): Promise<TxBroadcastResult>
As a delegator, generate and broadcast a transaction to increase partial commitment committed delegatee tokens
Parameters
- options: StackAggregationIncreaseOptions & BaseTxOptions
  
  a required stack aggregation increase options object
Returns Promise<TxBroadcastResult>
that resolves to a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:921

stackExtend

stackExtend(-): Promise<TxBroadcastResult>
stack-extend

Generate and broadcast a stacking transaction to extend locked STX (pox-2.stack-extend)
Parameters
- -: StackExtendOptions & BaseTxOptions
  
  a required extend STX options object
Returns Promise<TxBroadcastResult>
a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:618

stackIncrease

stackIncrease(-): Promise<TxBroadcastResult>
Generate and broadcast a stacking transaction to increase locked STX (pox-2.stack-increase)
Parameters
- -: StackIncreaseOptions & BaseTxOptions
  
  a required increase STX options object
Returns Promise<TxBroadcastResult>
a broadcasted txid if the operation succeeds
- Defined in packages/stacking/src/index.ts:662

Class StackingClient

Hierarchy

Index

Constructors

Properties

Methods - Other

Methods - PoX-2

Constructors

constructor

Parameters

opts: { address: string; api?: ApiOpts | StacksNodeApi; network: StacksNetwork | "mainnet" | "testnet" | "devnet" | "mocknet"; }

address: string

Optional api?: ApiOpts | StacksNodeApi

network: StacksNetwork | "mainnet" | "testnet" | "devnet" | "mocknet"

Returns StackingClient

Properties

address

api

network

Methods - Other

canStack

Parameters

options: CanLockStxOptions

Returns Promise<StackingEligibility>

delegateStackStx

Parameters

options: DelegateStackStxOptions & BaseTxOptions

Returns Promise<TxBroadcastResult>

delegateStx

Parameters

options: DelegateStxOptions & BaseTxOptions

Returns Promise<TxBroadcastResult>

getAccountBalance

Returns Promise<bigint>

getAccountBalanceLocked

Returns Promise<bigint>

getAccountExtendedBalances

Returns Promise<ExtendedAccountBalances>

getAccountStatus

Returns Promise<any>

getCoreInfo

Returns Promise<V2CoreInfoResponse>

Deprecated

getCycleDuration

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

Parameters

__namedParameters: { contract: string; extendCount: number; poxAddress: string; stacker: string; }

contract: string

extendCount: number

poxAddress: string

stacker: string

Returns ContractCallOptions

getDelegateStackIncreaseOptions

Parameters

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

contract: string

increaseBy: IntegerType

poxAddress: string

stacker: string

Returns ContractCallOptions

getDelegateStackOptions

Parameters

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

amountMicroStx: IntegerType

burnBlockHeight: number

contract: string

cycles: number

poxAddress: string

stacker: string

Returns ContractCallOptions

opts: {
address: string;
api?: ApiOpts | StacksNodeApi;
network: StacksNetwork | "mainnet" | "testnet" | "devnet" | "mocknet";
}

`Optional` api?: ApiOpts | StacksNodeApi

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

`Optional` poxAddress?: string

`Optional` untilBurnBlockHeight?: number

__namedParameters: {
contract: string;
extendCount: number;
poxAddress: string;
stacker: string;
}

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

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

`Optional` poxInfo: V2PoxInfoResponse

`Optional` options: PaginationOptions

`Optional` options: PaginationOptions

__namedParameters: {
authId?: IntegerType;
contract: string;
maxAmount?: IntegerType;
poxAddress: string;
rewardCycle: number;
signerKey?: string;
signerSignature?: string;
}

`Optional` authId?: IntegerType

`Optional` maxAmount?: IntegerType

`Optional` signerKey?: string

`Optional` signerSignature?: string

__namedParameters: {
authId?: IntegerType;
contract: string;
maxAmount?: IntegerType;
poxAddress: string;
rewardCycle: number;
signerKey?: string;
signerSignature?: string;
}

`Optional` authId?: IntegerType

`Optional` maxAmount?: IntegerType

`Optional` signerKey?: string

`Optional` signerSignature?: string

__namedParameters: {
authId?: IntegerType;
contract: string;
maxAmount?: IntegerType;
poxAddress: string;
rewardCycle: number;
rewardCycleIndex: number;
signerKey?: string;
signerSignature?: string;
}

`Optional` authId?: IntegerType

`Optional` maxAmount?: IntegerType

`Optional` signerKey?: string

`Optional` signerSignature?: string

__namedParameters: {
authId?: IntegerType;
contract: string;
extendCycles: number;
maxAmount?: IntegerType;
poxAddress: string;
signerKey?: string;
signerSignature?: string;
}