algosdk 2.9.0 → 2.10.0

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;