@aeternity/aepp-sdk 14.0.0 → 14.1.0

package/es/account/Memory.js.map

@@ -1 +1 @@
-{"version":3,"file":"Memory.js","names":["nacl","AccountBase","hash","messageToHash","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","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, messageToHash, 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 */\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  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  override async sign(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.sign(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.sign(messageToHash(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.sign(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.sign(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,aAAa,EAAEC,mBAAmB,QAAQ,oBAAoB;AAC7E,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;AAFA,IAAAI,iBAAA,oBAAAC,OAAA;AAGA,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;EACA,MAAeG,IAAIA,CAACS,IAAyB,EAAEC,OAAa,EAAuB;IACjF,OAAOxC,IAAI,CAAC8B,IAAI,CAACW,QAAQ,CAACrB,OAAA,CAAOC,IAAI,CAACkB,IAAI,CAAC,EAAEG,qBAAA,CAAKnB,iBAAiB,EAAtB,IAAqB,CAAC,CAAC;EACtE;EAEA,MAAeoB,eAAeA,CAC5B7B,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,MAAM8B,eAAe,GAAG/B,eAAe,CAACC,WAAW,EAAEC,SAAS,EAAEC,OAAO,KAAK,IAAI,CAAC;IAEjF,MAAM6B,UAAU,GAAG,CAAC,MAAM,IAAI,CAACf,IAAI,CAACc,eAAe,EAAEJ,OAAO,CAAC,CAAC;IAC9D,OAAO7B,OAAO,CAAC;MAAEmC,GAAG,EAAElC,GAAG,CAACmC,QAAQ;MAAEC,SAAS,EAAE7B,WAAW;MAAE0B;IAAW,CAAC,CAAC;EAC3E;EAEA,MAAeI,WAAWA,CAACC,OAAe,EAAEV,OAAa,EAAuB;IAC9E,OAAO,IAAI,CAACV,IAAI,CAAC3B,aAAa,CAAC+C,OAAO,CAAC,EAAEV,OAAO,CAAC;EACnD;EAEA,MAAeW,aAAaA,CAC1BZ,IAA+B,EAC/Ba,GAAa,EACb;IACEC,IAAI;IACJC,OAAO;IACPvC,SAAS;IACTwC,eAAe;IACf,GAAGf;EACwC,CAAC,GAAG,CAAC,CAAC,EACvB;IAC5B,MAAMgB,KAAK,GAAG9C,aAAa,CAAC6B,IAAI,EAAEa,GAAG,EAAE;MACrCC,IAAI;MACJC,OAAO;MACPvC,SAAS;MACTwC;IACF,CAAC,CAAC;IACF,MAAME,SAAS,GAAG,MAAM,IAAI,CAAC3B,IAAI,CAAC0B,KAAK,EAAEhB,OAAO,CAAC;IACjD,OAAOjC,MAAM,CAACkD,SAAS,EAAEjD,QAAQ,CAACkD,SAAS,CAAC;EAC9C;EAEA,MAAeC,cAAcA,CAC3BC,UAA6B,EAC7B;IAAE7C;EAAkC,CAAC,GAAG,CAAC,CAAC,EACd;IAC5B,IAAIA,SAAS,IAAI,IAAI,EAAE,MAAM,IAAIV,aAAa,CAAC,WAAW,EAAE,UAAU,EAAEU,SAAS,CAAC;IAClF,MAAM8C,OAAO,GAAGpD,aAAa,CAAC,CAC5BL,mBAAmB,EACnB,IAAI0D,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EACnB1C,OAAA,CAAOC,IAAI,CAACN,SAAS,CAAC,EACtBT,MAAM,CAACsD,UAAU,CAAC,CACnB,CAAC;IACF,MAAMH,SAAS,GAAG,MAAM,IAAI,CAAC3B,IAAI,CAAC+B,OAAO,CAAC;IAC1C,OAAOtD,MAAM,CAACkD,SAAS,EAAEjD,QAAQ,CAACkD,SAAS,CAAC;EAC9C;AACF","ignoreList":[]}
+{"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

@@ -6,8 +6,12 @@ export declare function invokeSnap<R>(provider: BaseProvider, method: string, pa
 /**
  * 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;
@@ -15,7 +19,11 @@ export default class AccountMetamask extends AccountBase {
      * @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 }?: {

package/es/account/Metamask.js

@@ -23,8 +23,13 @@ export async function invokeSnap(provider, method, params, 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
    */
@@ -35,8 +40,16 @@ export default class AccountMetamask extends AccountBase {
     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');
   }
 

package/es/account/Metamask.js.map

@@ -1 +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","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 */\nexport default class AccountMetamask extends AccountBase {\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  // eslint-disable-next-line class-methods-use-this\n  override async sign(): 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,eAAe,MAAMK,eAAe,SAASd,WAAW,CAAC;EAOvD;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;EACA,MAAeC,IAAIA,CAAA,EAAwB;IACzC,MAAM,IAAIf,mBAAmB,CAAC,4BAA4B,CAAC;EAC7D;;EAEA;EACA,MAAegB,aAAaA,CAAA,EAA+B;IACzD,MAAM,IAAIhB,mBAAmB,CAAC,mCAAmC,CAAC;EACpE;;EAEA;EACA,MAAeiB,cAAcA,CAAA,EAA+B;IAC1D,MAAM,IAAIjB,mBAAmB,CAAC,mCAAmC,CAAC;EACpE;;EAEA;EACA,MAAekB,eAAeA,CAC5BC,EAAuB,EACvB;IAAEC,OAAO;IAAEC;EAAqD,CAAC,GAAG,CAAC,CAAC,EACxC;IAC9B,IAAID,OAAO,IAAI,IAAI,EAAE,MAAM,IAAIpB,mBAAmB,CAAC,mCAAmC,CAAC;IACvF,IAAIqB,SAAS,IAAI,IAAI,EAAE,MAAM,IAAIvB,aAAa,CAAC,WAAW,EAAE,UAAU,EAAEuB,SAAS,CAAC;IAElF,OAAOnB,UAAU,CACf,IAAI,CAACC,QAAQ,EACb,iBAAiB,EACjB;MAAEmB,cAAc,EAAE,CAAC,GAAG,IAAI,CAACT,KAAK,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC;MAAEM,EAAE;MAAEE;IAAU,CAAC,EACjE,UACF,CAAC;EACH;;EAEA;EACA,MAAeE,WAAWA,CAACC,OAAe,EAAuB;IAC/D,MAAMC,SAAS,GAAG,MAAMvB,UAAU,CAChC,IAAI,CAACC,QAAQ,EACb,aAAa,EACb;MACEmB,cAAc,EAAE,CAAC,GAAG,IAAI,CAACT,KAAK,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC;MAC9CW,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":[]}
+{"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

@@ -10,21 +10,39 @@ interface SnapDetails {
 }
 /**
  * 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;
-    readonly provider: BaseProvider;
+    /**
+     * @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.
+     * installed or is not connected to the aepp.
+     * @deprecated use `requestSnap` instead
      */
     ensureReady(): Promise<void>;
     /**

package/es/account/MetamaskFactory.js

@@ -1,8 +1,8 @@
-function _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
 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 _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';
@@ -10,40 +10,45 @@ 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 _ensureReadyPromise = /*#__PURE__*/new WeakMap();
+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(provider) {
+  constructor(_provider2) {
     super();
-    /**
-     * It throws an exception if MetaMask has an incompatible version.
-     */
     _classPrivateMethodInitSpec(this, _AccountMetamaskFactory_brand);
-    _classPrivateFieldInitSpec(this, _ensureReadyPromise, void 0);
-    if (provider != null) {
-      this.provider = provider;
-      return;
-    }
-    if (window == null) {
+    // 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');
     }
-    if (!('ethereum' in window) || window.ethereum == null) {
-      throw new UnsupportedPlatformError('`ethereum` object not found, you can run AccountMetamaskFactory only with Metamask enabled or setup a provider');
-    }
-    this.provider = window.ethereum;
   }
+
   /**
    * Request MetaMask to install Aeternity snap.
+   * @deprecated use `requestSnap` instead
    */
   async installSnap() {
-    await _assertClassBrand(_AccountMetamaskFactory_brand, this, _ensureMetamaskSupported).call(this);
-    const details = await this.provider.request({
+    const provider = await _assertClassBrand(_AccountMetamaskFactory_brand, this, _getProvider).call(this);
+    const details = await provider.request({
       method: 'wallet_requestSnaps',
       params: {
         [snapId]: {
@@ -51,30 +56,53 @@ export default class AccountMetamaskFactory extends AccountBaseFactory {
         }
       }
     });
-    _classPrivateFieldSet(_ensureReadyPromise, this, Promise.resolve());
+    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.
+   * 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);
-    _classPrivateFieldSet(_ensureReadyPromise, this, Promise.resolve());
   }
+
   /**
    * @returns the version of snap installed in MetaMask
    */
   async getSnapVersion() {
-    await _assertClassBrand(_AccountMetamaskFactory_brand, this, _ensureMetamaskSupported).call(this);
-    const snaps = await this.provider.request({
+    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');
+    if (version == null) throw new UnsupportedPlatformError('Aeternity snap is not installed to MetaMask or not connected to this aepp');
     return version;
   }
 
@@ -83,28 +111,54 @@ export default class AccountMetamaskFactory extends AccountBaseFactory {
    * @param accountIndex - Index of account
    */
   async initialize(accountIndex) {
-    await _assertClassBrand(_AccountMetamaskFactory_brand, this, _ensureReady).call(this);
-    const address = await invokeSnap(this.provider, 'getPublicKey', {
+    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(this.provider, accountIndex, address);
+    return new AccountMetamask(provider, accountIndex, address);
   }
 }
-async function _ensureMetamaskSupported() {
-  const version = await this.provider.request({
+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");
-  const metamaskPrefix = 'MetaMask/v';
-  if (!version.startsWith(metamaskPrefix)) {
-    throw new UnsupportedPlatformError(`Expected Metamask, got ${version} instead`);
-  }
-  const args = [version.slice(metamaskPrefix.length), '12.2.4'];
-  if (!semverSatisfies(...args)) throw new UnsupportedVersionError('Metamask', ...args);
+  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 _ensureReady() {
+async function _getProvider() {
   var _classPrivateFieldGet2;
-  (_classPrivateFieldGet2 = _classPrivateFieldGet(_ensureReadyPromise, this)) !== null && _classPrivateFieldGet2 !== void 0 ? _classPrivateFieldGet2 : _classPrivateFieldSet(_ensureReadyPromise, this, this.ensureReady());
-  return _classPrivateFieldGet(_ensureReadyPromise, this);
+  (_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

package/es/account/MetamaskFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"MetamaskFactory.js","names":["InternalError","UnsupportedPlatformError","UnsupportedVersionError","semverSatisfies","AccountBaseFactory","AccountMetamask","invokeSnap","snapId","snapMinVersion","snapMaxVersion","_AccountMetamaskFactory_brand","WeakSet","_ensureReadyPromise","WeakMap","AccountMetamaskFactory","constructor","provider","_classPrivateMethodInitSpec","_classPrivateFieldInitSpec","window","ethereum","installSnap","_assertClassBrand","_ensureMetamaskSupported","call","details","request","method","params","version","_classPrivateFieldSet","Promise","resolve","ensureReady","snapVersion","getSnapVersion","args","snaps","initialize","accountIndex","_ensureReady","address","derivationPath","metamaskPrefix","startsWith","slice","length","_classPrivateFieldGet2","_classPrivateFieldGet"],"sources":["../../src/account/MetamaskFactory.ts"],"sourcesContent":["import type { BaseProvider } from '@metamask/providers';\nimport {\n  InternalError,\n  UnsupportedPlatformError,\n  UnsupportedVersionError,\n} from '../utils/errors.js';\nimport { Encoded } from '../utils/encoder.js';\nimport semverSatisfies from '../utils/semver-satisfies.js';\nimport AccountBaseFactory from './BaseFactory.js';\nimport AccountMetamask, { invokeSnap, snapId } from './Metamask.js';\n\nconst snapMinVersion = '0.0.9';\nconst snapMaxVersion = '0.1.0';\n\ninterface SnapDetails {\n  blocked: boolean;\n  enabled: boolean;\n  id: typeof snapId;\n  version: string;\n  initialPermissions: Record<string, unknown>;\n}\n\n/**\n * A factory class that generates instances of AccountMetamask.\n */\nexport default class AccountMetamaskFactory extends AccountBaseFactory {\n  readonly provider: BaseProvider;\n\n  /**\n   * @param provider - Connection to MetaMask to use\n   */\n  constructor(provider?: BaseProvider) {\n    super();\n    if (provider != null) {\n      this.provider = provider;\n      return;\n    }\n    if (window == null) {\n      throw new UnsupportedPlatformError(\n        'Window object not found, you can run AccountMetamaskFactory only in browser or setup a provider',\n      );\n    }\n    if (!('ethereum' in window) || window.ethereum == null) {\n      throw new UnsupportedPlatformError(\n        '`ethereum` object not found, you can run AccountMetamaskFactory only with Metamask enabled or setup a provider',\n      );\n    }\n    this.provider = window.ethereum as BaseProvider;\n  }\n\n  /**\n   * It throws an exception if MetaMask has an incompatible version.\n   */\n  async #ensureMetamaskSupported(): Promise<void> {\n    const version = await this.provider.request<string>({ method: 'web3_clientVersion' });\n    if (version == null) throw new InternalError(\"Can't get Ethereum Provider version\");\n    const metamaskPrefix = 'MetaMask/v';\n    if (!version.startsWith(metamaskPrefix)) {\n      throw new UnsupportedPlatformError(`Expected Metamask, got ${version} instead`);\n    }\n    const args = [version.slice(metamaskPrefix.length), '12.2.4'] as const;\n    if (!semverSatisfies(...args)) throw new UnsupportedVersionError('Metamask', ...args);\n  }\n\n  #ensureReadyPromise?: Promise<void>;\n\n  /**\n   * Request MetaMask to install Aeternity snap.\n   */\n  async installSnap(): Promise<SnapDetails> {\n    await this.#ensureMetamaskSupported();\n    const details = (await this.provider.request({\n      method: 'wallet_requestSnaps',\n      params: { [snapId]: { version: snapMinVersion } },\n    })) as { [key in typeof snapId]: SnapDetails };\n    this.#ensureReadyPromise = Promise.resolve();\n    return details[snapId];\n  }\n\n  /**\n   * It throws an exception if MetaMask or Aeternity snap has an incompatible version or is not\n   * installed.\n   */\n  async ensureReady(): Promise<void> {\n    const snapVersion = await this.getSnapVersion();\n    const args = [snapVersion, snapMinVersion, snapMaxVersion] as const;\n    if (!semverSatisfies(...args))\n      throw new UnsupportedVersionError('Aeternity snap in MetaMask', ...args);\n    this.#ensureReadyPromise = Promise.resolve();\n  }\n\n  async #ensureReady(): Promise<void> {\n    this.#ensureReadyPromise ??= this.ensureReady();\n    return this.#ensureReadyPromise;\n  }\n\n  /**\n   * @returns the version of snap installed in MetaMask\n   */\n  async getSnapVersion(): Promise<string> {\n    await this.#ensureMetamaskSupported();\n    const snaps = (await this.provider.request({ method: 'wallet_getSnaps' })) as Record<\n      string,\n      { version: string }\n    >;\n    const version = snaps[snapId]?.version;\n    if (version == null)\n      throw new UnsupportedPlatformError('Aeternity snap is not installed to MetaMask');\n    return version;\n  }\n\n  /**\n   * Get an instance of AccountMetaMask for a given account index.\n   * @param accountIndex - Index of account\n   */\n  async initialize(accountIndex: number): Promise<AccountMetamask> {\n    await this.#ensureReady();\n    const address = await invokeSnap<Encoded.AccountAddress>(\n      this.provider,\n      'getPublicKey',\n      { derivationPath: [`${accountIndex}'`, \"0'\", \"0'\"] },\n      'publicKey',\n    );\n    return new AccountMetamask(this.provider, accountIndex, address);\n  }\n}\n"],"mappings":";;;;;;AACA,SACEA,aAAa,EACbC,wBAAwB,EACxBC,uBAAuB,QAClB,oBAAoB;AAE3B,OAAOC,eAAe,MAAM,8BAA8B;AAC1D,OAAOC,kBAAkB,MAAM,kBAAkB;AACjD,OAAOC,eAAe,IAAIC,UAAU,EAAEC,MAAM,QAAQ,eAAe;AAEnE,MAAMC,cAAc,GAAG,OAAO;AAC9B,MAAMC,cAAc,GAAG,OAAO;AAAC,IAAAC,6BAAA,oBAAAC,OAAA;AAAA,IAAAC,mBAAA,oBAAAC,OAAA;AAU/B;AACA;AACA;AACA,eAAe,MAAMC,sBAAsB,SAASV,kBAAkB,CAAC;EAGrE;AACF;AACA;EACEW,WAAWA,CAACC,QAAuB,EAAE;IACnC,KAAK,CAAC,CAAC;IAkBT;AACF;AACA;IAFEC,2BAAA,OAAAP,6BAAA;IAcAQ,0BAAA,OAAAN,mBAAmB;IA/BjB,IAAII,QAAQ,IAAI,IAAI,EAAE;MACpB,IAAI,CAACA,QAAQ,GAAGA,QAAQ;MACxB;IACF;IACA,IAAIG,MAAM,IAAI,IAAI,EAAE;MAClB,MAAM,IAAIlB,wBAAwB,CAChC,iGACF,CAAC;IACH;IACA,IAAI,EAAE,UAAU,IAAIkB,MAAM,CAAC,IAAIA,MAAM,CAACC,QAAQ,IAAI,IAAI,EAAE;MACtD,MAAM,IAAInB,wBAAwB,CAChC,gHACF,CAAC;IACH;IACA,IAAI,CAACe,QAAQ,GAAGG,MAAM,CAACC,QAAwB;EACjD;EAkBA;AACF;AACA;EACE,MAAMC,WAAWA,CAAA,EAAyB;IACxC,MAAMC,iBAAA,CAAAZ,6BAAA,MAAI,EAACa,wBAAuB,CAAC,CAAAC,IAAA,CAA7B,IAAI,CAA2B;IACrC,MAAMC,OAAO,GAAI,MAAM,IAAI,CAACT,QAAQ,CAACU,OAAO,CAAC;MAC3CC,MAAM,EAAE,qBAAqB;MAC7BC,MAAM,EAAE;QAAE,CAACrB,MAAM,GAAG;UAAEsB,OAAO,EAAErB;QAAe;MAAE;IAClD,CAAC,CAA6C;IAC9CsB,qBAAA,CAAKlB,mBAAmB,EAAxB,IAAI,EAAuBmB,OAAO,CAACC,OAAO,CAAC,CAApB,CAAC;IACxB,OAAOP,OAAO,CAAClB,MAAM,CAAC;EACxB;;EAEA;AACF;AACA;AACA;EACE,MAAM0B,WAAWA,CAAA,EAAkB;IACjC,MAAMC,WAAW,GAAG,MAAM,IAAI,CAACC,cAAc,CAAC,CAAC;IAC/C,MAAMC,IAAI,GAAG,CAACF,WAAW,EAAE1B,cAAc,EAAEC,cAAc,CAAU;IACnE,IAAI,CAACN,eAAe,CAAC,GAAGiC,IAAI,CAAC,EAC3B,MAAM,IAAIlC,uBAAuB,CAAC,4BAA4B,EAAE,GAAGkC,IAAI,CAAC;IAC1EN,qBAAA,CAAKlB,mBAAmB,EAAxB,IAAI,EAAuBmB,OAAO,CAACC,OAAO,CAAC,CAApB,CAAC;EAC1B;EAOA;AACF;AACA;EACE,MAAMG,cAAcA,CAAA,EAAoB;IACtC,MAAMb,iBAAA,CAAAZ,6BAAA,MAAI,EAACa,wBAAuB,CAAC,CAAAC,IAAA,CAA7B,IAAI,CAA2B;IACrC,MAAMa,KAAK,GAAI,MAAM,IAAI,CAACrB,QAAQ,CAACU,OAAO,CAAC;MAAEC,MAAM,EAAE;IAAkB,CAAC,CAGvE;IACD,MAAME,OAAO,GAAGQ,KAAK,CAAC9B,MAAM,CAAC,EAAEsB,OAAO;IACtC,IAAIA,OAAO,IAAI,IAAI,EACjB,MAAM,IAAI5B,wBAAwB,CAAC,6CAA6C,CAAC;IACnF,OAAO4B,OAAO;EAChB;;EAEA;AACF;AACA;AACA;EACE,MAAMS,UAAUA,CAACC,YAAoB,EAA4B;IAC/D,MAAMjB,iBAAA,CAAAZ,6BAAA,MAAI,EAAC8B,YAAW,CAAC,CAAAhB,IAAA,CAAjB,IAAI,CAAe;IACzB,MAAMiB,OAAO,GAAG,MAAMnC,UAAU,CAC9B,IAAI,CAACU,QAAQ,EACb,cAAc,EACd;MAAE0B,cAAc,EAAE,CAAC,GAAGH,YAAY,GAAG,EAAE,IAAI,EAAE,IAAI;IAAE,CAAC,EACpD,WACF,CAAC;IACD,OAAO,IAAIlC,eAAe,CAAC,IAAI,CAACW,QAAQ,EAAEuB,YAAY,EAAEE,OAAO,CAAC;EAClE;AACF;AAAC,eAAAlB,yBAAA,EAxEiD;EAC9C,MAAMM,OAAO,GAAG,MAAM,IAAI,CAACb,QAAQ,CAACU,OAAO,CAAS;IAAEC,MAAM,EAAE;EAAqB,CAAC,CAAC;EACrF,IAAIE,OAAO,IAAI,IAAI,EAAE,MAAM,IAAI7B,aAAa,CAAC,qCAAqC,CAAC;EACnF,MAAM2C,cAAc,GAAG,YAAY;EACnC,IAAI,CAACd,OAAO,CAACe,UAAU,CAACD,cAAc,CAAC,EAAE;IACvC,MAAM,IAAI1C,wBAAwB,CAAC,0BAA0B4B,OAAO,UAAU,CAAC;EACjF;EACA,MAAMO,IAAI,GAAG,CAACP,OAAO,CAACgB,KAAK,CAACF,cAAc,CAACG,MAAM,CAAC,EAAE,QAAQ,CAAU;EACtE,IAAI,CAAC3C,eAAe,CAAC,GAAGiC,IAAI,CAAC,EAAE,MAAM,IAAIlC,uBAAuB,CAAC,UAAU,EAAE,GAAGkC,IAAI,CAAC;AACvF;AAAC,eAAAI,aAAA,EA6BmC;EAAA,IAAAO,sBAAA;EAClC,CAAAA,sBAAA,GAAAC,qBAAA,CAAKpC,mBAAmB,EAAxB,IAAuB,CAAC,cAAAmC,sBAAA,cAAAA,sBAAA,GAAxBjB,qBAAA,CAAKlB,mBAAmB,EAAxB,IAAI,EAAyB,IAAI,CAACqB,WAAW,CAAC,CAAvB,CAAC;EACxB,OAAOe,qBAAA,CAAKpC,mBAAmB,EAAxB,IAAuB,CAAC;AACjC","ignoreList":[]}
+{"version":3,"file":"MetamaskFactory.js","names":["InternalError","UnsupportedPlatformError","UnsupportedVersionError","semverSatisfies","AccountBaseFactory","AccountMetamask","invokeSnap","snapId","snapMinVersion","snapMaxVersion","metamaskVersionPrefix","_provider","WeakMap","_AccountMetamaskFactory_brand","WeakSet","_providerPromise","AccountMetamaskFactory","provider","_classPrivateFieldGet","constructor","_classPrivateMethodInitSpec","_classPrivateFieldInitSpec","_classPrivateFieldSet","window","installSnap","_assertClassBrand","_getProvider","call","details","request","method","params","version","requestSnap","ensureReady","snapVersion","getSnapVersion","args","snaps","initialize","accountIndex","address","derivationPath","_getMetamaskAsInjected","ethereum","startsWith","_getMetamaskOverEip","setTimeout","dispatchEvent","Event","Promise","resolve","handler","event","detail","info","rdns","removeEventListener","addEventListener","undefined","_classPrivateFieldGet2","_classPrivateFieldGet3","_await$_assertClassBr","slice","length"],"sources":["../../src/account/MetamaskFactory.ts"],"sourcesContent":["import type { BaseProvider } from '@metamask/providers';\nimport {\n  InternalError,\n  UnsupportedPlatformError,\n  UnsupportedVersionError,\n} from '../utils/errors.js';\nimport { Encoded } from '../utils/encoder.js';\nimport semverSatisfies from '../utils/semver-satisfies.js';\nimport AccountBaseFactory from './BaseFactory.js';\nimport AccountMetamask, { invokeSnap, snapId } from './Metamask.js';\n\nconst snapMinVersion = '0.0.9';\nconst snapMaxVersion = '0.1.0';\nconst metamaskVersionPrefix = 'MetaMask/v';\n\ninterface SnapDetails {\n  blocked: boolean;\n  enabled: boolean;\n  id: typeof snapId;\n  version: string;\n  initialPermissions: Record<string, unknown>;\n}\n\n/**\n * A factory class that generates instances of AccountMetamask.\n * @see {@link https://www.npmjs.com/package/@aeternity-snap/plugin | Aeternity snap}\n * @category account\n */\nexport default class AccountMetamaskFactory extends AccountBaseFactory {\n  // TODO: remove after removing `provider`\n  #provider: BaseProvider | undefined;\n\n  /**\n   * @deprecated this class is not intended to provide raw access to the provider\n   */\n  get provider(): BaseProvider {\n    if (this.#provider == null) throw new UnsupportedPlatformError('Metamask is not detected yet');\n    return this.#provider;\n  }\n\n  async #getMetamaskAsInjected(): Promise<BaseProvider | undefined> {\n    if (!('ethereum' in window) || window.ethereum == null) return;\n    const provider = window.ethereum as BaseProvider;\n    const version = await provider.request<string>({ method: 'web3_clientVersion' });\n    if (version == null) throw new InternalError(\"Can't get Ethereum Provider version\");\n    if (!version.startsWith(metamaskVersionPrefix)) return;\n    return provider;\n  }\n\n  async #getMetamaskOverEip6963(): Promise<BaseProvider | undefined> {\n    setTimeout(() => window.dispatchEvent(new Event('eip6963:requestProvider')));\n    return new Promise<BaseProvider | undefined>((resolve) => {\n      const handler = (\n        event: CustomEvent<{ info: { rdns: string }; provider: BaseProvider }>,\n      ): void => {\n        if (event.detail.info.rdns !== 'io.metamask') return;\n        window.removeEventListener('eip6963:announceProvider', handler);\n        resolve(event.detail.provider);\n      };\n      window.addEventListener('eip6963:announceProvider', handler);\n      setTimeout(() => {\n        window.removeEventListener('eip6963:announceProvider', handler);\n        resolve(undefined);\n      }, 500);\n    });\n  }\n\n  #providerPromise: Promise<BaseProvider> | undefined;\n\n  async #getProvider(): Promise<BaseProvider> {\n    this.#providerPromise ??= (async () => {\n      this.#provider ??=\n        (await this.#getMetamaskAsInjected()) ?? (await this.#getMetamaskOverEip6963());\n      if (this.#provider == null) {\n        throw new UnsupportedPlatformError(\n          \"Can't find a Metamask extension as an injected provider and over EIP-6963. Ensure that Metamask is installed or setup a provider.\",\n        );\n      }\n      const version = await this.#provider.request<string>({ method: 'web3_clientVersion' });\n      if (version == null) throw new InternalError(\"Can't get Ethereum Provider version\");\n      const args = [version.slice(metamaskVersionPrefix.length), '12.2.4'] as const;\n      if (!semverSatisfies(...args)) throw new UnsupportedVersionError('Metamask', ...args);\n      return this.#provider;\n    })();\n    return this.#providerPromise;\n  }\n\n  /**\n   * @param provider - Connection to MetaMask to use\n   */\n  constructor(provider?: BaseProvider) {\n    super();\n    this.#provider = provider;\n    if (this.#provider == null && window == null) {\n      throw new UnsupportedPlatformError(\n        'Window object not found, you can run AccountMetamaskFactory only in browser or setup a provider',\n      );\n    }\n  }\n\n  /**\n   * Request MetaMask to install Aeternity snap.\n   * @deprecated use `requestSnap` instead\n   */\n  async installSnap(): Promise<SnapDetails> {\n    const provider = await this.#getProvider();\n    const details = (await provider.request({\n      method: 'wallet_requestSnaps',\n      params: { [snapId]: { version: snapMinVersion } },\n    })) as { [key in typeof snapId]: SnapDetails };\n    return details[snapId];\n  }\n\n  /**\n   * Request MetaMask to install Aeternity snap or connect it to the current aepp.\n   * MetaMask can have only one Aeternity snap version installed at a time.\n   * This method is intended to upgrade the snap to a specified version if needed by the aepp.\n   * If Aeternity snap is installed but wasn't used by the aepp, then the user still needs to approve the connection.\n   * If the currently installed version corresponds to the version range, then the snap won't be upgraded.\n   * To downgrade the snap, the user must manually uninstall the current version.\n   * @param version - Snap version range (e.g. `1`, `0.1.*`, `^0.0.9`, `~0.0.9`; `>=0.0.9 <0.1.0`)\n   * (default: a version range supported by sdk)\n   */\n  async requestSnap(version = `>=${snapMinVersion} <${snapMaxVersion}`): Promise<SnapDetails> {\n    const provider = await this.#getProvider();\n    const details = (await provider.request({\n      method: 'wallet_requestSnaps',\n      params: { [snapId]: { version } },\n    })) as { [key in typeof snapId]: SnapDetails };\n    return details[snapId];\n  }\n\n  /**\n   * It throws an exception if MetaMask or Aeternity snap has an incompatible version or is not\n   * installed or is not connected to the aepp.\n   * @deprecated use `requestSnap` instead\n   */\n  async ensureReady(): Promise<void> {\n    const snapVersion = await this.getSnapVersion();\n    const args = [snapVersion, snapMinVersion, snapMaxVersion] as const;\n    if (!semverSatisfies(...args))\n      throw new UnsupportedVersionError('Aeternity snap in MetaMask', ...args);\n  }\n\n  /**\n   * @returns the version of snap installed in MetaMask\n   */\n  async getSnapVersion(): Promise<string> {\n    const provider = await this.#getProvider();\n    const snaps = (await provider.request({ method: 'wallet_getSnaps' })) as Record<\n      string,\n      { version: string }\n    >;\n    const version = snaps[snapId]?.version;\n    if (version == null)\n      throw new UnsupportedPlatformError(\n        'Aeternity snap is not installed to MetaMask or not connected to this aepp',\n      );\n    return version;\n  }\n\n  /**\n   * Get an instance of AccountMetaMask for a given account index.\n   * @param accountIndex - Index of account\n   */\n  async initialize(accountIndex: number): Promise<AccountMetamask> {\n    await this.requestSnap();\n    const provider = await this.#getProvider();\n    const address = await invokeSnap<Encoded.AccountAddress>(\n      provider,\n      'getPublicKey',\n      { derivationPath: [`${accountIndex}'`, \"0'\", \"0'\"] },\n      'publicKey',\n    );\n    return new AccountMetamask(provider, accountIndex, address);\n  }\n}\n"],"mappings":";;;;;;AACA,SACEA,aAAa,EACbC,wBAAwB,EACxBC,uBAAuB,QAClB,oBAAoB;AAE3B,OAAOC,eAAe,MAAM,8BAA8B;AAC1D,OAAOC,kBAAkB,MAAM,kBAAkB;AACjD,OAAOC,eAAe,IAAIC,UAAU,EAAEC,MAAM,QAAQ,eAAe;AAEnE,MAAMC,cAAc,GAAG,OAAO;AAC9B,MAAMC,cAAc,GAAG,OAAO;AAC9B,MAAMC,qBAAqB,GAAG,YAAY;AAAC,IAAAC,SAAA,oBAAAC,OAAA;AAAA,IAAAC,6BAAA,oBAAAC,OAAA;AAAA,IAAAC,gBAAA,oBAAAH,OAAA;AAU3C;AACA;AACA;AACA;AACA;AACA,eAAe,MAAMI,sBAAsB,SAASZ,kBAAkB,CAAC;EAIrE;AACF;AACA;EACE,IAAIa,QAAQA,CAAA,EAAiB;IAC3B,IAAIC,qBAAA,CAAKP,SAAS,EAAd,IAAa,CAAC,IAAI,IAAI,EAAE,MAAM,IAAIV,wBAAwB,CAAC,8BAA8B,CAAC;IAC9F,OAAOiB,qBAAA,CAAKP,SAAS,EAAd,IAAa,CAAC;EACvB;EAiDA;AACF;AACA;EACEQ,WAAWA,CAACF,UAAuB,EAAE;IACnC,KAAK,CAAC,CAAC;IAACG,2BAAA,OAAAP,6BAAA;IA9DV;IACAQ,0BAAA,OAAAV,SAAS;IAqCTU,0BAAA,OAAAN,gBAAgB;IAyBdO,qBAAA,CAAKX,SAAS,EAAd,IAAI,EAAaM,UAAJ,CAAC;IACd,IAAIC,qBAAA,CAAKP,SAAS,EAAd,IAAa,CAAC,IAAI,IAAI,IAAIY,MAAM,IAAI,IAAI,EAAE;MAC5C,MAAM,IAAItB,wBAAwB,CAChC,iGACF,CAAC;IACH;EACF;;EAEA;AACF;AACA;AACA;EACE,MAAMuB,WAAWA,CAAA,EAAyB;IACxC,MAAMP,QAAQ,GAAG,MAAMQ,iBAAA,CAAAZ,6BAAA,MAAI,EAACa,YAAW,CAAC,CAAAC,IAAA,CAAjB,IAAI,CAAe;IAC1C,MAAMC,OAAO,GAAI,MAAMX,QAAQ,CAACY,OAAO,CAAC;MACtCC,MAAM,EAAE,qBAAqB;MAC7BC,MAAM,EAAE;QAAE,CAACxB,MAAM,GAAG;UAAEyB,OAAO,EAAExB;QAAe;MAAE;IAClD,CAAC,CAA6C;IAC9C,OAAOoB,OAAO,CAACrB,MAAM,CAAC;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAM0B,WAAWA,CAACD,OAAO,GAAG,KAAKxB,cAAc,KAAKC,cAAc,EAAE,EAAwB;IAC1F,MAAMQ,QAAQ,GAAG,MAAMQ,iBAAA,CAAAZ,6BAAA,MAAI,EAACa,YAAW,CAAC,CAAAC,IAAA,CAAjB,IAAI,CAAe;IAC1C,MAAMC,OAAO,GAAI,MAAMX,QAAQ,CAACY,OAAO,CAAC;MACtCC,MAAM,EAAE,qBAAqB;MAC7BC,MAAM,EAAE;QAAE,CAACxB,MAAM,GAAG;UAAEyB;QAAQ;MAAE;IAClC,CAAC,CAA6C;IAC9C,OAAOJ,OAAO,CAACrB,MAAM,CAAC;EACxB;;EAEA;AACF;AACA;AACA;AACA;EACE,MAAM2B,WAAWA,CAAA,EAAkB;IACjC,MAAMC,WAAW,GAAG,MAAM,IAAI,CAACC,cAAc,CAAC,CAAC;IAC/C,MAAMC,IAAI,GAAG,CAACF,WAAW,EAAE3B,cAAc,EAAEC,cAAc,CAAU;IACnE,IAAI,CAACN,eAAe,CAAC,GAAGkC,IAAI,CAAC,EAC3B,MAAM,IAAInC,uBAAuB,CAAC,4BAA4B,EAAE,GAAGmC,IAAI,CAAC;EAC5E;;EAEA;AACF;AACA;EACE,MAAMD,cAAcA,CAAA,EAAoB;IACtC,MAAMnB,QAAQ,GAAG,MAAMQ,iBAAA,CAAAZ,6BAAA,MAAI,EAACa,YAAW,CAAC,CAAAC,IAAA,CAAjB,IAAI,CAAe;IAC1C,MAAMW,KAAK,GAAI,MAAMrB,QAAQ,CAACY,OAAO,CAAC;MAAEC,MAAM,EAAE;IAAkB,CAAC,CAGlE;IACD,MAAME,OAAO,GAAGM,KAAK,CAAC/B,MAAM,CAAC,EAAEyB,OAAO;IACtC,IAAIA,OAAO,IAAI,IAAI,EACjB,MAAM,IAAI/B,wBAAwB,CAChC,2EACF,CAAC;IACH,OAAO+B,OAAO;EAChB;;EAEA;AACF;AACA;AACA;EACE,MAAMO,UAAUA,CAACC,YAAoB,EAA4B;IAC/D,MAAM,IAAI,CAACP,WAAW,CAAC,CAAC;IACxB,MAAMhB,QAAQ,GAAG,MAAMQ,iBAAA,CAAAZ,6BAAA,MAAI,EAACa,YAAW,CAAC,CAAAC,IAAA,CAAjB,IAAI,CAAe;IAC1C,MAAMc,OAAO,GAAG,MAAMnC,UAAU,CAC9BW,QAAQ,EACR,cAAc,EACd;MAAEyB,cAAc,EAAE,CAAC,GAAGF,YAAY,GAAG,EAAE,IAAI,EAAE,IAAI;IAAE,CAAC,EACpD,WACF,CAAC;IACD,OAAO,IAAInC,eAAe,CAACY,QAAQ,EAAEuB,YAAY,EAAEC,OAAO,CAAC;EAC7D;AACF;AAAC,eAAAE,uBAAA,EAxImE;EAChE,IAAI,EAAE,UAAU,IAAIpB,MAAM,CAAC,IAAIA,MAAM,CAACqB,QAAQ,IAAI,IAAI,EAAE;EACxD,MAAM3B,QAAQ,GAAGM,MAAM,CAACqB,QAAwB;EAChD,MAAMZ,OAAO,GAAG,MAAMf,QAAQ,CAACY,OAAO,CAAS;IAAEC,MAAM,EAAE;EAAqB,CAAC,CAAC;EAChF,IAAIE,OAAO,IAAI,IAAI,EAAE,MAAM,IAAIhC,aAAa,CAAC,qCAAqC,CAAC;EACnF,IAAI,CAACgC,OAAO,CAACa,UAAU,CAACnC,qBAAqB,CAAC,EAAE;EAChD,OAAOO,QAAQ;AACjB;AAAC,eAAA6B,oBAAA,EAEkE;EACjEC,UAAU,CAAC,MAAMxB,MAAM,CAACyB,aAAa,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC,CAAC;EAC5E,OAAO,IAAIC,OAAO,CAA4BC,OAAO,IAAK;IACxD,MAAMC,OAAO,GACXC,KAAsE,IAC7D;MACT,IAAIA,KAAK,CAACC,MAAM,CAACC,IAAI,CAACC,IAAI,KAAK,aAAa,EAAE;MAC9CjC,MAAM,CAACkC,mBAAmB,CAAC,0BAA0B,EAAEL,OAAO,CAAC;MAC/DD,OAAO,CAACE,KAAK,CAACC,MAAM,CAACrC,QAAQ,CAAC;IAChC,CAAC;IACDM,MAAM,CAACmC,gBAAgB,CAAC,0BAA0B,EAAEN,OAAO,CAAC;IAC5DL,UAAU,CAAC,MAAM;MACfxB,MAAM,CAACkC,mBAAmB,CAAC,0BAA0B,EAAEL,OAAO,CAAC;MAC/DD,OAAO,CAACQ,SAAS,CAAC;IACpB,CAAC,EAAE,GAAG,CAAC;EACT,CAAC,CAAC;AACJ;AAAC,eAAAjC,aAAA,EAI2C;EAAA,IAAAkC,sBAAA;EAC1C,CAAAA,sBAAA,GAAA1C,qBAAA,CAAKH,gBAAgB,EAArB,IAAoB,CAAC,cAAA6C,sBAAA,cAAAA,sBAAA,GAArBtC,qBAAA,CAAKP,gBAAgB,EAArB,IAAI,EAAsB,CAAC,OAAA8C,sBAAA,EAAAC,qBAAA,KAAY;IACrC,CAAAD,sBAAA,GAAA3C,qBAAA,CAAKP,SAAS,EAAd,IAAa,CAAC,cAAAkD,sBAAA,cAAAA,sBAAA,GAAdvC,qBAAA,CAAKX,SAAS,EAAd,IAAI,GAAAmD,qBAAA,GACD,MAAMrC,iBAAA,CAAAZ,6BAAA,MAAI,EAAC8B,sBAAqB,CAAC,CAAAhB,IAAA,CAA3B,IAAI,CAAyB,cAAAmC,qBAAA,cAAAA,qBAAA,GAAM,MAAMrC,iBAAA,CAAAZ,6BAAA,MAAI,EAACiC,mBAAsB,CAAC,CAAAnB,IAAA,CAA5B,IAAI,CADzC,CAAC;IAEd,IAAIT,qBAAA,CAAKP,SAAS,EAAd,IAAa,CAAC,IAAI,IAAI,EAAE;MAC1B,MAAM,IAAIV,wBAAwB,CAChC,mIACF,CAAC;IACH;IACA,MAAM+B,OAAO,GAAG,MAAMd,qBAAA,CAAKP,SAAS,EAAd,IAAa,CAAC,CAACkB,OAAO,CAAS;MAAEC,MAAM,EAAE;IAAqB,CAAC,CAAC;IACtF,IAAIE,OAAO,IAAI,IAAI,EAAE,MAAM,IAAIhC,aAAa,CAAC,qCAAqC,CAAC;IACnF,MAAMqC,IAAI,GAAG,CAACL,OAAO,CAAC+B,KAAK,CAACrD,qBAAqB,CAACsD,MAAM,CAAC,EAAE,QAAQ,CAAU;IAC7E,IAAI,CAAC7D,eAAe,CAAC,GAAGkC,IAAI,CAAC,EAAE,MAAM,IAAInC,uBAAuB,CAAC,UAAU,EAAE,GAAGmC,IAAI,CAAC;IACrF,OAAOnB,qBAAA,CAAKP,SAAS,EAAd,IAAa,CAAC;EACvB,CAAC,EAAE,CAbiB,CAAC;EAcrB,OAAOO,qBAAA,CAAKH,gBAAgB,EAArB,IAAoB,CAAC;AAC9B","ignoreList":[]}

package/es/account/MnemonicFactory.d.ts

@@ -14,22 +14,32 @@ interface Wallet {
 }
 /**
  * A factory class that generates instances of AccountMemory based on provided mnemonic phrase.
+ * @category account
  */
 export default class AccountMnemonicFactory extends AccountBaseFactory {
     #private;
     /**
-     * @param mnemonicOrWallet - BIP39-compatible mnemonic phrase or a wallet derived from mnemonic
+     * @param mnemonicOrWalletOrSeed - BIP39-compatible mnemonic phrase or a wallet/seed derived from
+     * mnemonic
      */
-    constructor(mnemonicOrWallet: string | Wallet);
+    constructor(mnemonicOrWalletOrSeed: string | Wallet | Uint8Array);
     /**
      * Get a wallet to initialize AccountMnemonicFactory instead mnemonic phrase.
      * In comparison with mnemonic, the wallet can be used to derive aeternity accounts only.
      */
     getWallet(): Promise<Wallet>;
+    /**
+     * The same as `getWallet` but synchronous.
+     */
+    getWalletSync(): Wallet;
     /**
      * Get an instance of AccountMemory for a given account index.
      * @param accountIndex - Index of account
      */
     initialize(accountIndex: number): Promise<AccountMemory>;
+    /**
+     * The same as `initialize` but synchronous.
+     */
+    initializeSync(accountIndex: number): AccountMemory;
 }
 export {};

package/es/account/MnemonicFactory.js

@@ -5,13 +5,13 @@ function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("C
 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 { mnemonicToSeed } from '@scure/bip39';
+import { mnemonicToSeed, mnemonicToSeedSync } from '@scure/bip39';
 import tweetnaclAuth from 'tweetnacl-auth';
 import AccountBaseFactory from './BaseFactory.js';
 import AccountMemory from './Memory.js';
 import { encode, Encoding, decode } from '../utils/encoder.js';
 import { concatBuffers } from '../utils/other.js';
-import { InternalError } from '../utils/errors.js';
+import { ArgumentError } from '../utils/errors.js';
 export const ED25519_CURVE = _Buffer.from('ed25519 seed');
 const HARDENED_OFFSET = 0x80000000;
 export function deriveKey(message, key) {
@@ -34,55 +34,79 @@ export function derivePathFromKey(key, segments) {
     return deriveKey(data, chainCode);
   }, key);
 }
-var _mnemonic = /*#__PURE__*/new WeakMap();
-var _wallet = /*#__PURE__*/new WeakMap();
+var _mnemonicOrWalletOrSeed = /*#__PURE__*/new WeakMap();
 var _AccountMnemonicFactory_brand = /*#__PURE__*/new WeakSet();
 /**
  * A factory class that generates instances of AccountMemory based on provided mnemonic phrase.
+ * @category account
  */
 export default class AccountMnemonicFactory extends AccountBaseFactory {
   /**
-   * @param mnemonicOrWallet - BIP39-compatible mnemonic phrase or a wallet derived from mnemonic
+   * @param mnemonicOrWalletOrSeed - BIP39-compatible mnemonic phrase or a wallet/seed derived from
+   * mnemonic
    */
-  constructor(mnemonicOrWallet) {
+  constructor(mnemonicOrWalletOrSeed) {
     super();
     _classPrivateMethodInitSpec(this, _AccountMnemonicFactory_brand);
-    _classPrivateFieldInitSpec(this, _mnemonic, void 0);
-    _classPrivateFieldInitSpec(this, _wallet, void 0);
-    if (typeof mnemonicOrWallet === 'string') _classPrivateFieldSet(_mnemonic, this, mnemonicOrWallet);else _classPrivateFieldSet(_wallet, this, mnemonicOrWallet);
+    _classPrivateFieldInitSpec(this, _mnemonicOrWalletOrSeed, void 0);
+    _classPrivateFieldSet(_mnemonicOrWalletOrSeed, this, mnemonicOrWalletOrSeed);
   }
-
   /**
    * Get a wallet to initialize AccountMnemonicFactory instead mnemonic phrase.
    * In comparison with mnemonic, the wallet can be used to derive aeternity accounts only.
    */
   async getWallet() {
-    if (_classPrivateFieldGet(_wallet, this) != null) return _classPrivateFieldGet(_wallet, this);
-    if (_classPrivateFieldGet(_mnemonic, this) == null) throw new InternalError('AccountMnemonicFactory should be initialized with mnemonic or wallet');
-    const seed = await mnemonicToSeed(_classPrivateFieldGet(_mnemonic, this));
-    const masterKey = deriveKey(seed, ED25519_CURVE);
-    const walletKey = derivePathFromKey(masterKey, [44, 457]);
-    _classPrivateFieldSet(_wallet, this, {
-      secretKey: encode(walletKey.secretKey, Encoding.Bytearray),
-      chainCode: encode(walletKey.chainCode, Encoding.Bytearray)
-    });
-    return _classPrivateFieldGet(_wallet, this);
+    return _assertClassBrand(_AccountMnemonicFactory_brand, this, _getWallet).call(this, false);
+  }
+
+  /**
+   * The same as `getWallet` but synchronous.
+   */
+  getWalletSync() {
+    return _assertClassBrand(_AccountMnemonicFactory_brand, this, _getWallet).call(this, true);
   }
   /**
    * Get an instance of AccountMemory for a given account index.
    * @param accountIndex - Index of account
    */
   async initialize(accountIndex) {
-    return new AccountMemory(await _assertClassBrand(_AccountMnemonicFactory_brand, this, _getAccountSecretKey).call(this, accountIndex));
+    const wallet = await this.getWallet();
+    return _assertClassBrand(_AccountMnemonicFactory_brand, this, _getAccountByWallet).call(this, accountIndex, wallet);
+  }
+
+  /**
+   * The same as `initialize` but synchronous.
+   */
+  initializeSync(accountIndex) {
+    const wallet = this.getWalletSync();
+    return _assertClassBrand(_AccountMnemonicFactory_brand, this, _getAccountByWallet).call(this, accountIndex, wallet);
+  }
+}
+function _getWallet(sync) {
+  const setWalletBySeed = seed => {
+    const masterKey = deriveKey(seed, ED25519_CURVE);
+    const walletKey = derivePathFromKey(masterKey, [44, 457]);
+    _classPrivateFieldSet(_mnemonicOrWalletOrSeed, this, {
+      secretKey: encode(walletKey.secretKey, Encoding.Bytearray),
+      chainCode: encode(walletKey.chainCode, Encoding.Bytearray)
+    });
+    return _classPrivateFieldGet(_mnemonicOrWalletOrSeed, this);
+  };
+  if (ArrayBuffer.isView(_classPrivateFieldGet(_mnemonicOrWalletOrSeed, this))) {
+    if (_classPrivateFieldGet(_mnemonicOrWalletOrSeed, this).length !== 64) {
+      throw new ArgumentError('seed length', 64, _classPrivateFieldGet(_mnemonicOrWalletOrSeed, this).length);
+    }
+    return setWalletBySeed(_classPrivateFieldGet(_mnemonicOrWalletOrSeed, this));
   }
+  if (typeof _classPrivateFieldGet(_mnemonicOrWalletOrSeed, this) === 'object') return _classPrivateFieldGet(_mnemonicOrWalletOrSeed, this);
+  return sync ? setWalletBySeed(mnemonicToSeedSync(_classPrivateFieldGet(_mnemonicOrWalletOrSeed, this))) : mnemonicToSeed(_classPrivateFieldGet(_mnemonicOrWalletOrSeed, this)).then(setWalletBySeed);
 }
-async function _getAccountSecretKey(accountIndex) {
-  const wallet = await this.getWallet();
+function _getAccountByWallet(accountIndex, wallet) {
   const walletKey = {
     secretKey: decode(wallet.secretKey),
     chainCode: decode(wallet.chainCode)
   };
   const raw = derivePathFromKey(walletKey, [accountIndex, 0, 0]).secretKey;
-  return encode(raw, Encoding.AccountSecretKey);
+  return new AccountMemory(encode(raw, Encoding.AccountSecretKey));
 }
 //# sourceMappingURL=MnemonicFactory.js.map