algosdk 1.19.0 → 1.20.0

package/dist/types/src/client/v2/algod/stateproof.d.ts

@@ -0,0 +1,8 @@
+import JSONRequest from '../jsonrequest';
+import HTTPClient from '../../client';
+import IntDecoding from '../../../types/intDecoding';
+export default class StateProof extends JSONRequest {
+    private round;
+    constructor(c: HTTPClient, intDecoding: IntDecoding, round: number);
+    path(): string;
+}

package/dist/types/src/client/v2/indexer/lookupAccountTransactions.d.ts

@@ -55,7 +55,7 @@ export default class LookupAccountTransactions extends JSONRequest {
      *        .do();
      * ```
      *
-     * @param type - one of `pay`, `keyreg`, `acfg`, `axfer`, `afrz`, `appl`
+     * @param type - one of `pay`, `keyreg`, `acfg`, `axfer`, `afrz`, `appl`, `stpf`
      * @category query
      */
     txType(type: string): this;

package/dist/types/src/client/v2/indexer/searchForTransactions.d.ts

@@ -42,7 +42,7 @@ export default class SearchForTransactions extends JSONRequest {
      *        .do();
      * ```
      *
-     * @param type - one of `pay`, `keyreg`, `acfg`, `axfer`, `afrz`, `appl`
+     * @param type - one of `pay`, `keyreg`, `acfg`, `axfer`, `afrz`, `appl`, `stpf`
      * @category query
      */
     txType(type: string): this;

package/dist/types/src/logic/logic.d.ts

@@ -1,9 +1,16 @@
 /**
  * Utilities for working with program bytes.
  */
+/** @deprecated for langspec.json is deprecated aross all SDKs */
 export declare function parseUvarint(array: Uint8Array): [numberFound: number, size: number];
 /** readProgram validates program for length and running cost,
  * and additionally provides the found int variables and byte blocks
+ *
+ * @deprecated Validation relies on metadata (`langspec.json`) that
+ * does not accurately represent opcode behavior across program versions.
+ * The behavior of `readProgram` relies on `langspec.json`.
+ * Thus, this method is being deprecated.
+ *
  * @param program - Program to check
  * @param args - Program arguments as array of Uint8Array arrays
  * @throws
@@ -12,15 +19,27 @@ export declare function parseUvarint(array: Uint8Array): [numberFound: number, s
 export declare function readProgram(program: Uint8Array, args?: Uint8Array[]): [ints: number[], byteArrays: Uint8Array[], valid: boolean];
 /**
  * checkProgram validates program for length and running cost
+ *
+ * @deprecated Validation relies on metadata (`langspec.json`) that
+ * does not accurately represent opcode behavior across program versions.
+ * The behavior of `checkProgram` relies on `langspec.json`.
+ * Thus, this method is being deprecated.
+ *
  * @param program - Program to check
  * @param args - Program arguments as array of Uint8Array arrays
  * @throws
  * @returns true if success
  */
 export declare function checkProgram(program: Uint8Array, args?: Uint8Array[]): boolean;
+/** @deprecated for langspec.json is deprecated aross all SDKs */
 export declare function checkIntConstBlock(program: Uint8Array, pc: number): number;
+/** @deprecated for langspec.json is deprecated aross all SDKs */
 export declare function checkByteConstBlock(program: Uint8Array, pc: number): number;
+/** @deprecated for langspec.json is deprecated aross all SDKs */
 export declare function checkPushIntOp(program: Uint8Array, pc: number): number;
+/** @deprecated for langspec.json is deprecated aross all SDKs */
 export declare function checkPushByteOp(program: Uint8Array, pc: number): number;
+/** @deprecated for langspec.json is deprecated aross all SDKs */
 export declare const langspecEvalMaxVersion: number;
+/** @deprecated for langspec.json is deprecated aross all SDKs */
 export declare const langspecLogicSigVersion: number;

package/dist/types/src/logicsig.d.ts

@@ -8,6 +8,12 @@ interface LogicSigStorageStructure {
     sig?: Uint8Array;
     msig?: EncodedMultisig;
 }
+/** sanityCheckProgram performs heuristic program validation:
+ * check if passed in bytes are Algorand address or is B64 encoded, rather than Teal bytes
+ *
+ * @param program - Program bytes to check
+ */
+export declare function sanityCheckProgram(program: Uint8Array): void;
 /**
  LogicSig implementation
  */

package/dist/types/src/main.d.ts

@@ -77,7 +77,7 @@ export { mnemonicToMasterDerivationKey, masterDerivationKeyToMnemonic, secretKey
 export { microalgosToAlgos, algosToMicroalgos, INVALID_MICROALGOS_ERROR_MSG, } from './convert';
 export { computeGroupID, assignGroupID } from './group';
 export { LogicSigAccount, makeLogicSig, signLogicSigTransaction, signLogicSigTransactionObject, logicSigFromByte, tealSign, tealSignFromProgram, } from './logicsig';
-export { signMultisigTransaction, mergeMultisigTransactions, appendSignMultisigTransaction, multisigAddress, } from './multisig';
+export { signMultisigTransaction, mergeMultisigTransactions, appendSignMultisigTransaction, createMultisigTransaction, appendSignRawMultisigSignature, verifyMultisig, multisigAddress, } from './multisig';
 export { SourceMap } from './logic/sourcemap';
 export declare const LogicTemplates: any;
 export * from './dryrun';

package/dist/types/src/multisig.d.ts

@@ -12,9 +12,19 @@ export declare const MULTISIG_MERGE_WRONG_PREIMAGE_ERROR_MSG = "Cannot merge txs
 export declare const MULTISIG_MERGE_SIG_MISMATCH_ERROR_MSG = "Cannot merge txs. subsigs are mismatched.";
 export declare const MULTISIG_NO_MUTATE_ERROR_MSG = "Cannot mutate a multisig field as it would invalidate all existing signatures.";
 export declare const MULTISIG_USE_PARTIAL_SIGN_ERROR_MSG = "Cannot sign a multisig transaction using `signTxn`. Use `partialSignTxn` instead.";
+export declare const MULTISIG_SIGNATURE_LENGTH_ERROR_MSG = "Cannot add multisig signature. Signature is not of the correct length.";
 interface MultisigMetadataWithPks extends Omit<MultisigMetadata, 'addrs'> {
     pks: Uint8Array[];
 }
+/**
+ * createRawMultisigTransaction creates a raw, unsigned multisig transaction blob.
+ * @param txn - the actual transaction.
+ * @param version - multisig version
+ * @param threshold - multisig threshold
+ * @param pks - ordered list of public keys in this multisig
+ * @returns encoded multisig blob
+ */
+export declare function createMultisigTransaction(txn: txnBuilder.Transaction, { version, threshold, addrs }: MultisigMetadata): Uint8Array;
 /**
  * MultisigTransaction is a Transaction that also supports creating partially-signed multisig transactions.
  */
@@ -41,6 +51,15 @@ export declare class MultisigTransaction extends txnBuilder.Transaction {
      * @returns an encoded, partially signed multisig transaction.
      */
     partialSignTxn({ version, threshold, pks }: MultisigMetadataWithPks, sk: Uint8Array): Uint8Array;
+    /**
+     * partialSignWithMultisigSignature partially signs this transaction with an external raw multisig signature and returns
+     * a partially-signed multisig transaction, encoded with msgpack as a typed array.
+     * @param metadata - multisig metadata
+     * @param signerAddr - address of the signer
+     * @param signature - raw multisig signature
+     * @returns an encoded, partially signed multisig transaction.
+     */
+    partialSignWithMultisigSignature(metadata: MultisigMetadataWithPks, signerAddr: string, signature: Uint8Array): Uint8Array;
     static from_obj_for_encoding(txnForEnc: EncodedTransaction): MultisigTransaction;
 }
 /**
@@ -53,7 +72,7 @@ export declare function verifyMultisig(toBeVerified: Uint8Array, msig: EncodedMu
 /**
  * signMultisigTransaction takes a raw transaction (see signTransaction), a multisig preimage, a secret key, and returns
  * a multisig transaction, which is a blob representing a transaction and multisignature account preimage. The returned
- * multisig txn can accumulate additional signatures through mergeMultisigTransactions or appendMultisigTransaction.
+ * multisig txn can accumulate additional signatures through mergeMultisigTransactions or appendSignMultisigTransaction.
  * @param txn - object with either payment or key registration fields
  * @param version - multisig version
  * @param threshold - multisig threshold
@@ -81,9 +100,24 @@ export declare function appendSignMultisigTransaction(multisigTxnBlob: Uint8Arra
     txID: string;
     blob: Uint8Array;
 };
+/**
+ * appendMultisigTransactionSignature takes a multisig transaction blob, and appends a given raw signature to it.
+ * This makes it possible to compile a multisig signature using only raw signatures from external methods.
+ * @param multisigTxnBlob - an encoded multisig txn. Supports non-payment txn types.
+ * @param version - multisig version
+ * @param threshold - multisig threshold
+ * @param addrs - a list of Algorand addresses representing possible signers for this multisig. Order is important.
+ * @param signerAddr - address of the signer
+ * @param signature - raw multisig signature
+ * @returns object containing txID, and blob representing encoded multisig txn
+ */
+export declare function appendSignRawMultisigSignature(multisigTxnBlob: Uint8Array, { version, threshold, addrs }: MultisigMetadata, signerAddr: string, signature: Uint8Array): {
+    txID: string;
+    blob: Uint8Array;
+};
 /**
  * multisigAddress takes multisig metadata (preimage) and returns the corresponding human readable Algorand address.
- * @param version - mutlisig version
+ * @param version - multisig version
  * @param threshold - multisig threshold
  * @param addrs - list of Algorand addresses
  */

package/dist/types/src/nacl/naclWrappers.d.ts

@@ -4,6 +4,7 @@ export declare function genericHash(arr: sha512.Message): number[];
 export declare function randomBytes(length: number): Uint8Array;
 export declare function keyPairFromSeed(seed: Uint8Array): nacl.SignKeyPair;
 export declare function keyPair(): nacl.SignKeyPair;
+export declare function isValidSignatureLength(len: number): boolean;
 export declare function keyPairFromSecretKey(sk: Uint8Array): nacl.SignKeyPair;
 export declare function sign(msg: Uint8Array, secretKey: Uint8Array): Uint8Array;
 export declare function bytesEqual(a: Uint8Array, b: Uint8Array): boolean;

package/dist/types/src/transaction.d.ts

@@ -58,6 +58,9 @@ interface TransactionStorageStructure extends Omit<TransactionParams, 'from' | '
     nonParticipation?: boolean;
     group?: Buffer;
     extraPages?: number;
+    stateProofType?: number | bigint;
+    stateProof?: Uint8Array;
+    stateProofMessage?: Uint8Array;
 }
 /**
  * Transaction enables construction of Algorand transactions
@@ -115,6 +118,9 @@ export declare class Transaction implements TransactionStorageStructure {
     nonParticipation?: boolean;
     group?: Buffer;
     extraPages?: number;
+    stateProofType?: number | bigint;
+    stateProof?: Uint8Array;
+    stateProofMessage?: Uint8Array;
     constructor({ ...transaction }: AnyTransaction);
     get_obj_for_encoding(): EncodedTransaction;
     static from_obj_for_encoding(txnForEnc: EncodedTransaction): Transaction;
@@ -123,6 +129,7 @@ export declare class Transaction implements TransactionStorageStructure {
     toByte(): Uint8Array;
     rawSignTxn(sk: Uint8Array): Buffer;
     signTxn(sk: Uint8Array): Uint8Array;
+    attachSignature(signerAddr: string, signature: Uint8Array): Uint8Array;
     rawTxID(): Buffer;
     txID(): string;
     addLease(lease: Uint8Array, feePerByte?: number): void;

package/dist/types/src/types/blockHeader.d.ts

@@ -53,7 +53,15 @@ export default interface BlockHeader {
      */
     ts: number;
     /**
-     * Transaction root
+     * Transaction root SHA512_256
      */
     txn: string;
+    /**
+     * Transaction root SHA256
+     */
+    txn256: string;
+    /**
+     * StateProofTracking map of type to tracking data
+     */
+    spt: Map<number, Uint8Array>;
 }

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

@@ -27,7 +27,11 @@ export declare enum TransactionType {
     /**
      * Application transaction
      */
-    appl = "appl"
+    appl = "appl",
+    /**
+     * State proof transaction
+     */
+    stpf = "stpf"
 }
 export declare function isTransactionType(s: string): s is TransactionType;
 /**
@@ -309,4 +313,16 @@ export interface TransactionParams {
      * Int representing extra pages of memory to rent during an application create transaction.
      */
     extraPages?: number;
+    /**
+     * Uint64 identifying a particular configuration of state proofs.
+     */
+    stateProofType?: number | bigint;
+    /**
+     * Byte array containing the state proof.
+     */
+    stateProof?: Uint8Array;
+    /**
+     * Byte array containing the state proof message.
+     */
+    stateProofMessage?: Uint8Array;
 }

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

@@ -240,6 +240,18 @@ export interface EncodedTransaction {
      * extraPages
      */
     apep?: number;
+    /**
+     * stateProofType
+     */
+    sptype?: number | bigint;
+    /**
+     * stateProof
+     */
+    sp?: Buffer;
+    /**
+     * stateProofMessage
+     */
+    spmsg?: Buffer;
 }
 export interface EncodedSubsig {
     /**

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

@@ -2,6 +2,7 @@ import PaymentTxn from './payment';
 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';
 export { TransactionParams, TransactionType, SuggestedParams } from './base';
 export { MustHaveSuggestedParams, MustHaveSuggestedParamsInline, } from './builder';
 export * from './encoded';
@@ -9,5 +10,6 @@ export { default as PaymentTxn } from './payment';
 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';
-declare type AnyTransaction = PaymentTxn | KeyRegistrationTxn | AssetCreateTxn | AssetConfigTxn | AssetDestroyTxn | AssetFreezeTxn | AssetTransferTxn | AppCreateTxn | AppUpdateTxn | AppDeleteTxn | AppOptInTxn | AppCloseOutTxn | AppClearStateTxn | AppNoOpTxn;
+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 AnyTransaction;

package/dist/types/src/types/transactions/stateproof.d.ts

@@ -0,0 +1,8 @@
+import { TransactionType, TransactionParams } from './base';
+import { ConstructTransaction } from './builder';
+declare type SpecificParameters = Pick<TransactionParams, 'stateProofType' | 'stateProof' | 'stateProofMessage'>;
+interface Overwrites {
+    type?: TransactionType.stpf;
+}
+declare type StateProofTransaction = ConstructTransaction<SpecificParameters, Overwrites>;
+export default StateProofTransaction;

package/package.json

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

package/dist/cjs/src/client/v2/algod/proof.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"proof.js","sourceRoot":"","sources":["../../../../../../src/client/v2/algod/proof.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAIzC,MAAqB,KAAM,SAAQ,qBAAW;IAC5C,YACE,CAAa,EACb,WAAwB,EAChB,KAAa,EACb,IAAY;QAEpB,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAHd,UAAK,GAAL,KAAK,CAAQ;QACb,SAAI,GAAJ,IAAI,CAAQ;QAIpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,iBAAiB,IAAI,CAAC,IAAI,QAAQ,CAAC;IACpE,CAAC;CACF;AAhBD,wBAgBC"}

package/dist/esm/src/client/v2/algod/proof.js

@@ -1,14 +0,0 @@
-import JSONRequest from '../jsonrequest';
-export default class Proof extends JSONRequest {
-    constructor(c, intDecoding, round, txID) {
-        super(c, intDecoding);
-        this.round = round;
-        this.txID = txID;
-        this.round = round;
-        this.txID = txID;
-    }
-    path() {
-        return `/v2/blocks/${this.round}/transactions/${this.txID}/proof`;
-    }
-}
-//# sourceMappingURL=proof.js.map

package/dist/esm/src/client/v2/algod/proof.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"proof.js","sourceRoot":"","sources":["../../../../../../src/client/v2/algod/proof.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAIzC,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,WAAW;IAC5C,YACE,CAAa,EACb,WAAwB,EAChB,KAAa,EACb,IAAY;QAEpB,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QAHd,UAAK,GAAL,KAAK,CAAQ;QACb,SAAI,GAAJ,IAAI,CAAQ;QAIpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI;QACF,OAAO,cAAc,IAAI,CAAC,KAAK,iBAAiB,IAAI,CAAC,IAAI,QAAQ,CAAC;IACpE,CAAC;CACF"}