algosdk 2.8.0 → 2.10.0

package/dist/types/client/v2/algod/models/types.d.ts

@@ -992,6 +992,23 @@ export declare class BlockHashResponse extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): BlockHashResponse;
 }
+/**
+ * Block header.
+ */
+export declare class BlockHeaderResponse extends BaseModel {
+    /**
+     * Block header data.
+     */
+    blockheader?: BlockHeader;
+    /**
+     * Creates a new `BlockHeaderResponse` object.
+     * @param blockheader - Block header data.
+     */
+    constructor({ blockheader }: {
+        blockheader?: BlockHeader;
+    });
+    static from_obj_for_encoding(data: Record<string, any>): BlockHeaderResponse;
+}
 /**
  * All logs emitted in the given round. Each app call, whether top-level or inner,
  * that contains logs results in a separate AppCallLogs object. Therefore there may
@@ -1983,6 +2000,11 @@ export declare class SimulateRequest extends BaseModel {
      * Applies extra opcode budget during simulation for each transaction group.
      */
     extraOpcodeBudget?: number | bigint;
+    /**
+     * If true, signers for transactions that are missing signatures will be fixed
+     * during evaluation.
+     */
+    fixSigners?: boolean;
     /**
      * If provided, specifies the round preceding the simulation. State changes through
      * this round will be used to run this simulation. Usually only the 4 most recent
@@ -1999,18 +2021,21 @@ export declare class SimulateRequest extends BaseModel {
      * @param allowUnnamedResources - Allows access to unnamed resources during simulation.
      * @param execTraceConfig - An object that configures simulation execution trace.
      * @param extraOpcodeBudget - Applies extra opcode budget during simulation for each transaction group.
+     * @param fixSigners - If true, signers for transactions that are missing signatures will be fixed
+     * during evaluation.
      * @param round - If provided, specifies the round preceding the simulation. State changes through
      * this round will be used to run this simulation. Usually only the 4 most recent
      * rounds will be available (controlled by the node config value MaxAcctLookback).
      * If not specified, defaults to the latest available round.
      */
-    constructor({ txnGroups, allowEmptySignatures, allowMoreLogging, allowUnnamedResources, execTraceConfig, extraOpcodeBudget, round, }: {
+    constructor({ txnGroups, allowEmptySignatures, allowMoreLogging, allowUnnamedResources, execTraceConfig, extraOpcodeBudget, fixSigners, round, }: {
         txnGroups: SimulateRequestTransactionGroup[];
         allowEmptySignatures?: boolean;
         allowMoreLogging?: boolean;
         allowUnnamedResources?: boolean;
         execTraceConfig?: SimulateTraceConfig;
         extraOpcodeBudget?: number | bigint;
+        fixSigners?: boolean;
         round?: number | bigint;
     });
     static from_obj_for_encoding(data: Record<string, any>): SimulateRequest;
@@ -2216,6 +2241,11 @@ export declare class SimulateTransactionResult extends BaseModel {
      * call trace in a recursive way.
      */
     execTrace?: SimulationTransactionExecTrace;
+    /**
+     * The account that needed to sign this transaction when no signature was provided
+     * and the provided signer was incorrect.
+     */
+    fixedSigner?: string;
     /**
      * Budget used during execution of a logic sig transaction.
      */
@@ -2240,6 +2270,8 @@ export declare class SimulateTransactionResult extends BaseModel {
      * budged used by inner app calls spawned by this transaction.
      * @param execTrace - The execution trace of calling an app or a logic sig, containing the inner app
      * call trace in a recursive way.
+     * @param fixedSigner - The account that needed to sign this transaction when no signature was provided
+     * and the provided signer was incorrect.
      * @param logicSigBudgetConsumed - Budget used during execution of a logic sig transaction.
      * @param unnamedResourcesAccessed - These are resources that were accessed by this group that would normally have
      * caused failure, but were allowed in simulation. Depending on where this object
@@ -2251,10 +2283,11 @@ export declare class SimulateTransactionResult extends BaseModel {
      * transaction of the group; otherwise, resources must be placed in the same
      * transaction which accessed them.
      */
-    constructor({ txnResult, appBudgetConsumed, execTrace, logicSigBudgetConsumed, unnamedResourcesAccessed, }: {
+    constructor({ txnResult, appBudgetConsumed, execTrace, fixedSigner, logicSigBudgetConsumed, unnamedResourcesAccessed, }: {
         txnResult: PendingTransactionResponse;
         appBudgetConsumed?: number | bigint;
         execTrace?: SimulationTransactionExecTrace;
+        fixedSigner?: string;
         logicSigBudgetConsumed?: number | bigint;
         unnamedResourcesAccessed?: SimulateUnnamedResourcesAccessed;
     });
@@ -2350,6 +2383,11 @@ export declare class SimulationEvalOverrides extends BaseModel {
      * The extra opcode budget added to each transaction group during simulation
      */
     extraOpcodeBudget?: number | bigint;
+    /**
+     * If true, signers for transactions that are missing signatures will be fixed
+     * during evaluation.
+     */
+    fixSigners?: boolean;
     /**
      * The maximum log calls one can make during simulation
      */
@@ -2364,13 +2402,16 @@ export declare class SimulationEvalOverrides extends BaseModel {
      * were properly signed.
      * @param allowUnnamedResources - If true, allows access to unnamed resources during simulation.
      * @param extraOpcodeBudget - The extra opcode budget added to each transaction group during simulation
+     * @param fixSigners - If true, signers for transactions that are missing signatures will be fixed
+     * during evaluation.
      * @param maxLogCalls - The maximum log calls one can make during simulation
      * @param maxLogSize - The maximum byte number to log during simulation
      */
-    constructor({ allowEmptySignatures, allowUnnamedResources, extraOpcodeBudget, maxLogCalls, maxLogSize, }: {
+    constructor({ allowEmptySignatures, allowUnnamedResources, extraOpcodeBudget, fixSigners, maxLogCalls, maxLogSize, }: {
         allowEmptySignatures?: boolean;
         allowUnnamedResources?: boolean;
         extraOpcodeBudget?: number | bigint;
+        fixSigners?: boolean;
         maxLogCalls?: number | bigint;
         maxLogSize?: number | bigint;
     });

package/dist/types/client/v2/indexer/models/types.d.ts

@@ -1152,6 +1152,34 @@ export declare class Block extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): Block;
 }
+/**
+ *
+ */
+export declare class BlockHeadersResponse extends BaseModel {
+    blocks?: Block[];
+    /**
+     * Round at which the results were computed.
+     */
+    currentRound?: number | bigint;
+    /**
+     * Used for pagination, when making another request provide this token with the
+     * next parameter.
+     */
+    nextToken?: string;
+    /**
+     * Creates a new `BlockHeadersResponse` object.
+     * @param blocks -
+     * @param currentRound - Round at which the results were computed.
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter.
+     */
+    constructor({ blocks, currentRound, nextToken, }: {
+        blocks?: Block[];
+        currentRound?: number | bigint;
+        nextToken?: string;
+    });
+    static from_obj_for_encoding(data: Record<string, any>): BlockHeadersResponse;
+}
 /**
  * Fields relating to rewards,
  */
@@ -1435,6 +1463,52 @@ export declare class HashFactory extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): HashFactory;
 }
+/**
+ * (hbprf) HbProof is a signature using HeartbeatAddress's partkey, thereby showing
+ * it is online.
+ */
+export declare class HbProofFields extends BaseModel {
+    /**
+     * (p) Public key of the heartbeat message.
+     */
+    hbPk?: Uint8Array;
+    /**
+     * (p1s) Signature of OneTimeSignatureSubkeyOffsetID(PK, Batch, Offset) under the
+     * key PK2.
+     */
+    hbPk1sig?: Uint8Array;
+    /**
+     * (p2) Key for new-style two-level ephemeral signature.
+     */
+    hbPk2?: Uint8Array;
+    /**
+     * (p2s) Signature of OneTimeSignatureSubkeyBatchID(PK2, Batch) under the master
+     * key (OneTimeSignatureVerifier).
+     */
+    hbPk2sig?: Uint8Array;
+    /**
+     * (s) Signature of the heartbeat message.
+     */
+    hbSig?: Uint8Array;
+    /**
+     * Creates a new `HbProofFields` object.
+     * @param hbPk - (p) Public key of the heartbeat message.
+     * @param hbPk1sig - (p1s) Signature of OneTimeSignatureSubkeyOffsetID(PK, Batch, Offset) under the
+     * key PK2.
+     * @param hbPk2 - (p2) Key for new-style two-level ephemeral signature.
+     * @param hbPk2sig - (p2s) Signature of OneTimeSignatureSubkeyBatchID(PK2, Batch) under the master
+     * key (OneTimeSignatureVerifier).
+     * @param hbSig - (s) Signature of the heartbeat message.
+     */
+    constructor({ hbPk, hbPk1sig, hbPk2, hbPk2sig, hbSig, }: {
+        hbPk?: string | Uint8Array;
+        hbPk1sig?: string | Uint8Array;
+        hbPk2?: string | Uint8Array;
+        hbPk2sig?: string | Uint8Array;
+        hbSig?: string | Uint8Array;
+    });
+    static from_obj_for_encoding(data: Record<string, any>): HbProofFields;
+}
 /**
  * A health check response.
  */
@@ -1966,6 +2040,12 @@ export declare class Transaction extends BaseModel {
      * sha512/256 hash of the transactions in that group.
      */
     group?: Uint8Array;
+    /**
+     * Fields for a heartbeat transaction.
+     * Definition:
+     * data/transactions/heartbeat.go : HeartbeatTxnFields
+     */
+    heartbeatTransaction?: TransactionHeartbeat;
     /**
      * Transaction ID
      */
@@ -2051,6 +2131,7 @@ export declare class Transaction extends BaseModel {
      * * (afrz) asset-freeze-transaction
      * * (appl) application-transaction
      * * (stpf) state-proof-transaction
+     * * (hb) heartbeat-transaction
      */
     txType?: string;
     /**
@@ -2089,6 +2170,9 @@ export declare class Transaction extends BaseModel {
      * @param group - (grp) Base64 encoded byte array of a sha512/256 digest. When present indicates
      * that this transaction is part of a transaction group and the value is the
      * sha512/256 hash of the transactions in that group.
+     * @param heartbeatTransaction - Fields for a heartbeat transaction.
+     * Definition:
+     * data/transactions/heartbeat.go : HeartbeatTxnFields
      * @param id - Transaction ID
      * @param innerTxns - Inner transactions produced by application execution.
      * @param intraRoundOffset - Offset into the round where this transaction was confirmed.
@@ -2128,8 +2212,9 @@ export declare class Transaction extends BaseModel {
      * * (afrz) asset-freeze-transaction
      * * (appl) application-transaction
      * * (stpf) state-proof-transaction
+     * * (hb) heartbeat-transaction
      */
-    constructor({ fee, firstValid, lastValid, sender, applicationTransaction, assetConfigTransaction, assetFreezeTransaction, assetTransferTransaction, authAddr, closeRewards, closingAmount, confirmedRound, createdApplicationIndex, createdAssetIndex, genesisHash, genesisId, globalStateDelta, group, id, innerTxns, intraRoundOffset, keyregTransaction, lease, localStateDelta, logs, note, paymentTransaction, receiverRewards, rekeyTo, roundTime, senderRewards, signature, stateProofTransaction, txType, }: {
+    constructor({ fee, firstValid, lastValid, sender, applicationTransaction, assetConfigTransaction, assetFreezeTransaction, assetTransferTransaction, authAddr, closeRewards, closingAmount, confirmedRound, createdApplicationIndex, createdAssetIndex, genesisHash, genesisId, globalStateDelta, group, heartbeatTransaction, id, innerTxns, intraRoundOffset, keyregTransaction, lease, localStateDelta, logs, note, paymentTransaction, receiverRewards, rekeyTo, roundTime, senderRewards, signature, stateProofTransaction, txType, }: {
         fee: number | bigint;
         firstValid: number | bigint;
         lastValid: number | bigint;
@@ -2148,6 +2233,7 @@ export declare class Transaction extends BaseModel {
         genesisId?: string;
         globalStateDelta?: EvalDeltaKeyValue[];
         group?: string | Uint8Array;
+        heartbeatTransaction?: TransactionHeartbeat;
         id?: string;
         innerTxns?: Transaction[];
         intraRoundOffset?: number | bigint;
@@ -2419,6 +2505,53 @@ export declare class TransactionAssetTransfer extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): TransactionAssetTransfer;
 }
+/**
+ * Fields for a heartbeat transaction.
+ * Definition:
+ * data/transactions/heartbeat.go : HeartbeatTxnFields
+ */
+export declare class TransactionHeartbeat extends BaseModel {
+    /**
+     * (hbad) HbAddress is the account this txn is proving onlineness for.
+     */
+    hbAddress: string;
+    /**
+     * (hbkd) HbKeyDilution must match HbAddress account's current KeyDilution.
+     */
+    hbKeyDilution: number | bigint;
+    /**
+     * (hbprf) HbProof is a signature using HeartbeatAddress's partkey, thereby showing
+     * it is online.
+     */
+    hbProof: HbProofFields;
+    /**
+     * (hbsd) HbSeed must be the block seed for the this transaction's firstValid
+     * block.
+     */
+    hbSeed: Uint8Array;
+    /**
+     * (hbvid) HbVoteID must match the HbAddress account's current VoteID.
+     */
+    hbVoteId: Uint8Array;
+    /**
+     * Creates a new `TransactionHeartbeat` object.
+     * @param hbAddress - (hbad) HbAddress is the account this txn is proving onlineness for.
+     * @param hbKeyDilution - (hbkd) HbKeyDilution must match HbAddress account's current KeyDilution.
+     * @param hbProof - (hbprf) HbProof is a signature using HeartbeatAddress's partkey, thereby showing
+     * it is online.
+     * @param hbSeed - (hbsd) HbSeed must be the block seed for the this transaction's firstValid
+     * block.
+     * @param hbVoteId - (hbvid) HbVoteID must match the HbAddress account's current VoteID.
+     */
+    constructor({ hbAddress, hbKeyDilution, hbProof, hbSeed, hbVoteId, }: {
+        hbAddress: string;
+        hbKeyDilution: number | bigint;
+        hbProof: HbProofFields;
+        hbSeed: string | Uint8Array;
+        hbVoteId: string | Uint8Array;
+    });
+    static from_obj_for_encoding(data: Record<string, any>): TransactionHeartbeat;
+}
 /**
  * Fields for a keyreg transaction.
  * Definition:

package/dist/types/makeTxn.d.ts

@@ -17,6 +17,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 declare function makePaymentTxnWithSuggestedParams(from: PaymentTxn['from'], to: PaymentTxn['to'], amount: PaymentTxn['amount'], closeRemainderTo: PaymentTxn['closeRemainderTo'], note: PaymentTxn['note'], suggestedParams: MustHaveSuggestedParams<PaymentTxn>['suggestedParams'], rekeyTo?: PaymentTxn['reKeyTo']): txnBuilder.Transaction;
 export declare function makePaymentTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<PaymentTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'to' | 'amount' | 'closeRemainderTo' | 'note' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction;
@@ -43,6 +45,8 @@ export declare function makePaymentTxnWithSuggestedParamsFromObject(o: Expand<Pi
  * @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 declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegistrationTxn['from'], note: KeyRegistrationTxn['note'], voteKey: KeyRegistrationTxn['voteKey'], selectionKey: KeyRegistrationTxn['selectionKey'], voteFirst: KeyRegistrationTxn['voteFirst'], voteLast: KeyRegistrationTxn['voteLast'], voteKeyDilution: KeyRegistrationTxn['voteKeyDilution'], suggestedParams: MustHaveSuggestedParams<KeyRegistrationTxn>['suggestedParams'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: false, stateProofKey?: KeyRegistrationTxn['stateProofKey']): txnBuilder.Transaction;
 export declare function makeKeyRegistrationTxnWithSuggestedParams(from: KeyRegistrationTxn['from'], note: KeyRegistrationTxn['note'], voteKey: undefined, selectionKey: undefined, voteFirst: undefined, voteLast: undefined, voteKeyDilution: undefined, suggestedParams: MustHaveSuggestedParams<KeyRegistrationTxn>['suggestedParams'], rekeyTo?: KeyRegistrationTxn['reKeyTo'], nonParticipation?: boolean, stateProofKey?: undefined): txnBuilder.Transaction;
@@ -75,6 +79,8 @@ export declare function makeKeyRegistrationTxnWithSuggestedParamsFromObject(o: E
  * 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 declare function makeAssetCreateTxnWithSuggestedParams(from: AssetCreateTxn['from'], note: AssetCreateTxn['note'], total: AssetCreateTxn['assetTotal'], decimals: AssetCreateTxn['assetDecimals'], defaultFrozen: AssetCreateTxn['assetDefaultFrozen'], manager: AssetCreateTxn['assetManager'], reserve: AssetCreateTxn['assetReserve'], freeze: AssetCreateTxn['assetFreeze'], clawback: AssetCreateTxn['assetClawback'], unitName: AssetCreateTxn['assetUnitName'], assetName: AssetCreateTxn['assetName'], assetURL: AssetCreateTxn['assetURL'], assetMetadataHash: AssetCreateTxn['assetMetadataHash'] | undefined, suggestedParams: MustHaveSuggestedParams<AssetCreateTxn>['suggestedParams'], rekeyTo?: AssetCreateTxn['reKeyTo']): txnBuilder.Transaction;
 export declare function makeAssetCreateTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetCreateTxn>, {
@@ -109,6 +115,8 @@ export declare function makeAssetCreateTxnWithSuggestedParamsFromObject(o: Expan
  * 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 declare function makeAssetConfigTxnWithSuggestedParams(from: AssetConfigTxn['from'], note: AssetConfigTxn['note'], assetIndex: AssetConfigTxn['assetIndex'], manager: AssetConfigTxn['assetManager'], reserve: AssetConfigTxn['assetReserve'], freeze: AssetConfigTxn['assetFreeze'], clawback: AssetConfigTxn['assetClawback'], suggestedParams: MustHaveSuggestedParams<AssetConfigTxn>['suggestedParams'], strictEmptyAddressChecking?: boolean, rekeyTo?: AssetConfigTxn['reKeyTo']): txnBuilder.Transaction;
 export declare function makeAssetConfigTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetConfigTxn>, {
@@ -135,6 +143,8 @@ export declare function makeAssetConfigTxnWithSuggestedParamsFromObject(o: Expan
  * 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 declare function makeAssetDestroyTxnWithSuggestedParams(from: AssetDestroyTxn['from'], note: AssetDestroyTxn['note'], assetIndex: AssetDestroyTxn['assetIndex'], suggestedParams: MustHaveSuggestedParams<AssetDestroyTxn>['suggestedParams'], rekeyTo?: AssetDestroyTxn['reKeyTo']): txnBuilder.Transaction;
 export declare function makeAssetDestroyTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperty<MustHaveSuggestedParams<AssetDestroyTxn>, 'reKeyTo', 'rekeyTo'>, 'from' | 'note' | 'assetIndex' | 'suggestedParams' | 'rekeyTo'>>): txnBuilder.Transaction;
@@ -155,6 +165,8 @@ export declare function makeAssetDestroyTxnWithSuggestedParamsFromObject(o: Expa
  * 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 declare function makeAssetFreezeTxnWithSuggestedParams(from: AssetFreezeTxn['from'], note: AssetFreezeTxn['note'], assetIndex: AssetFreezeTxn['assetIndex'], freezeTarget: AssetFreezeTxn['freezeAccount'], freezeState: AssetFreezeTxn['freezeState'], suggestedParams: MustHaveSuggestedParams<AssetFreezeTxn>['suggestedParams'], rekeyTo?: AssetFreezeTxn['reKeyTo']): txnBuilder.Transaction;
 export declare function makeAssetFreezeTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetFreezeTxn>, {
@@ -184,6 +196,8 @@ export declare function makeAssetFreezeTxnWithSuggestedParamsFromObject(o: Expan
  * 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 declare function makeAssetTransferTxnWithSuggestedParams(from: AssetTransferTxn['from'], to: AssetTransferTxn['to'], closeRemainderTo: AssetTransferTxn['closeRemainderTo'], revocationTarget: AssetTransferTxn['assetRevocationTarget'], amount: AssetTransferTxn['amount'], note: AssetTransferTxn['note'], assetIndex: AssetTransferTxn['assetIndex'], suggestedParams: MustHaveSuggestedParams<AssetTransferTxn>['suggestedParams'], rekeyTo?: AssetTransferTxn['reKeyTo']): txnBuilder.Transaction;
 export declare function makeAssetTransferTxnWithSuggestedParamsFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AssetTransferTxn>, {
@@ -217,6 +231,8 @@ export declare function makeAssetTransferTxnWithSuggestedParamsFromObject(o: Exp
  * @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 declare function makeApplicationCreateTxn(from: AppCreateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppCreateTxn>['suggestedParams'], onComplete: AppCreateTxn['appOnComplete'], approvalProgram: AppCreateTxn['appApprovalProgram'], clearProgram: AppCreateTxn['appClearProgram'], numLocalInts: AppCreateTxn['appLocalInts'], numLocalByteSlices: AppCreateTxn['appLocalByteSlices'], numGlobalInts: AppCreateTxn['appGlobalInts'], numGlobalByteSlices: AppCreateTxn['appGlobalByteSlices'], appArgs?: AppCreateTxn['appArgs'], accounts?: AppCreateTxn['appAccounts'], foreignApps?: AppCreateTxn['appForeignApps'], foreignAssets?: AppCreateTxn['appForeignAssets'], note?: AppCreateTxn['note'], lease?: AppCreateTxn['lease'], rekeyTo?: AppCreateTxn['reKeyTo'], extraPages?: AppCreateTxn['extraPages'], boxes?: AppCreateTxn['boxes']): txnBuilder.Transaction;
 export declare function makeApplicationCreateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppCreateTxn>, {
@@ -254,6 +270,8 @@ export declare function makeApplicationCreateTxnFromObject(o: Expand<Pick<Rename
  * @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 declare function makeApplicationUpdateTxn(from: AppUpdateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppUpdateTxn>['suggestedParams'], appIndex: AppUpdateTxn['appIndex'], approvalProgram: AppUpdateTxn['appApprovalProgram'], clearProgram: AppUpdateTxn['appClearProgram'], appArgs?: AppUpdateTxn['appArgs'], accounts?: AppUpdateTxn['appAccounts'], foreignApps?: AppUpdateTxn['appForeignApps'], foreignAssets?: AppUpdateTxn['appForeignAssets'], note?: AppUpdateTxn['note'], lease?: AppUpdateTxn['lease'], rekeyTo?: AppUpdateTxn['reKeyTo'], boxes?: AppUpdateTxn['boxes']): txnBuilder.Transaction;
 export declare function makeApplicationUpdateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppUpdateTxn>, {
@@ -284,6 +302,8 @@ export declare function makeApplicationUpdateTxnFromObject(o: Expand<Pick<Rename
  * @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 declare function makeApplicationDeleteTxn(from: AppDeleteTxn['from'], suggestedParams: MustHaveSuggestedParams<AppDeleteTxn>['suggestedParams'], appIndex: AppDeleteTxn['appIndex'], appArgs?: AppDeleteTxn['appArgs'], accounts?: AppDeleteTxn['appAccounts'], foreignApps?: AppDeleteTxn['appForeignApps'], foreignAssets?: AppDeleteTxn['appForeignAssets'], note?: AppDeleteTxn['note'], lease?: AppDeleteTxn['lease'], rekeyTo?: AppDeleteTxn['reKeyTo'], boxes?: AppDeleteTxn['boxes']): txnBuilder.Transaction;
 export declare function makeApplicationDeleteTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppDeleteTxn>, {
@@ -312,6 +332,8 @@ export declare function makeApplicationDeleteTxnFromObject(o: Expand<Pick<Rename
  * @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 declare function makeApplicationOptInTxn(from: AppOptInTxn['from'], suggestedParams: MustHaveSuggestedParams<AppOptInTxn>['suggestedParams'], appIndex: AppOptInTxn['appIndex'], appArgs?: AppOptInTxn['appArgs'], accounts?: AppOptInTxn['appAccounts'], foreignApps?: AppOptInTxn['appForeignApps'], foreignAssets?: AppOptInTxn['appForeignAssets'], note?: AppOptInTxn['note'], lease?: AppOptInTxn['lease'], rekeyTo?: AppOptInTxn['reKeyTo'], boxes?: AppOptInTxn['boxes']): txnBuilder.Transaction;
 export declare function makeApplicationOptInTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, {
@@ -340,6 +362,8 @@ export declare function makeApplicationOptInTxnFromObject(o: Expand<Pick<RenameP
  * @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 declare function makeApplicationCloseOutTxn(from: AppCloseOutTxn['from'], suggestedParams: MustHaveSuggestedParams<AppCloseOutTxn>['suggestedParams'], appIndex: AppCloseOutTxn['appIndex'], appArgs?: AppCloseOutTxn['appArgs'], accounts?: AppCloseOutTxn['appAccounts'], foreignApps?: AppCloseOutTxn['appForeignApps'], foreignAssets?: AppCloseOutTxn['appForeignAssets'], note?: AppCloseOutTxn['note'], lease?: AppCloseOutTxn['lease'], rekeyTo?: AppCloseOutTxn['reKeyTo'], boxes?: AppCloseOutTxn['boxes']): txnBuilder.Transaction;
 export declare function makeApplicationCloseOutTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, {
@@ -368,6 +392,8 @@ export declare function makeApplicationCloseOutTxnFromObject(o: Expand<Pick<Rena
  * @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 declare function makeApplicationClearStateTxn(from: AppClearStateTxn['from'], suggestedParams: MustHaveSuggestedParams<AppClearStateTxn>['suggestedParams'], appIndex: AppClearStateTxn['appIndex'], appArgs?: AppClearStateTxn['appArgs'], accounts?: AppClearStateTxn['appAccounts'], foreignApps?: AppClearStateTxn['appForeignApps'], foreignAssets?: AppClearStateTxn['appForeignAssets'], note?: AppClearStateTxn['note'], lease?: AppClearStateTxn['lease'], rekeyTo?: AppClearStateTxn['reKeyTo'], boxes?: AppClearStateTxn['boxes']): txnBuilder.Transaction;
 export declare function makeApplicationClearStateTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, {
@@ -396,6 +422,8 @@ export declare function makeApplicationClearStateTxnFromObject(o: Expand<Pick<Re
  * @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 declare function makeApplicationNoOpTxn(from: AppNoOpTxn['from'], suggestedParams: MustHaveSuggestedParams<AppNoOpTxn>['suggestedParams'], appIndex: AppNoOpTxn['appIndex'], appArgs?: AppNoOpTxn['appArgs'], accounts?: AppNoOpTxn['appAccounts'], foreignApps?: AppNoOpTxn['appForeignApps'], foreignAssets?: AppNoOpTxn['appForeignAssets'], note?: AppNoOpTxn['note'], lease?: AppNoOpTxn['lease'], rekeyTo?: AppNoOpTxn['reKeyTo'], boxes?: AppNoOpTxn['boxes']): txnBuilder.Transaction;
 export declare function makeApplicationNoOpTxnFromObject(o: Expand<Pick<RenameProperties<MustHaveSuggestedParams<AppOptInTxn>, {

package/dist/types/transaction.d.ts

@@ -1,13 +1,39 @@
 /// <reference types="node" />
 import { OnApplicationComplete, TransactionParams, TransactionType, BoxReference } from './types/transactions/base';
-import AnyTransaction, { EncodedTransaction, EncodedMultisig, EncodedLogicSig } from './types/transactions';
+import AnyTransaction, { EncodedTransaction, EncodedMultisig, EncodedLogicSig, EncodedHeartbeatFields, EncodedHeartbeatProof } from './types/transactions';
 import { Address } from './types/address';
 export declare const ALGORAND_MIN_TX_FEE = 1000;
+/**
+ * Object representing a heartbeat proof
+ */
+declare class HeartbeatProof {
+    s: Buffer;
+    p: Buffer;
+    p2: Buffer;
+    p1s: Buffer;
+    p2s: Buffer;
+    constructor(sig: Buffer, pk: Buffer, pk2: Buffer, p1s: Buffer, p2s: Buffer);
+    static from_obj_for_encoding(encHbFields: EncodedHeartbeatProof): HeartbeatProof;
+    get_obj_for_encoding(): EncodedHeartbeatProof;
+}
+/**
+ * Object representing a heartbeat transaction
+ */
+declare 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);
+    static from_obj_for_encoding(encHbFields: EncodedHeartbeatFields): HeartbeatFields;
+    get_obj_for_encoding(): EncodedHeartbeatFields;
+}
 /**
  * A modified version of the transaction params. Represents the internal structure that the Transaction class uses
  * to store inputted transaction objects.
  */
-interface TransactionStorageStructure extends Omit<TransactionParams, 'from' | 'to' | 'genesisHash' | 'closeRemainderTo' | 'voteKey' | 'selectionKey' | 'stateProofKey' | 'assetManager' | 'assetReserve' | 'assetFreeze' | 'assetClawback' | 'assetRevocationTarget' | 'freezeAccount' | 'appAccounts' | 'suggestedParams' | 'reKeyTo'> {
+interface TransactionStorageStructure extends Omit<TransactionParams, 'from' | 'to' | 'genesisHash' | 'closeRemainderTo' | 'voteKey' | 'selectionKey' | 'stateProofKey' | 'assetManager' | 'assetReserve' | 'assetFreeze' | 'assetClawback' | 'assetRevocationTarget' | 'freezeAccount' | 'appAccounts' | 'suggestedParams' | 'reKeyTo' | 'heartbeatFields'> {
     from: string | Address;
     to: string | Address;
     fee: number;
@@ -62,6 +88,7 @@ interface TransactionStorageStructure extends Omit<TransactionParams, 'from' | '
     stateProofType?: number | bigint;
     stateProof?: Uint8Array;
     stateProofMessage?: Uint8Array;
+    heartbeatFields?: HeartbeatFields;
 }
 /**
  * Transaction enables construction of Algorand transactions
@@ -123,6 +150,7 @@ export declare class Transaction implements TransactionStorageStructure {
     stateProofType?: number | bigint;
     stateProof?: Uint8Array;
     stateProofMessage?: Uint8Array;
+    heartbeatFields?: HeartbeatFields;
     constructor({ ...transaction }: AnyTransaction);
     get_obj_for_encoding(): EncodedTransaction;
     static from_obj_for_encoding(txnForEnc: EncodedTransaction): Transaction;

package/dist/types/types/transactions/base.d.ts

@@ -31,7 +31,11 @@ export declare enum TransactionType {
     /**
      * State proof transaction
      */
-    stpf = "stpf"
+    stpf = "stpf",
+    /**
+     * Heartbeat transaction
+     */
+    hb = "hb"
 }
 export declare function isTransactionType(s: string): s is TransactionType;
 /**
@@ -120,6 +124,13 @@ 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
  *
@@ -345,4 +356,9 @@ export interface TransactionParams {
      * Byte array containing the state proof message.
      */
     stateProofMessage?: Uint8Array;
+    /**
+     * HeartbeatFields fields
+     */
+    heartbeatFields?: heartbeatFields;
 }
+export {};

package/dist/types/types/transactions/encoded.d.ts

@@ -78,6 +78,56 @@ 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
  */
@@ -263,6 +313,10 @@ export interface EncodedTransaction {
      * stateProofMessage
      */
     spmsg?: Buffer;
+    /**
+     * heartbeat fields
+     */
+    hb?: EncodedHeartbeatFields;
 }
 export interface EncodedSubsig {
     /**

package/dist/types/types/transactions/heartbeat.d.ts

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

package/dist/types/types/transactions/index.d.ts

@@ -3,6 +3,7 @@ import KeyRegistrationTxn from './keyreg';
 import { AssetCreateTransaction as AssetCreateTxn, AssetConfigurationTransaction as AssetConfigTxn, AssetDestroyTransaction as AssetDestroyTxn, AssetFreezeTransaction as AssetFreezeTxn, AssetTransferTransaction as AssetTransferTxn } from './asset';
 import { ApplicationCreateTransaction as AppCreateTxn, ApplicationUpdateTransaction as AppUpdateTxn, ApplicationDeleteTransaction as AppDeleteTxn, ApplicationOptInTransaction as AppOptInTxn, ApplicationCloseOutTransaction as AppCloseOutTxn, ApplicationClearStateTransaction as AppClearStateTxn, ApplicationNoOpTransaction as AppNoOpTxn } from './application';
 import StateProofTxn from './stateproof';
+import HeartbeatTxn from './heartbeat';
 export { TransactionParams, TransactionType, SuggestedParams, BoxReference, } from './base';
 export { MustHaveSuggestedParams, MustHaveSuggestedParamsInline, } from './builder';
 export * from './encoded';
@@ -11,5 +12,6 @@ export { default as KeyRegistrationTxn } from './keyreg';
 export { AssetCreateTransaction as AssetCreateTxn, AssetConfigurationTransaction as AssetConfigTxn, AssetDestroyTransaction as AssetDestroyTxn, AssetFreezeTransaction as AssetFreezeTxn, AssetTransferTransaction as AssetTransferTxn, } from './asset';
 export { ApplicationCreateTransaction as AppCreateTxn, ApplicationUpdateTransaction as AppUpdateTxn, ApplicationDeleteTransaction as AppDeleteTxn, ApplicationOptInTransaction as AppOptInTxn, ApplicationCloseOutTransaction as AppCloseOutTxn, ApplicationClearStateTransaction as AppClearStateTxn, ApplicationNoOpTransaction as AppNoOpTxn, } from './application';
 export { default as StateProofTxn } from './stateproof';
-declare type AnyTransaction = PaymentTxn | KeyRegistrationTxn | AssetCreateTxn | AssetConfigTxn | AssetDestroyTxn | AssetFreezeTxn | AssetTransferTxn | AppCreateTxn | AppUpdateTxn | AppDeleteTxn | AppOptInTxn | AppCloseOutTxn | AppClearStateTxn | AppNoOpTxn | StateProofTxn;
+export { default as HeartbeatTransaction } from './heartbeat';
+declare type AnyTransaction = PaymentTxn | KeyRegistrationTxn | AssetCreateTxn | AssetConfigTxn | AssetDestroyTxn | AssetFreezeTxn | AssetTransferTxn | AppCreateTxn | AppUpdateTxn | AppDeleteTxn | AppOptInTxn | AppCloseOutTxn | AppClearStateTxn | AppNoOpTxn | StateProofTxn | HeartbeatTxn;
 export default AnyTransaction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",