Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

encodeNote

  • encodeNote(note: string | undefined, noteb64: string | undefined): Uint8Array | undefined
  • Parameters

    • note: string | undefined
    • noteb64: string | undefined

    Returns Uint8Array | undefined

getFromAddress

  • Returns from address from the transaction params depending on @SignType

    Parameters

    • execParams: ExecParams

      transaction execution params passed by user

    Returns AccountAddress

mkTransaction

  • mkTransaction(execParams: ExecParams, suggestedParams: SuggestedParams): Transaction
  • Returns unsigned transaction as per ExecParams ExecParams can be of following types:

    • AlgoTransferParam used for transferring algo
    • AssetTransferParam used for transferring asset
    • ModifyAssetParam used to modify asset mutable properties
    • FreezeAssetParam used to freeze asset (only permitted by asa freeze account)
    • RevokeAssetParam used to revoke assets (by asset clawback)
    • DestroyAssetParam used to delete asset (by asset manager)
    • Deploy Params - deploy ASA, deploy App
    • OptIn Params - optInToASA, optInToApp
    • AppCallsParam (NoOp, Clear, Delete..)used for calling stateful smart contracts. For more advanced use-cases, please use algosdk.tx directly. NOTE: parseAppArgs is used to handle case when user passes appArgs similar to goal

    Parameters

    • execParams: ExecParams

      ExecParams

    • suggestedParams: SuggestedParams

      blockchain transaction suggested parameters (firstRound, lastRound, fee..)

    Returns Transaction

    SDK Transaction object

updateTxFee

  • updateTxFee(params: TxParams, tx: Transaction): Transaction

Generated using TypeDoc