Sui (SUI)

ConnectClient.staking.sui

Sui blockchain staking operations.

Methods

stake(params)

Initiates a stake operation on the Sui blockchain.

Param	Type	Description
params	object	Parameters for the stake operation
params.data	object	Stake operation details
params.connectionId	string	Connection identifier
params.accessToken	string	Access token for authentication

Returns: Stake operation responseThrows: ArmorySdkException - If there's an error initiating the stake operation

unstake(params)

Initiates an unstake operation on the Sui blockchain.

Param	Type	Description
params	object	Parameters for the unstake operation
params.data	object	Unstake operation details
params.connectionId	string	Connection identifier
params.accessToken	string	Access token for authentication

Returns: Unstake operation responseThrows: ArmorySdkException - If there's an error initiating the unstake operation

getStake(params)

Retrieves details of a specific stake operation on the Sui blockchain.

Param	Type	Description
params	object	Parameters for retrieving the stake operation
params.stakeId	string	Unique identifier of the stake operation
params.connectionId	string	Connection identifier
params.accessToken	string	Access token for authentication

Returns: Stake operation detailsThrows: ArmorySdkException - If there's an error retrieving the stake operation

listUnstakeablePositions(params)

Retrieves a list of positions that can be unstaked on the Sui blockchain.

Param	Type	Description
params	object	Parameters for listing unstakeable positions
params.connectionId	string	Connection identifier
params.accessToken	string	Access token for authentication

Returns: List of unstakeable positionsThrows: ArmorySdkException - If there's an error retrieving the unstakeable positions

getUnstake(params)

Retrieves details of a specific unstake operation on the Sui blockchain.

Param	Type	Description
params	object	Parameters for retrieving the unstake operation
params.unstakeId	string	Unique identifier of the unstake operation
params.connectionId	string	Connection identifier
params.accessToken	string	Access token for authentication

Returns: Unstake operation detailsThrows: ArmorySdkException - If there's an error retrieving the unstake operation

withdraw(params)

Withdraws unstaked tokens on the Sui blockchain.

Param	Type	Description
params	object	Parameters for withdrawing unstaked tokens
params.unstakeId	string	Unique identifier of the unstake operation
params.connectionId	string	Connection identifier
params.accessToken	string	Access token for authentication

Throws: ArmorySdkException - If there's an error withdrawing unstaked tokens