@aeternity/aepp-sdk 13.3.3 → 14.1.0

package/es/account/LedgerFactory.js

@@ -0,0 +1,86 @@
+import { Buffer as _Buffer } from "buffer";
+import _defineProperty from "@babel/runtime-corejs3/helpers/defineProperty";
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+import AccountLedger, { CLA, GET_ADDRESS, GET_APP_CONFIGURATION } from './Ledger.js';
+import { UnsupportedVersionError } from '../utils/errors.js';
+import semverSatisfies from '../utils/semver-satisfies.js';
+import AccountBaseFactory from './BaseFactory.js';
+var _ensureReadyPromise = /*#__PURE__*/new WeakMap();
+var _AccountLedgerFactory_brand = /*#__PURE__*/new WeakSet();
+/**
+ * A factory class that generates instances of AccountLedger based on provided transport.
+ * @category account
+ */
+export default class AccountLedgerFactory extends AccountBaseFactory {
+  /**
+   * @param transport - Connection to Ledger to use
+   */
+  constructor(transport) {
+    super();
+    _classPrivateMethodInitSpec(this, _AccountLedgerFactory_brand);
+    _classPrivateFieldInitSpec(this, _ensureReadyPromise, void 0);
+    // TODO: remove after release Ledger app v1.0.0
+    _defineProperty(this, "_enableExperimentalLedgerAppSupport", false);
+    this.transport = transport;
+    transport.decorateAppAPIMethods(this, ['getAddress', 'getAppConfiguration'], 'w0w');
+  }
+  /**
+   * It throws an exception if Aeternity app on Ledger has an incompatible version, not opened or
+   * not installed.
+   */
+  async ensureReady() {
+    const {
+      version
+    } = await _assertClassBrand(_AccountLedgerFactory_brand, this, _getAppConfiguration).call(this);
+    const oldApp = [version, '0.4.4', '0.5.0'];
+    const newApp = [version, '1.0.0', '2.0.0'];
+    if (!semverSatisfies(...oldApp) && (!this._enableExperimentalLedgerAppSupport || !semverSatisfies(...newApp))) throw new UnsupportedVersionError('Aeternity app on Ledger', ...oldApp);
+    _classPrivateFieldSet(_ensureReadyPromise, this, Promise.resolve());
+  }
+  /**
+   * @returns the version of Aeternity app installed on Ledger wallet
+   */
+  async getAppConfiguration() {
+    return _assertClassBrand(_AccountLedgerFactory_brand, this, _getAppConfiguration).call(this);
+  }
+
+  /**
+   * Get `ak_`-prefixed address for a given account index.
+   * @param accountIndex - Index of account
+   * @param verify - Ask user to confirm address by showing it on the device screen
+   */
+  async getAddress(accountIndex, verify = false) {
+    await _assertClassBrand(_AccountLedgerFactory_brand, this, _ensureReady).call(this);
+    const buffer = _Buffer.alloc(4);
+    buffer.writeUInt32BE(accountIndex, 0);
+    const response = await this.transport.send(CLA, GET_ADDRESS, verify ? 0x01 : 0x00, 0x00, buffer);
+    const addressLength = response[0];
+    return response.subarray(1, 1 + addressLength).toString('ascii');
+  }
+
+  /**
+   * Get an instance of AccountLedger for a given account index.
+   * @param accountIndex - Index of account
+   */
+  async initialize(accountIndex) {
+    return new AccountLedger(this.transport, accountIndex, await this.getAddress(accountIndex));
+  }
+}
+async function _ensureReady() {
+  var _classPrivateFieldGet2;
+  (_classPrivateFieldGet2 = _classPrivateFieldGet(_ensureReadyPromise, this)) !== null && _classPrivateFieldGet2 !== void 0 ? _classPrivateFieldGet2 : _classPrivateFieldSet(_ensureReadyPromise, this, this.ensureReady());
+  return _classPrivateFieldGet(_ensureReadyPromise, this);
+}
+async function _getAppConfiguration() {
+  let response = await this.transport.send(CLA, GET_APP_CONFIGURATION, 0x00, 0x00);
+  if (response.length === 6) response = response.subarray(1);
+  return {
+    version: [response[0], response[1], response[2]].join('.')
+  };
+}
+//# sourceMappingURL=LedgerFactory.js.map

package/es/account/LedgerFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LedgerFactory.js","names":["AccountLedger","CLA","GET_ADDRESS","GET_APP_CONFIGURATION","UnsupportedVersionError","semverSatisfies","AccountBaseFactory","_ensureReadyPromise","WeakMap","_AccountLedgerFactory_brand","WeakSet","AccountLedgerFactory","constructor","transport","_classPrivateMethodInitSpec","_classPrivateFieldInitSpec","_defineProperty","decorateAppAPIMethods","ensureReady","version","_assertClassBrand","_getAppConfiguration","call","oldApp","newApp","_enableExperimentalLedgerAppSupport","_classPrivateFieldSet","Promise","resolve","getAppConfiguration","getAddress","accountIndex","verify","_ensureReady","buffer","_Buffer","alloc","writeUInt32BE","response","send","addressLength","subarray","toString","initialize","_classPrivateFieldGet2","_classPrivateFieldGet","length","join"],"sources":["../../src/account/LedgerFactory.ts"],"sourcesContent":["import type Transport from '@ledgerhq/hw-transport';\nimport AccountLedger, { CLA, GET_ADDRESS, GET_APP_CONFIGURATION } from './Ledger.js';\nimport { UnsupportedVersionError } from '../utils/errors.js';\nimport { Encoded } from '../utils/encoder.js';\nimport semverSatisfies from '../utils/semver-satisfies.js';\nimport AccountBaseFactory from './BaseFactory.js';\n\ninterface AppConfiguration {\n  version: string;\n}\n\n/**\n * A factory class that generates instances of AccountLedger based on provided transport.\n * @category account\n */\nexport default class AccountLedgerFactory extends AccountBaseFactory {\n  /**\n   * @param transport - Connection to Ledger to use\n   */\n  constructor(readonly transport: Transport) {\n    super();\n    transport.decorateAppAPIMethods(this, ['getAddress', 'getAppConfiguration'], 'w0w');\n  }\n\n  #ensureReadyPromise?: Promise<void>;\n\n  // TODO: remove after release Ledger app v1.0.0\n  _enableExperimentalLedgerAppSupport = false;\n\n  /**\n   * It throws an exception if Aeternity app on Ledger has an incompatible version, not opened or\n   * not installed.\n   */\n  async ensureReady(): Promise<void> {\n    const { version } = await this.#getAppConfiguration();\n    const oldApp = [version, '0.4.4', '0.5.0'] as const;\n    const newApp = [version, '1.0.0', '2.0.0'] as const;\n    if (\n      !semverSatisfies(...oldApp) &&\n      (!this._enableExperimentalLedgerAppSupport || !semverSatisfies(...newApp))\n    )\n      throw new UnsupportedVersionError('Aeternity app on Ledger', ...oldApp);\n    this.#ensureReadyPromise = Promise.resolve();\n  }\n\n  async #ensureReady(): Promise<void> {\n    this.#ensureReadyPromise ??= this.ensureReady();\n    return this.#ensureReadyPromise;\n  }\n\n  async #getAppConfiguration(): Promise<AppConfiguration> {\n    let response = await this.transport.send(CLA, GET_APP_CONFIGURATION, 0x00, 0x00);\n    if (response.length === 6) response = response.subarray(1);\n    return {\n      version: [response[0], response[1], response[2]].join('.'),\n    };\n  }\n\n  /**\n   * @returns the version of Aeternity app installed on Ledger wallet\n   */\n  async getAppConfiguration(): Promise<AppConfiguration> {\n    return this.#getAppConfiguration();\n  }\n\n  /**\n   * Get `ak_`-prefixed address for a given account index.\n   * @param accountIndex - Index of account\n   * @param verify - Ask user to confirm address by showing it on the device screen\n   */\n  async getAddress(accountIndex: number, verify = false): Promise<Encoded.AccountAddress> {\n    await this.#ensureReady();\n    const buffer = Buffer.alloc(4);\n    buffer.writeUInt32BE(accountIndex, 0);\n    const response = await this.transport.send(\n      CLA,\n      GET_ADDRESS,\n      verify ? 0x01 : 0x00,\n      0x00,\n      buffer,\n    );\n    const addressLength = response[0];\n    return response.subarray(1, 1 + addressLength).toString('ascii') as Encoded.AccountAddress;\n  }\n\n  /**\n   * Get an instance of AccountLedger for a given account index.\n   * @param accountIndex - Index of account\n   */\n  async initialize(accountIndex: number): Promise<AccountLedger> {\n    return new AccountLedger(this.transport, accountIndex, await this.getAddress(accountIndex));\n  }\n}\n"],"mappings":";;;;;;;;AACA,OAAOA,aAAa,IAAIC,GAAG,EAAEC,WAAW,EAAEC,qBAAqB,QAAQ,aAAa;AACpF,SAASC,uBAAuB,QAAQ,oBAAoB;AAE5D,OAAOC,eAAe,MAAM,8BAA8B;AAC1D,OAAOC,kBAAkB,MAAM,kBAAkB;AAAC,IAAAC,mBAAA,oBAAAC,OAAA;AAAA,IAAAC,2BAAA,oBAAAC,OAAA;AAMlD;AACA;AACA;AACA;AACA,eAAe,MAAMC,oBAAoB,SAASL,kBAAkB,CAAC;EACnE;AACF;AACA;EACEM,WAAWA,CAAUC,SAAoB,EAAE;IACzC,KAAK,CAAC,CAAC;IAACC,2BAAA,OAAAL,2BAAA;IAIVM,0BAAA,OAAAR,mBAAmB;IAEnB;IAAAS,eAAA,8CACsC,KAAK;IAAA,KARtBH,SAAoB,GAApBA,SAAoB;IAEvCA,SAAS,CAACI,qBAAqB,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,qBAAqB,CAAC,EAAE,KAAK,CAAC;EACrF;EAOA;AACF;AACA;AACA;EACE,MAAMC,WAAWA,CAAA,EAAkB;IACjC,MAAM;MAAEC;IAAQ,CAAC,GAAG,MAAMC,iBAAA,CAAAX,2BAAA,MAAI,EAACY,oBAAmB,CAAC,CAAAC,IAAA,CAAzB,IAAI,CAAuB;IACrD,MAAMC,MAAM,GAAG,CAACJ,OAAO,EAAE,OAAO,EAAE,OAAO,CAAU;IACnD,MAAMK,MAAM,GAAG,CAACL,OAAO,EAAE,OAAO,EAAE,OAAO,CAAU;IACnD,IACE,CAACd,eAAe,CAAC,GAAGkB,MAAM,CAAC,KAC1B,CAAC,IAAI,CAACE,mCAAmC,IAAI,CAACpB,eAAe,CAAC,GAAGmB,MAAM,CAAC,CAAC,EAE1E,MAAM,IAAIpB,uBAAuB,CAAC,yBAAyB,EAAE,GAAGmB,MAAM,CAAC;IACzEG,qBAAA,CAAKnB,mBAAmB,EAAxB,IAAI,EAAuBoB,OAAO,CAACC,OAAO,CAAC,CAApB,CAAC;EAC1B;EAeA;AACF;AACA;EACE,MAAMC,mBAAmBA,CAAA,EAA8B;IACrD,OAAOT,iBAAA,CAAAX,2BAAA,MAAI,EAACY,oBAAmB,CAAC,CAAAC,IAAA,CAAzB,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAMQ,UAAUA,CAACC,YAAoB,EAAEC,MAAM,GAAG,KAAK,EAAmC;IACtF,MAAMZ,iBAAA,CAAAX,2BAAA,MAAI,EAACwB,YAAW,CAAC,CAAAX,IAAA,CAAjB,IAAI,CAAe;IACzB,MAAMY,MAAM,GAAGC,OAAA,CAAOC,KAAK,CAAC,CAAC,CAAC;IAC9BF,MAAM,CAACG,aAAa,CAACN,YAAY,EAAE,CAAC,CAAC;IACrC,MAAMO,QAAQ,GAAG,MAAM,IAAI,CAACzB,SAAS,CAAC0B,IAAI,CACxCtC,GAAG,EACHC,WAAW,EACX8B,MAAM,GAAG,IAAI,GAAG,IAAI,EACpB,IAAI,EACJE,MACF,CAAC;IACD,MAAMM,aAAa,GAAGF,QAAQ,CAAC,CAAC,CAAC;IACjC,OAAOA,QAAQ,CAACG,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAGD,aAAa,CAAC,CAACE,QAAQ,CAAC,OAAO,CAAC;EAClE;;EAEA;AACF;AACA;AACA;EACE,MAAMC,UAAUA,CAACZ,YAAoB,EAA0B;IAC7D,OAAO,IAAI/B,aAAa,CAAC,IAAI,CAACa,SAAS,EAAEkB,YAAY,EAAE,MAAM,IAAI,CAACD,UAAU,CAACC,YAAY,CAAC,CAAC;EAC7F;AACF;AAAC,eAAAE,aAAA,EA/CqC;EAAA,IAAAW,sBAAA;EAClC,CAAAA,sBAAA,GAAAC,qBAAA,CAAKtC,mBAAmB,EAAxB,IAAuB,CAAC,cAAAqC,sBAAA,cAAAA,sBAAA,GAAxBlB,qBAAA,CAAKnB,mBAAmB,EAAxB,IAAI,EAAyB,IAAI,CAACW,WAAW,CAAC,CAAvB,CAAC;EACxB,OAAO2B,qBAAA,CAAKtC,mBAAmB,EAAxB,IAAuB,CAAC;AACjC;AAAC,eAAAc,qBAAA,EAEuD;EACtD,IAAIiB,QAAQ,GAAG,MAAM,IAAI,CAACzB,SAAS,CAAC0B,IAAI,CAACtC,GAAG,EAAEE,qBAAqB,EAAE,IAAI,EAAE,IAAI,CAAC;EAChF,IAAImC,QAAQ,CAACQ,MAAM,KAAK,CAAC,EAAER,QAAQ,GAAGA,QAAQ,CAACG,QAAQ,CAAC,CAAC,CAAC;EAC1D,OAAO;IACLtB,OAAO,EAAE,CAACmB,QAAQ,CAAC,CAAC,CAAC,EAAEA,QAAQ,CAAC,CAAC,CAAC,EAAEA,QAAQ,CAAC,CAAC,CAAC,CAAC,CAACS,IAAI,CAAC,GAAG;EAC3D,CAAC;AACH","ignoreList":[]}

package/es/account/Memory.d.ts

@@ -1,45 +1,34 @@
-import AccountBase from './Base';
-import { Encoded } from '../utils/encoder';
-import { AciValue } from '../utils/typed-data';
-import { AensName, ConsensusProtocolVersion } from '../tx/builder/constants';
+import AccountBase from './Base.js';
+import { Encoded } from '../utils/encoder.js';
+import { AciValue } from '../utils/typed-data.js';
 export declare function getBufferToSign(transaction: Encoded.Transaction, networkId: string, innerTx: boolean): Uint8Array;
 /**
  * In-memory account class
+ * @category account
  */
 export default class AccountMemory extends AccountBase {
+    #private;
+    readonly secretKey: Encoded.AccountSecretKey;
     readonly address: Encoded.AccountAddress;
     /**
      * @param secretKey - Secret key
      */
-    constructor(secretKey: string | Uint8Array);
+    constructor(secretKey: Encoded.AccountSecretKey);
     /**
      * Generates a new AccountMemory using a random secret key
      */
     static generate(): AccountMemory;
+    /**
+     * @deprecated Use `unsafeSign` method instead
+     */
     sign(data: string | Uint8Array, options?: any): Promise<Uint8Array>;
+    unsafeSign(data: string | Uint8Array, options?: any): Promise<Uint8Array>;
     signTransaction(transaction: Encoded.Transaction, { innerTx, networkId, ...options }?: {
         innerTx?: boolean;
         networkId?: string;
     }): Promise<Encoded.Transaction>;
     signMessage(message: string, options?: any): Promise<Uint8Array>;
     signTypedData(data: Encoded.ContractBytearray, aci: AciValue, { name, version, networkId, contractAddress, ...options }?: Parameters<AccountBase['signTypedData']>[2]): Promise<Encoded.Signature>;
-    signDelegationToContract(contractAddress: Encoded.ContractAddress, { networkId, consensusProtocolVersion, isOracle }?: {
-        networkId?: string;
-        consensusProtocolVersion?: ConsensusProtocolVersion;
-        isOracle?: boolean;
-    }): Promise<Encoded.Signature>;
-    signNameDelegationToContract(contractAddress: Encoded.ContractAddress, name: AensName, { networkId, consensusProtocolVersion }?: {
-        networkId?: string;
-        consensusProtocolVersion?: ConsensusProtocolVersion;
-    }): Promise<Encoded.Signature>;
-    signAllNamesDelegationToContract(contractAddress: Encoded.ContractAddress, { networkId, consensusProtocolVersion }?: {
-        networkId?: string;
-        consensusProtocolVersion?: ConsensusProtocolVersion;
-    }): Promise<Encoded.Signature>;
-    signOracleQueryDelegationToContract(contractAddress: Encoded.ContractAddress, oracleQueryId: Encoded.OracleQueryId, { networkId, consensusProtocolVersion }?: {
-        networkId?: string;
-        consensusProtocolVersion?: ConsensusProtocolVersion;
-    }): Promise<Encoded.Signature>;
     signDelegation(delegation: Encoded.Bytearray, { networkId }?: {
         networkId?: string;
     }): Promise<Encoded.Signature>;

package/es/account/Memory.js

@@ -0,0 +1,106 @@
+import { Buffer as _Buffer } from "buffer";
+function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+import nacl from 'tweetnacl';
+import AccountBase from './Base.js';
+import { hash, hashMessage, messagePrefixLength } from '../utils/crypto.js';
+import { ArgumentError } from '../utils/errors.js';
+import { decode, encode, Encoding } from '../utils/encoder.js';
+import { concatBuffers } from '../utils/other.js';
+import { hashTypedData } from '../utils/typed-data.js';
+import { buildTx } from '../tx/builder/index.js';
+import { Tag } from '../tx/builder/constants.js';
+export function getBufferToSign(transaction, networkId, innerTx) {
+  const prefixes = [networkId];
+  if (innerTx) prefixes.push('inner_tx');
+  const rlpBinaryTx = decode(transaction);
+  return concatBuffers([_Buffer.from(prefixes.join('-')), hash(rlpBinaryTx)]);
+}
+
+/**
+ * In-memory account class
+ * @category account
+ */
+var _secretKeyDecoded = /*#__PURE__*/new WeakMap();
+export default class AccountMemory extends AccountBase {
+  /**
+   * @param secretKey - Secret key
+   */
+  constructor(secretKey) {
+    super();
+    _classPrivateFieldInitSpec(this, _secretKeyDecoded, void 0);
+    this.secretKey = secretKey;
+    const keyPair = nacl.sign.keyPair.fromSeed(decode(secretKey));
+    _classPrivateFieldSet(_secretKeyDecoded, this, keyPair.secretKey);
+    this.address = encode(keyPair.publicKey, Encoding.AccountAddress);
+  }
+
+  /**
+   * Generates a new AccountMemory using a random secret key
+   */
+  static generate() {
+    const secretKey = encode(nacl.randomBytes(32), Encoding.AccountSecretKey);
+    return new AccountMemory(secretKey);
+  }
+
+  /**
+   * @deprecated Use `unsafeSign` method instead
+   */
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async sign(data, options) {
+    return this.unsafeSign(data, options);
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  async unsafeSign(data, options) {
+    return nacl.sign.detached(_Buffer.from(data), _classPrivateFieldGet(_secretKeyDecoded, this));
+  }
+  async signTransaction(transaction, {
+    innerTx,
+    networkId,
+    ...options
+  } = {}) {
+    if (networkId == null) {
+      throw new ArgumentError('networkId', 'provided', networkId);
+    }
+    const rlpBinaryTx = decode(transaction);
+    const txWithNetworkId = getBufferToSign(transaction, networkId, innerTx === true);
+    const signatures = [await this.unsafeSign(txWithNetworkId, options)];
+    return buildTx({
+      tag: Tag.SignedTx,
+      encodedTx: rlpBinaryTx,
+      signatures
+    });
+  }
+  async signMessage(message, options) {
+    return this.unsafeSign(hashMessage(message), options);
+  }
+  async signTypedData(data, aci, {
+    name,
+    version,
+    networkId,
+    contractAddress,
+    ...options
+  } = {}) {
+    const dHash = hashTypedData(data, aci, {
+      name,
+      version,
+      networkId,
+      contractAddress
+    });
+    const signature = await this.unsafeSign(dHash, options);
+    return encode(signature, Encoding.Signature);
+  }
+  async signDelegation(delegation, {
+    networkId
+  } = {}) {
+    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);
+    const payload = concatBuffers([messagePrefixLength, new Uint8Array([1]), _Buffer.from(networkId), decode(delegation)]);
+    const signature = await this.unsafeSign(payload);
+    return encode(signature, Encoding.Signature);
+  }
+}
+//# sourceMappingURL=Memory.js.map

package/es/account/Memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Memory.js","names":["nacl","AccountBase","hash","hashMessage","messagePrefixLength","ArgumentError","decode","encode","Encoding","concatBuffers","hashTypedData","buildTx","Tag","getBufferToSign","transaction","networkId","innerTx","prefixes","push","rlpBinaryTx","_Buffer","from","join","_secretKeyDecoded","WeakMap","AccountMemory","constructor","secretKey","_classPrivateFieldInitSpec","keyPair","sign","fromSeed","_classPrivateFieldSet","address","publicKey","AccountAddress","generate","randomBytes","AccountSecretKey","data","options","unsafeSign","detached","_classPrivateFieldGet","signTransaction","txWithNetworkId","signatures","tag","SignedTx","encodedTx","signMessage","message","signTypedData","aci","name","version","contractAddress","dHash","signature","Signature","signDelegation","delegation","payload","Uint8Array"],"sources":["../../src/account/Memory.ts"],"sourcesContent":["import nacl from 'tweetnacl';\nimport AccountBase from './Base.js';\nimport { hash, hashMessage, messagePrefixLength } from '../utils/crypto.js';\nimport { ArgumentError } from '../utils/errors.js';\nimport { decode, encode, Encoded, Encoding } from '../utils/encoder.js';\nimport { concatBuffers } from '../utils/other.js';\nimport { hashTypedData, AciValue } from '../utils/typed-data.js';\nimport { buildTx } from '../tx/builder/index.js';\nimport { Tag } from '../tx/builder/constants.js';\n\nexport function getBufferToSign(\n  transaction: Encoded.Transaction,\n  networkId: string,\n  innerTx: boolean,\n): Uint8Array {\n  const prefixes = [networkId];\n  if (innerTx) prefixes.push('inner_tx');\n  const rlpBinaryTx = decode(transaction);\n  return concatBuffers([Buffer.from(prefixes.join('-')), hash(rlpBinaryTx)]);\n}\n\n/**\n * In-memory account class\n * @category account\n */\nexport default class AccountMemory extends AccountBase {\n  override readonly address: Encoded.AccountAddress;\n\n  readonly #secretKeyDecoded: Uint8Array;\n\n  /**\n   * @param secretKey - Secret key\n   */\n  constructor(public readonly secretKey: Encoded.AccountSecretKey) {\n    super();\n    const keyPair = nacl.sign.keyPair.fromSeed(decode(secretKey));\n    this.#secretKeyDecoded = keyPair.secretKey;\n    this.address = encode(keyPair.publicKey, Encoding.AccountAddress);\n  }\n\n  /**\n   * Generates a new AccountMemory using a random secret key\n   */\n  static generate(): AccountMemory {\n    const secretKey = encode(nacl.randomBytes(32), Encoding.AccountSecretKey);\n    return new AccountMemory(secretKey);\n  }\n\n  /**\n   * @deprecated Use `unsafeSign` method instead\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  override async sign(data: string | Uint8Array, options?: any): Promise<Uint8Array> {\n    return this.unsafeSign(data, options);\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  override async unsafeSign(data: string | Uint8Array, options?: any): Promise<Uint8Array> {\n    return nacl.sign.detached(Buffer.from(data), this.#secretKeyDecoded);\n  }\n\n  override async signTransaction(\n    transaction: Encoded.Transaction,\n    { innerTx, networkId, ...options }: { innerTx?: boolean; networkId?: string } = {},\n  ): Promise<Encoded.Transaction> {\n    if (networkId == null) {\n      throw new ArgumentError('networkId', 'provided', networkId);\n    }\n    const rlpBinaryTx = decode(transaction);\n    const txWithNetworkId = getBufferToSign(transaction, networkId, innerTx === true);\n\n    const signatures = [await this.unsafeSign(txWithNetworkId, options)];\n    return buildTx({ tag: Tag.SignedTx, encodedTx: rlpBinaryTx, signatures });\n  }\n\n  override async signMessage(message: string, options?: any): Promise<Uint8Array> {\n    return this.unsafeSign(hashMessage(message), options);\n  }\n\n  override async signTypedData(\n    data: Encoded.ContractBytearray,\n    aci: AciValue,\n    {\n      name,\n      version,\n      networkId,\n      contractAddress,\n      ...options\n    }: Parameters<AccountBase['signTypedData']>[2] = {},\n  ): Promise<Encoded.Signature> {\n    const dHash = hashTypedData(data, aci, {\n      name,\n      version,\n      networkId,\n      contractAddress,\n    });\n    const signature = await this.unsafeSign(dHash, options);\n    return encode(signature, Encoding.Signature);\n  }\n\n  override async signDelegation(\n    delegation: Encoded.Bytearray,\n    { networkId }: { networkId?: string } = {},\n  ): Promise<Encoded.Signature> {\n    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);\n    const payload = concatBuffers([\n      messagePrefixLength,\n      new Uint8Array([1]),\n      Buffer.from(networkId),\n      decode(delegation),\n    ]);\n    const signature = await this.unsafeSign(payload);\n    return encode(signature, Encoding.Signature);\n  }\n}\n"],"mappings":";;;;;;AAAA,OAAOA,IAAI,MAAM,WAAW;AAC5B,OAAOC,WAAW,MAAM,WAAW;AACnC,SAASC,IAAI,EAAEC,WAAW,EAAEC,mBAAmB,QAAQ,oBAAoB;AAC3E,SAASC,aAAa,QAAQ,oBAAoB;AAClD,SAASC,MAAM,EAAEC,MAAM,EAAWC,QAAQ,QAAQ,qBAAqB;AACvE,SAASC,aAAa,QAAQ,mBAAmB;AACjD,SAASC,aAAa,QAAkB,wBAAwB;AAChE,SAASC,OAAO,QAAQ,wBAAwB;AAChD,SAASC,GAAG,QAAQ,4BAA4B;AAEhD,OAAO,SAASC,eAAeA,CAC7BC,WAAgC,EAChCC,SAAiB,EACjBC,OAAgB,EACJ;EACZ,MAAMC,QAAQ,GAAG,CAACF,SAAS,CAAC;EAC5B,IAAIC,OAAO,EAAEC,QAAQ,CAACC,IAAI,CAAC,UAAU,CAAC;EACtC,MAAMC,WAAW,GAAGb,MAAM,CAACQ,WAAW,CAAC;EACvC,OAAOL,aAAa,CAAC,CAACW,OAAA,CAAOC,IAAI,CAACJ,QAAQ,CAACK,IAAI,CAAC,GAAG,CAAC,CAAC,EAAEpB,IAAI,CAACiB,WAAW,CAAC,CAAC,CAAC;AAC5E;;AAEA;AACA;AACA;AACA;AAHA,IAAAI,iBAAA,oBAAAC,OAAA;AAIA,eAAe,MAAMC,aAAa,SAASxB,WAAW,CAAC;EAKrD;AACF;AACA;EACEyB,WAAWA,CAAiBC,SAAmC,EAAE;IAC/D,KAAK,CAAC,CAAC;IANTC,0BAAA,OAASL,iBAAiB;IAAa,KAKXI,SAAmC,GAAnCA,SAAmC;IAE7D,MAAME,OAAO,GAAG7B,IAAI,CAAC8B,IAAI,CAACD,OAAO,CAACE,QAAQ,CAACzB,MAAM,CAACqB,SAAS,CAAC,CAAC;IAC7DK,qBAAA,CAAKT,iBAAiB,EAAtB,IAAI,EAAqBM,OAAO,CAACF,SAAZ,CAAC;IACtB,IAAI,CAACM,OAAO,GAAG1B,MAAM,CAACsB,OAAO,CAACK,SAAS,EAAE1B,QAAQ,CAAC2B,cAAc,CAAC;EACnE;;EAEA;AACF;AACA;EACE,OAAOC,QAAQA,CAAA,EAAkB;IAC/B,MAAMT,SAAS,GAAGpB,MAAM,CAACP,IAAI,CAACqC,WAAW,CAAC,EAAE,CAAC,EAAE7B,QAAQ,CAAC8B,gBAAgB,CAAC;IACzE,OAAO,IAAIb,aAAa,CAACE,SAAS,CAAC;EACrC;;EAEA;AACF;AACA;EACE;EACA,MAAeG,IAAIA,CAACS,IAAyB,EAAEC,OAAa,EAAuB;IACjF,OAAO,IAAI,CAACC,UAAU,CAACF,IAAI,EAAEC,OAAO,CAAC;EACvC;;EAEA;EACA,MAAeC,UAAUA,CAACF,IAAyB,EAAEC,OAAa,EAAuB;IACvF,OAAOxC,IAAI,CAAC8B,IAAI,CAACY,QAAQ,CAACtB,OAAA,CAAOC,IAAI,CAACkB,IAAI,CAAC,EAAEI,qBAAA,CAAKpB,iBAAiB,EAAtB,IAAqB,CAAC,CAAC;EACtE;EAEA,MAAeqB,eAAeA,CAC5B9B,WAAgC,EAChC;IAAEE,OAAO;IAAED,SAAS;IAAE,GAAGyB;EAAmD,CAAC,GAAG,CAAC,CAAC,EACpD;IAC9B,IAAIzB,SAAS,IAAI,IAAI,EAAE;MACrB,MAAM,IAAIV,aAAa,CAAC,WAAW,EAAE,UAAU,EAAEU,SAAS,CAAC;IAC7D;IACA,MAAMI,WAAW,GAAGb,MAAM,CAACQ,WAAW,CAAC;IACvC,MAAM+B,eAAe,GAAGhC,eAAe,CAACC,WAAW,EAAEC,SAAS,EAAEC,OAAO,KAAK,IAAI,CAAC;IAEjF,MAAM8B,UAAU,GAAG,CAAC,MAAM,IAAI,CAACL,UAAU,CAACI,eAAe,EAAEL,OAAO,CAAC,CAAC;IACpE,OAAO7B,OAAO,CAAC;MAAEoC,GAAG,EAAEnC,GAAG,CAACoC,QAAQ;MAAEC,SAAS,EAAE9B,WAAW;MAAE2B;IAAW,CAAC,CAAC;EAC3E;EAEA,MAAeI,WAAWA,CAACC,OAAe,EAAEX,OAAa,EAAuB;IAC9E,OAAO,IAAI,CAACC,UAAU,CAACtC,WAAW,CAACgD,OAAO,CAAC,EAAEX,OAAO,CAAC;EACvD;EAEA,MAAeY,aAAaA,CAC1Bb,IAA+B,EAC/Bc,GAAa,EACb;IACEC,IAAI;IACJC,OAAO;IACPxC,SAAS;IACTyC,eAAe;IACf,GAAGhB;EACwC,CAAC,GAAG,CAAC,CAAC,EACvB;IAC5B,MAAMiB,KAAK,GAAG/C,aAAa,CAAC6B,IAAI,EAAEc,GAAG,EAAE;MACrCC,IAAI;MACJC,OAAO;MACPxC,SAAS;MACTyC;IACF,CAAC,CAAC;IACF,MAAME,SAAS,GAAG,MAAM,IAAI,CAACjB,UAAU,CAACgB,KAAK,EAAEjB,OAAO,CAAC;IACvD,OAAOjC,MAAM,CAACmD,SAAS,EAAElD,QAAQ,CAACmD,SAAS,CAAC;EAC9C;EAEA,MAAeC,cAAcA,CAC3BC,UAA6B,EAC7B;IAAE9C;EAAkC,CAAC,GAAG,CAAC,CAAC,EACd;IAC5B,IAAIA,SAAS,IAAI,IAAI,EAAE,MAAM,IAAIV,aAAa,CAAC,WAAW,EAAE,UAAU,EAAEU,SAAS,CAAC;IAClF,MAAM+C,OAAO,GAAGrD,aAAa,CAAC,CAC5BL,mBAAmB,EACnB,IAAI2D,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EACnB3C,OAAA,CAAOC,IAAI,CAACN,SAAS,CAAC,EACtBT,MAAM,CAACuD,UAAU,CAAC,CACnB,CAAC;IACF,MAAMH,SAAS,GAAG,MAAM,IAAI,CAACjB,UAAU,CAACqB,OAAO,CAAC;IAChD,OAAOvD,MAAM,CAACmD,SAAS,EAAElD,QAAQ,CAACmD,SAAS,CAAC;EAC9C;AACF","ignoreList":[]}

package/es/account/Metamask.d.ts

@@ -0,0 +1,34 @@
+import type { BaseProvider } from '@metamask/providers';
+import AccountBase from './Base.js';
+import { Encoded } from '../utils/encoder.js';
+export declare const snapId = "npm:@aeternity-snap/plugin";
+export declare function invokeSnap<R>(provider: BaseProvider, method: string, params: unknown, key: string): Promise<R>;
+/**
+ * Account connected to Aeternity Snap for MetaMask
+ * https://www.npmjs.com/package/\@aeternity-snap/plugin
+ * @category account
+ */
+export default class AccountMetamask extends AccountBase {
+    /**
+     * @deprecated this class is not intended to provide raw access to the provider
+     */
+    readonly provider: BaseProvider;
+    readonly index: number;
+    readonly address: Encoded.AccountAddress;
+    /**
+     * @param address - Address of account
+     */
+    constructor(provider: BaseProvider, index: number, address: Encoded.AccountAddress);
+    /**
+     * @deprecated Use `unsafeSign` method instead
+     */
+    sign(): Promise<Uint8Array>;
+    unsafeSign(): Promise<Uint8Array>;
+    signTypedData(): Promise<Encoded.Signature>;
+    signDelegation(): Promise<Encoded.Signature>;
+    signTransaction(tx: Encoded.Transaction, { innerTx, networkId }?: {
+        innerTx?: boolean;
+        networkId?: string;
+    }): Promise<Encoded.Transaction>;
+    signMessage(message: string): Promise<Uint8Array>;
+}

package/es/account/Metamask.js

@@ -0,0 +1,89 @@
+import { Buffer as _Buffer } from "buffer";
+import AccountBase from './Base.js';
+import { ArgumentError, InternalError, NotImplementedError } from '../utils/errors.js';
+export const snapId = 'npm:@aeternity-snap/plugin';
+export async function invokeSnap(provider, method, params, key) {
+  const response = await provider.request({
+    method: 'wallet_invokeSnap',
+    params: {
+      snapId,
+      request: {
+        method,
+        params
+      }
+    }
+  });
+  if (response == null) throw new InternalError('Empty MetaMask response');
+  if (!(key in response)) {
+    throw new InternalError(`Key ${key} missed in response ${JSON.stringify(response)}`);
+  }
+  return response[key];
+}
+
+/**
+ * Account connected to Aeternity Snap for MetaMask
+ * https://www.npmjs.com/package/\@aeternity-snap/plugin
+ * @category account
+ */
+export default class AccountMetamask extends AccountBase {
+  /**
+   * @deprecated this class is not intended to provide raw access to the provider
+   */
+
+  /**
+   * @param address - Address of account
+   */
+  constructor(provider, index, address) {
+    super();
+    this.provider = provider;
+    this.index = index;
+    this.address = address;
+  }
+
+  /**
+   * @deprecated Use `unsafeSign` method instead
+   */
+  // eslint-disable-next-line class-methods-use-this
+  async sign() {
+    return this.unsafeSign();
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async unsafeSign() {
+    throw new NotImplementedError('RAW signing using MetaMask');
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async signTypedData() {
+    throw new NotImplementedError('Typed data signing using MetaMask');
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async signDelegation() {
+    throw new NotImplementedError('signing delegation using MetaMask');
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async signTransaction(tx, {
+    innerTx,
+    networkId
+  } = {}) {
+    if (innerTx != null) throw new NotImplementedError('innerTx option in AccountMetamask');
+    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);
+    return invokeSnap(this.provider, 'signTransaction', {
+      derivationPath: [`${this.index}'`, "0'", "0'"],
+      tx,
+      networkId
+    }, 'signedTx');
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async signMessage(message) {
+    const signature = await invokeSnap(this.provider, 'signMessage', {
+      derivationPath: [`${this.index}'`, "0'", "0'"],
+      message: _Buffer.from(message).toString('base64')
+    }, 'signature');
+    return _Buffer.from(signature, 'base64');
+  }
+}
+//# sourceMappingURL=Metamask.js.map

package/es/account/Metamask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metamask.js","names":["AccountBase","ArgumentError","InternalError","NotImplementedError","snapId","invokeSnap","provider","method","params","key","response","request","JSON","stringify","AccountMetamask","constructor","index","address","sign","unsafeSign","signTypedData","signDelegation","signTransaction","tx","innerTx","networkId","derivationPath","signMessage","message","signature","_Buffer","from","toString"],"sources":["../../src/account/Metamask.ts"],"sourcesContent":["import type { BaseProvider } from '@metamask/providers';\nimport AccountBase from './Base.js';\nimport { Encoded } from '../utils/encoder.js';\nimport { ArgumentError, InternalError, NotImplementedError } from '../utils/errors.js';\n\nexport const snapId = 'npm:@aeternity-snap/plugin';\n\nexport async function invokeSnap<R>(\n  provider: BaseProvider,\n  method: string,\n  params: unknown,\n  key: string,\n): Promise<R> {\n  const response = await provider.request<{ [k in string]: unknown }>({\n    method: 'wallet_invokeSnap',\n    params: { snapId, request: { method, params } },\n  });\n  if (response == null) throw new InternalError('Empty MetaMask response');\n  if (!(key in response)) {\n    throw new InternalError(`Key ${key} missed in response ${JSON.stringify(response)}`);\n  }\n  return response[key] as R;\n}\n\n/**\n * Account connected to Aeternity Snap for MetaMask\n * https://www.npmjs.com/package/\\@aeternity-snap/plugin\n * @category account\n */\nexport default class AccountMetamask extends AccountBase {\n  /**\n   * @deprecated this class is not intended to provide raw access to the provider\n   */\n  readonly provider: BaseProvider;\n\n  readonly index: number;\n\n  override readonly address: Encoded.AccountAddress;\n\n  /**\n   * @param address - Address of account\n   */\n  constructor(provider: BaseProvider, index: number, address: Encoded.AccountAddress) {\n    super();\n    this.provider = provider;\n    this.index = index;\n    this.address = address;\n  }\n\n  /**\n   * @deprecated Use `unsafeSign` method instead\n   */\n  // eslint-disable-next-line class-methods-use-this\n  override async sign(): Promise<Uint8Array> {\n    return this.unsafeSign();\n  }\n\n  // eslint-disable-next-line class-methods-use-this\n  override async unsafeSign(): Promise<Uint8Array> {\n    throw new NotImplementedError('RAW signing using MetaMask');\n  }\n\n  // eslint-disable-next-line class-methods-use-this\n  override async signTypedData(): Promise<Encoded.Signature> {\n    throw new NotImplementedError('Typed data signing using MetaMask');\n  }\n\n  // eslint-disable-next-line class-methods-use-this\n  override async signDelegation(): Promise<Encoded.Signature> {\n    throw new NotImplementedError('signing delegation using MetaMask');\n  }\n\n  // eslint-disable-next-line class-methods-use-this\n  override async signTransaction(\n    tx: Encoded.Transaction,\n    { innerTx, networkId }: { innerTx?: boolean; networkId?: string } = {},\n  ): Promise<Encoded.Transaction> {\n    if (innerTx != null) throw new NotImplementedError('innerTx option in AccountMetamask');\n    if (networkId == null) throw new ArgumentError('networkId', 'provided', networkId);\n\n    return invokeSnap<Encoded.Transaction>(\n      this.provider,\n      'signTransaction',\n      { derivationPath: [`${this.index}'`, \"0'\", \"0'\"], tx, networkId },\n      'signedTx',\n    );\n  }\n\n  // eslint-disable-next-line class-methods-use-this\n  override async signMessage(message: string): Promise<Uint8Array> {\n    const signature = await invokeSnap<string>(\n      this.provider,\n      'signMessage',\n      {\n        derivationPath: [`${this.index}'`, \"0'\", \"0'\"],\n        message: Buffer.from(message).toString('base64'),\n      },\n      'signature',\n    );\n    return Buffer.from(signature, 'base64');\n  }\n}\n"],"mappings":";AACA,OAAOA,WAAW,MAAM,WAAW;AAEnC,SAASC,aAAa,EAAEC,aAAa,EAAEC,mBAAmB,QAAQ,oBAAoB;AAEtF,OAAO,MAAMC,MAAM,GAAG,4BAA4B;AAElD,OAAO,eAAeC,UAAUA,CAC9BC,QAAsB,EACtBC,MAAc,EACdC,MAAe,EACfC,GAAW,EACC;EACZ,MAAMC,QAAQ,GAAG,MAAMJ,QAAQ,CAACK,OAAO,CAA6B;IAClEJ,MAAM,EAAE,mBAAmB;IAC3BC,MAAM,EAAE;MAAEJ,MAAM;MAAEO,OAAO,EAAE;QAAEJ,MAAM;QAAEC;MAAO;IAAE;EAChD,CAAC,CAAC;EACF,IAAIE,QAAQ,IAAI,IAAI,EAAE,MAAM,IAAIR,aAAa,CAAC,yBAAyB,CAAC;EACxE,IAAI,EAAEO,GAAG,IAAIC,QAAQ,CAAC,EAAE;IACtB,MAAM,IAAIR,aAAa,CAAC,OAAOO,GAAG,uBAAuBG,IAAI,CAACC,SAAS,CAACH,QAAQ,CAAC,EAAE,CAAC;EACtF;EACA,OAAOA,QAAQ,CAACD,GAAG,CAAC;AACtB;;AAEA;AACA;AACA;AACA;AACA;AACA,eAAe,MAAMK,eAAe,SAASd,WAAW,CAAC;EACvD;AACF;AACA;;EAOE;AACF;AACA;EACEe,WAAWA,CAACT,QAAsB,EAAEU,KAAa,EAAEC,OAA+B,EAAE;IAClF,KAAK,CAAC,CAAC;IACP,IAAI,CAACX,QAAQ,GAAGA,QAAQ;IACxB,IAAI,CAACU,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACC,OAAO,GAAGA,OAAO;EACxB;;EAEA;AACF;AACA;EACE;EACA,MAAeC,IAAIA,CAAA,EAAwB;IACzC,OAAO,IAAI,CAACC,UAAU,CAAC,CAAC;EAC1B;;EAEA;EACA,MAAeA,UAAUA,CAAA,EAAwB;IAC/C,MAAM,IAAIhB,mBAAmB,CAAC,4BAA4B,CAAC;EAC7D;;EAEA;EACA,MAAeiB,aAAaA,CAAA,EAA+B;IACzD,MAAM,IAAIjB,mBAAmB,CAAC,mCAAmC,CAAC;EACpE;;EAEA;EACA,MAAekB,cAAcA,CAAA,EAA+B;IAC1D,MAAM,IAAIlB,mBAAmB,CAAC,mCAAmC,CAAC;EACpE;;EAEA;EACA,MAAemB,eAAeA,CAC5BC,EAAuB,EACvB;IAAEC,OAAO;IAAEC;EAAqD,CAAC,GAAG,CAAC,CAAC,EACxC;IAC9B,IAAID,OAAO,IAAI,IAAI,EAAE,MAAM,IAAIrB,mBAAmB,CAAC,mCAAmC,CAAC;IACvF,IAAIsB,SAAS,IAAI,IAAI,EAAE,MAAM,IAAIxB,aAAa,CAAC,WAAW,EAAE,UAAU,EAAEwB,SAAS,CAAC;IAElF,OAAOpB,UAAU,CACf,IAAI,CAACC,QAAQ,EACb,iBAAiB,EACjB;MAAEoB,cAAc,EAAE,CAAC,GAAG,IAAI,CAACV,KAAK,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC;MAAEO,EAAE;MAAEE;IAAU,CAAC,EACjE,UACF,CAAC;EACH;;EAEA;EACA,MAAeE,WAAWA,CAACC,OAAe,EAAuB;IAC/D,MAAMC,SAAS,GAAG,MAAMxB,UAAU,CAChC,IAAI,CAACC,QAAQ,EACb,aAAa,EACb;MACEoB,cAAc,EAAE,CAAC,GAAG,IAAI,CAACV,KAAK,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC;MAC9CY,OAAO,EAAEE,OAAA,CAAOC,IAAI,CAACH,OAAO,CAAC,CAACI,QAAQ,CAAC,QAAQ;IACjD,CAAC,EACD,WACF,CAAC;IACD,OAAOF,OAAA,CAAOC,IAAI,CAACF,SAAS,EAAE,QAAQ,CAAC;EACzC;AACF","ignoreList":[]}

package/es/account/MetamaskFactory.d.ts

@@ -0,0 +1,58 @@
+import type { BaseProvider } from '@metamask/providers';
+import AccountBaseFactory from './BaseFactory.js';
+import AccountMetamask, { snapId } from './Metamask.js';
+interface SnapDetails {
+    blocked: boolean;
+    enabled: boolean;
+    id: typeof snapId;
+    version: string;
+    initialPermissions: Record<string, unknown>;
+}
+/**
+ * A factory class that generates instances of AccountMetamask.
+ * @see {@link https://www.npmjs.com/package/@aeternity-snap/plugin | Aeternity snap}
+ * @category account
+ */
+export default class AccountMetamaskFactory extends AccountBaseFactory {
+    #private;
+    /**
+     * @deprecated this class is not intended to provide raw access to the provider
+     */
+    get provider(): BaseProvider;
+    /**
+     * @param provider - Connection to MetaMask to use
+     */
+    constructor(provider?: BaseProvider);
+    /**
+     * Request MetaMask to install Aeternity snap.
+     * @deprecated use `requestSnap` instead
+     */
+    installSnap(): Promise<SnapDetails>;
+    /**
+     * Request MetaMask to install Aeternity snap or connect it to the current aepp.
+     * MetaMask can have only one Aeternity snap version installed at a time.
+     * This method is intended to upgrade the snap to a specified version if needed by the aepp.
+     * If Aeternity snap is installed but wasn't used by the aepp, then the user still needs to approve the connection.
+     * If the currently installed version corresponds to the version range, then the snap won't be upgraded.
+     * To downgrade the snap, the user must manually uninstall the current version.
+     * @param version - Snap version range (e.g. `1`, `0.1.*`, `^0.0.9`, `~0.0.9`; `>=0.0.9 <0.1.0`)
+     * (default: a version range supported by sdk)
+     */
+    requestSnap(version?: string): Promise<SnapDetails>;
+    /**
+     * It throws an exception if MetaMask or Aeternity snap has an incompatible version or is not
+     * installed or is not connected to the aepp.
+     * @deprecated use `requestSnap` instead
+     */
+    ensureReady(): Promise<void>;
+    /**
+     * @returns the version of snap installed in MetaMask
+     */
+    getSnapVersion(): Promise<string>;
+    /**
+     * Get an instance of AccountMetaMask for a given account index.
+     * @param accountIndex - Index of account
+     */
+    initialize(accountIndex: number): Promise<AccountMetamask>;
+}
+export {};

package/es/account/MetamaskFactory.js

@@ -0,0 +1,164 @@
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+import { InternalError, UnsupportedPlatformError, UnsupportedVersionError } from '../utils/errors.js';
+import semverSatisfies from '../utils/semver-satisfies.js';
+import AccountBaseFactory from './BaseFactory.js';
+import AccountMetamask, { invokeSnap, snapId } from './Metamask.js';
+const snapMinVersion = '0.0.9';
+const snapMaxVersion = '0.1.0';
+const metamaskVersionPrefix = 'MetaMask/v';
+var _provider = /*#__PURE__*/new WeakMap();
+var _AccountMetamaskFactory_brand = /*#__PURE__*/new WeakSet();
+var _providerPromise = /*#__PURE__*/new WeakMap();
+/**
+ * A factory class that generates instances of AccountMetamask.
+ * @see {@link https://www.npmjs.com/package/@aeternity-snap/plugin | Aeternity snap}
+ * @category account
+ */
+export default class AccountMetamaskFactory extends AccountBaseFactory {
+  /**
+   * @deprecated this class is not intended to provide raw access to the provider
+   */
+  get provider() {
+    if (_classPrivateFieldGet(_provider, this) == null) throw new UnsupportedPlatformError('Metamask is not detected yet');
+    return _classPrivateFieldGet(_provider, this);
+  }
+  /**
+   * @param provider - Connection to MetaMask to use
+   */
+  constructor(_provider2) {
+    super();
+    _classPrivateMethodInitSpec(this, _AccountMetamaskFactory_brand);
+    // TODO: remove after removing `provider`
+    _classPrivateFieldInitSpec(this, _provider, void 0);
+    _classPrivateFieldInitSpec(this, _providerPromise, void 0);
+    _classPrivateFieldSet(_provider, this, _provider2);
+    if (_classPrivateFieldGet(_provider, this) == null && window == null) {
+      throw new UnsupportedPlatformError('Window object not found, you can run AccountMetamaskFactory only in browser or setup a provider');
+    }
+  }
+
+  /**
+   * Request MetaMask to install Aeternity snap.
+   * @deprecated use `requestSnap` instead
+   */
+  async installSnap() {
+    const provider = await _assertClassBrand(_AccountMetamaskFactory_brand, this, _getProvider).call(this);
+    const details = await provider.request({
+      method: 'wallet_requestSnaps',
+      params: {
+        [snapId]: {
+          version: snapMinVersion
+        }
+      }
+    });
+    return details[snapId];
+  }
+
+  /**
+   * Request MetaMask to install Aeternity snap or connect it to the current aepp.
+   * MetaMask can have only one Aeternity snap version installed at a time.
+   * This method is intended to upgrade the snap to a specified version if needed by the aepp.
+   * If Aeternity snap is installed but wasn't used by the aepp, then the user still needs to approve the connection.
+   * If the currently installed version corresponds to the version range, then the snap won't be upgraded.
+   * To downgrade the snap, the user must manually uninstall the current version.
+   * @param version - Snap version range (e.g. `1`, `0.1.*`, `^0.0.9`, `~0.0.9`; `>=0.0.9 <0.1.0`)
+   * (default: a version range supported by sdk)
+   */
+  async requestSnap(version = `>=${snapMinVersion} <${snapMaxVersion}`) {
+    const provider = await _assertClassBrand(_AccountMetamaskFactory_brand, this, _getProvider).call(this);
+    const details = await provider.request({
+      method: 'wallet_requestSnaps',
+      params: {
+        [snapId]: {
+          version
+        }
+      }
+    });
+    return details[snapId];
+  }
+
+  /**
+   * It throws an exception if MetaMask or Aeternity snap has an incompatible version or is not
+   * installed or is not connected to the aepp.
+   * @deprecated use `requestSnap` instead
+   */
+  async ensureReady() {
+    const snapVersion = await this.getSnapVersion();
+    const args = [snapVersion, snapMinVersion, snapMaxVersion];
+    if (!semverSatisfies(...args)) throw new UnsupportedVersionError('Aeternity snap in MetaMask', ...args);
+  }
+
+  /**
+   * @returns the version of snap installed in MetaMask
+   */
+  async getSnapVersion() {
+    const provider = await _assertClassBrand(_AccountMetamaskFactory_brand, this, _getProvider).call(this);
+    const snaps = await provider.request({
+      method: 'wallet_getSnaps'
+    });
+    const version = snaps[snapId]?.version;
+    if (version == null) throw new UnsupportedPlatformError('Aeternity snap is not installed to MetaMask or not connected to this aepp');
+    return version;
+  }
+
+  /**
+   * Get an instance of AccountMetaMask for a given account index.
+   * @param accountIndex - Index of account
+   */
+  async initialize(accountIndex) {
+    await this.requestSnap();
+    const provider = await _assertClassBrand(_AccountMetamaskFactory_brand, this, _getProvider).call(this);
+    const address = await invokeSnap(provider, 'getPublicKey', {
+      derivationPath: [`${accountIndex}'`, "0'", "0'"]
+    }, 'publicKey');
+    return new AccountMetamask(provider, accountIndex, address);
+  }
+}
+async function _getMetamaskAsInjected() {
+  if (!('ethereum' in window) || window.ethereum == null) return;
+  const provider = window.ethereum;
+  const version = await provider.request({
+    method: 'web3_clientVersion'
+  });
+  if (version == null) throw new InternalError("Can't get Ethereum Provider version");
+  if (!version.startsWith(metamaskVersionPrefix)) return;
+  return provider;
+}
+async function _getMetamaskOverEip() {
+  setTimeout(() => window.dispatchEvent(new Event('eip6963:requestProvider')));
+  return new Promise(resolve => {
+    const handler = event => {
+      if (event.detail.info.rdns !== 'io.metamask') return;
+      window.removeEventListener('eip6963:announceProvider', handler);
+      resolve(event.detail.provider);
+    };
+    window.addEventListener('eip6963:announceProvider', handler);
+    setTimeout(() => {
+      window.removeEventListener('eip6963:announceProvider', handler);
+      resolve(undefined);
+    }, 500);
+  });
+}
+async function _getProvider() {
+  var _classPrivateFieldGet2;
+  (_classPrivateFieldGet2 = _classPrivateFieldGet(_providerPromise, this)) !== null && _classPrivateFieldGet2 !== void 0 ? _classPrivateFieldGet2 : _classPrivateFieldSet(_providerPromise, this, (async (_classPrivateFieldGet3, _await$_assertClassBr) => {
+    (_classPrivateFieldGet3 = _classPrivateFieldGet(_provider, this)) !== null && _classPrivateFieldGet3 !== void 0 ? _classPrivateFieldGet3 : _classPrivateFieldSet(_provider, this, (_await$_assertClassBr = await _assertClassBrand(_AccountMetamaskFactory_brand, this, _getMetamaskAsInjected).call(this)) !== null && _await$_assertClassBr !== void 0 ? _await$_assertClassBr : await _assertClassBrand(_AccountMetamaskFactory_brand, this, _getMetamaskOverEip).call(this));
+    if (_classPrivateFieldGet(_provider, this) == null) {
+      throw new UnsupportedPlatformError("Can't find a Metamask extension as an injected provider and over EIP-6963. Ensure that Metamask is installed or setup a provider.");
+    }
+    const version = await _classPrivateFieldGet(_provider, this).request({
+      method: 'web3_clientVersion'
+    });
+    if (version == null) throw new InternalError("Can't get Ethereum Provider version");
+    const args = [version.slice(metamaskVersionPrefix.length), '12.2.4'];
+    if (!semverSatisfies(...args)) throw new UnsupportedVersionError('Metamask', ...args);
+    return _classPrivateFieldGet(_provider, this);
+  })());
+  return _classPrivateFieldGet(_providerPromise, this);
+}
+//# sourceMappingURL=MetamaskFactory.js.map