algosdk 1.18.0 → 1.19.1

package/dist/types/src/logicTemplates/htlc.d.ts

@@ -22,7 +22,7 @@ export class HTLC {
      * @param {int} maxFee: the maximum fee that can be paid to the network by the account
      * @returns {HTLC}
      */
-    constructor(owner: string, receiver: string, hashFunction: string, hashImage: string, expiryRound: any, maxFee: any);
+    constructor(owner: string, receiver: string, hashFunction: string, hashImage: string, expiryRound: int, maxFee: int);
     programBytes: any;
     address: string;
     /**

package/dist/types/src/logicTemplates/limitorder.d.ts

@@ -32,11 +32,11 @@ export class LimitOrder {
      * @param {int} maxFee: maximum fee used by the limit order transaction
      * @returns {LimitOrder}
      */
-    constructor(owner: string, assetid: any, ratn: any, ratd: any, expiryRound: any, minTrade: any, maxFee: any);
+    constructor(owner: string, assetid: int, ratn: int, ratd: int, expiryRound: int, minTrade: int, maxFee: int);
     programBytes: any;
     address: string;
     owner: string;
-    assetid: any;
+    assetid: int;
     /**
      * returns the program bytes
      * @returns {Uint8Array}
@@ -67,4 +67,4 @@ export class LimitOrder {
  * these transactions will be rejected if they do not meet the restrictions set by the contract
  * @throws error if arguments fail contract validation
  */
-export function getSwapAssetsTransaction(contract: Uint8Array, assetAmount: any, microAlgoAmount: any, secretKey: Uint8Array, fee: any, firstRound: any, lastRound: any, genesisHash: string): Uint8Array;
+export function getSwapAssetsTransaction(contract: Uint8Array, assetAmount: int, microAlgoAmount: int, secretKey: Uint8Array, fee: int, firstRound: int, lastRound: int, genesisHash: string): Uint8Array;

package/dist/types/src/logicTemplates/periodicpayment.d.ts

@@ -22,13 +22,13 @@ export class PeriodicPayment {
      * @param {string} lease: b64 representation of lease to use, or leave undefined to generate one
      * @returns {PeriodicPayment}
      */
-    constructor(receiver: string, amount: any, withdrawalWindow: any, period: any, expiryRound: any, maxFee: any, lease: string);
+    constructor(receiver: string, amount: int, withdrawalWindow: int, period: int, expiryRound: int, maxFee: int, lease: string);
     receiver: string;
-    amount: any;
-    withdrawalWindow: any;
-    period: any;
-    expiryRound: any;
-    maxFee: any;
+    amount: int;
+    withdrawalWindow: int;
+    period: int;
+    expiryRound: int;
+    maxFee: int;
     lease: string;
     programBytes: Uint8Array;
     address: string;
@@ -55,4 +55,4 @@ export class PeriodicPayment {
  * @returns {Object} Object containing txID and blob representing signed transaction
  * @throws error on failure
  */
-export function getPeriodicPaymentWithdrawalTransaction(contract: Uint8Array, fee: any, firstValid: any, genesisHash: string): any;
+export function getPeriodicPaymentWithdrawalTransaction(contract: Uint8Array, fee: int, firstValid: int, genesisHash: string): any;

package/dist/types/src/logicTemplates/split.d.ts

@@ -27,7 +27,7 @@ export class Split {
      * @param {int} maxFee: half of the maximum fee used by each split forwarding group transaction
      * @returns {Split}
      */
-    constructor(owner: string, receiverOne: string, receiverTwo: string, rat1: any, rat2: any, expiryRound: any, minPay: any, maxFee: any);
+    constructor(owner: string, receiverOne: string, receiverTwo: string, rat1: int, rat2: int, expiryRound: int, minPay: int, maxFee: int);
     programBytes: any;
     address: string;
     /**
@@ -54,4 +54,4 @@ export class Split {
  * @param {string} genesisHash: the b64-encoded genesis hash indicating the network for this transaction
  * @returns {Uint8Array}
  */
-export function getSplitFundsTransaction(contract: Uint8Array, amount: any, firstRound: any, lastRound: any, fee: any, genesisHash: string): Uint8Array;
+export function getSplitFundsTransaction(contract: Uint8Array, amount: int, firstRound: int, lastRound: int, fee: int, genesisHash: string): Uint8Array;

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

@@ -169,12 +169,12 @@ export declare function signLogicSigTransaction(txn: txnBuilder.TransactionLike,
  */
 export declare function logicSigFromByte(encoded: Uint8Array): LogicSig;
 /**
- * tealSign creates a signature compatible with ed25519verify opcode from contract address
+ * tealSign creates a signature compatible with ed25519verify opcode from program hash
  * @param sk - uint8array with secret key
  * @param data - buffer with data to sign
- * @param contractAddress - string representation of teal contract address (program hash)
+ * @param programHash - string representation of teal program hash (= contract address for LogicSigs)
  */
-export declare function tealSign(sk: Uint8Array, data: Uint8Array | Buffer, contractAddress: string): Uint8Array;
+export declare function tealSign(sk: Uint8Array, data: Uint8Array | Buffer, programHash: string): Uint8Array;
 /**
  * tealSignFromProgram creates a signature compatible with ed25519verify opcode from raw program bytes
  * @param sk - uint8array with secret key

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

@@ -77,7 +77,8 @@ 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';
 export * from './makeTxn';

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

@@ -123,6 +123,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/utils/utils.d.ts

@@ -5,7 +5,6 @@ export interface JSONOptions {
 /**
  * Parse JSON with additional options.
  * @param str - The JSON string to parse.
- * @param options - Parsing options.
  * @param options - Options object to configure how integers in
  *   this request's JSON response will be decoded. Use the `intDecoding`
  *   property with one of the following options:
@@ -39,6 +38,7 @@ export declare function concatArrays(...arrs: ArrayLike<number>[]): Uint8Array;
 export declare function removeUndefinedProperties(obj: Record<string | number | symbol, any>): {
     [x: string]: any;
     [x: number]: any;
+    [x: symbol]: any;
 };
 /**
  * Check whether the environment is Node.js (as opposed to the browser)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "1.18.0",
+  "version": "1.19.1",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -26,7 +26,10 @@
     "json-bigint": "^1.0.0",
     "superagent": "^6.1.0",
     "tweetnacl": "^1.0.3",
-    "url-parse": "^1.5.1"
+    "vlq": "^2.0.4"
+  },
+  "optionalDependencies": {
+    "fsevents": "2.1.2"
   },
   "devDependencies": {
     "@types/json-bigint": "^1.0.0",
@@ -53,16 +56,15 @@
     "mocha": "^9.0.0",
     "mocha-lcov-reporter": "^1.3.0",
     "mock-http-server": "^1.4.3",
-    "path-browserify": "^1.0.1",
     "prettier": "2.2.1",
     "selenium-webdriver": "^4.2.0",
     "source-map-loader": "^2.0.2",
-    "ts-loader": "^8.3.0",
-    "ts-node": "^10.0.0",
-    "typedoc": "^0.22.13",
-    "typedoc-plugin-missing-exports": "^0.22.6",
-    "typedoc-plugin-rename-defaults": "^0.4.0",
-    "typescript": "^4.2.3",
+    "ts-loader": "^9.3.1",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.23.8",
+    "typedoc-plugin-missing-exports": "^0.23.0",
+    "typedoc-plugin-rename-defaults": "^0.6.4",
+    "typescript": "^4.7.4",
     "webpack": "^5.38.1",
     "webpack-cli": "^4.7.2"
   },
@@ -71,8 +73,8 @@
     "prepare": "npm run build",
     "prepare-browser-tests": "npm run build && mkdir -p tests/cucumber/browser/build && cp dist/browser/algosdk.min.* tests/cucumber/browser/build/ && webpack --config tests/cucumber/browser/webpack.config.js",
     "build": "concurrently \"webpack --config webpack.config.js\" \"tsc -p tsconfig-esm.json\" \"tsc -p tsconfig-cjs.json\"",
-    "docs": "typedoc src/main.ts --options typedoc.config.json",
-    "docs:dev": "typedoc src/main.ts --options typedoc.config.json --watch --preserveWatchOutput",
+    "docs": "typedoc --options typedoc.config.json",
+    "docs:dev": "typedoc --options typedoc.config.json --watch --preserveWatchOutput",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "format": "prettier --write .",