Class KeyregTxBuilder

Implements

IKeyregTxBuilder

Index

Constructors

Methods

addFee addFirstValidRound addGroup addLastValidRound addLease addNonParticipation addNote addRekey addSelectionKey addSender addStateProofKey addVoteFirst addVoteKey addVoteKeyDilution addVoteLast get

Constructors

constructor

new KeyregTxBuilder(genesisId, genesisHash): KeyregTxBuilder
Parameters
- genesisId: string
- genesisHash: string
Returns KeyregTxBuilder
- Defined in algorand.transaction.keyreg.ts:128

Methods

addFee

addFee(fee): IKeyregTxBuilder
Add Fee
Parameters
- fee: number | bigint
  Paid by the sender to the FeeSink to prevent denial-of-service. The minimum fee on Algorand is currently 1000 microAlgos.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addFee
- Defined in algorand.transaction.keyreg.ts:169

addFirstValidRound

addFirstValidRound(fv): IKeyregTxBuilder
Add First Valid Round
Parameters
- fv: number | bigint
  The first round for when the transaction is valid. If the transaction is sent prior to this round it will be rejected by the network.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addFirstValidRound
- Defined in algorand.transaction.keyreg.ts:173

addGroup

addGroup(grp): IKeyregTxBuilder
Add Group
Parameters
- grp: Uint8Array
  The group specifies that the transaction is part of a group and, if so, specifies the hash of the transaction group.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addGroup
- Defined in algorand.transaction.keyreg.ts:193

addLastValidRound

addLastValidRound(lv): IKeyregTxBuilder
Add Last Valid Round
Parameters
- lv: number | bigint
  The ending round for which the transaction is valid. After this round, the transaction will be rejected by the network.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addLastValidRound
- Defined in algorand.transaction.keyreg.ts:177

addLease

addLease(lx): IKeyregTxBuilder
Add Lease
Parameters
- lx: Uint8Array
  A lease enforces mutual exclusion of transactions. If this field is nonzero, then once the transaction is confirmed, it acquires the lease identified by the (Sender, Lease) pair of the transaction until the LastValid round passes.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addLease
- Defined in algorand.transaction.keyreg.ts:189

addNonParticipation

addNonParticipation(nonParticipation): IKeyregTxBuilder
Add Non-Participating

All new Algorand accounts are participating by default.
Parameters
- nonParticipation: boolean
  Mark an account nonparticipating by setting this value to true and this account will no longer earn rewards.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addNonParticipation
- Defined in algorand.transaction.keyreg.ts:161

addNote

addNote(note, encoding?): IKeyregTxBuilder
Add Note
Parameters
- note: string
  Any data up to 1000 bytes.
- encoding: BufferEncoding = "utf8"
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addNote
- Defined in algorand.transaction.keyreg.ts:181

addRekey

addRekey(rekey): IKeyregTxBuilder
Add Rekey Address
Parameters
- rekey: string
  Specifies the authorized address. This address will be used to authorize all future transactions.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addRekey
- Defined in algorand.transaction.keyreg.ts:185

addSelectionKey

addSelectionKey(selectionKey, encoding?): IKeyregTxBuilder
Add VRF PublicKey
Parameters
- selectionKey: string
  The VRF public key.
- encoding: BufferEncoding = "base64"
  Buffer encoding
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addSelectionKey
- Defined in algorand.transaction.keyreg.ts:141

addSender

addSender(sender): IKeyregTxBuilder
Add Sender
Parameters
- sender: string
  The address of the account that pays the fee and amount.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addSender
- Defined in algorand.transaction.keyreg.ts:165

addStateProofKey

addStateProofKey(stateProofKey, encoding?): IKeyregTxBuilder
Add State Proof PublicKey
Parameters
- stateProofKey: string
  The 64 byte state proof public key commitment.
- encoding: BufferEncoding = "base64"
  Buffer encoding
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addStateProofKey
- Defined in algorand.transaction.keyreg.ts:145

addVoteFirst

addVoteFirst(voteFirst): IKeyregTxBuilder
Add Vote First
Parameters
- voteFirst: number | bigint
  The first round that the participation key is valid.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addVoteFirst
- Defined in algorand.transaction.keyreg.ts:149

addVoteKey

addVoteKey(voteKey, encoding?): IKeyregTxBuilder
Add Participation PublicKey
Parameters
- voteKey: string
  The root participation public key.
- encoding: BufferEncoding = "base64"
  Buffer encoding
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addVoteKey
- Defined in algorand.transaction.keyreg.ts:137

addVoteKeyDilution

addVoteKeyDilution(voteKeyDilution): IKeyregTxBuilder
Add Dilution
Parameters
- voteKeyDilution: number | bigint
  This is the dilution for the 2-level participation key.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addVoteKeyDilution
- Defined in algorand.transaction.keyreg.ts:157

addVoteLast

addVoteLast(voteLast): IKeyregTxBuilder
Add Vote Last
Parameters
- voteLast: number | bigint
  The last round that the participation key is valid.
Returns IKeyregTxBuilder
Implementation of IKeyregTxBuilder.addVoteLast
- Defined in algorand.transaction.keyreg.ts:153

get

get(): KeyregTransaction
Returns KeyregTransaction
Implementation of IKeyregTxBuilder.get
- Defined in algorand.transaction.keyreg.ts:197