algosdk 2.8.0 → 2.10.0

package/src/makeTxn.ts

@@ -39,6 +39,8 @@ import { RenameProperties, RenameProperty, Expand } from './types/utils';
  * genesisHash - string specifies hash genesis block of network in use
  * genesisID - string specifies genesis ID of network in use
  * @param rekeyTo - rekeyTo address, optional
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makePaymentTxnWithSuggestedParamsFromObject}
  */
 export function makePaymentTxnWithSuggestedParams(
   from: PaymentTxn['from'],
@@ -111,6 +113,8 @@ export function makePaymentTxnWithSuggestedParamsFromObject(
  * @param nonParticipation - configure whether the address wants to stop participating. If true,
  *   voteKey, selectionKey, voteFirst, voteLast, and voteKeyDilution must be undefined.
  * @param stateProofKey - state proof key. for key deregistration, leave undefined
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeKeyRegistrationTxnWithSuggestedParamsFromObject}
  */
 export function makeKeyRegistrationTxnWithSuggestedParams(
   from: KeyRegistrationTxn['from'],
@@ -245,6 +249,8 @@ export function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: any) {
  * genesisHash - string specifies hash genesis block of network in use
  * genesisID - string specifies genesis ID of network in use
  * @param rekeyTo - rekeyTo address, optional
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeAssetCreateTxnWithSuggestedParamsFromObject}
  */
 export function makeAssetCreateTxnWithSuggestedParams(
   from: AssetCreateTxn['from'],
@@ -360,6 +366,8 @@ export function makeAssetCreateTxnWithSuggestedParamsFromObject(
  * genesisHash - string specifies hash genesis block of network in use
  * genesisID - string specifies genesis ID of network in use
  * @param rekeyTo - rekeyTo address, optional
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeAssetConfigTxnWithSuggestedParamsFromObject}
  */
 export function makeAssetConfigTxnWithSuggestedParams(
   from: AssetConfigTxn['from'],
@@ -456,6 +464,8 @@ export function makeAssetConfigTxnWithSuggestedParamsFromObject(
  * genesisHash - string specifies hash genesis block of network in use
  * genesisID - string specifies genesis ID of network in use
  * @param rekeyTo - rekeyTo address, optional
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeAssetDestroyTxnWithSuggestedParamsFromObject}
  */
 export function makeAssetDestroyTxnWithSuggestedParams(
   from: AssetDestroyTxn['from'],
@@ -514,6 +524,8 @@ export function makeAssetDestroyTxnWithSuggestedParamsFromObject(
  * genesisHash - string specifies hash genesis block of network in use
  * genesisID - string specifies genesis ID of network in use
  * @param rekeyTo - rekeyTo address, optional
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeAssetFreezeTxnWithSuggestedParamsFromObject}
  */
 export function makeAssetFreezeTxnWithSuggestedParams(
   from: AssetFreezeTxn['from'],
@@ -592,6 +604,8 @@ export function makeAssetFreezeTxnWithSuggestedParamsFromObject(
  * genesisHash - string specifies hash genesis block of network in use
  * genesisID - string specifies genesis ID of network in use
  * @param rekeyTo - rekeyTo address, optional
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeAssetTransferTxnWithSuggestedParamsFromObject}
  */
 export function makeAssetTransferTxnWithSuggestedParams(
   from: AssetTransferTxn['from'],
@@ -682,6 +696,8 @@ export function makeAssetTransferTxnWithSuggestedParamsFromObject(
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  * @param extraPages - integer extra pages of memory to rent on creation of application
  * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeApplicationCreateTxnFromObject}
  */
 export function makeApplicationCreateTxn(
   from: AppCreateTxn['from'],
@@ -813,6 +829,8 @@ export function makeApplicationCreateTxnFromObject(
  * @param lease - Lease a transaction
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeApplicationUpdateTxnFromObject}
  */
 export function makeApplicationUpdateTxn(
   from: AppUpdateTxn['from'],
@@ -917,6 +935,8 @@ export function makeApplicationUpdateTxnFromObject(
  * @param lease - Lease a transaction
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeApplicationDeleteTxnFromObject}
  */
 export function makeApplicationDeleteTxn(
   from: AppDeleteTxn['from'],
@@ -1011,6 +1031,8 @@ export function makeApplicationDeleteTxnFromObject(
  * @param lease - Lease a transaction
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeApplicationOptInTxnFromObject}
  */
 export function makeApplicationOptInTxn(
   from: AppOptInTxn['from'],
@@ -1105,6 +1127,8 @@ export function makeApplicationOptInTxnFromObject(
  * @param lease - Lease a transaction
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeApplicationCloseOutTxnFromObject}
  */
 export function makeApplicationCloseOutTxn(
   from: AppCloseOutTxn['from'],
@@ -1199,6 +1223,8 @@ export function makeApplicationCloseOutTxnFromObject(
  * @param lease - Lease a transaction
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeApplicationClearStateTxnFromObject}
  */
 export function makeApplicationClearStateTxn(
   from: AppClearStateTxn['from'],
@@ -1293,6 +1319,8 @@ export function makeApplicationClearStateTxnFromObject(
  * @param lease - Lease a transaction
  * @param rekeyTo - String representation of the Algorand address that will be used to authorize all future transactions
  * @param boxes - Array of BoxReference, app ID and name of box to be accessed
+ *
+ * @deprecated This function will be removed in v3 in favor of {@link makeApplicationNoOpTxnFromObject}
  */
 export function makeApplicationNoOpTxn(
   from: AppNoOpTxn['from'],

package/src/transaction.ts

@@ -19,6 +19,8 @@ import AnyTransaction, {
   EncodedSignedTransaction,
   EncodedMultisig,
   EncodedLogicSig,
+  EncodedHeartbeatFields,
+  EncodedHeartbeatProof,
 } from './types/transactions';
 import { Address } from './types/address';
 
@@ -38,6 +40,100 @@ const KEYREG_STATE_PROOF_KEY_LENGTH = 64;
 type AnyTransactionWithParams = MustHaveSuggestedParams<AnyTransaction>;
 type AnyTransactionWithParamsInline = MustHaveSuggestedParamsInline<AnyTransaction>;
 
+/**
+ * Object representing a heartbeat proof
+ */
+class HeartbeatProof {
+  s: Buffer;
+  p: Buffer;
+  p2: Buffer;
+  p1s: Buffer;
+  p2s: Buffer;
+
+  constructor(sig: Buffer, pk: Buffer, pk2: Buffer, p1s: Buffer, p2s: Buffer) {
+    this.s = sig;
+    this.p = pk;
+    this.p2 = pk2;
+    this.p1s = p1s;
+    this.p2s = p2s;
+  }
+
+  // eslint-disable-next-line camelcase
+  static from_obj_for_encoding(
+    encHbFields: EncodedHeartbeatProof
+  ): HeartbeatProof {
+    const proof = Object.create(this.prototype) as HeartbeatProof;
+    proof.s = encHbFields.s;
+    proof.p = encHbFields.p;
+    proof.p2 = encHbFields.p2;
+    proof.p1s = encHbFields.p1s;
+    proof.p2s = encHbFields.p2s;
+    return proof;
+  }
+
+  // eslint-disable-next-line camelcase
+  get_obj_for_encoding() {
+    const fields: EncodedHeartbeatProof = {
+      s: this.s,
+      p: this.p,
+      p2: this.p2,
+      p1s: this.p1s,
+      p2s: this.p2s,
+    };
+    return fields;
+  }
+}
+
+/**
+ * Object representing a heartbeat transaction
+ */
+class HeartbeatFields {
+  a: string | Address;
+  prf: HeartbeatProof;
+  sd: Buffer;
+  vid: Buffer;
+  kd: number;
+
+  constructor(
+    addr: string | Address,
+    proof: EncodedHeartbeatProof,
+    seed: Buffer,
+    voteID: Buffer,
+    kd: number
+  ) {
+    this.a = addr;
+    this.prf = HeartbeatProof.from_obj_for_encoding(proof);
+    this.sd = seed;
+    this.vid = voteID;
+    this.kd = kd;
+  }
+
+  // eslint-disable-next-line camelcase
+  static from_obj_for_encoding(
+    encHbFields: EncodedHeartbeatFields
+  ): HeartbeatFields {
+    const fields = Object.create(this.prototype) as HeartbeatFields;
+    fields.a = address.decodeAddress(address.encodeAddress(encHbFields.a));
+    fields.prf = HeartbeatProof.from_obj_for_encoding(encHbFields.prf);
+    fields.sd = Buffer.from(encHbFields.sd);
+    fields.vid = Buffer.from(encHbFields.vid);
+    fields.kd = encHbFields.kd;
+    return fields;
+  }
+
+  // eslint-disable-next-line camelcase
+  get_obj_for_encoding() {
+    const fields: EncodedHeartbeatFields = {
+      a: Buffer.from((this.a as Address).publicKey),
+      prf: this.prf.get_obj_for_encoding(),
+      sd: this.sd,
+      vid: this.vid,
+      kd: this.kd,
+    };
+    return fields;
+  }
+}
+
 /**
  * A modified version of the transaction params. Represents the internal structure that the Transaction class uses
  * to store inputted transaction objects.
@@ -62,6 +158,7 @@ interface TransactionStorageStructure
     | 'appAccounts'
     | 'suggestedParams'
     | 'reKeyTo'
+    | 'heartbeatFields' // redefine type to silent TS error about 'string | Address' and 'string' incompatibility
   > {
   from: string | Address;
   to: string | Address;
@@ -117,6 +214,7 @@ interface TransactionStorageStructure
   stateProofType?: number | bigint;
   stateProof?: Uint8Array;
   stateProofMessage?: Uint8Array;
+  heartbeatFields?: HeartbeatFields;
 }
 
 function getKeyregKey(
@@ -209,6 +307,7 @@ export class Transaction implements TransactionStorageStructure {
   stateProofType?: number | bigint;
   stateProof?: Uint8Array;
   stateProofMessage?: Uint8Array;
+  heartbeatFields?: HeartbeatFields;
 
   constructor({ ...transaction }: AnyTransaction) {
     // Populate defaults
@@ -574,6 +673,10 @@ export class Transaction implements TransactionStorageStructure {
     } else {
       txn.stateProof = new Uint8Array(0);
     }
+    if (txn.heartbeatFields !== undefined) {
+      if (txn.heartbeatFields.constructor !== HeartbeatFields)
+        throw Error('heartbeatFields must be a HeartbeatFields.');
+    }
   }
 
   // eslint-disable-next-line camelcase
@@ -918,6 +1021,28 @@ export class Transaction implements TransactionStorageStructure {
       if (txn.grp === undefined) delete txn.grp;
       return txn;
     }
+    if (this.type === 'hb') {
+      // heartbeat txn
+      const txn: EncodedTransaction = {
+        fee: this.fee,
+        fv: this.firstRound,
+        lv: this.lastRound,
+        note: Buffer.from(this.note),
+        snd: Buffer.from(this.from.publicKey),
+        type: this.type,
+        gen: this.genesisID,
+        gh: this.genesisHash,
+        lx: Buffer.from(this.lease),
+        hb: this.heartbeatFields.get_obj_for_encoding(),
+      };
+      // allowed zero values
+      if (!txn.note.length) delete txn.note;
+      if (!txn.lx.length) delete txn.lx;
+      if (!txn.fee) delete txn.fee;
+      if (!txn.gen) delete txn.gen;
+      if (txn.grp === undefined) delete txn.grp;
+      return txn;
+    }
 
     return undefined;
   }
@@ -1105,6 +1230,12 @@ export class Transaction implements TransactionStorageStructure {
       if (txnForEnc.spmsg !== undefined) {
         txn.stateProofMessage = txnForEnc.spmsg;
       }
+    } else if (txnForEnc.type === 'hb') {
+      if (txnForEnc.hb !== undefined) {
+        txn.heartbeatFields = HeartbeatFields.from_obj_for_encoding(
+          txnForEnc.hb
+        );
+      }
     }
     return txn;
   }

package/src/types/transactions/base.ts

@@ -37,6 +37,11 @@ export enum TransactionType {
    * State proof transaction
    */
   stpf = 'stpf',
+
+  /**
+   * Heartbeat transaction
+   */
+  hb = 'hb',
 }
 
 export function isTransactionType(s: string): s is TransactionType {
@@ -47,7 +52,8 @@ export function isTransactionType(s: string): s is TransactionType {
     s === TransactionType.axfer ||
     s === TransactionType.afrz ||
     s === TransactionType.appl ||
-    s === TransactionType.stpf
+    s === TransactionType.stpf ||
+    s === TransactionType.hb
   );
 }
 
@@ -152,6 +158,14 @@ export interface BoxReference {
   name: Uint8Array;
 }
 
+interface heartbeatFields {
+  a: string;
+  prf: Uint8Array;
+  sd: Uint8Array;
+  vid: Uint8Array;
+  kd: number;
+}
+
 /**
  * A full list of all available transaction parameters
  *
@@ -432,4 +446,9 @@ export interface TransactionParams {
    * Byte array containing the state proof message.
    */
   stateProofMessage?: Uint8Array;
+
+  /**
+   * HeartbeatFields fields
+   */
+  heartbeatFields?: heartbeatFields;
 }

package/src/types/transactions/encoded.ts

@@ -97,6 +97,66 @@ export interface EncodedBoxReference {
   n: Uint8Array;
 }
 
+/**
+ * A structure for an encoded heartbeat proof fields object
+ */
+export interface EncodedHeartbeatProof {
+  /**
+   * Sig
+   */
+  s: Buffer;
+
+  /**
+   * PK
+   */
+  p: Buffer;
+
+  /**
+   * PK2
+   */
+  p2: Buffer;
+
+  /**
+   * PK1Sig
+   */
+  p1s: Buffer;
+
+  /**
+   * PK2Sig
+   */
+  p2s: Buffer;
+}
+
+/**
+ * A structure for an encoded heartbeat fields object
+ */
+export interface EncodedHeartbeatFields {
+  /**
+   * HbAddress
+   */
+  a: Buffer;
+
+  /**
+   * HbProof
+   */
+  prf: EncodedHeartbeatProof;
+
+  /**
+   * HbSeed
+   */
+  sd: Buffer;
+
+  /**
+   * HbVoteID
+   */
+  vid: Buffer;
+
+  /**
+   * HbKeyDilution
+   */
+  kd: number;
+}
+
 /**
  * A rough structure for the encoded transaction object. Every property is labelled with its associated Transaction type property
  */
@@ -330,6 +390,11 @@ export interface EncodedTransaction {
    * stateProofMessage
    */
   spmsg?: Buffer;
+
+  /**
+   * heartbeat fields
+   */
+  hb?: EncodedHeartbeatFields;
 }
 
 export interface EncodedSubsig {

package/src/types/transactions/heartbeat.ts

@@ -0,0 +1,14 @@
+import { TransactionType, TransactionParams } from './base';
+import { ConstructTransaction } from './builder';
+
+type SpecificParameters = Pick<TransactionParams, 'heartbeatFields'>;
+
+interface Overwrites {
+  type?: TransactionType.hb;
+}
+
+type HeartbeatTransaction = ConstructTransaction<
+  SpecificParameters,
+  Overwrites
+>;
+export default HeartbeatTransaction;

package/src/types/transactions/index.ts

@@ -17,6 +17,7 @@ import {
   ApplicationNoOpTransaction as AppNoOpTxn,
 } from './application';
 import StateProofTxn from './stateproof';
+import HeartbeatTxn from './heartbeat';
 
 // Utilities
 export {
@@ -51,6 +52,7 @@ export {
   ApplicationNoOpTransaction as AppNoOpTxn,
 } from './application';
 export { default as StateProofTxn } from './stateproof';
+export { default as HeartbeatTransaction } from './heartbeat';
 
 // All possible transaction types
 type AnyTransaction =
@@ -68,5 +70,6 @@ type AnyTransaction =
   | AppCloseOutTxn
   | AppClearStateTxn
   | AppNoOpTxn
-  | StateProofTxn;
+  | StateProofTxn
+  | HeartbeatTxn;
 export default AnyTransaction;