Function prepareImmediateStakeTransactions

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

    • Returns a group transaction to stake ALGO and get xALGO immediately.

      Parameters

      • consensusConfig: ConsensusConfig

        consensus application and xALGO config

      • consensusState: ConsensusState

        current state of the consensus application

      • senderAddr: string

        account address for the sender

      • receiverAddr: string

        account address to receive the xALGO at (typically the user)

      • amount: number | bigint

        amount of ALGO to send

      • minReceivedAmount: number | bigint

        min amount of xALGO expected to receive

      • params: SuggestedParams

        suggested params for the transactions with the fees overwritten

      • Optionalnote: Uint8Array<ArrayBufferLike>

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

      Returns Transaction[]

      Transaction[] stake transactions

    Settings

    Member Visibility