@aeternity/aepp-sdk 12.1.3 → 13.0.0-alpha.1

package/package.json

@@ -1,31 +1,54 @@
 {
   "name": "@aeternity/aepp-sdk",
-  "version": "12.1.3",
+  "version": "13.0.0-alpha.1",
   "description": "SDK for the æternity blockchain",
   "main": "dist/aepp-sdk.js",
   "types": "es/index.d.ts",
+  "typesVersions": {
+    "<4.5": {
+      "es/index.d.ts": [
+        "./types-legacy/ts4.2/index.d.ts"
+      ]
+    },
+    "<4.7": {
+      "es/index.d.ts": [
+        "./types-legacy/ts4.5/index.d.ts"
+      ]
+    }
+  },
   "module": "es/index.mjs",
   "browser": {
+    "es/index.mjs": "./es/index-browser.mjs",
     "dist/aepp-sdk.js": "./dist/aepp-sdk.browser.js"
   },
+  "exports": {
+    "node": {
+      "import": "./es/index.mjs",
+      "default": "./dist/aepp-sdk.js"
+    },
+    "import": "./es/index-browser.mjs",
+    "default": "./dist/aepp-sdk.browser.js"
+  },
   "sideEffects": false,
   "scripts": {
-    "build:es": "tsc && babel src --config-file ./babel.esm.config.js --out-dir es --extensions .js,.ts --out-file-extension .mjs --source-maps true",
-    "build:api": "npx autorest tooling/autorest/compiler.yaml --output-artifact:code-model-v4 && npx autorest tooling/autorest/node.yaml --output-artifact:code-model-v4",
-    "build": "npm run build:api && webpack --mode=production && npm run build:es",
-    "build:dev": "webpack --mode=development && npm run build:es",
-    "docs:examples": "node tooling/docs/examples-to-md.js examples/node/*.js",
+    "build:assets": "node tooling/fetch-aesophia-cli.mjs",
+    "build:types": "tsc && node tooling/downlevel/run.mjs",
+    "build:es": "babel src --config-file ./babel.esm.config.js --out-dir es --extensions .js,.ts --out-file-extension .mjs --source-maps true",
+    "build:api": "node tooling/autorest/compiler-prepare.mjs && autorest tooling/autorest/compiler.yaml --output-artifact:code-model-v4 && autorest tooling/autorest/node.yaml --output-artifact:code-model-v4",
+    "build": "npm run build:api && webpack && npm run build:types && npm run build:es && npm run build:assets",
+    "docs:examples": "node tooling/docs/examples-to-md.js examples/node/*.mjs",
     "docs:api": "typedoc",
     "commitlint": "commitlint --from develop",
-    "lint": "eslint . --ext .ts,.js,.mjs",
-    "report-coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
-    "test": "nyc mocha './test/unit/' './test/integration/'",
-    "test:integration": "nyc mocha './test/integration/'",
-    "test:unit": "nyc mocha './test/unit/'",
+    "lint": "npm run lint:types && eslint . --ext .ts,.js,.mjs",
+    "lint:types": "tsc -p tsconfig.tests.json",
+    "test": "mocha './test/unit/' './test/integration/'",
+    "test:integration": "mocha './test/integration/'",
+    "test:unit": "mocha './test/unit/'",
     "test:watch": "mocha './test/unit/' './test/integration/' --watch",
     "prepare": "npm run build",
     "prepublishOnly": "test/examples.sh && npm run docs:examples && npm run docs:api",
-    "release": "standard-version --skip.tag --infile docs/CHANGELOG.md"
+    "release": "standard-version --skip.tag --infile docs/CHANGELOG.md",
+    "release-alpha": "npm run release -- --prerelease alpha"
   },
   "license": "ISC",
   "keywords": [
@@ -36,20 +59,20 @@
   ],
   "dependencies": {
     "@aeternity/aepp-calldata": "^1.3.0",
-    "@aeternity/argon2-browser": "^0.1.2",
+    "@aeternity/argon2": "^0.0.1",
     "@aeternity/uuid": "^0.0.1",
     "@azure/core-client": "1.6.0",
-    "@azure/core-rest-pipeline": "^1.9.0",
-    "@babel/runtime-corejs3": "^7.18.9",
+    "@azure/core-rest-pipeline": "^1.10.0",
+    "@babel/runtime-corejs3": "^7.20.7",
+    "@ledgerhq/hw-transport": "^6.27.9",
     "@types/aes-js": "^3.1.1",
-    "@types/argon2-browser": "^1.18.1",
     "@types/json-bigint": "^1.0.1",
     "@types/sha.js": "^2.4.0",
-    "@types/uuid": "^8.3.4",
-    "@types/webextension-polyfill": "^0.9.0",
+    "@types/uuid": "^9.0.0",
+    "@types/webextension-polyfill": "^0.9.2",
     "@types/websocket": "^1.0.5",
     "aes-js": "^3.1.2",
-    "bignumber.js": "^9.0.2",
+    "bignumber.js": "^9.1.1",
     "bip32-path": "^0.4.2",
     "blakejs": "^1.2.1",
     "bs58": "^5.0.0",
@@ -69,55 +92,79 @@
     "url": "https://github.com/aeternity/aepp-sdk-js"
   },
   "devDependencies": {
-    "@babel/cli": "^7.18.9",
-    "@babel/core": "^7.18.9",
-    "@babel/node": "^7.18.9",
-    "@babel/plugin-transform-runtime": "^7.18.9",
-    "@babel/preset-env": "^7.18.9",
+    "@babel/cli": "^7.20.7",
+    "@babel/core": "^7.20.7",
+    "@babel/node": "^7.20.7",
+    "@babel/plugin-transform-runtime": "^7.19.6",
+    "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.18.6",
     "@babel/register": "^7.18.9",
-    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^17.0.3",
-    "@types/chai": "^4.3.1",
+    "@commitlint/cli": "^17.3.0",
+    "@commitlint/config-conventional": "^17.3.0",
+    "@ledgerhq/hw-transport-mocker": "^6.27.9",
+    "@ledgerhq/hw-transport-node-hid-singleton": "^6.28.6",
+    "@ledgerhq/hw-transport-webusb": "^6.27.9",
+    "@types/chai": "^4.3.4",
     "@types/chai-as-promised": "^7.1.5",
-    "@types/mocha": "^9.1.1",
+    "@types/mocha": "^10.0.1",
+    "@types/node-hid": "^1.3.1",
     "@types/sinon": "^10.0.13",
-    "@typescript-eslint/eslint-plugin": "^5.31.0",
-    "@typescript-eslint/parser": "^5.31.0",
-    "babel-loader": "^8.2.5",
+    "@typescript-eslint/eslint-plugin": "^5.47.1",
+    "@typescript-eslint/parser": "^5.47.1",
+    "autorest": "^3.6.2",
+    "babel-loader": "^9.1.0",
     "babel-plugin-add-import-extension": "^1.6.0",
     "babel-plugin-import-globals": "^2.0.0",
     "babel-plugin-transform-default-named-imports": "^1.2.2",
-    "chai": "^4.3.6",
+    "babel-plugin-transform-import-meta": "^2.2.0",
+    "chai": "^4.3.7",
     "chai-as-promised": "^7.1.1",
-    "codecov": "^3.8.3",
-    "eslint": "^8.20.0",
+    "cross-fetch": "^3.1.5",
+    "downlevel-dts": "github:aeternity/downlevel-dts",
+    "eslint": "^8.30.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-plugin-rulesdir": "^0.2.1",
-    "eslint-plugin-tsdoc": "^0.2.16",
-    "mocha": "^10.0.0",
+    "eslint-plugin-rulesdir": "^0.2.2",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "html-webpack-plugin": "^5.5.0",
+    "mocha": "^10.2.0",
     "nyc": "^15.1.0",
-    "sinon": "^14.0.0",
+    "sinon": "^15.0.1",
     "source-map": "^0.7.4",
     "standard-version": "^9.5.0",
-    "ts-node": "^10.9.1",
-    "typedoc": "^0.23.9",
-    "typedoc-plugin-missing-exports": "^0.23.0",
-    "typescript": "^4.7.4",
-    "webpack": "^5.74.0",
-    "webpack-bundle-analyzer": "^4.5.0",
-    "webpack-cli": "^4.10.0"
+    "typedoc": "^0.23.23",
+    "typedoc-plugin-missing-exports": "^1.0.0",
+    "typescript": "^4.9.4",
+    "webpack": "^5.75.0",
+    "webpack-bundle-analyzer": "^4.7.0",
+    "webpack-cli": "^5.0.1"
   },
   "files": [
     "dist",
+    "bin",
+    "types-legacy",
     "src",
     "es"
   ],
-  "browserslist": [
-    "> 1%",
-    "last 2 versions",
-    "not dead",
-    "not ie 11"
-  ]
+  "browserslist": {
+    "node": [
+      "node >= 14.19"
+    ],
+    "browser": [
+      "> 1%",
+      "last 2 versions",
+      "not dead",
+      "not ie 11"
+    ],
+    "production": [
+      "node >= 14.19",
+      "> 1%",
+      "last 2 versions",
+      "not dead",
+      "not ie 11"
+    ]
+  },
+  "engines": {
+    "node": ">=14.19.0"
+  }
 }

package/src/AeSdk.ts

@@ -1,4 +1,5 @@
-import AeSdkBase, { Account } from './AeSdkBase';
+import AeSdkBase from './AeSdkBase';
+import { OnAccount } from './AeSdkMethods';
 import AccountBase from './account/Base';
 import { decode, Encoded } from './utils/encoder';
 import { UnavailableAccountError } from './utils/errors';
@@ -8,9 +9,15 @@ export default class AeSdk extends AeSdkBase {
 
   selectedAddress?: Encoded.AccountAddress;
 
-  _resolveAccount(
-    account: Account | Encoded.AccountAddress = this.selectedAddress,
-  ): AccountBase {
+  constructor(
+    { accounts, ...options }: { accounts?: AccountBase[] }
+    & ConstructorParameters<typeof AeSdkBase>[0] = {},
+  ) {
+    super(options);
+    accounts?.forEach((account, idx) => this.addAccount(account, { select: idx === 0 }));
+  }
+
+  override _resolveAccount(account: OnAccount = this.selectedAddress): AccountBase {
     if (typeof account === 'string') {
       const address = account as Encoded.AccountAddress;
       decode(address);
@@ -24,7 +31,7 @@ export default class AeSdk extends AeSdkBase {
    * Get accounts addresses
    * @example addresses()
    */
-  addresses(): Encoded.AccountAddress[] {
+  override addresses(): Encoded.AccountAddress[] {
     return Object.keys(this.accounts) as Encoded.AccountAddress[];
   }
 
@@ -35,8 +42,8 @@ export default class AeSdk extends AeSdkBase {
    * @param options.select - Select account
    * @example addAccount(account)
    */
-  async addAccount(account: AccountBase, { select }: { select?: boolean } = {}): Promise<void> {
-    const address = await account.address();
+  addAccount(account: AccountBase, { select }: { select?: boolean } = {}): void {
+    const { address } = account;
     this.accounts[address] = account;
     if (select === true) this.selectAccount(address);
   }
@@ -47,10 +54,7 @@ export default class AeSdk extends AeSdkBase {
    * @example removeAccount(address)
    */
   removeAccount(address: Encoded.AccountAddress): void {
-    if (this.accounts[address] == null) {
-      console.warn(`removeAccount: Account for ${address} not available`);
-      return;
-    }
+    if (this.accounts[address] == null) throw new UnavailableAccountError(address);
     delete this.accounts[address]; // eslint-disable-line @typescript-eslint/no-dynamic-delete
     if (this.selectedAddress === address) delete this.selectedAddress;
   }

package/src/AeSdkAepp.ts

@@ -1,4 +1,5 @@
-import AeSdkBase, { Account } from './AeSdkBase';
+import AeSdkBase from './AeSdkBase';
+import { OnAccount } from './AeSdkMethods';
 import AccountBase from './account/Base';
 import AccountRpc from './account/Rpc';
 import { decode, Encoded } from './utils/encoder';
@@ -50,9 +51,9 @@ export default class AeSdkAepp extends AeSdkBase {
     ...other
   }: {
     name: string;
-    onAddressChange: (a: Accounts) => void;
-    onDisconnect: (p: any) => void;
-    onNetworkChange: (a: Network) => void;
+    onAddressChange?: (a: Accounts) => void;
+    onDisconnect?: (p: any) => void;
+    onNetworkChange?: (a: Network) => void;
   } & ConstructorParameters<typeof AeSdkBase>[0]) {
     super(other);
     this.onAddressChange = onAddressChange;
@@ -61,18 +62,19 @@ export default class AeSdkAepp extends AeSdkBase {
     this.name = name;
   }
 
-  _resolveAccount(account: Account = this.addresses()[0]): AccountBase {
+  override _resolveAccount(account: OnAccount = this.addresses()[0]): AccountBase {
     if (typeof account === 'string') {
       const address = account as Encoded.AccountAddress;
       decode(address);
       if (!this.addresses().includes(address)) throw new UnAuthorizedAccountError(address);
-      account = new AccountRpc({ rpcClient: this.rpcClient, address });
+      this._ensureConnected();
+      account = new AccountRpc(this.rpcClient, address);
     }
     if (account == null) this._ensureAccountAccess();
     return super._resolveAccount(account);
   }
 
-  addresses(): Encoded.AccountAddress[] {
+  override addresses(): Encoded.AccountAddress[] {
     if (this._accounts == null) return [];
     const current = Object.keys(this._accounts.current)[0];
     return [

package/src/AeSdkBase.ts

@@ -1,105 +1,45 @@
-import * as chainMethods from './chain';
-import * as txMethods from './tx';
-import * as aensMethods from './aens';
-import * as spendMethods from './spend';
-import * as oracleMethods from './oracle';
-import * as contractMethods from './contract/methods';
-import * as contractGaMethods from './contract/ga';
-import * as deprecatedMethods from './deprecated/methods';
-import { _buildTx } from './tx';
-import { mapObject } from './utils/other';
-import Node, { getNetworkId } from './Node';
-import { AE_AMOUNT_FORMATS } from './utils/amount-formatter';
-import { AMOUNT } from './tx/builder/schema';
-import { Tag } from './tx/builder/constants';
-import MemoryAccount, { Keypair } from './account/Memory';
-import AccountBase, { isAccountBase } from './account/Base';
-import {
-  CompilerError,
-  DuplicateNodeError,
-  NodeNotFoundError,
-  NotImplementedError,
-  TypeError,
-} from './utils/errors';
+import Node from './Node';
+import AccountBase from './account/Base';
+import { CompilerError, DuplicateNodeError, NodeNotFoundError } from './utils/errors';
 import { Encoded } from './utils/encoder';
-import Compiler from './contract/Compiler';
-
-export type Account = Keypair | AccountBase | any;
+import CompilerBase from './contract/compiler/Base';
+import AeSdkMethods, { OnAccount, getValueOrErrorProxy } from './AeSdkMethods';
 
 type NodeInfo = Awaited<ReturnType<Node['getNodeInfo']>> & { name: string };
 
-function getValueOrErrorProxy<Value extends object>(valueCb: () => Value): Value {
-  try {
-    return valueCb();
-  } catch (error) {
-    return new Proxy(
-      {},
-      Object.fromEntries(['get', 'set', 'has'].map((name) => [name, () => { throw error; }])),
-    ) as Value;
-  }
-}
-
 /**
- * Basic AeSdk class
- *
- * AeSdkBase objects are the composition of:
- * - chain methods
- * - tx methods
- * - aens methods
- * - spend methods
- * - oracle methods
- * - contract methods
- * - contract ga methods
- * Only by providing the joint functionality of them, most more advanced
- * operations, i.e. the ones with actual use value on the chain, become
- * available.
+ * Basic AeSdk class implements:
+ * - node selector,
+ * - integrated compiler support,
+ * - wrappers of account methods mapped to the current account.
  */
-class AeSdkBase {
-  _options: {
-    denomination: AE_AMOUNT_FORMATS;
-    amount: number;
-    [key: string]: any;
-  } = { denomination: AE_AMOUNT_FORMATS.AETTOS, amount: AMOUNT };
-
+export default class AeSdkBase extends AeSdkMethods {
   pool: Map<string, Node> = new Map();
 
   selectedNodeName?: string;
 
-  compilerApi: Compiler;
-
   /**
    * @param options - Options
    * @param options.nodes - Array of nodes
-   * @param options.compilerUrl - Url for compiler API
-   * @param options.ignoreVersion - Don't check node or compiler version
    */
   constructor(
-    {
-      nodes = [], compilerUrl, ignoreVersion = false, ...options
-    }:
-    {
+    { nodes = [], ...options }: ConstructorParameters<typeof AeSdkMethods>[0] & {
       nodes?: Array<{ name: string; instance: Node }>;
-      compilerUrl?: string;
-      ignoreVersion?: boolean;
-      [key: string]: any; // TODO: consider combining all possible options instead
     } = {},
   ) {
-    Object.assign(this._options, options);
+    super(options);
 
     nodes.forEach(({ name, instance }, i) => this.addNode(name, instance, i === 0));
-
-    if (compilerUrl == null) {
-      this.compilerApi = getValueOrErrorProxy(() => {
-        throw new CompilerError('You can\'t use Compiler API. Compiler is not ready!');
-      });
-    } else this.setCompilerUrl(compilerUrl, { ignoreVersion });
   }
 
-  setCompilerUrl(
-    compilerUrl: string,
-    { ignoreVersion = false }: { ignoreVersion?: boolean } = {},
-  ): void {
-    this.compilerApi = new Compiler(compilerUrl, { ignoreVersion });
+  // TODO: consider dropping this getter, because:
+  // compiler is not intended to be used separately any more (functionality limited to sdk needs)
+  // and user creates its instance by himself
+  get compilerApi(): CompilerBase {
+    if (this._options.onCompiler == null) {
+      throw new CompilerError('You can\'t use Compiler API. Compiler is not ready!');
+    }
+    return this._options.onCompiler;
   }
 
   get api(): Node {
@@ -138,13 +78,6 @@ class AeSdkBase {
     this.selectedNodeName = name;
   }
 
-  /**
-   * Get NetworkId of current Node
-   * @example
-   * nodePool.getNetworkId()
-   */
-  readonly getNetworkId = getNetworkId;
-
   /**
    * Check if you have selected node
    * @example
@@ -194,145 +127,41 @@ class AeSdkBase {
     return [];
   }
 
-  async address({ onAccount }: { onAccount?: Account } = {}): Promise<Encoded.AccountAddress> {
-    return this._resolveAccount(onAccount).address();
+  get address(): Encoded.AccountAddress {
+    return this._resolveAccount().address;
   }
 
   async sign(
     data: string | Uint8Array,
-    { onAccount, ...options }: { onAccount?: Account } = {},
+    { onAccount, ...options }: { onAccount?: OnAccount } = {},
   ): Promise<Uint8Array> {
     return this._resolveAccount(onAccount).sign(data, options);
   }
 
   async signTransaction(
     tx: Encoded.Transaction,
-    { onAccount, ...options }: { onAccount?: Account } & Parameters<AccountBase['signTransaction']>[1] = {},
+    { onAccount, ...options }: { onAccount?: OnAccount } & Parameters<AccountBase['signTransaction']>[1] = {},
   ): Promise<Encoded.Transaction> {
-    return this._resolveAccount(onAccount)
-      .signTransaction(tx, { ...options, networkId: await this.getNetworkId(options) });
+    const networkId = this.selectedNodeName !== null ? await this.api.getNetworkId() : undefined;
+    return this._resolveAccount(onAccount).signTransaction(tx, { networkId, ...options });
   }
 
   async signMessage(
     message: string,
-    { onAccount, ...options }: { onAccount?: Account } & Parameters<AccountBase['signMessage']>[1] = {},
-  ): Promise<string | Uint8Array> {
+    { onAccount, ...options }: { onAccount?: OnAccount } & Parameters<AccountBase['signMessage']>[1] = {},
+  ): Promise<Uint8Array> {
     return this._resolveAccount(onAccount).signMessage(message, options);
   }
 
-  async verifyMessage(
-    message: string,
-    signature: string | Uint8Array,
-    { onAccount, ...options }: { onAccount?: Account } & Parameters<AccountBase['verifyMessage']>[2] = {},
-  ): Promise<boolean> {
-    return this._resolveAccount(onAccount).verifyMessage(message, signature, options);
-  }
-
-  /**
-   * Resolves an account
-   * @param account - ak-address, instance of AccountBase, or keypair
-   */
-  // eslint-disable-next-line class-methods-use-this
-  _resolveAccount(account?: Account): AccountBase {
-    switch (account !== null && typeof account) {
-      case 'string':
-        throw new NotImplementedError('Address in AccountResolver');
-      case 'object':
-        return isAccountBase(account) ? account : new MemoryAccount({ keypair: account });
-      default:
-        throw new TypeError(
-          'Account should be an address (ak-prefixed string), '
-          + `keypair, or instance of AccountBase, got ${String(account)} instead`,
-        );
-    }
-  }
-
-  _getOptions(): {
+  override _getOptions(): {
     onNode: Node;
     onAccount: AccountBase;
-    onCompiler: Compiler;
+    onCompiler: CompilerBase;
   } {
     return {
-      ...this._options,
+      ...super._getOptions(),
       onNode: getValueOrErrorProxy(() => this.api),
-      onAccount: getValueOrErrorProxy(() => this._resolveAccount()),
       onCompiler: getValueOrErrorProxy(() => this.compilerApi),
     };
   }
-
-  async buildTx<TxType extends Tag>(
-    txType: TxType,
-    options: Omit<Parameters<typeof _buildTx<TxType>>[1], 'onNode'> & { onNode?: Node },
-  ): Promise<Encoded.Transaction> {
-    // @ts-expect-error TODO: need to figure out what's wrong here
-    return _buildTx<TxType>(txType, {
-      ...this._getOptions(),
-      ...options,
-    });
-  }
 }
-
-const { _buildTx: _, ...txMethodsOther } = txMethods;
-const { InvalidTxError: _2, ...chainMethodsOther } = chainMethods;
-
-const methods = {
-  ...chainMethodsOther,
-  ...txMethodsOther,
-  ...aensMethods,
-  ...spendMethods,
-  ...oracleMethods,
-  ...contractMethods,
-  ...contractGaMethods,
-  ...deprecatedMethods,
-} as const;
-
-type RequiredKeys<T> = {
-  [K in keyof T]-?: {} extends Pick<T, K> ? never : K
-}[keyof T];
-
-type OptionalIfNotRequired<T extends [any]> = RequiredKeys<T[0]> extends never ? T | [] : T;
-
-type MakeOptional<Args extends any[]> = Args extends [infer Head, ...infer Tail]
-  ? Tail extends []
-    ? Head extends object
-      ? OptionalIfNotRequired<[Omit<Head, 'onNode' | 'onCompiler' | 'onAccount'>
-      & {
-        onNode?: Node;
-        onCompiler?: Compiler;
-        onAccount?: AccountBase | Encoded.AccountAddress | Keypair;
-      }]>
-      : [Head]
-    : [Head, ...MakeOptional<Tail>]
-  : never;
-
-type TransformMethods <Methods extends { [key: string]: Function }> =
-  {
-    [Name in keyof Methods]:
-    Methods[Name] extends (...args: infer Args) => infer Ret
-      ? (...args: MakeOptional<Args>) => Ret
-      : never
-  };
-
-interface AeSdkBaseMethods extends TransformMethods<typeof methods> {}
-
-Object.assign(AeSdkBase.prototype, mapObject<Function, Function>(
-  methods,
-  ([name, handler]) => [
-    name,
-    function methodWrapper(...args: any[]) {
-      const instanceOptions = this._getOptions();
-      const lastArg = args[args.length - 1];
-      if (lastArg != null && typeof lastArg === 'object' && lastArg.constructor === Object) {
-        args[args.length - 1] = {
-          ...instanceOptions,
-          ...lastArg,
-          ...lastArg.onAccount != null && { onAccount: this._resolveAccount(lastArg.onAccount) },
-        };
-      } else args.push(instanceOptions);
-      return handler(...args);
-    },
-  ],
-));
-
-export default AeSdkBase as new (options?: ConstructorParameters<typeof AeSdkBase>[0]) =>
-AeSdkBase & AeSdkBaseMethods;