@frequency-chain/recovery-sdk 0.0.0-fe548b

package/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# CONTRIBUTING
+
+For contributing guidelines see the [Project Liberty Contributing Guidelines](https://github.com/LibertyDSNP/meta/blob/main/CONTRIBUTING.md).
+
+## Running Tests
+- `js/recovery-sdk` folder
+- `npm run tests`

package/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 2024 Frequency Network Foundation
+
+   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/README.md

@@ -0,0 +1,80 @@
+# Recovery SDK package
+
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![NPM @latest][npm-shield]][npm-url]
+[![NPM @next][npm-next-shield]][npm-next-url]
+
+# Recovery SDK for Frequency Recovery System
+
+Support for generating and validating the hashes needed to use the Recovery System on Frequency.
+
+<!-- GETTING STARTED -->
+
+## Getting Started
+
+- `npm install @frequency-chain/recovery-sdk`
+
+### React Native
+
+To use this with React Native, you will need to shim `crypto.getRandomValues`.
+[`react-native-get-random-values`](https://github.com/LinusU/react-native-get-random-values) is suggested.
+
+## Usage
+
+| Method | Description |
+| --- | --- |
+| `generateRecoverySecret` | Generates a new Recovery Secret, formatted for users |
+| `getRecoveryCommitment` | Gets the Recovery Commitment for the given Recovery Secret and contact |
+| `getIntermediaryHashes` | Gets the Intermediary Recovery Hashes for the Recovery Provider to use to recover |
+| `getRecoveryCommitmentFromIntermediary` | Gets the Recovery Commitment from the Intermediary Recovery Hashes |
+
+## Upgrades and Matching Versions
+
+`@frequency-chain/recovery-sdk` is versioned with Frequency and should work against any release version of a Frequency node that has a compatible recovery system.
+If you are working against a development node that has changes in the recovery system, you should match the package version against the commit hash using `v0.0.0-[First 6 of the commit hash]`.
+
+Changelog is maintained in the [releases for Frequency](https://github.com/frequency-chain/frequency/releases).
+
+
+<!-- CONTRIBUTING -->
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+
+<!-- LICENSE -->
+
+## License
+
+Distributed under the Apache 2.0 License. See `LICENSE` for more information.
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/frequency-chain/frequency.svg?style=for-the-badge
+[contributors-url]: https://github.com/frequency-chain/frequency/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/frequency-chain/frequency.svg?style=for-the-badge
+[forks-url]: https://github.com/frequency-chain/frequency/network/members
+[stars-shield]: https://img.shields.io/github/stars/frequency-chain/frequency.svg?style=for-the-badge
+[stars-url]: https://github.com/frequency-chain/frequency/stargazers
+[issues-shield]: https://img.shields.io/github/issues/frequency-chain/frequency.svg?style=for-the-badge
+[issues-url]: https://github.com/frequency-chain/frequency/issues
+[license-shield]: https://img.shields.io/github/license/frequency-chain/frequency.svg?style=for-the-badge
+[license-url]: https://github.com/frequency-chain/frequency/blob/master/LICENSE
+[npm-shield]: https://img.shields.io/npm/v/@frequency-chain/recovery-sdk?label=npm%20%40latest&style=for-the-badge
+[npm-url]: https://www.npmjs.com/package/@frequency-chain/recovery-sdk
+[npm-next-shield]: https://img.shields.io/npm/v/@frequency-chain/recovery-sdk/next?label=npm%20%40next&style=for-the-badge
+[npm-next-url]: https://www.npmjs.com/package/@frequency-chain/recovery-sdk

package/cjs/index.js

@@ -0,0 +1,83 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateRecoverySecret = generateRecoverySecret;
+exports.getIntermediaryHashes = getIntermediaryHashes;
+exports.getRecoveryCommitment = getRecoveryCommitment;
+exports.getRecoveryCommitmentFromIntermediary = getRecoveryCommitmentFromIntermediary;
+const sha3_1 = require("@noble/hashes/sha3");
+const utils_1 = require("@noble/hashes/utils");
+const standardize_js_1 = require("./standardize.js");
+__exportStar(require("./types.js"), exports);
+/**
+ * Generates a new Recovery Secret for a user
+ *
+ * @returns A new recovery secret string formatted for user consumption
+ */
+function generateRecoverySecret() {
+    const unformatted = (0, utils_1.bytesToHex)((0, utils_1.randomBytes)(32)).split('');
+    return [...Array(64 / 4)]
+        .map((_a) => unformatted.splice(0, 4).join(''))
+        .join('-')
+        .toUpperCase();
+}
+/**
+ * Gets the Intermediary Hashes `a` and `b` used to do the Recovery
+ *
+ * @param recoverySecret The string form of the Recovery Secret
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns { a: Hex String of H(s), b: H(s + sc) }
+ */
+function getIntermediaryHashes(recoverySecret, contactType, contact) {
+    const { a, b } = getIntermediaryHashesAsUint8Array(recoverySecret, contactType, contact);
+    return {
+        a: `0x${(0, utils_1.bytesToHex)(a)}`,
+        b: `0x${(0, utils_1.bytesToHex)(b)}`,
+    };
+}
+function getIntermediaryHashesAsUint8Array(recoverySecret, contactType, contact) {
+    const s = (0, utils_1.hexToBytes)(recoverySecret.replaceAll('-', ''));
+    const contactStandard = (0, standardize_js_1.standardizeContact)(contactType, contact);
+    return {
+        a: (0, sha3_1.keccak_256)(s),
+        b: (0, sha3_1.keccak_256)((0, utils_1.concatBytes)(s, (0, utils_1.hexToBytes)(contactType.replace('0x', '')), (0, utils_1.utf8ToBytes)(contactStandard))),
+    };
+}
+/**
+ * Gets the Recovery Commitment that is stored on chain for the validation at time of recovery
+ *
+ * @param recoverySecret The string form of the Recovery Secret
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns the hex string of the Recovery Commitment
+ */
+function getRecoveryCommitment(recoverySecret, contactType, contact) {
+    const { a, b } = getIntermediaryHashesAsUint8Array(recoverySecret, contactType, contact);
+    return `0x${(0, utils_1.bytesToHex)((0, sha3_1.keccak_256)((0, utils_1.concatBytes)(a, b)))}`;
+}
+/**
+ * Gets the Recovery Commitment that is stored on chain for the validation at time of recovery from the Intermediary Hashes
+ *
+ * @param aHash A hash, H(s)
+ * @param bHash B hash, H(s + c)
+ * @returns the hex string of the Recovery Commitment
+ */
+function getRecoveryCommitmentFromIntermediary(aHash, bHash) {
+    const a = (0, utils_1.hexToBytes)(aHash.replace('0x', ''));
+    const b = (0, utils_1.hexToBytes)(bHash.replace('0x', ''));
+    return `0x${(0, utils_1.bytesToHex)((0, sha3_1.keccak_256)((0, utils_1.concatBytes)(a, b)))}`;
+}

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/cjs/standardize.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.standardizeContact = standardizeContact;
+const min_1 = require("libphonenumber-js/min");
+const types_js_1 = require("./types.js");
+// Via https://shramko.dev/snippets/is-email-valid-regex
+function isValidEmail(email) {
+    // [RFC 5321] https://datatracker.ietf.org/doc/html/rfc5321
+    const MAX_EMAIL_LENGTH = 254;
+    const isInvalidInput = !email || email.length === 0 || email.length > MAX_EMAIL_LENGTH;
+    if (isInvalidInput)
+        return false;
+    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+    return emailRegex.test(email);
+}
+/**
+ * Cleans up the email by lowercasing and removing periods in the username
+ * Does NOT validate the email
+ *
+ * @param email Raw email
+ * @returns standardized email string
+ */
+function standardizeEmail(email) {
+    const cleanEmail = email.toLowerCase().trim();
+    if (!isValidEmail(cleanEmail))
+        throw new Error('Unable to parse email contact method');
+    return cleanEmail;
+}
+/**
+ * Parses and standardizes the phone number to the E.164 Standard
+ *
+ * @param phone Raw phone number. Assumed to be a US phone number if not complete
+ * @returns
+ */
+function standardizePhone(phone) {
+    const parsed = (0, min_1.parsePhoneNumberFromString)(phone, 'US');
+    if (!parsed)
+        throw new Error('Unable to parse phone contact method');
+    return parsed.format('E.164');
+}
+/**
+ * Converts the contact into the standard form for hashing
+ *
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns The standardized string ready for conversion to utf8 bytes and hashed
+ */
+function standardizeContact(contactType, contact) {
+    switch (contactType) {
+        case types_js_1.ContactType.EMAIL:
+            return standardizeEmail(contact);
+        case types_js_1.ContactType.PHONE:
+            return standardizePhone(contact);
+    }
+}

package/cjs/types.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContactType = void 0;
+/**
+ * The contact types supported
+ */
+var ContactType;
+(function (ContactType) {
+    /**
+     * Email is standardized and utf8 encoded and appended after the type
+     */
+    ContactType["EMAIL"] = "0x00";
+    /**
+     * Phone is standardized as E.164 and utf8 encoded and appended after the type
+     */
+    ContactType["PHONE"] = "0x01";
+})(ContactType || (exports.ContactType = ContactType = {}));

package/esm/index.js

@@ -0,0 +1,63 @@
+import { keccak_256 } from '@noble/hashes/sha3';
+import { bytesToHex, randomBytes, concatBytes, hexToBytes, utf8ToBytes } from '@noble/hashes/utils';
+import { standardizeContact } from './standardize.js';
+export * from './types.js';
+/**
+ * Generates a new Recovery Secret for a user
+ *
+ * @returns A new recovery secret string formatted for user consumption
+ */
+export function generateRecoverySecret() {
+    const unformatted = bytesToHex(randomBytes(32)).split('');
+    return [...Array(64 / 4)]
+        .map((_a) => unformatted.splice(0, 4).join(''))
+        .join('-')
+        .toUpperCase();
+}
+/**
+ * Gets the Intermediary Hashes `a` and `b` used to do the Recovery
+ *
+ * @param recoverySecret The string form of the Recovery Secret
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns { a: Hex String of H(s), b: H(s + sc) }
+ */
+export function getIntermediaryHashes(recoverySecret, contactType, contact) {
+    const { a, b } = getIntermediaryHashesAsUint8Array(recoverySecret, contactType, contact);
+    return {
+        a: `0x${bytesToHex(a)}`,
+        b: `0x${bytesToHex(b)}`,
+    };
+}
+function getIntermediaryHashesAsUint8Array(recoverySecret, contactType, contact) {
+    const s = hexToBytes(recoverySecret.replaceAll('-', ''));
+    const contactStandard = standardizeContact(contactType, contact);
+    return {
+        a: keccak_256(s),
+        b: keccak_256(concatBytes(s, hexToBytes(contactType.replace('0x', '')), utf8ToBytes(contactStandard))),
+    };
+}
+/**
+ * Gets the Recovery Commitment that is stored on chain for the validation at time of recovery
+ *
+ * @param recoverySecret The string form of the Recovery Secret
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns the hex string of the Recovery Commitment
+ */
+export function getRecoveryCommitment(recoverySecret, contactType, contact) {
+    const { a, b } = getIntermediaryHashesAsUint8Array(recoverySecret, contactType, contact);
+    return `0x${bytesToHex(keccak_256(concatBytes(a, b)))}`;
+}
+/**
+ * Gets the Recovery Commitment that is stored on chain for the validation at time of recovery from the Intermediary Hashes
+ *
+ * @param aHash A hash, H(s)
+ * @param bHash B hash, H(s + c)
+ * @returns the hex string of the Recovery Commitment
+ */
+export function getRecoveryCommitmentFromIntermediary(aHash, bHash) {
+    const a = hexToBytes(aHash.replace('0x', ''));
+    const b = hexToBytes(bHash.replace('0x', ''));
+    return `0x${bytesToHex(keccak_256(concatBytes(a, b)))}`;
+}

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/esm/standardize.js

@@ -0,0 +1,52 @@
+import { parsePhoneNumberFromString } from 'libphonenumber-js/min';
+import { ContactType } from './types.js';
+// Via https://shramko.dev/snippets/is-email-valid-regex
+function isValidEmail(email) {
+    // [RFC 5321] https://datatracker.ietf.org/doc/html/rfc5321
+    const MAX_EMAIL_LENGTH = 254;
+    const isInvalidInput = !email || email.length === 0 || email.length > MAX_EMAIL_LENGTH;
+    if (isInvalidInput)
+        return false;
+    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+    return emailRegex.test(email);
+}
+/**
+ * Cleans up the email by lowercasing and removing periods in the username
+ * Does NOT validate the email
+ *
+ * @param email Raw email
+ * @returns standardized email string
+ */
+function standardizeEmail(email) {
+    const cleanEmail = email.toLowerCase().trim();
+    if (!isValidEmail(cleanEmail))
+        throw new Error('Unable to parse email contact method');
+    return cleanEmail;
+}
+/**
+ * Parses and standardizes the phone number to the E.164 Standard
+ *
+ * @param phone Raw phone number. Assumed to be a US phone number if not complete
+ * @returns
+ */
+function standardizePhone(phone) {
+    const parsed = parsePhoneNumberFromString(phone, 'US');
+    if (!parsed)
+        throw new Error('Unable to parse phone contact method');
+    return parsed.format('E.164');
+}
+/**
+ * Converts the contact into the standard form for hashing
+ *
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns The standardized string ready for conversion to utf8 bytes and hashed
+ */
+export function standardizeContact(contactType, contact) {
+    switch (contactType) {
+        case ContactType.EMAIL:
+            return standardizeEmail(contact);
+        case ContactType.PHONE:
+            return standardizePhone(contact);
+    }
+}

package/esm/types.js

@@ -0,0 +1,14 @@
+/**
+ * The contact types supported
+ */
+export var ContactType;
+(function (ContactType) {
+    /**
+     * Email is standardized and utf8 encoded and appended after the type
+     */
+    ContactType["EMAIL"] = "0x00";
+    /**
+     * Phone is standardized as E.164 and utf8 encoded and appended after the type
+     */
+    ContactType["PHONE"] = "0x01";
+})(ContactType || (ContactType = {}));

package/index.d.ts

@@ -0,0 +1,37 @@
+import { ContactType, HexString } from './types.js';
+export * from './types.js';
+/**
+ * Generates a new Recovery Secret for a user
+ *
+ * @returns A new recovery secret string formatted for user consumption
+ */
+export declare function generateRecoverySecret(): string;
+/**
+ * Gets the Intermediary Hashes `a` and `b` used to do the Recovery
+ *
+ * @param recoverySecret The string form of the Recovery Secret
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns { a: Hex String of H(s), b: H(s + sc) }
+ */
+export declare function getIntermediaryHashes(recoverySecret: string, contactType: ContactType, contact: string): {
+    a: HexString;
+    b: HexString;
+};
+/**
+ * Gets the Recovery Commitment that is stored on chain for the validation at time of recovery
+ *
+ * @param recoverySecret The string form of the Recovery Secret
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns the hex string of the Recovery Commitment
+ */
+export declare function getRecoveryCommitment(recoverySecret: string, contactType: ContactType, contact: string): HexString;
+/**
+ * Gets the Recovery Commitment that is stored on chain for the validation at time of recovery from the Intermediary Hashes
+ *
+ * @param aHash A hash, H(s)
+ * @param bHash B hash, H(s + c)
+ * @returns the hex string of the Recovery Commitment
+ */
+export declare function getRecoveryCommitmentFromIntermediary(aHash: string, bHash: string): HexString;

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@frequency-chain/recovery-sdk",
+  "version": "0.0.0-fe548b",
+  "bugs": {
+    "url": "https://github.com/frequency-chain/frequency/issues"
+  },
+  "description": "Provides utilties for interacting with the Frequency Recovery System",
+  "main": "./cjs/index.js",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/frequency-chain/frequency.git",
+    "directory": "js/recovery-sdk"
+  },
+  "author": "frequency-chain",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@noble/hashes": "^1.8.0",
+    "libphonenumber-js": "^1.12.9"
+  },
+  "module": "./esm/index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./cjs/index.js",
+      "import": "./esm/index.js",
+      "default": "./esm/index.js"
+    }
+  }
+}

package/standardize.d.ts

@@ -0,0 +1,9 @@
+import { ContactType } from './types.js';
+/**
+ * Converts the contact into the standard form for hashing
+ *
+ * @param contactType Email = "0x00", Phone = "0x01"
+ * @param contact The raw contact string
+ * @returns The standardized string ready for conversion to utf8 bytes and hashed
+ */
+export declare function standardizeContact(contactType: ContactType, contact: string): string;

package/types.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The contact types supported
+ */
+export declare enum ContactType {
+    /**
+     * Email is standardized and utf8 encoded and appended after the type
+     */
+    EMAIL = "0x00",
+    /**
+     * Phone is standardized as E.164 and utf8 encoded and appended after the type
+     */
+    PHONE = "0x01"
+}
+/**
+ * Identifies a 0x-prefixed base16 string
+ */
+export type HexString = `0x${string}`;