Function prepareUnstakeTransactions

prepareUnstakeTransactions(consensusConfig: ConsensusConfig, consensusState: ConsensusState, senderAddr: string, amount: number | bigint, minReceivedAmount: number | bigint, params: SuggestedParams, proposerAllocations?: ProposerAllocations, note?: Uint8Array): Transaction[]
Returns a group transaction to unstake xALGO and get ALGO.

Returns
Transaction[] unstake transactions
Parameters
- consensusConfig: ConsensusConfig
  
  consensus application and xALGO config
- consensusState: ConsensusState
  
  current state of the consensus application
- senderAddr: string
  
  account address for the sender
- amount: number | bigint
  
  amount of xALGO to send
- minReceivedAmount: number | bigint
  
  min amount of ALGO expected to receive
- params: SuggestedParams
  
  suggested params for the transactions with the fees overwritten
- proposerAllocations: ProposerAllocations = ...
  
  determines which proposers the ALGO received comes from
- Optional note: Uint8Array
  
  optional note to distinguish who is the burner (must pass to be eligible for revenue share)
Returns Transaction[]
- Defined in xAlgo/consensus.ts:370

Generated using TypeDoc