algosdk 2.8.0 → 3.0.0-beta.1

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

@@ -1,269 +1,4 @@
-/// <reference types="node" />
-/**
- * Interfaces for the encoded transaction object. Every property is labelled with its associated Transaction type property
- */
-export interface EncodedAssetParams {
-    /**
-     * assetTotal
-     */
-    t: number | bigint;
-    /**
-     * assetDefaultFrozen
-     */
-    df: boolean;
-    /**
-     * assetDecimals
-     */
-    dc: number;
-    /**
-     * assetManager
-     */
-    m?: Buffer;
-    /**
-     * assetReserve
-     */
-    r?: Buffer;
-    /**
-     * assetFreeze
-     */
-    f?: Buffer;
-    /**
-     * assetClawback
-     */
-    c?: Buffer;
-    /**
-     * assetName
-     */
-    an?: string;
-    /**
-     * assetUnitName
-     */
-    un?: string;
-    /**
-     * assetURL
-     */
-    au?: string;
-    /**
-     * assetMetadataHash
-     */
-    am?: Buffer;
-}
-export interface EncodedLocalStateSchema {
-    /**
-     * appLocalInts
-     */
-    nui: number;
-    /**
-     * appLocalByteSlices
-     */
-    nbs: number;
-}
-export interface EncodedGlobalStateSchema {
-    /**
-     * appGlobalInts
-     */
-    nui: number;
-    /**
-     * appGlobalByteSlices
-     */
-    nbs: number;
-}
-export interface EncodedBoxReference {
-    /**
-     * index of the app ID in the foreign apps array
-     */
-    i: number;
-    /**
-     * box name
-     */
-    n: Uint8Array;
-}
-/**
- * A rough structure for the encoded transaction object. Every property is labelled with its associated Transaction type property
- */
-export interface EncodedTransaction {
-    /**
-     * fee
-     */
-    fee?: number;
-    /**
-     * firstRound
-     */
-    fv?: number;
-    /**
-     * lastRound
-     */
-    lv: number;
-    /**
-     * note
-     */
-    note?: Buffer;
-    /**
-     * from
-     */
-    snd: Buffer;
-    /**
-     * type
-     */
-    type: string;
-    /**
-     * genesisID
-     */
-    gen: string;
-    /**
-     * genesisHash
-     */
-    gh: Buffer;
-    /**
-     * lease
-     */
-    lx?: Buffer;
-    /**
-     * group
-     */
-    grp?: Buffer;
-    /**
-     * amount
-     */
-    amt?: number | bigint;
-    /**
-     * amount (but for asset transfers)
-     */
-    aamt?: number | bigint;
-    /**
-     * closeRemainderTo
-     */
-    close?: Buffer;
-    /**
-     * closeRemainderTo (but for asset transfers)
-     */
-    aclose?: Buffer;
-    /**
-     * reKeyTo
-     */
-    rekey?: Buffer;
-    /**
-     * to
-     */
-    rcv?: Buffer;
-    /**
-     * to (but for asset transfers)
-     */
-    arcv?: Buffer;
-    /**
-     * voteKey
-     */
-    votekey?: Buffer;
-    /**
-     * selectionKey
-     */
-    selkey?: Buffer;
-    /**
-     * stateProofKey
-     */
-    sprfkey?: Buffer;
-    /**
-     * voteFirst
-     */
-    votefst?: number;
-    /**
-     * voteLast
-     */
-    votelst?: number;
-    /**
-     * voteKeyDilution
-     */
-    votekd?: number;
-    /**
-     * nonParticipation
-     */
-    nonpart?: boolean;
-    /**
-     * assetIndex
-     */
-    caid?: number;
-    /**
-     * assetIndex (but for asset transfers)
-     */
-    xaid?: number;
-    /**
-     * assetIndex (but for asset freezing/unfreezing)
-     */
-    faid?: number;
-    /**
-     * freezeState
-     */
-    afrz?: boolean;
-    /**
-     * freezeAccount
-     */
-    fadd?: Buffer;
-    /**
-     * assetRevocationTarget
-     */
-    asnd?: Buffer;
-    /**
-     * See EncodedAssetParams type
-     */
-    apar?: EncodedAssetParams;
-    /**
-     * appIndex
-     */
-    apid?: number;
-    /**
-     * appOnComplete
-     */
-    apan?: number;
-    /**
-     * See EncodedLocalStateSchema type
-     */
-    apls?: EncodedLocalStateSchema;
-    /**
-     * See EncodedGlobalStateSchema type
-     */
-    apgs?: EncodedGlobalStateSchema;
-    /**
-     * appForeignApps
-     */
-    apfa?: number[];
-    /**
-     * appForeignAssets
-     */
-    apas?: number[];
-    /**
-     * appApprovalProgram
-     */
-    apap?: Buffer;
-    /**
-     * appClearProgram
-     */
-    apsu?: Buffer;
-    /**
-     * appArgs
-     */
-    apaa?: Buffer[];
-    /**
-     * appAccounts
-     */
-    apat?: Buffer[];
-    /**
-     * extraPages
-     */
-    apep?: number;
-    /**
-     * boxes
-     */
-    apbx?: EncodedBoxReference[];
-    sptype?: number | bigint;
-    /**
-     * stateProof
-     */
-    sp?: Buffer;
-    /**
-     * stateProofMessage
-     */
-    spmsg?: Buffer;
-}
+import { NamedMapSchema } from '../../encoding/schema/index.js';
 export interface EncodedSubsig {
     /**
      *  The public key
@@ -274,6 +9,9 @@ export interface EncodedSubsig {
      */
     s?: Uint8Array;
 }
+export declare const ENCODED_SUBSIG_SCHEMA: NamedMapSchema;
+export declare function encodedSubsigFromEncodingData(data: unknown): EncodedSubsig;
+export declare function encodedSubsigToEncodingData(subsig: EncodedSubsig): Map<string, unknown>;
 /**
  * A rough structure for the encoded multi signature transaction object.
  * Every property is labelled with its associated `MultisigMetadata` type property
@@ -292,38 +30,6 @@ export interface EncodedMultisig {
      */
     subsig: EncodedSubsig[];
 }
-export interface EncodedLogicSig {
-    l: Uint8Array;
-    arg?: Uint8Array[];
-    sig?: Uint8Array;
-    msig?: EncodedMultisig;
-}
-export interface EncodedLogicSigAccount {
-    lsig: EncodedLogicSig;
-    sigkey?: Uint8Array;
-}
-/**
- * A structure for an encoded signed transaction object
- */
-export interface EncodedSignedTransaction {
-    /**
-     * Transaction signature
-     */
-    sig?: Buffer;
-    /**
-     * The transaction that was signed
-     */
-    txn: EncodedTransaction;
-    /**
-     * Multisig structure
-     */
-    msig?: EncodedMultisig;
-    /**
-     * Logic signature
-     */
-    lsig?: EncodedLogicSig;
-    /**
-     * The signer, if signing with a different key than the Transaction type `from` property indicates
-     */
-    sgnr?: Buffer;
-}
+export declare const ENCODED_MULTISIG_SCHEMA: NamedMapSchema;
+export declare function encodedMultiSigFromEncodingData(data: unknown): EncodedMultisig;
+export declare function encodedMultiSigToEncodingData(msig: EncodedMultisig): Map<string, unknown>;

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

@@ -1,15 +1,2 @@
-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, BoxReference, } from './base';
-export { MustHaveSuggestedParams, MustHaveSuggestedParamsInline, } from './builder';
-export * from './encoded';
-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';
-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;
+export * from './base.js';
+export * from './encoded.js';

package/dist/types/types/utils.d.ts

@@ -2,25 +2,25 @@
  * Expands types for IntelliSense so they are more human readable
  * See https://stackoverflow.com/a/69288824
  */
-export declare type Expand<T> = T extends (...args: infer A) => infer R ? (...args: Expand<A>) => Expand<R> : T extends infer O ? {
+export type Expand<T> = T extends (...args: infer A) => infer R ? (...args: Expand<A>) => Expand<R> : T extends infer O ? {
     [K in keyof O]: O[K];
 } : never;
 /**
  * Same as TypeScript's Pick, but will distribute the Pick over unions
  */
-export declare type DistributivePick<T, K extends keyof T> = T extends unknown ? Pick<T, K> : never;
+export type DistributivePick<T, K extends keyof T> = T extends unknown ? Pick<T, K> : never;
 /**
  * Overwrite a type with properties from another type
  */
-export declare type Overwrite<T, U extends Partial<T>> = Pick<T, Exclude<keyof T, keyof U>> & U;
+export type Overwrite<T, U extends Partial<T>> = Pick<T, Exclude<keyof T, keyof U>> & U;
 /**
  * Same as Overwrite, but will distribute the Overwrite over unions
  */
-export declare type DistributiveOverwrite<T, K extends Partial<T>> = T extends unknown ? Overwrite<T, K> : never;
+export type DistributiveOverwrite<T, K extends Partial<T>> = T extends unknown ? Overwrite<T, K> : never;
 /**
  * Mark certain keys as prohibited
  */
-export declare type NeverAllow<T, K extends keyof T> = {
+export type NeverAllow<T, K extends keyof T> = {
     [P in K]?: never;
 };
 /**
@@ -29,7 +29,7 @@ export declare type NeverAllow<T, K extends keyof T> = {
  * Usage: RenameProperty\<\{ a: string \}, 'a', 'b'\>
  * -\> \{ b: string \}
  */
-export declare type RenameProperty<T, K extends keyof T, R extends PropertyKey> = {
+export type RenameProperty<T, K extends keyof T, R extends PropertyKey> = {
     [P in keyof T as P extends K ? R : P]: T[P];
 };
 /**
@@ -38,7 +38,7 @@ export declare type RenameProperty<T, K extends keyof T, R extends PropertyKey>
  * Usage: RenameProperties\<\{ a: string, b: number \}, \{ a: 'c', b: 'd' \}\>
  * -\> \{ c: string, d: number \}
  */
-export declare type RenameProperties<T, R extends {
+export type RenameProperties<T, R extends {
     [K in keyof R]: K extends keyof T ? PropertyKey : 'Error: key not in T';
 }> = {
     [P in keyof T as P extends keyof R ? R[P] : P]: T[P];

package/dist/types/utils/utils.d.ts

@@ -1,29 +1,30 @@
-import IntDecoding from '../types/intDecoding';
-export interface JSONOptions {
-    intDecoding?: IntDecoding;
+import IntDecoding from '../types/intDecoding.js';
+export interface ParseJSONOptions {
+    intDecoding: IntDecoding;
 }
 /**
  * Parse JSON with additional options.
  * @param str - The JSON string to parse.
- * @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:
+ * @param options - Configures how integers in this JSON string will be decoded. See the
+ *   `IntDecoding` enum for more details.
+ */
+export declare function parseJSON(str: string, { intDecoding }: ParseJSONOptions): any;
+/**
+ * Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
+ *
+ * This functions differs from the built-in JSON.stringify in that it supports serializing BigInts.
  *
- *   * "default": All integers will be decoded as Numbers, meaning any values greater than
- *     Number.MAX_SAFE_INTEGER will lose precision.
- *   * "safe": All integers will be decoded as Numbers, but if any values are greater than
- *     Number.MAX_SAFE_INTEGER an error will be thrown.
- *   * "mixed": Integers will be decoded as Numbers if they are less than or equal to
- *     Number.MAX_SAFE_INTEGER, otherwise they will be decoded as BigInts.
- *   * "bigint": All integers will be decoded as BigInts.
+ * This function takes the same arguments as the built-in JSON.stringify function.
  *
- *   Defaults to "default" if not included.
+ * @param value - A JavaScript value, usually an object or array, to be converted.
+ * @param replacer - A function that transforms the results.
+ * @param space - Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
  */
-export declare function parseJSON(str: string, options?: JSONOptions): any;
+export declare function stringifyJSON(value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
 /**
  * ArrayEqual takes two arrays and return true if equal, false otherwise
  */
-export declare function arrayEqual(a: ArrayLike<any>, b: ArrayLike<any>): boolean;
+export declare function arrayEqual<T>(a: ArrayLike<T>, b: ArrayLike<T>): boolean;
 /**
  * ConcatArrays takes n number arrays and returns a joint Uint8Array
  * @param arrs - An arbitrary number of n array-like number list arguments
@@ -50,3 +51,7 @@ export declare function isNode(): boolean;
  * @returns True if ReactNative, false otherwise
  */
 export declare function isReactNative(): boolean;
+export declare function ensureSafeInteger(value: unknown): number;
+export declare function ensureSafeUnsignedInteger(value: unknown): number;
+export declare function ensureBigInt(value: unknown): bigint;
+export declare function ensureUint64(value: unknown): bigint;

package/dist/types/wait.d.ts

@@ -1,4 +1,5 @@
-import Algodv2 from './client/v2/algod/algod';
+import { AlgodClient } from './client/v2/algod/algod.js';
+import { PendingTransactionResponse } from './client/v2/algod/models/types.js';
 /**
  * Wait until a transaction has been confirmed or rejected by the network, or
  * until 'waitRounds' number of rounds have passed.
@@ -8,4 +9,4 @@ import Algodv2 from './client/v2/algod/algod';
  * @returns A promise that, upon success, will resolve to the output of the
  *   `pendingTransactionInformation` call for the confirmed transaction.
  */
-export declare function waitForConfirmation(client: Algodv2, txid: string, waitRounds: number): Promise<Record<string, any>>;
+export declare function waitForConfirmation(client: AlgodClient, txid: string, waitRounds: number): Promise<PendingTransactionResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "algosdk",
-  "version": "2.8.0",
+  "version": "3.0.0-beta.1",
   "description": "The official JavaScript SDK for Algorand",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -8,6 +8,33 @@
     ".": "dist/browser/algosdk.min.js",
     "crypto": false
   },
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./client": {
+      "import": "./dist/esm/client/index.js",
+      "require": "./dist/cjs/client/index.js",
+      "types": "./dist/types/client/index.d.ts"
+    },
+    "./client/algod": {
+      "import": "./dist/esm/client/v2/algod/index.js",
+      "require": "./dist/cjs/client/v2/algod/index.js",
+      "types": "./dist/types/client/v2/algod/index.d.ts"
+    },
+    "./client/indexer": {
+      "import": "./dist/esm/client/v2/indexer/index.js",
+      "require": "./dist/cjs/client/v2/indexer/index.js",
+      "types": "./dist/types/client/v2/indexer/index.d.ts"
+    },
+    "./client/kmd": {
+      "import": "./dist/esm/client/kmd.js",
+      "require": "./dist/cjs/client/kmd.js",
+      "types": "./dist/types/client/kmd.d.ts"
+    }
+  },
   "types": "dist/types/index.d.ts",
   "files": [
     "dist/",
@@ -21,8 +48,7 @@
     "url": "git://github.com/algorand/js-algorand-sdk.git"
   },
   "dependencies": {
-    "algo-msgpack-with-bigint": "^2.1.1",
-    "buffer": "^6.0.3",
+    "algorand-msgpack": "^1.1.0",
     "hi-base32": "^0.5.1",
     "js-sha256": "^0.9.0",
     "js-sha3": "^0.8.0",
@@ -34,38 +60,40 @@
   "devDependencies": {
     "@types/json-bigint": "^1.0.0",
     "@types/mocha": "^8.2.2",
-    "@typescript-eslint/eslint-plugin": "^4.26.1",
-    "@typescript-eslint/parser": "^4.26.1",
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
     "assert": "^2.0.0",
-    "chromedriver": "^122.0.3",
+    "chromedriver": "^126.0.3",
     "concurrently": "^6.2.0",
     "cucumber": "^5.1.0",
     "es-abstract": "^1.18.3",
-    "eslint": "^7.21.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.22.1",
+    "eslint": "8.22.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-tsdoc": "^0.2.11",
-    "express": "^4.17.1",
-    "geckodriver": "^3.0.1",
+    "express": "^4.19.2",
+    "geckodriver": "^4.3.0",
     "husky": "^4.3.8",
     "lint-staged": "^10.5.4",
     "mocha": "^9.0.0",
     "mock-http-server": "^1.4.3",
-    "prettier": "2.2.1",
+    "prettier": "^3.2.1",
     "selenium-webdriver": "^4.10.0",
     "source-map-loader": "^2.0.2",
     "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.75.0",
+    "tsx": "^4.7.0",
+    "typedoc": "^0.25.7",
+    "typedoc-plugin-missing-exports": "^2.1.0",
+    "typedoc-plugin-rename-defaults": "^0.7.0",
+    "typescript": "^5.3.3",
+    "webpack": "^5.89.0",
     "webpack-cli": "^5.0.1"
   },
   "scripts": {
-    "test": "node -r ts-node/register tests/mocha.js",
+    "test": "tsx tests/mocha.js",
     "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\"",