Function prepareUnstakeTransactions

    • prepareUnstakeTransactions(
          consensusConfig: ConsensusConfig,
          consensusState: ConsensusState,
          senderAddr: string,
          amount: number | bigint,
          minReceivedAmount: number | bigint,
          params: SuggestedParams,
          proposerAllocations?: ProposerAllocations,
          note?: Uint8Array<ArrayBufferLike>,
      ): Transaction[]

    • Returns a group transaction to unstake xALGO and get ALGO.

      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

      • Optionalnote: Uint8Array<ArrayBufferLike>

        optional note to distinguish who is the burner (must pass to be eligible for revenue share)

      Returns Transaction[]

      Transaction[] unstake transactions

    Settings

    Member Visibility