Class AlgorandTransactionCrafter

Hierarchy

Crafter
- AlgorandTransactionCrafter

Index

Constructors

Methods

addSignature changeOffline changeOnline createAsset destroyAsset freezeAsset markNonParticipation pay transferAsset

Constructors

constructor

new AlgorandTransactionCrafter(genesisId, genesisHash): AlgorandTransactionCrafter
Parameters
- genesisId: string
- genesisHash: string
Returns AlgorandTransactionCrafter
Overrides Crafter.constructor
- Defined in algorand.transaction.crafter.ts:15

Methods

addSignature

addSignature(encodedTransaction, signature): Uint8Array
Add Signature
Parameters
- encodedTransaction: Uint8Array
  Transaction Bytes
- signature: Uint8Array
  Signature Bytes
Returns Uint8Array
Overrides Crafter.addSignature
- Defined in algorand.transaction.crafter.ts:124

changeOffline

changeOffline(from): IKeyregTxBuilder
Offline Key Registration Transaction
Parameters
- from: string
  The address of the account that pays the fee and amount.
Returns IKeyregTxBuilder
- Defined in algorand.transaction.crafter.ts:54

changeOnline

changeOnline(from, voteKey, selectionKey, stateProofKey, voteFirst, voteLast, voteKeyDilution): IKeyregTxBuilder
Online Key Registration Transaction
Parameters
- from: string
  The address of the account that pays the fee and amount.
- voteKey: string
  The root participation public key.
- selectionKey: string
  The VRF public key.
- stateProofKey: string
  The 64 byte state proof public key commitment.
- voteFirst: number | bigint
  The first round that the participation key is valid.
- voteLast: number | bigint
  The last round that the participation key is valid.
- voteKeyDilution: number | bigint
  This is the dilution for the 2-level participation key.
Returns IKeyregTxBuilder
- Defined in algorand.transaction.crafter.ts:39

createAsset

createAsset(from, params): IAssetConfigTxBuilder
Create a new Asset
Parameters
- from: string
  The address of the account that pays the fee and amount.
- params: AssetParams
  Asset Parameters
Returns IAssetConfigTxBuilder
- Defined in algorand.transaction.crafter.ts:74

destroyAsset

destroyAsset(from, caid): IAssetConfigTxBuilder
Destroy an existing Asset
Parameters
- from: string
  The address of the account that pays the fee and amount.
- caid: number | bigint
  Unique asset ID.
Returns IAssetConfigTxBuilder
- Defined in algorand.transaction.crafter.ts:85

freezeAsset

freezeAsset(fadd, faid, afrz): IAssetFreezeTxBuilder
Freeze an Asset
Parameters
- fadd: string
  The address of the account whose asset is being frozen or unfrozen.
- faid: number | bigint
  The asset ID being frozen or unfrozen.
- afrz: boolean
  True to freeze the asset.
Returns IAssetFreezeTxBuilder
- Defined in algorand.transaction.crafter.ts:97

markNonParticipation

markNonParticipation(from): IKeyregTxBuilder
Mark Non-Participation Transaction
Parameters
- from: string
  The address of the account that pays the fee and amount.
Returns IKeyregTxBuilder
- Defined in algorand.transaction.crafter.ts:63

pay

pay(amount, from, to): IPayTxBuilder
Payment Transaction
Parameters
- amount: number | bigint
  The total amount to be sent in microAlgos.
- from: string
  The address of the account that pays the fee and amount.
- to: string
  The address of the account that receives the amount.
Returns IPayTxBuilder
- Defined in algorand.transaction.crafter.ts:25

transferAsset

transferAsset(from, xaid, arcv, aamt): IAssetTransferTxBuilder
Transfer Asset Transaction
Parameters
- from: string
  The address of the account that pays the fee and amount.
- xaid: number | bigint
  The unique ID of the asset to be transferred.
- arcv: string
  The recipient of the asset transfer.
- aamt: number | bigint
  The amount of the asset to be transferred.
Returns IAssetTransferTxBuilder
- Defined in algorand.transaction.crafter.ts:111