@prosopo/keyring 2.6.4 → 2.8.7

package/dist/cjs/keyring/keyring.cjs

@@ -0,0 +1,271 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const util = require("@polkadot/util");
+const hex = require("@polkadot/util/hex");
+const is = require("@polkadot/util/is");
+const utilCrypto = require("@prosopo/util-crypto");
+const index = require("../pair/index.cjs");
+const pairs = require("./pairs.cjs");
+const DEV_PHRASE = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
+const PairFromSeed = {
+  sr25519: (seed) => utilCrypto.sr25519FromSeed(seed),
+  ed25519: () => {
+    throw new Error("Not Implemented");
+  },
+  ecdsa: () => {
+    throw new Error("Not Implemented");
+  },
+  ethereum: () => {
+    throw new Error("Not Implemented");
+  }
+};
+function pairToPublic({ publicKey }) {
+  return publicKey;
+}
+class Keyring {
+  constructor(options = {}) {
+    this.decodeAddress = utilCrypto.decodeAddress;
+    this.encodeAddress = (address, ss58Format) => {
+      return utilCrypto.encodeAddress(address, ss58Format ?? this.#ss58);
+    };
+    options.type = options.type || "sr25519";
+    if (!["sr25519"].includes(options.type || "undefined")) {
+      throw new Error(
+        `Expected a keyring type of either 'sr25519', found '${options.type || "unknown"}`
+      );
+    }
+    this.#pairs = new pairs.Pairs();
+    this.#ss58 = options.ss58Format;
+    this.#type = options.type;
+  }
+  #pairs;
+  #type;
+  #ss58;
+  /**
+   * @description retrieve the pairs (alias for getPairs)
+   */
+  get pairs() {
+    return this.getPairs();
+  }
+  /**
+   * @description retrieve the publicKeys (alias for getPublicKeys)
+   */
+  get publicKeys() {
+    return this.getPublicKeys();
+  }
+  /**
+   * @description Returns the type of the keyring, ed25519, sr25519 or ecdsa
+   */
+  get type() {
+    return this.#type;
+  }
+  /**
+   * @name addPair
+   * @summary Stores an account, given a keyring pair, as a Key/Value (public key, pair) in Keyring Pair Dictionary
+   */
+  addPair(pair) {
+    return this.#pairs.add(pair);
+  }
+  /**
+   * @name addFromAddress
+   * @summary Stores an account, given an account address, as a Key/Value (public key, pair) in Keyring Pair Dictionary
+   * @description Allows user to explicitly provide separate inputs including account address or public key, and optionally
+   * the associated account metadata, and the default encoded value as arguments (that may be obtained from the json file
+   * of an account backup), and then generates a keyring pair from them that it passes to
+   * `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
+   */
+  addFromAddress(address, meta = {}, encoded = null, type = this.type, ignoreChecksum, encType) {
+    const publicKey = this.decodeAddress(address, ignoreChecksum);
+    return this.addPair(
+      index.createPair(
+        { toSS58: this.encodeAddress, type },
+        { publicKey, secretKey: new Uint8Array() },
+        meta,
+        encoded,
+        encType
+      )
+    );
+  }
+  /**
+   * @name addFromJson
+   * @summary Stores an account, given JSON data, as a Key/Value (public key, pair) in Keyring Pair Dictionary
+   * @description Allows user to provide a json object argument that contains account information (that may be obtained from the json file
+   * of an account backup), and then generates a keyring pair from it that it passes to
+   * `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
+   */
+  addFromJson(json, ignoreChecksum) {
+    return this.addPair(this.createFromJson(json, ignoreChecksum));
+  }
+  /**
+   * @name addFromMnemonic
+   * @summary Stores an account, given a mnemonic, as a Key/Value (public key, pair) in Keyring Pair Dictionary
+   * @description Allows user to provide a mnemonic (seed phrase that is provided when account is originally created)
+   * argument and a metadata argument that contains account information (that may be obtained from the json file
+   * of an account backup), and then generates a keyring pair from it that it passes to
+   * `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
+   */
+  addFromMnemonic(mnemonic, meta = {}, type = this.type) {
+    return this.addFromUri(mnemonic, meta, type);
+  }
+  /**
+   * @name addFromPair
+   * @summary Stores an account created from an explicit publicKey/secreteKey combination
+   */
+  addFromPair(pair, meta = {}, type = this.type) {
+    return this.addPair(this.createFromPair(pair, meta, type));
+  }
+  /**
+   * @name addFromSeed
+   * @summary Stores an account, given seed data, as a Key/Value (public key, pair) in Keyring Pair Dictionary
+   * @description Stores in a keyring pair dictionary the public key of the pair as a key and the pair as the associated value.
+   * Allows user to provide the account seed as an argument, and then generates a keyring pair from it that it passes to
+   * `addPair` to store in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
+   */
+  addFromSeed(seed, meta = {}, type = this.type) {
+    return this.addPair(
+      index.createPair(
+        { toSS58: this.encodeAddress, type },
+        PairFromSeed[type](seed),
+        meta,
+        null
+      )
+    );
+  }
+  /**
+   * @name addFromUri
+   * @summary Creates an account via an suri
+   * @description Extracts the phrase, path and password from a SURI format for specifying secret keys `<secret>/<soft-key>//<hard-key>///<password>` (the `///password` may be omitted, and `/<soft-key>` and `//<hard-key>` maybe repeated and mixed). The secret can be a hex string, mnemonic phrase or a string (to be padded)
+   */
+  addFromUri(suri, meta = {}, type = this.type) {
+    return this.addPair(this.createFromUri(suri, meta, type));
+  }
+  /**
+   * @name createFromJson
+   * @description Creates a pair from a JSON keyfile
+   */
+  createFromJson({
+    address,
+    encoded,
+    encoding: { content, type, version },
+    meta
+  }, ignoreChecksum) {
+    if (version === "3" && content[0] !== "pkcs8") {
+      throw new Error(
+        `Unable to decode non-pkcs8 type, [${content.join(",")}] found}`
+      );
+    }
+    const cryptoType = version === "0" || !Array.isArray(content) ? this.type : content[1];
+    if (!cryptoType) {
+      throw new Error("cryptoType is undefined");
+    }
+    const encType = !Array.isArray(type) ? [type] : type;
+    if (!["sr25519"].includes(cryptoType)) {
+      throw new Error(`Unknown crypto type ${cryptoType}`);
+    }
+    const publicKey = is.isHex(address) ? hex.hexToU8a(address) : this.decodeAddress(address, ignoreChecksum);
+    const decoded = is.isHex(encoded) ? hex.hexToU8a(encoded) : utilCrypto.base64Decode(encoded);
+    return index.createPair(
+      { toSS58: this.encodeAddress, type: cryptoType },
+      { publicKey, secretKey: new Uint8Array() },
+      meta,
+      decoded,
+      encType
+    );
+  }
+  /**
+   * @name createFromPair
+   * @summary Creates a pair from an explicit publicKey/secreteKey combination
+   */
+  createFromPair(pair, meta = {}, type = this.type) {
+    return index.createPair({ toSS58: this.encodeAddress, type }, pair, meta, null);
+  }
+  /**
+   * @name createFromUri
+   * @summary Creates a Keypair from an suri
+   * @description This creates a pair from the suri, but does not add it to the keyring
+   */
+  createFromUri(_suri, meta = {}, type = this.type) {
+    const suri = _suri.startsWith("//") ? `${DEV_PHRASE}${_suri}` : _suri;
+    const { derivePath, password, path, phrase } = utilCrypto.keyExtractSuri(suri);
+    let seed;
+    const isPhraseHex = is.isHex(phrase, 256);
+    if (isPhraseHex) {
+      seed = hex.hexToU8a(phrase);
+    } else {
+      const parts = phrase.split(" ");
+      if ([12, 15, 18, 21, 24].includes(parts.length)) {
+        seed = type === "ethereum" ? (() => {
+          throw new Error(
+            "Not implemented - Prosopo Keyring supports sr25519 only"
+          );
+        })() : utilCrypto.mnemonicToMiniSecret(phrase, password);
+      } else {
+        if (phrase.length > 32) {
+          throw new Error(
+            "specified phrase is not a valid mnemonic and is invalid as a raw seed at > 32 bytes"
+          );
+        }
+        seed = util.stringToU8a(phrase.padEnd(32));
+      }
+    }
+    const derived = utilCrypto.keyFromPath(PairFromSeed[type](seed), path, type);
+    return index.createPair(
+      { toSS58: this.encodeAddress, type },
+      derived,
+      meta,
+      null
+    );
+  }
+  /**
+   * @name getPair
+   * @summary Retrieves an account keyring pair from the Keyring Pair Dictionary, given an account address
+   * @description Returns a keyring pair value from the keyring pair dictionary by performing
+   * a key lookup using the provided account address or public key (after decoding it).
+   */
+  getPair(address) {
+    return this.#pairs.get(address);
+  }
+  /**
+   * @name getPairs
+   * @summary Retrieves all account keyring pairs from the Keyring Pair Dictionary
+   * @description Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary.
+   */
+  getPairs() {
+    return this.#pairs.all();
+  }
+  /**
+   * @name getPublicKeys
+   * @summary Retrieves Public Keys of all Keyring Pairs stored in the Keyring Pair Dictionary
+   * @description Returns an array list of all the public keys associated with each of the keyring pair values that are stored in the keyring pair dictionary.
+   */
+  getPublicKeys() {
+    return this.#pairs.all().map(pairToPublic);
+  }
+  /**
+   * @name removePair
+   * @description Deletes the provided input address or public key from the stored Keyring Pair Dictionary.
+   */
+  removePair(address) {
+    this.#pairs.remove(address);
+  }
+  /**
+   * @name setSS58Format;
+   * @description Sets the ss58 format for the keyring
+   */
+  setSS58Format(ss58) {
+    this.#ss58 = ss58;
+  }
+  /**
+   * @name toJson
+   * @summary Returns a JSON object associated with the input argument that contains metadata assocated with an account
+   * @description Returns a JSON object containing the metadata associated with an account
+   * when valid address or public key and when the account passphrase is provided if the account secret
+   * is not already unlocked and available in memory. Note that in [Polkadot-JS Apps](https://github.com/polkadot-js/apps) the user
+   * may backup their account to a JSON file that contains this information.
+   */
+  toJson(address, passphrase) {
+    return this.#pairs.get(address).toJson(passphrase);
+  }
+}
+exports.DEV_PHRASE = DEV_PHRASE;
+exports.Keyring = Keyring;

package/dist/cjs/keyring/pairs.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const util$1 = require("@polkadot/util");
+const util = require("@prosopo/util");
+const utilCrypto = require("@prosopo/util-crypto");
+class Pairs {
+  #map = {};
+  add(pair) {
+    this.#map[utilCrypto.decodeAddress(pair.address).toString()] = pair;
+    return pair;
+  }
+  all() {
+    return Object.values(this.#map);
+  }
+  get(address) {
+    const pair = this.#map[utilCrypto.decodeAddress(address).toString()];
+    if (!pair) {
+      throw new Error(
+        `Unable to retrieve keypair '${util$1.isU8a(address) || util$1.isHex(address) ? util.u8aToHex(util$1.u8aToU8a(address)) : address}'`
+      );
+    }
+    return pair;
+  }
+  remove(address) {
+    delete this.#map[utilCrypto.decodeAddress(address).toString()];
+  }
+}
+exports.Pairs = Pairs;

package/dist/cjs/pair/decode.cjs

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const util = require("@polkadot/util");
+const utilCrypto = require("@prosopo/util-crypto");
+const defaults = require("./defaults.cjs");
+const SEED_OFFSET = defaults.PAIR_HDR.length;
+function decodePair(passphrase, encrypted, _encType) {
+  const encType = Array.isArray(_encType) || _encType === void 0 ? _encType : [_encType];
+  const decrypted = utilCrypto.jsonDecryptData(encrypted, passphrase, encType);
+  const header = decrypted.subarray(0, defaults.PAIR_HDR.length);
+  if (!util.u8aEq(header, defaults.PAIR_HDR)) {
+    throw new Error("Invalid encoding header found in body");
+  }
+  let secretKey = decrypted.subarray(SEED_OFFSET, SEED_OFFSET + defaults.SEC_LENGTH);
+  let divOffset = SEED_OFFSET + defaults.SEC_LENGTH;
+  let divider = decrypted.subarray(divOffset, divOffset + defaults.PAIR_DIV.length);
+  if (!util.u8aEq(divider, defaults.PAIR_DIV)) {
+    divOffset = SEED_OFFSET + defaults.SEED_LENGTH;
+    secretKey = decrypted.subarray(SEED_OFFSET, divOffset);
+    divider = decrypted.subarray(divOffset, divOffset + defaults.PAIR_DIV.length);
+    if (!util.u8aEq(divider, defaults.PAIR_DIV)) {
+      throw new Error("Invalid encoding divider found in body");
+    }
+  }
+  const pubOffset = divOffset + defaults.PAIR_DIV.length;
+  const publicKey = decrypted.subarray(pubOffset, pubOffset + defaults.PUB_LENGTH);
+  return {
+    publicKey,
+    secretKey
+  };
+}
+exports.decodePair = decodePair;

package/dist/cjs/pair/defaults.cjs

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const PAIR_DIV = new Uint8Array([161, 35, 3, 33, 0]);
+const PAIR_HDR = new Uint8Array([
+  48,
+  83,
+  2,
+  1,
+  1,
+  48,
+  5,
+  6,
+  3,
+  43,
+  101,
+  112,
+  4,
+  34,
+  4,
+  32
+]);
+const PUB_LENGTH = 32;
+const SALT_LENGTH = 32;
+const SEC_LENGTH = 64;
+const SEED_LENGTH = 32;
+exports.PAIR_DIV = PAIR_DIV;
+exports.PAIR_HDR = PAIR_HDR;
+exports.PUB_LENGTH = PUB_LENGTH;
+exports.SALT_LENGTH = SALT_LENGTH;
+exports.SEC_LENGTH = SEC_LENGTH;
+exports.SEED_LENGTH = SEED_LENGTH;

package/dist/cjs/pair/encode.cjs

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const util = require("@polkadot/util");
+const utilCrypto = require("@prosopo/util-crypto");
+const defaults = require("./defaults.cjs");
+function encodePair({ publicKey, secretKey }, passphrase) {
+  if (!secretKey) {
+    throw new Error("Expected a valid secretKey to be passed to encode");
+  }
+  const encoded = util.u8aConcat(defaults.PAIR_HDR, secretKey, defaults.PAIR_DIV, publicKey);
+  if (!passphrase) {
+    return encoded;
+  }
+  const { params, password, salt } = utilCrypto.scryptEncode(passphrase);
+  const { encrypted, nonce } = utilCrypto.naclEncrypt(encoded, password.subarray(0, 32));
+  return util.u8aConcat(utilCrypto.scryptToU8a(salt, params), nonce, encrypted);
+}
+exports.encodePair = encodePair;

package/dist/cjs/pair/index.cjs

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const util = require("@polkadot/util");
+const utilCrypto = require("@prosopo/util-crypto");
+const decode = require("./decode.cjs");
+const encode = require("./encode.cjs");
+const toJson = require("./toJson.cjs");
+const SIG_TYPE_NONE = new Uint8Array([]);
+const TYPE_FROM_SEED = {
+  sr25519: utilCrypto.sr25519FromSeed,
+  ed25519: () => {
+    throw new Error("Not Implemented");
+  },
+  ecdsa: () => {
+    throw new Error("Not Implemented");
+  },
+  ethereum: () => {
+    throw new Error("Not Implemented");
+  }
+};
+const TYPE_PREFIX = {
+  ecdsa: new Uint8Array([2]),
+  ed25519: new Uint8Array([0]),
+  ethereum: new Uint8Array([2]),
+  sr25519: new Uint8Array([1])
+};
+const TYPE_SIGNATURE = {
+  sr25519: utilCrypto.sr25519Sign,
+  ed25519: () => {
+    throw new Error("Not Implemented");
+  },
+  ecdsa: () => {
+    throw new Error("Not Implemented");
+  },
+  ethereum: () => {
+    throw new Error("Not Implemented");
+  }
+};
+const TYPE_ADDRESS = {
+  sr25519: (p) => p,
+  ed25519: () => {
+    throw new Error("Not Implemented");
+  },
+  ecdsa: () => {
+    throw new Error("Not Implemented");
+  },
+  ethereum: () => {
+    throw new Error("Not Implemented");
+  }
+};
+function isLocked(secretKey) {
+  return !secretKey || util.u8aEmpty(secretKey);
+}
+function vrfHash(proof, context, extra) {
+  return utilCrypto.blake2AsU8a(util.u8aConcat(context || "", extra || "", proof));
+}
+function createPair({ toSS58, type }, { publicKey, secretKey }, meta = {}, encoded = null, encTypes) {
+  const decodePkcs8 = (passphrase, userEncoded) => {
+    const decoded = decode.decodePair(passphrase, userEncoded || encoded, encTypes);
+    if (decoded.secretKey.length === 64) {
+      publicKey = decoded.publicKey;
+      secretKey = decoded.secretKey;
+    } else {
+      const pair = TYPE_FROM_SEED[type](decoded.secretKey);
+      publicKey = pair.publicKey;
+      secretKey = pair.secretKey;
+    }
+  };
+  const recode = (passphrase) => {
+    isLocked(secretKey) && encoded && decodePkcs8(passphrase, encoded);
+    encoded = encode.encodePair({ publicKey, secretKey }, passphrase);
+    encTypes = void 0;
+    return encoded;
+  };
+  const encodeAddress = () => {
+    const raw = TYPE_ADDRESS[type](publicKey);
+    return toSS58(raw);
+  };
+  return {
+    get address() {
+      return encodeAddress();
+    },
+    get addressRaw() {
+      return TYPE_ADDRESS[type](publicKey);
+    },
+    get isLocked() {
+      return isLocked(secretKey);
+    },
+    get meta() {
+      return meta;
+    },
+    get publicKey() {
+      return publicKey;
+    },
+    get type() {
+      return type;
+    },
+    // eslint-disable-next-line sort-keys
+    decodePkcs8,
+    derive: (suri, meta2) => {
+      if (isLocked(secretKey)) {
+        throw new Error("Cannot derive on a locked keypair");
+      }
+      const { path } = utilCrypto.keyExtractPath(suri);
+      const derived = utilCrypto.keyFromPath({ publicKey, secretKey }, path, type);
+      return createPair({ toSS58, type }, derived, meta2, null);
+    },
+    encodePkcs8: (passphrase) => {
+      return recode(passphrase);
+    },
+    lock: () => {
+      secretKey = new Uint8Array([]);
+    },
+    setMeta: (additional) => {
+      meta = util.objectSpread({}, meta, additional);
+    },
+    sign: (message, options = {}) => {
+      if (isLocked(secretKey)) {
+        throw new Error("Cannot sign with a locked key pair");
+      }
+      return util.u8aConcat(
+        options.withType ? TYPE_PREFIX[type] : SIG_TYPE_NONE,
+        TYPE_SIGNATURE[type](util.u8aToU8a(message), { publicKey, secretKey })
+      );
+    },
+    toJson: (passphrase) => {
+      const address = ["ecdsa", "ethereum"].includes(type) ? publicKey.length === 20 ? util.u8aToHex(publicKey) : util.u8aToHex(utilCrypto.secp256k1Compress(publicKey)) : encodeAddress();
+      return toJson.pairToJson(
+        type,
+        { address, meta },
+        recode(passphrase),
+        !!passphrase
+      );
+    },
+    unlock: (passphrase) => {
+      decodePkcs8(passphrase);
+    },
+    verify: (message, signature, signerPublic) => {
+      return utilCrypto.signatureVerify(
+        message,
+        signature,
+        TYPE_ADDRESS[type](util.u8aToU8a(signerPublic))
+      ).isValid;
+    },
+    vrfSign: (message, context, extra) => {
+      if (isLocked(secretKey)) {
+        throw new Error("Cannot sign with a locked key pair");
+      }
+      return utilCrypto.sr25519VrfSign(message, { secretKey }, context, extra);
+    },
+    vrfVerify: (message, vrfResult, signerPublic, context, extra) => {
+      return utilCrypto.sr25519VrfVerify(message, vrfResult, publicKey, context, extra);
+    }
+  };
+}
+exports.createPair = createPair;

package/dist/cjs/pair/toJson.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const util = require("@polkadot/util");
+const utilCrypto = require("@prosopo/util-crypto");
+function pairToJson(type, { address, meta }, encoded, isEncrypted) {
+  return util.objectSpread(
+    utilCrypto.jsonEncryptFormat(encoded, ["pkcs8", type], isEncrypted),
+    {
+      address,
+      meta
+    }
+  );
+}
+exports.pairToJson = pairToJson;

package/dist/index.js

@@ -1,2 +1,19 @@
-export * from "./accounts/index.js";
-//# sourceMappingURL=index.js.map
+import "./accounts/index.js";
+import "./keyring/index.js";
+import { createPair } from "./pair/index.js";
+import { generateMiniSecret, generateMnemonic } from "./accounts/mnemonic.js";
+import { getPair } from "./accounts/getPair.js";
+import { getDefaultProviders, getDefaultSiteKeys } from "./accounts/testAccounts.js";
+import { DEV_PHRASE, Keyring } from "./keyring/keyring.js";
+import { Pairs } from "./keyring/pairs.js";
+export {
+  DEV_PHRASE,
+  Keyring,
+  Pairs,
+  createPair,
+  generateMiniSecret,
+  generateMnemonic,
+  getDefaultProviders,
+  getDefaultSiteKeys,
+  getPair
+};

package/dist/keyring/index.js

@@ -0,0 +1,7 @@
+import { DEV_PHRASE, Keyring } from "./keyring.js";
+import { Pairs } from "./pairs.js";
+export {
+  DEV_PHRASE,
+  Keyring,
+  Pairs
+};