@pezkuwi/keyring 14.0.22 → 14.0.23

package/build/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/build/README.md

@@ -0,0 +1,17 @@
+# @pezkuwi/keyring
+
+Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.
+
+## Usage
+
+Installation -
+
+```
+yarn add @pezkuwi/keyring
+```
+
+Classes and Functions can be imported as follows:
+
+```js
+import Keyring from '@pezkuwi/keyring';
+```

package/build/bundle.d.ts

@@ -0,0 +1,7 @@
+export { decodeAddress, encodeAddress, setSS58Format } from '@pezkuwi/util-crypto';
+export { Keyring } from './keyring.js';
+export { packageInfo } from './packageInfo.js';
+export { createPair } from './pair/index.js';
+export { createTestKeyring } from './testing.js';
+export { createTestPairs } from './testingPairs.js';
+export * from './defaults.js';

package/build/bundle.js

@@ -0,0 +1,7 @@
+export { decodeAddress, encodeAddress, setSS58Format } from '@pezkuwi/util-crypto';
+export { Keyring } from './keyring.js';
+export { packageInfo } from './packageInfo.js';
+export { createPair } from './pair/index.js';
+export { createTestKeyring } from './testing.js';
+export { createTestPairs } from './testingPairs.js';
+export * from './defaults.js';

package/build/cjs/bundle.d.ts

@@ -0,0 +1,7 @@
+export { decodeAddress, encodeAddress, setSS58Format } from '@pezkuwi/util-crypto';
+export { Keyring } from './keyring.js';
+export { packageInfo } from './packageInfo.js';
+export { createPair } from './pair/index.js';
+export { createTestKeyring } from './testing.js';
+export { createTestPairs } from './testingPairs.js';
+export * from './defaults.js';

package/build/cjs/bundle.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestPairs = exports.createTestKeyring = exports.createPair = exports.packageInfo = exports.Keyring = exports.setSS58Format = exports.encodeAddress = exports.decodeAddress = void 0;
+const tslib_1 = require("tslib");
+var util_crypto_1 = require("@pezkuwi/util-crypto");
+Object.defineProperty(exports, "decodeAddress", { enumerable: true, get: function () { return util_crypto_1.decodeAddress; } });
+Object.defineProperty(exports, "encodeAddress", { enumerable: true, get: function () { return util_crypto_1.encodeAddress; } });
+Object.defineProperty(exports, "setSS58Format", { enumerable: true, get: function () { return util_crypto_1.setSS58Format; } });
+var keyring_js_1 = require("./keyring.js");
+Object.defineProperty(exports, "Keyring", { enumerable: true, get: function () { return keyring_js_1.Keyring; } });
+var packageInfo_js_1 = require("./packageInfo.js");
+Object.defineProperty(exports, "packageInfo", { enumerable: true, get: function () { return packageInfo_js_1.packageInfo; } });
+var index_js_1 = require("./pair/index.js");
+Object.defineProperty(exports, "createPair", { enumerable: true, get: function () { return index_js_1.createPair; } });
+var testing_js_1 = require("./testing.js");
+Object.defineProperty(exports, "createTestKeyring", { enumerable: true, get: function () { return testing_js_1.createTestKeyring; } });
+var testingPairs_js_1 = require("./testingPairs.js");
+Object.defineProperty(exports, "createTestPairs", { enumerable: true, get: function () { return testingPairs_js_1.createTestPairs; } });
+tslib_1.__exportStar(require("./defaults.js"), exports);

package/build/cjs/defaults.d.ts

@@ -0,0 +1,2 @@
+export declare const DEV_PHRASE = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
+export declare const DEV_SEED = "0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e";

package/build/cjs/defaults.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEV_SEED = exports.DEV_PHRASE = void 0;
+exports.DEV_PHRASE = 'bottom drive obey lake curtain smoke basket hold race lonely fit walk';
+exports.DEV_SEED = '0xfac7959dbfe72f052e5a0c3c8d6530f202b02fd8f9f5ca3580ec8deb7797479e';

package/build/cjs/index.d.ts

@@ -0,0 +1,4 @@
+import './packageDetect.js';
+import { Keyring } from './bundle.js';
+export * from './bundle.js';
+export default Keyring;

package/build/cjs/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+require("./packageDetect.js");
+const bundle_js_1 = require("./bundle.js");
+tslib_1.__exportStar(require("./bundle.js"), exports);
+exports.default = bundle_js_1.Keyring;

package/build/cjs/keyring.d.ts

@@ -0,0 +1,145 @@
+import type { EncryptedJsonEncoding, Keypair, KeypairType } from '@pezkuwi/util-crypto/types';
+import type { KeyringInstance, KeyringOptions, KeyringPair, KeyringPair$Json, KeyringPair$Meta } from './types.js';
+import { decodeAddress } from '@pezkuwi/util-crypto';
+/**
+ * # @pezkuwi/keyring
+ *
+ * ## Overview
+ *
+ * @name Keyring
+ * @summary Keyring management of user accounts
+ * @description Allows generation of keyring pairs from a variety of input combinations, such as
+ * json object containing account address or public key, account metadata, and account encoded using
+ * `addFromJson`, or by providing those values as arguments separately to `addFromAddress`,
+ * or by providing the mnemonic (seed phrase) and account metadata as arguments to `addFromMnemonic`.
+ * Stores the keyring pairs in a keyring pair dictionary. Removal of the keyring pairs from the keyring pair
+ * dictionary is achieved using `removePair`. Retrieval of all the stored pairs via `getPairs` or perform
+ * lookup of a pair for a given account address or public key using `getPair`. JSON metadata associated with
+ * an account may be obtained using `toJson` accompanied by the account passphrase.
+ */
+export declare class Keyring implements KeyringInstance {
+    #private;
+    decodeAddress: typeof decodeAddress;
+    constructor(options?: KeyringOptions);
+    /**
+     * @description retrieve the pairs (alias for getPairs)
+     */
+    get pairs(): KeyringPair[];
+    /**
+     * @description retrieve the publicKeys (alias for getPublicKeys)
+     */
+    get publicKeys(): Uint8Array[];
+    /**
+     * @description Returns the type of the keyring, ed25519, sr25519 or ecdsa
+     */
+    get type(): KeypairType;
+    /**
+     * @name addPair
+     * @summary Stores an account, given a keyring pair, as a Key/Value (public key, pair) in Keyring Pair Dictionary
+     */
+    addPair(pair: KeyringPair): KeyringPair;
+    /**
+     * @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: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeypairType, ignoreChecksum?: boolean, encType?: EncryptedJsonEncoding[]): KeyringPair;
+    /**
+     * @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: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair;
+    /**
+     * @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: string, meta?: KeyringPair$Meta, type?: KeypairType, wordlist?: string[]): KeyringPair;
+    /**
+     * @name addFromPair
+     * @summary Stores an account created from an explicit publicKey/secreteKey combination
+     */
+    addFromPair(pair: Keypair, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
+    /**
+     * @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: Uint8Array, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
+    /**
+     * @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: string, meta?: KeyringPair$Meta, type?: KeypairType, wordlist?: string[]): KeyringPair;
+    /**
+     * @name createFromJson
+     * @description Creates a pair from a JSON keyfile
+     */
+    createFromJson({ address, encoded, encoding: { content, type, version }, meta }: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair;
+    /**
+     * @name createFromPair
+     * @summary Creates a pair from an explicit publicKey/secreteKey combination
+     */
+    createFromPair(pair: Keypair, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
+    /**
+     * @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: string, meta?: KeyringPair$Meta, type?: KeypairType, wordlist?: string[]): KeyringPair;
+    /**
+     * @name encodeAddress
+     * @description Encodes the input into an ss58 representation
+     */
+    encodeAddress: (address: Uint8Array | string, ss58Format?: number) => string;
+    /**
+     * @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: string | Uint8Array): KeyringPair;
+    /**
+     * @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(): KeyringPair[];
+    /**
+     * @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(): Uint8Array[];
+    /**
+     * @name removePair
+     * @description Deletes the provided input address or public key from the stored Keyring Pair Dictionary.
+     */
+    removePair(address: string | Uint8Array): void;
+    /**
+     * @name setSS58Format;
+     * @description Sets the ss58 format for the keyring
+     */
+    setSS58Format(ss58: number): void;
+    /**
+     * @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: string | Uint8Array, passphrase?: string): KeyringPair$Json;
+}