@frequency-chain/ethereum-utils 1.17.0-rc7 → 1.17.1

package/browser/frequency-ethereum-utils.esm.min.js

@@ -3626,6 +3626,8 @@ function stringToU8a(value) {
  * @summary Creates a Uint8Array value from a Uint8Array, Buffer, string or hex input.
  * @description
  * `null` or `undefined` inputs returns a `[]` result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.
+ * If `strict` is true, `null` or `undefined` will throw an error instead of returning an empty array.
+ * Supports input types: Uint8Array, Buffer, hex string, string, or number array.
  * @example
  * <BR>
  *
@@ -3636,7 +3638,10 @@ function stringToU8a(value) {
  * u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34])
  * ```
  */
-function u8aToU8a(value) {
+function u8aToU8a(value, strict = false) {
+    if (strict && (value === null || value === undefined)) {
+        throw new Error('u8aToU8a: Expected non-null, non-undefined value');
+    }
     return isU8a(value)
         // NOTE isBuffer needs to go here since it actually extends
         // Uint8Array on Node.js environments, so all Buffer are Uint8Array,
@@ -10515,7 +10520,7 @@ function ethereumEncode(addressOrPublic) {
 /**
  *  The current version of Ethers.
  */
-const version = "6.14.4";/**
+const version = "6.15.0";/**
  *  Property helper functions.
  *
  *  @_subsection api/utils:Properties  [about-properties]
@@ -14694,12 +14699,28 @@ class Signature {
     /**
      *  The ``s`` value for a signature.
      */
-    get s() { return this.#s; }
+    get s() {
+        assertArgument(parseInt(this.#s.substring(0, 3)) < 8, "non-canonical s; use ._s", "s", this.#s);
+        return this.#s;
+    }
     set s(_value) {
         assertArgument(dataLength(_value) === 32, "invalid s", "value", _value);
-        const value = hexlify(_value);
-        assertArgument(parseInt(value.substring(0, 3)) < 8, "non-canonical s", "value", value);
-        this.#s = value;
+        this.#s = hexlify(_value);
+    }
+    /**
+     *  Return the s value, unchecked for EIP-2 compliance.
+     *
+     *  This should generally not be used and is for situations where
+     *  a non-canonical S value might be relevant, such as Frontier blocks
+     *  that were mined prior to EIP-2 or invalid Authorization List
+     *  signatures.
+     */
+    get _s() { return this.#s; }
+    /**
+     *  Returns true if the Signature is valid for [[link-eip-2]] signatures.
+     */
+    isValid() {
+        return (parseInt(this.#s.substring(0, 3)) < 8);
     }
     /**
      *  The ``v`` value for a signature.
@@ -14776,13 +14797,13 @@ class Signature {
         this.#networkV = null;
     }
     [Symbol.for('nodejs.util.inspect.custom')]() {
-        return `Signature { r: "${this.r}", s: "${this.s}", yParity: ${this.yParity}, networkV: ${this.networkV} }`;
+        return `Signature { r: "${this.r}", s: "${this._s}"${this.isValid() ? "" : ', valid: "false"'}, yParity: ${this.yParity}, networkV: ${this.networkV} }`;
     }
     /**
      *  Returns a new identical [[Signature]].
      */
     clone() {
-        const clone = new Signature(_guard$2, this.r, this.s, this.v);
+        const clone = new Signature(_guard$2, this.r, this._s, this.v);
         if (this.networkV) {
             clone.#networkV = this.networkV;
         }
@@ -14796,7 +14817,7 @@ class Signature {
         return {
             _type: "signature",
             networkV: ((networkV != null) ? networkV.toString() : null),
-            r: this.r, s: this.s, v: this.v,
+            r: this.r, s: this._s, v: this.v,
         };
     }
     /**
@@ -14895,10 +14916,9 @@ class Signature {
             }
             if (bytes.length === 65) {
                 const r = hexlify(bytes.slice(0, 32));
-                const s = bytes.slice(32, 64);
-                assertError((s[0] & 0x80) === 0, "non-canonical s");
+                const s = hexlify(bytes.slice(32, 64));
                 const v = Signature.getNormalizedV(bytes[64]);
-                return new Signature(_guard$2, r, hexlify(s), v);
+                return new Signature(_guard$2, r, s, v);
             }
             assertError(false, "invalid raw signature length");
         }
@@ -14922,7 +14942,6 @@ class Signature {
             }
             assertError(false, "missing s");
         })(sig.s, sig.yParityAndS);
-        assertError((getBytes(s)[0] & 0x80) == 0, "non-canonical s");
         // Get v; by any means necessary (we check consistency below)
         const { networkV, v } = (function (_v, yParityAndS, yParity) {
             if (_v != null) {
@@ -19473,6 +19492,18 @@ const AUTHORIZED_KEY_DATA_DEFINITION = {
         },
     ],
 };
+const RECOVERY_COMMITMENT_PAYLOAD_DEFINITION = {
+    RecoveryCommitmentPayload: [
+        {
+            name: 'recoveryCommitment',
+            type: 'bytes',
+        },
+        {
+            name: 'expiration',
+            type: 'uint32',
+        },
+    ],
+};
 const CLAIM_HANDLE_PAYLOAD_DEFINITION = {
     ClaimHandlePayload: [
         {
@@ -19577,7 +19608,7 @@ const SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION = {
             type: 'string',
         },
     ],
-};var signatureDefinitions=/*#__PURE__*/Object.freeze({__proto__:null,ADD_KEY_DATA_DEFINITION:ADD_KEY_DATA_DEFINITION,ADD_PROVIDER_DEFINITION:ADD_PROVIDER_DEFINITION,AUTHORIZED_KEY_DATA_DEFINITION:AUTHORIZED_KEY_DATA_DEFINITION,CLAIM_HANDLE_PAYLOAD_DEFINITION:CLAIM_HANDLE_PAYLOAD_DEFINITION,EIP712_DOMAIN_DEFINITION:EIP712_DOMAIN_DEFINITION,EIP712_DOMAIN_MAINNET:EIP712_DOMAIN_MAINNET,EIP712_DOMAIN_TESTNET:EIP712_DOMAIN_TESTNET,ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2:ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2:PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2:PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,PASSKEY_PUBLIC_KEY_DEFINITION:PASSKEY_PUBLIC_KEY_DEFINITION,SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION:SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION});/**
+};var signatureDefinitions=/*#__PURE__*/Object.freeze({__proto__:null,ADD_KEY_DATA_DEFINITION:ADD_KEY_DATA_DEFINITION,ADD_PROVIDER_DEFINITION:ADD_PROVIDER_DEFINITION,AUTHORIZED_KEY_DATA_DEFINITION:AUTHORIZED_KEY_DATA_DEFINITION,CLAIM_HANDLE_PAYLOAD_DEFINITION:CLAIM_HANDLE_PAYLOAD_DEFINITION,EIP712_DOMAIN_DEFINITION:EIP712_DOMAIN_DEFINITION,EIP712_DOMAIN_MAINNET:EIP712_DOMAIN_MAINNET,EIP712_DOMAIN_TESTNET:EIP712_DOMAIN_TESTNET,ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2:ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2:PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2:PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,PASSKEY_PUBLIC_KEY_DEFINITION:PASSKEY_PUBLIC_KEY_DEFINITION,RECOVERY_COMMITMENT_PAYLOAD_DEFINITION:RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION:SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION});/**
  * Signing EIP-712 or ERC-191 compatible signature based on payload
  * @param secretKey
  * @param payload
@@ -19634,6 +19665,7 @@ function normalizePayload(payload) {
         case 'PasskeyPublicKey':
         case 'ClaimHandlePayload':
         case 'AddProvider':
+        case 'RecoveryCommitmentPayload':
         case 'SiwfLoginRequestPayload':
             break;
         case 'AddKeyData':
@@ -19672,6 +19704,7 @@ function getTypesFor(payloadType) {
         AddKeyData: ADD_KEY_DATA_DEFINITION,
         AuthorizedKeyData: AUTHORIZED_KEY_DATA_DEFINITION,
         AddProvider: ADD_PROVIDER_DEFINITION,
+        RecoveryCommitmentPayload: RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,
         // offchain signatures
         SiwfSignedRequestPayload: SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
     };
@@ -19747,6 +19780,21 @@ function createAddProvider(authorizedMsaId, schemaIds, expirationBlock) {
         expiration: expirationBlock,
     };
 }
+/**
+ * Build a RecoveryCommitmentPayload for signature.
+ *
+ * @param recoveryCommitment The recovery commitment data as a HexString
+ * @param expirationBlock Block number after which this payload is invalid
+ */
+function createRecoveryCommitmentPayload(recoveryCommitment, expirationBlock) {
+    assert(isHexString(recoveryCommitment), 'recoveryCommitment should be a valid hex string');
+    assert(isValidUint32(expirationBlock), 'expiration should be a valid uint32');
+    return {
+        type: 'RecoveryCommitmentPayload',
+        recoveryCommitment: recoveryCommitment,
+        expiration: expirationBlock,
+    };
+}
 /**
  * Build a ClaimHandlePayload for signature.
  *
@@ -19919,6 +19967,18 @@ function getEip712BrowserRequestAddProvider(authorizedMsaId, schemaIds, expirati
     const normalized = normalizePayload(message);
     return createEip712Payload(ADD_PROVIDER_DEFINITION, message.type, domain, normalized);
 }
+/**
+ * Returns the EIP-712 browser request for a RecoveryCommitmentPayload for signing.
+ *
+ * @param recoveryCommitment The recovery commitment data as a Uint8Array
+ * @param expirationBlock Block number after which this payload is invalid
+ * @param domain
+ */
+function getEip712BrowserRequestRecoveryCommitmentPayload(recoveryCommitment, expirationBlock, domain = EIP712_DOMAIN_MAINNET) {
+    const message = createRecoveryCommitmentPayload(recoveryCommitment, expirationBlock);
+    const normalized = normalizePayload(message);
+    return createEip712Payload(RECOVERY_COMMITMENT_PAYLOAD_DEFINITION, message.type, domain, normalized);
+}
 /**
  * Returns the EIP-712 browser request for a PaginatedUpsertSignaturePayloadV2 for signing.
  *
@@ -20054,4 +20114,4 @@ function prefixEthereumTags(hexPayload) {
     const wrapped = `\x19Ethereum Signed Message:\n${hexPayload.length}${hexPayload}`;
     const buffer = Buffer.from(wrapped, 'utf-8');
     return new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.length);
-}var signature=/*#__PURE__*/Object.freeze({__proto__:null,createAddKeyData:createAddKeyData,createAddProvider:createAddProvider,createAuthorizedKeyData:createAuthorizedKeyData,createClaimHandlePayload:createClaimHandlePayload,createItemizedAddAction:createItemizedAddAction,createItemizedDeleteAction:createItemizedDeleteAction,createItemizedSignaturePayloadV2:createItemizedSignaturePayloadV2,createPaginatedDeleteSignaturePayloadV2:createPaginatedDeleteSignaturePayloadV2,createPaginatedUpsertSignaturePayloadV2:createPaginatedUpsertSignaturePayloadV2,createPasskeyPublicKey:createPasskeyPublicKey,createSiwfLoginRequestPayload:createSiwfLoginRequestPayload,createSiwfSignedRequestPayload:createSiwfSignedRequestPayload,getEip712BrowserRequestAddKeyData:getEip712BrowserRequestAddKeyData,getEip712BrowserRequestAddProvider:getEip712BrowserRequestAddProvider,getEip712BrowserRequestAuthorizedKeyData:getEip712BrowserRequestAuthorizedKeyData,getEip712BrowserRequestClaimHandlePayload:getEip712BrowserRequestClaimHandlePayload,getEip712BrowserRequestItemizedSignaturePayloadV2:getEip712BrowserRequestItemizedSignaturePayloadV2,getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2:getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2,getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2:getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2,getEip712BrowserRequestPasskeyPublicKey:getEip712BrowserRequestPasskeyPublicKey,getEip712BrowserRequestSiwfSignedRequestPayload:getEip712BrowserRequestSiwfSignedRequestPayload,getEthereumMessageSigner:getEthereumMessageSigner,getEthereumRegularSigner:getEthereumRegularSigner,sign:sign,verifySignature:verifySignature});var index = { ...payloads, ...address, ...signatureDefinitions, ...signature };export{ADD_KEY_DATA_DEFINITION,ADD_PROVIDER_DEFINITION,AUTHORIZED_KEY_DATA_DEFINITION,CLAIM_HANDLE_PAYLOAD_DEFINITION,EIP712_DOMAIN_DEFINITION,EIP712_DOMAIN_MAINNET,EIP712_DOMAIN_TESTNET,ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,PASSKEY_PUBLIC_KEY_DEFINITION,SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,createAddKeyData,createAddProvider,createAuthorizedKeyData,createClaimHandlePayload,createItemizedAddAction,createItemizedDeleteAction,createItemizedSignaturePayloadV2,createPaginatedDeleteSignaturePayloadV2,createPaginatedUpsertSignaturePayloadV2,createPasskeyPublicKey,createRandomKey,createSiwfLoginRequestPayload,createSiwfSignedRequestPayload,index as default,ethereumAddressToKeyringPair,getAccountId20MultiAddress,getEip712BrowserRequestAddKeyData,getEip712BrowserRequestAddProvider,getEip712BrowserRequestAuthorizedKeyData,getEip712BrowserRequestClaimHandlePayload,getEip712BrowserRequestItemizedSignaturePayloadV2,getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2,getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2,getEip712BrowserRequestPasskeyPublicKey,getEip712BrowserRequestSiwfSignedRequestPayload,getEthereumMessageSigner,getEthereumRegularSigner,getKeyringPairFromSecp256k1PrivateKey,getSS58AccountFromEthereumAccount,getUnifiedAddress,getUnifiedPublicKey,reverseUnifiedAddressToEthereumAddress,sign,verifySignature};
+}var signature=/*#__PURE__*/Object.freeze({__proto__:null,createAddKeyData:createAddKeyData,createAddProvider:createAddProvider,createAuthorizedKeyData:createAuthorizedKeyData,createClaimHandlePayload:createClaimHandlePayload,createItemizedAddAction:createItemizedAddAction,createItemizedDeleteAction:createItemizedDeleteAction,createItemizedSignaturePayloadV2:createItemizedSignaturePayloadV2,createPaginatedDeleteSignaturePayloadV2:createPaginatedDeleteSignaturePayloadV2,createPaginatedUpsertSignaturePayloadV2:createPaginatedUpsertSignaturePayloadV2,createPasskeyPublicKey:createPasskeyPublicKey,createRecoveryCommitmentPayload:createRecoveryCommitmentPayload,createSiwfLoginRequestPayload:createSiwfLoginRequestPayload,createSiwfSignedRequestPayload:createSiwfSignedRequestPayload,getEip712BrowserRequestAddKeyData:getEip712BrowserRequestAddKeyData,getEip712BrowserRequestAddProvider:getEip712BrowserRequestAddProvider,getEip712BrowserRequestAuthorizedKeyData:getEip712BrowserRequestAuthorizedKeyData,getEip712BrowserRequestClaimHandlePayload:getEip712BrowserRequestClaimHandlePayload,getEip712BrowserRequestItemizedSignaturePayloadV2:getEip712BrowserRequestItemizedSignaturePayloadV2,getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2:getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2,getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2:getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2,getEip712BrowserRequestPasskeyPublicKey:getEip712BrowserRequestPasskeyPublicKey,getEip712BrowserRequestRecoveryCommitmentPayload:getEip712BrowserRequestRecoveryCommitmentPayload,getEip712BrowserRequestSiwfSignedRequestPayload:getEip712BrowserRequestSiwfSignedRequestPayload,getEthereumMessageSigner:getEthereumMessageSigner,getEthereumRegularSigner:getEthereumRegularSigner,sign:sign,verifySignature:verifySignature});var index = { ...payloads, ...address, ...signatureDefinitions, ...signature };export{ADD_KEY_DATA_DEFINITION,ADD_PROVIDER_DEFINITION,AUTHORIZED_KEY_DATA_DEFINITION,CLAIM_HANDLE_PAYLOAD_DEFINITION,EIP712_DOMAIN_DEFINITION,EIP712_DOMAIN_MAINNET,EIP712_DOMAIN_TESTNET,ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,PASSKEY_PUBLIC_KEY_DEFINITION,RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,createAddKeyData,createAddProvider,createAuthorizedKeyData,createClaimHandlePayload,createItemizedAddAction,createItemizedDeleteAction,createItemizedSignaturePayloadV2,createPaginatedDeleteSignaturePayloadV2,createPaginatedUpsertSignaturePayloadV2,createPasskeyPublicKey,createRandomKey,createRecoveryCommitmentPayload,createSiwfLoginRequestPayload,createSiwfSignedRequestPayload,index as default,ethereumAddressToKeyringPair,getAccountId20MultiAddress,getEip712BrowserRequestAddKeyData,getEip712BrowserRequestAddProvider,getEip712BrowserRequestAuthorizedKeyData,getEip712BrowserRequestClaimHandlePayload,getEip712BrowserRequestItemizedSignaturePayloadV2,getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2,getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2,getEip712BrowserRequestPasskeyPublicKey,getEip712BrowserRequestRecoveryCommitmentPayload,getEip712BrowserRequestSiwfSignedRequestPayload,getEthereumMessageSigner,getEthereumRegularSigner,getKeyringPairFromSecp256k1PrivateKey,getSS58AccountFromEthereumAccount,getUnifiedAddress,getUnifiedPublicKey,reverseUnifiedAddressToEthereumAddress,sign,verifySignature};

package/browser/frequency-ethereum-utils.umd.min.js

@@ -3626,6 +3626,8 @@ function stringToU8a(value) {
  * @summary Creates a Uint8Array value from a Uint8Array, Buffer, string or hex input.
  * @description
  * `null` or `undefined` inputs returns a `[]` result, Uint8Array values returns the value, hex strings returns a Uint8Array representation.
+ * If `strict` is true, `null` or `undefined` will throw an error instead of returning an empty array.
+ * Supports input types: Uint8Array, Buffer, hex string, string, or number array.
  * @example
  * <BR>
  *
@@ -3636,7 +3638,10 @@ function stringToU8a(value) {
  * u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34])
  * ```
  */
-function u8aToU8a(value) {
+function u8aToU8a(value, strict = false) {
+    if (strict && (value === null || value === undefined)) {
+        throw new Error('u8aToU8a: Expected non-null, non-undefined value');
+    }
     return isU8a(value)
         // NOTE isBuffer needs to go here since it actually extends
         // Uint8Array on Node.js environments, so all Buffer are Uint8Array,
@@ -10733,6 +10738,18 @@ const AUTHORIZED_KEY_DATA_DEFINITION = {
         },
     ],
 };
+const RECOVERY_COMMITMENT_PAYLOAD_DEFINITION = {
+    RecoveryCommitmentPayload: [
+        {
+            name: 'recoveryCommitment',
+            type: 'bytes',
+        },
+        {
+            name: 'expiration',
+            type: 'uint32',
+        },
+    ],
+};
 const CLAIM_HANDLE_PAYLOAD_DEFINITION = {
     ClaimHandlePayload: [
         {
@@ -10837,7 +10854,7 @@ const SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION = {
             type: 'string',
         },
     ],
-};var signatureDefinitions=/*#__PURE__*/Object.freeze({__proto__:null,ADD_KEY_DATA_DEFINITION:ADD_KEY_DATA_DEFINITION,ADD_PROVIDER_DEFINITION:ADD_PROVIDER_DEFINITION,AUTHORIZED_KEY_DATA_DEFINITION:AUTHORIZED_KEY_DATA_DEFINITION,CLAIM_HANDLE_PAYLOAD_DEFINITION:CLAIM_HANDLE_PAYLOAD_DEFINITION,EIP712_DOMAIN_DEFINITION:EIP712_DOMAIN_DEFINITION,EIP712_DOMAIN_MAINNET:EIP712_DOMAIN_MAINNET,EIP712_DOMAIN_TESTNET:EIP712_DOMAIN_TESTNET,ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2:ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2:PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2:PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,PASSKEY_PUBLIC_KEY_DEFINITION:PASSKEY_PUBLIC_KEY_DEFINITION,SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION:SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION});/**
+};var signatureDefinitions=/*#__PURE__*/Object.freeze({__proto__:null,ADD_KEY_DATA_DEFINITION:ADD_KEY_DATA_DEFINITION,ADD_PROVIDER_DEFINITION:ADD_PROVIDER_DEFINITION,AUTHORIZED_KEY_DATA_DEFINITION:AUTHORIZED_KEY_DATA_DEFINITION,CLAIM_HANDLE_PAYLOAD_DEFINITION:CLAIM_HANDLE_PAYLOAD_DEFINITION,EIP712_DOMAIN_DEFINITION:EIP712_DOMAIN_DEFINITION,EIP712_DOMAIN_MAINNET:EIP712_DOMAIN_MAINNET,EIP712_DOMAIN_TESTNET:EIP712_DOMAIN_TESTNET,ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2:ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2:PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2:PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,PASSKEY_PUBLIC_KEY_DEFINITION:PASSKEY_PUBLIC_KEY_DEFINITION,RECOVERY_COMMITMENT_PAYLOAD_DEFINITION:RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION:SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION});/**
  * Signing EIP-712 or ERC-191 compatible signature based on payload
  * @param secretKey
  * @param payload
@@ -10894,6 +10911,7 @@ function normalizePayload(payload) {
         case 'PasskeyPublicKey':
         case 'ClaimHandlePayload':
         case 'AddProvider':
+        case 'RecoveryCommitmentPayload':
         case 'SiwfLoginRequestPayload':
             break;
         case 'AddKeyData':
@@ -10932,6 +10950,7 @@ function getTypesFor(payloadType) {
         AddKeyData: ADD_KEY_DATA_DEFINITION,
         AuthorizedKeyData: AUTHORIZED_KEY_DATA_DEFINITION,
         AddProvider: ADD_PROVIDER_DEFINITION,
+        RecoveryCommitmentPayload: RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,
         // offchain signatures
         SiwfSignedRequestPayload: SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
     };
@@ -11007,6 +11026,21 @@ function createAddProvider(authorizedMsaId, schemaIds, expirationBlock) {
         expiration: expirationBlock,
     };
 }
+/**
+ * Build a RecoveryCommitmentPayload for signature.
+ *
+ * @param recoveryCommitment The recovery commitment data as a HexString
+ * @param expirationBlock Block number after which this payload is invalid
+ */
+function createRecoveryCommitmentPayload(recoveryCommitment, expirationBlock) {
+    assert(isHexString(recoveryCommitment), 'recoveryCommitment should be a valid hex string');
+    assert(isValidUint32(expirationBlock), 'expiration should be a valid uint32');
+    return {
+        type: 'RecoveryCommitmentPayload',
+        recoveryCommitment: recoveryCommitment,
+        expiration: expirationBlock,
+    };
+}
 /**
  * Build a ClaimHandlePayload for signature.
  *
@@ -11179,6 +11213,18 @@ function getEip712BrowserRequestAddProvider(authorizedMsaId, schemaIds, expirati
     const normalized = normalizePayload(message);
     return createEip712Payload(ADD_PROVIDER_DEFINITION, message.type, domain, normalized);
 }
+/**
+ * Returns the EIP-712 browser request for a RecoveryCommitmentPayload for signing.
+ *
+ * @param recoveryCommitment The recovery commitment data as a Uint8Array
+ * @param expirationBlock Block number after which this payload is invalid
+ * @param domain
+ */
+function getEip712BrowserRequestRecoveryCommitmentPayload(recoveryCommitment, expirationBlock, domain = EIP712_DOMAIN_MAINNET) {
+    const message = createRecoveryCommitmentPayload(recoveryCommitment, expirationBlock);
+    const normalized = normalizePayload(message);
+    return createEip712Payload(RECOVERY_COMMITMENT_PAYLOAD_DEFINITION, message.type, domain, normalized);
+}
 /**
  * Returns the EIP-712 browser request for a PaginatedUpsertSignaturePayloadV2 for signing.
  *
@@ -11314,4 +11360,4 @@ function prefixEthereumTags(hexPayload) {
     const wrapped = `\x19Ethereum Signed Message:\n${hexPayload.length}${hexPayload}`;
     const buffer = Buffer.from(wrapped, 'utf-8');
     return new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.length);
-}var signature=/*#__PURE__*/Object.freeze({__proto__:null,createAddKeyData:createAddKeyData,createAddProvider:createAddProvider,createAuthorizedKeyData:createAuthorizedKeyData,createClaimHandlePayload:createClaimHandlePayload,createItemizedAddAction:createItemizedAddAction,createItemizedDeleteAction:createItemizedDeleteAction,createItemizedSignaturePayloadV2:createItemizedSignaturePayloadV2,createPaginatedDeleteSignaturePayloadV2:createPaginatedDeleteSignaturePayloadV2,createPaginatedUpsertSignaturePayloadV2:createPaginatedUpsertSignaturePayloadV2,createPasskeyPublicKey:createPasskeyPublicKey,createSiwfLoginRequestPayload:createSiwfLoginRequestPayload,createSiwfSignedRequestPayload:createSiwfSignedRequestPayload,getEip712BrowserRequestAddKeyData:getEip712BrowserRequestAddKeyData,getEip712BrowserRequestAddProvider:getEip712BrowserRequestAddProvider,getEip712BrowserRequestAuthorizedKeyData:getEip712BrowserRequestAuthorizedKeyData,getEip712BrowserRequestClaimHandlePayload:getEip712BrowserRequestClaimHandlePayload,getEip712BrowserRequestItemizedSignaturePayloadV2:getEip712BrowserRequestItemizedSignaturePayloadV2,getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2:getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2,getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2:getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2,getEip712BrowserRequestPasskeyPublicKey:getEip712BrowserRequestPasskeyPublicKey,getEip712BrowserRequestSiwfSignedRequestPayload:getEip712BrowserRequestSiwfSignedRequestPayload,getEthereumMessageSigner:getEthereumMessageSigner,getEthereumRegularSigner:getEthereumRegularSigner,sign:sign,verifySignature:verifySignature});var index = { ...payloads, ...address, ...signatureDefinitions, ...signature };exports.ADD_KEY_DATA_DEFINITION=ADD_KEY_DATA_DEFINITION;exports.ADD_PROVIDER_DEFINITION=ADD_PROVIDER_DEFINITION;exports.AUTHORIZED_KEY_DATA_DEFINITION=AUTHORIZED_KEY_DATA_DEFINITION;exports.CLAIM_HANDLE_PAYLOAD_DEFINITION=CLAIM_HANDLE_PAYLOAD_DEFINITION;exports.EIP712_DOMAIN_DEFINITION=EIP712_DOMAIN_DEFINITION;exports.EIP712_DOMAIN_MAINNET=EIP712_DOMAIN_MAINNET;exports.EIP712_DOMAIN_TESTNET=EIP712_DOMAIN_TESTNET;exports.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2=ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2;exports.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2=PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2;exports.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2=PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2;exports.PASSKEY_PUBLIC_KEY_DEFINITION=PASSKEY_PUBLIC_KEY_DEFINITION;exports.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION=SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION;exports.createAddKeyData=createAddKeyData;exports.createAddProvider=createAddProvider;exports.createAuthorizedKeyData=createAuthorizedKeyData;exports.createClaimHandlePayload=createClaimHandlePayload;exports.createItemizedAddAction=createItemizedAddAction;exports.createItemizedDeleteAction=createItemizedDeleteAction;exports.createItemizedSignaturePayloadV2=createItemizedSignaturePayloadV2;exports.createPaginatedDeleteSignaturePayloadV2=createPaginatedDeleteSignaturePayloadV2;exports.createPaginatedUpsertSignaturePayloadV2=createPaginatedUpsertSignaturePayloadV2;exports.createPasskeyPublicKey=createPasskeyPublicKey;exports.createRandomKey=createRandomKey;exports.createSiwfLoginRequestPayload=createSiwfLoginRequestPayload;exports.createSiwfSignedRequestPayload=createSiwfSignedRequestPayload;exports.default=index;exports.ethereumAddressToKeyringPair=ethereumAddressToKeyringPair;exports.getAccountId20MultiAddress=getAccountId20MultiAddress;exports.getEip712BrowserRequestAddKeyData=getEip712BrowserRequestAddKeyData;exports.getEip712BrowserRequestAddProvider=getEip712BrowserRequestAddProvider;exports.getEip712BrowserRequestAuthorizedKeyData=getEip712BrowserRequestAuthorizedKeyData;exports.getEip712BrowserRequestClaimHandlePayload=getEip712BrowserRequestClaimHandlePayload;exports.getEip712BrowserRequestItemizedSignaturePayloadV2=getEip712BrowserRequestItemizedSignaturePayloadV2;exports.getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2=getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2;exports.getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2=getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2;exports.getEip712BrowserRequestPasskeyPublicKey=getEip712BrowserRequestPasskeyPublicKey;exports.getEip712BrowserRequestSiwfSignedRequestPayload=getEip712BrowserRequestSiwfSignedRequestPayload;exports.getEthereumMessageSigner=getEthereumMessageSigner;exports.getEthereumRegularSigner=getEthereumRegularSigner;exports.getKeyringPairFromSecp256k1PrivateKey=getKeyringPairFromSecp256k1PrivateKey;exports.getSS58AccountFromEthereumAccount=getSS58AccountFromEthereumAccount;exports.getUnifiedAddress=getUnifiedAddress;exports.getUnifiedPublicKey=getUnifiedPublicKey;exports.reverseUnifiedAddressToEthereumAddress=reverseUnifiedAddressToEthereumAddress;exports.sign=sign;exports.verifySignature=verifySignature;Object.defineProperty(exports,'__esModule',{value:true});}));
+}var signature=/*#__PURE__*/Object.freeze({__proto__:null,createAddKeyData:createAddKeyData,createAddProvider:createAddProvider,createAuthorizedKeyData:createAuthorizedKeyData,createClaimHandlePayload:createClaimHandlePayload,createItemizedAddAction:createItemizedAddAction,createItemizedDeleteAction:createItemizedDeleteAction,createItemizedSignaturePayloadV2:createItemizedSignaturePayloadV2,createPaginatedDeleteSignaturePayloadV2:createPaginatedDeleteSignaturePayloadV2,createPaginatedUpsertSignaturePayloadV2:createPaginatedUpsertSignaturePayloadV2,createPasskeyPublicKey:createPasskeyPublicKey,createRecoveryCommitmentPayload:createRecoveryCommitmentPayload,createSiwfLoginRequestPayload:createSiwfLoginRequestPayload,createSiwfSignedRequestPayload:createSiwfSignedRequestPayload,getEip712BrowserRequestAddKeyData:getEip712BrowserRequestAddKeyData,getEip712BrowserRequestAddProvider:getEip712BrowserRequestAddProvider,getEip712BrowserRequestAuthorizedKeyData:getEip712BrowserRequestAuthorizedKeyData,getEip712BrowserRequestClaimHandlePayload:getEip712BrowserRequestClaimHandlePayload,getEip712BrowserRequestItemizedSignaturePayloadV2:getEip712BrowserRequestItemizedSignaturePayloadV2,getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2:getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2,getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2:getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2,getEip712BrowserRequestPasskeyPublicKey:getEip712BrowserRequestPasskeyPublicKey,getEip712BrowserRequestRecoveryCommitmentPayload:getEip712BrowserRequestRecoveryCommitmentPayload,getEip712BrowserRequestSiwfSignedRequestPayload:getEip712BrowserRequestSiwfSignedRequestPayload,getEthereumMessageSigner:getEthereumMessageSigner,getEthereumRegularSigner:getEthereumRegularSigner,sign:sign,verifySignature:verifySignature});var index = { ...payloads, ...address, ...signatureDefinitions, ...signature };exports.ADD_KEY_DATA_DEFINITION=ADD_KEY_DATA_DEFINITION;exports.ADD_PROVIDER_DEFINITION=ADD_PROVIDER_DEFINITION;exports.AUTHORIZED_KEY_DATA_DEFINITION=AUTHORIZED_KEY_DATA_DEFINITION;exports.CLAIM_HANDLE_PAYLOAD_DEFINITION=CLAIM_HANDLE_PAYLOAD_DEFINITION;exports.EIP712_DOMAIN_DEFINITION=EIP712_DOMAIN_DEFINITION;exports.EIP712_DOMAIN_MAINNET=EIP712_DOMAIN_MAINNET;exports.EIP712_DOMAIN_TESTNET=EIP712_DOMAIN_TESTNET;exports.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2=ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2;exports.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2=PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2;exports.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2=PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2;exports.PASSKEY_PUBLIC_KEY_DEFINITION=PASSKEY_PUBLIC_KEY_DEFINITION;exports.RECOVERY_COMMITMENT_PAYLOAD_DEFINITION=RECOVERY_COMMITMENT_PAYLOAD_DEFINITION;exports.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION=SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION;exports.createAddKeyData=createAddKeyData;exports.createAddProvider=createAddProvider;exports.createAuthorizedKeyData=createAuthorizedKeyData;exports.createClaimHandlePayload=createClaimHandlePayload;exports.createItemizedAddAction=createItemizedAddAction;exports.createItemizedDeleteAction=createItemizedDeleteAction;exports.createItemizedSignaturePayloadV2=createItemizedSignaturePayloadV2;exports.createPaginatedDeleteSignaturePayloadV2=createPaginatedDeleteSignaturePayloadV2;exports.createPaginatedUpsertSignaturePayloadV2=createPaginatedUpsertSignaturePayloadV2;exports.createPasskeyPublicKey=createPasskeyPublicKey;exports.createRandomKey=createRandomKey;exports.createRecoveryCommitmentPayload=createRecoveryCommitmentPayload;exports.createSiwfLoginRequestPayload=createSiwfLoginRequestPayload;exports.createSiwfSignedRequestPayload=createSiwfSignedRequestPayload;exports.default=index;exports.ethereumAddressToKeyringPair=ethereumAddressToKeyringPair;exports.getAccountId20MultiAddress=getAccountId20MultiAddress;exports.getEip712BrowserRequestAddKeyData=getEip712BrowserRequestAddKeyData;exports.getEip712BrowserRequestAddProvider=getEip712BrowserRequestAddProvider;exports.getEip712BrowserRequestAuthorizedKeyData=getEip712BrowserRequestAuthorizedKeyData;exports.getEip712BrowserRequestClaimHandlePayload=getEip712BrowserRequestClaimHandlePayload;exports.getEip712BrowserRequestItemizedSignaturePayloadV2=getEip712BrowserRequestItemizedSignaturePayloadV2;exports.getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2=getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2;exports.getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2=getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2;exports.getEip712BrowserRequestPasskeyPublicKey=getEip712BrowserRequestPasskeyPublicKey;exports.getEip712BrowserRequestRecoveryCommitmentPayload=getEip712BrowserRequestRecoveryCommitmentPayload;exports.getEip712BrowserRequestSiwfSignedRequestPayload=getEip712BrowserRequestSiwfSignedRequestPayload;exports.getEthereumMessageSigner=getEthereumMessageSigner;exports.getEthereumRegularSigner=getEthereumRegularSigner;exports.getKeyringPairFromSecp256k1PrivateKey=getKeyringPairFromSecp256k1PrivateKey;exports.getSS58AccountFromEthereumAccount=getSS58AccountFromEthereumAccount;exports.getUnifiedAddress=getUnifiedAddress;exports.getUnifiedPublicKey=getUnifiedPublicKey;exports.reverseUnifiedAddressToEthereumAddress=reverseUnifiedAddressToEthereumAddress;exports.sign=sign;exports.verifySignature=verifySignature;Object.defineProperty(exports,'__esModule',{value:true});}));

package/cjs/signature.definitions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION = exports.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2 = exports.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2 = exports.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2 = exports.PASSKEY_PUBLIC_KEY_DEFINITION = exports.CLAIM_HANDLE_PAYLOAD_DEFINITION = exports.AUTHORIZED_KEY_DATA_DEFINITION = exports.ADD_KEY_DATA_DEFINITION = exports.ADD_PROVIDER_DEFINITION = exports.EIP712_DOMAIN_TESTNET = exports.EIP712_DOMAIN_MAINNET = exports.EIP712_DOMAIN_DEFINITION = void 0;
+exports.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION = exports.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2 = exports.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2 = exports.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2 = exports.PASSKEY_PUBLIC_KEY_DEFINITION = exports.CLAIM_HANDLE_PAYLOAD_DEFINITION = exports.RECOVERY_COMMITMENT_PAYLOAD_DEFINITION = exports.AUTHORIZED_KEY_DATA_DEFINITION = exports.ADD_KEY_DATA_DEFINITION = exports.ADD_PROVIDER_DEFINITION = exports.EIP712_DOMAIN_TESTNET = exports.EIP712_DOMAIN_MAINNET = exports.EIP712_DOMAIN_DEFINITION = void 0;
 exports.EIP712_DOMAIN_DEFINITION = {
     EIP712Domain: [
         {
@@ -83,6 +83,18 @@ exports.AUTHORIZED_KEY_DATA_DEFINITION = {
         },
     ],
 };
+exports.RECOVERY_COMMITMENT_PAYLOAD_DEFINITION = {
+    RecoveryCommitmentPayload: [
+        {
+            name: 'recoveryCommitment',
+            type: 'bytes',
+        },
+        {
+            name: 'expiration',
+            type: 'uint32',
+        },
+    ],
+};
 exports.CLAIM_HANDLE_PAYLOAD_DEFINITION = {
     ClaimHandlePayload: [
         {
@@ -196,6 +208,7 @@ const PAYLOAD_DEFINITIONS = [
     exports.PASSKEY_PUBLIC_KEY_DEFINITION,
     exports.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,
     exports.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,
+    exports.RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,
     exports.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,
     exports.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
 ];

package/cjs/signature.js

@@ -5,6 +5,7 @@ exports.verifySignature = verifySignature;
 exports.createAddKeyData = createAddKeyData;
 exports.createAuthorizedKeyData = createAuthorizedKeyData;
 exports.createAddProvider = createAddProvider;
+exports.createRecoveryCommitmentPayload = createRecoveryCommitmentPayload;
 exports.createClaimHandlePayload = createClaimHandlePayload;
 exports.createPasskeyPublicKey = createPasskeyPublicKey;
 exports.createItemizedAddAction = createItemizedAddAction;
@@ -17,6 +18,7 @@ exports.createSiwfLoginRequestPayload = createSiwfLoginRequestPayload;
 exports.getEip712BrowserRequestAddKeyData = getEip712BrowserRequestAddKeyData;
 exports.getEip712BrowserRequestAuthorizedKeyData = getEip712BrowserRequestAuthorizedKeyData;
 exports.getEip712BrowserRequestAddProvider = getEip712BrowserRequestAddProvider;
+exports.getEip712BrowserRequestRecoveryCommitmentPayload = getEip712BrowserRequestRecoveryCommitmentPayload;
 exports.getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2 = getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2;
 exports.getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2 = getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2;
 exports.getEip712BrowserRequestItemizedSignaturePayloadV2 = getEip712BrowserRequestItemizedSignaturePayloadV2;
@@ -87,6 +89,7 @@ function normalizePayload(payload) {
         case 'PasskeyPublicKey':
         case 'ClaimHandlePayload':
         case 'AddProvider':
+        case 'RecoveryCommitmentPayload':
         case 'SiwfLoginRequestPayload':
             break;
         case 'AddKeyData':
@@ -125,6 +128,7 @@ function getTypesFor(payloadType) {
         AddKeyData: signature_definitions_js_1.ADD_KEY_DATA_DEFINITION,
         AuthorizedKeyData: signature_definitions_js_1.AUTHORIZED_KEY_DATA_DEFINITION,
         AddProvider: signature_definitions_js_1.ADD_PROVIDER_DEFINITION,
+        RecoveryCommitmentPayload: signature_definitions_js_1.RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,
         // offchain signatures
         SiwfSignedRequestPayload: signature_definitions_js_1.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
     };
@@ -200,6 +204,21 @@ function createAddProvider(authorizedMsaId, schemaIds, expirationBlock) {
         expiration: expirationBlock,
     };
 }
+/**
+ * Build a RecoveryCommitmentPayload for signature.
+ *
+ * @param recoveryCommitment The recovery commitment data as a HexString
+ * @param expirationBlock Block number after which this payload is invalid
+ */
+function createRecoveryCommitmentPayload(recoveryCommitment, expirationBlock) {
+    (0, utils_js_1.assert)((0, utils_js_1.isHexString)(recoveryCommitment), 'recoveryCommitment should be a valid hex string');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(expirationBlock), 'expiration should be a valid uint32');
+    return {
+        type: 'RecoveryCommitmentPayload',
+        recoveryCommitment: recoveryCommitment,
+        expiration: expirationBlock,
+    };
+}
 /**
  * Build a ClaimHandlePayload for signature.
  *
@@ -372,6 +391,18 @@ function getEip712BrowserRequestAddProvider(authorizedMsaId, schemaIds, expirati
     const normalized = normalizePayload(message);
     return createEip712Payload(signature_definitions_js_1.ADD_PROVIDER_DEFINITION, message.type, domain, normalized);
 }
+/**
+ * Returns the EIP-712 browser request for a RecoveryCommitmentPayload for signing.
+ *
+ * @param recoveryCommitment The recovery commitment data as a Uint8Array
+ * @param expirationBlock Block number after which this payload is invalid
+ * @param domain
+ */
+function getEip712BrowserRequestRecoveryCommitmentPayload(recoveryCommitment, expirationBlock, domain = signature_definitions_js_1.EIP712_DOMAIN_MAINNET) {
+    const message = createRecoveryCommitmentPayload(recoveryCommitment, expirationBlock);
+    const normalized = normalizePayload(message);
+    return createEip712Payload(signature_definitions_js_1.RECOVERY_COMMITMENT_PAYLOAD_DEFINITION, message.type, domain, normalized);
+}
 /**
  * Returns the EIP-712 browser request for a PaginatedUpsertSignaturePayloadV2 for signing.
  *

package/esm/signature.definitions.js

@@ -80,6 +80,18 @@ export const AUTHORIZED_KEY_DATA_DEFINITION = {
         },
     ],
 };
+export const RECOVERY_COMMITMENT_PAYLOAD_DEFINITION = {
+    RecoveryCommitmentPayload: [
+        {
+            name: 'recoveryCommitment',
+            type: 'bytes',
+        },
+        {
+            name: 'expiration',
+            type: 'uint32',
+        },
+    ],
+};
 export const CLAIM_HANDLE_PAYLOAD_DEFINITION = {
     ClaimHandlePayload: [
         {
@@ -193,6 +205,7 @@ const PAYLOAD_DEFINITIONS = [
     PASSKEY_PUBLIC_KEY_DEFINITION,
     PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,
     PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,
+    RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,
     ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,
     SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
 ];

package/esm/signature.js

@@ -2,7 +2,7 @@ import { assert, isHexString, isValidUint16, isValidUint32, isValidUint64String
 import { reverseUnifiedAddressToEthereumAddress } from './address.js';
 import { ethers } from 'ethers';
 import { u8aToHex } from '@polkadot/util';
-import { ADD_KEY_DATA_DEFINITION, ADD_PROVIDER_DEFINITION, AUTHORIZED_KEY_DATA_DEFINITION, CLAIM_HANDLE_PAYLOAD_DEFINITION, EIP712_DOMAIN_MAINNET, EIP712_DOMAIN_DEFINITION, ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2, PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2, PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2, PASSKEY_PUBLIC_KEY_DEFINITION, SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION, EIP712_DOMAIN_TESTNET, } from './signature.definitions.js';
+import { ADD_KEY_DATA_DEFINITION, ADD_PROVIDER_DEFINITION, AUTHORIZED_KEY_DATA_DEFINITION, CLAIM_HANDLE_PAYLOAD_DEFINITION, EIP712_DOMAIN_MAINNET, EIP712_DOMAIN_DEFINITION, ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2, PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2, PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2, PASSKEY_PUBLIC_KEY_DEFINITION, SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION, EIP712_DOMAIN_TESTNET, RECOVERY_COMMITMENT_PAYLOAD_DEFINITION, } from './signature.definitions.js';
 /**
  * Signing EIP-712 or ERC-191 compatible signature based on payload
  * @param secretKey
@@ -60,6 +60,7 @@ function normalizePayload(payload) {
         case 'PasskeyPublicKey':
         case 'ClaimHandlePayload':
         case 'AddProvider':
+        case 'RecoveryCommitmentPayload':
         case 'SiwfLoginRequestPayload':
             break;
         case 'AddKeyData':
@@ -98,6 +99,7 @@ function getTypesFor(payloadType) {
         AddKeyData: ADD_KEY_DATA_DEFINITION,
         AuthorizedKeyData: AUTHORIZED_KEY_DATA_DEFINITION,
         AddProvider: ADD_PROVIDER_DEFINITION,
+        RecoveryCommitmentPayload: RECOVERY_COMMITMENT_PAYLOAD_DEFINITION,
         // offchain signatures
         SiwfSignedRequestPayload: SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
     };
@@ -173,6 +175,21 @@ export function createAddProvider(authorizedMsaId, schemaIds, expirationBlock) {
         expiration: expirationBlock,
     };
 }
+/**
+ * Build a RecoveryCommitmentPayload for signature.
+ *
+ * @param recoveryCommitment The recovery commitment data as a HexString
+ * @param expirationBlock Block number after which this payload is invalid
+ */
+export function createRecoveryCommitmentPayload(recoveryCommitment, expirationBlock) {
+    assert(isHexString(recoveryCommitment), 'recoveryCommitment should be a valid hex string');
+    assert(isValidUint32(expirationBlock), 'expiration should be a valid uint32');
+    return {
+        type: 'RecoveryCommitmentPayload',
+        recoveryCommitment: recoveryCommitment,
+        expiration: expirationBlock,
+    };
+}
 /**
  * Build a ClaimHandlePayload for signature.
  *
@@ -345,6 +362,18 @@ export function getEip712BrowserRequestAddProvider(authorizedMsaId, schemaIds, e
     const normalized = normalizePayload(message);
     return createEip712Payload(ADD_PROVIDER_DEFINITION, message.type, domain, normalized);
 }
+/**
+ * Returns the EIP-712 browser request for a RecoveryCommitmentPayload for signing.
+ *
+ * @param recoveryCommitment The recovery commitment data as a Uint8Array
+ * @param expirationBlock Block number after which this payload is invalid
+ * @param domain
+ */
+export function getEip712BrowserRequestRecoveryCommitmentPayload(recoveryCommitment, expirationBlock, domain = EIP712_DOMAIN_MAINNET) {
+    const message = createRecoveryCommitmentPayload(recoveryCommitment, expirationBlock);
+    const normalized = normalizePayload(message);
+    return createEip712Payload(RECOVERY_COMMITMENT_PAYLOAD_DEFINITION, message.type, domain, normalized);
+}
 /**
  * Returns the EIP-712 browser request for a PaginatedUpsertSignaturePayloadV2 for signing.
  *

package/index.d.ts

@@ -9,6 +9,7 @@ declare const _default: {
     createAddKeyData(msaId: string | bigint, newPublicKey: payloads.HexString | Uint8Array, expirationBlock: number): payloads.AddKeyData;
     createAuthorizedKeyData(msaId: string | bigint, newPublicKey: payloads.HexString | Uint8Array, expirationBlock: number): payloads.AuthorizedKeyData;
     createAddProvider(authorizedMsaId: string | bigint, schemaIds: number[], expirationBlock: number): payloads.AddProvider;
+    createRecoveryCommitmentPayload(recoveryCommitment: payloads.HexString, expirationBlock: number): payloads.RecoveryCommitmentPayload;
     createClaimHandlePayload(handle: string, expirationBlock: number): payloads.ClaimHandlePayload;
     createPasskeyPublicKey(publicKey: payloads.HexString | Uint8Array): payloads.PasskeyPublicKey;
     createItemizedAddAction(data: payloads.HexString | Uint8Array): payloads.AddItemizedAction;
@@ -21,6 +22,7 @@ declare const _default: {
     getEip712BrowserRequestAddKeyData(msaId: string | bigint, newPublicKey: payloads.HexString | Uint8Array, expirationBlock: number, domain?: payloads.EipDomainPayload): unknown;
     getEip712BrowserRequestAuthorizedKeyData(msaId: string | bigint, authorizedPublicKey: payloads.HexString | Uint8Array, expirationBlock: number, domain?: payloads.EipDomainPayload): unknown;
     getEip712BrowserRequestAddProvider(authorizedMsaId: string | bigint, schemaIds: number[], expirationBlock: number, domain?: payloads.EipDomainPayload): unknown;
+    getEip712BrowserRequestRecoveryCommitmentPayload(recoveryCommitment: payloads.HexString, expirationBlock: number, domain?: payloads.EipDomainPayload): unknown;
     getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number, payload: payloads.HexString | Uint8Array, domain?: payloads.EipDomainPayload): unknown;
     getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number, domain?: payloads.EipDomainPayload): unknown;
     getEip712BrowserRequestItemizedSignaturePayloadV2(schemaId: number, targetHash: number, expiration: number, actions: payloads.ItemizedAction[], domain?: payloads.EipDomainPayload): unknown;
@@ -55,6 +57,12 @@ declare const _default: {
             type: string;
         }[];
     };
+    RECOVERY_COMMITMENT_PAYLOAD_DEFINITION: {
+        RecoveryCommitmentPayload: {
+            name: string;
+            type: string;
+        }[];
+    };
     CLAIM_HANDLE_PAYLOAD_DEFINITION: {
         ClaimHandlePayload: {
             name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frequency-chain/ethereum-utils",
-  "version": "1.17.0-rc7",
+  "version": "1.17.1",
   "bugs": {
     "url": "https://github.com/frequency-chain/frequency/issues"
   },
@@ -15,9 +15,9 @@
   "author": "frequency-chain",
   "license": "Apache-2.0",
   "dependencies": {
-    "@polkadot/api": "^16.2.2",
-    "@polkadot/util": "13.5.2",
-    "ethers": "^6.14.4"
+    "@polkadot/api": "^16.3.1",
+    "@polkadot/util": "13.5.3",
+    "ethers": "^6.15.0"
   },
   "optionalDependencies": {
     "@rollup/rollup-linux-x64-gnu": "^4.44.1"

package/payloads.d.ts

@@ -77,6 +77,11 @@ export interface AddProvider {
     schemaIds: number[];
     expiration: number;
 }
+export interface RecoveryCommitmentPayload {
+    type: 'RecoveryCommitmentPayload';
+    recoveryCommitment: HexString;
+    expiration: number;
+}
 export interface SiwfSignedRequestPayload {
     type: 'SiwfSignedRequestPayload';
     callback: string;
@@ -87,7 +92,7 @@ export interface SiwfLoginRequestPayload {
     type: 'SiwfLoginRequestPayload';
     message: string;
 }
-export type SupportedPayload = PaginatedUpsertSignaturePayloadV2 | PaginatedDeleteSignaturePayloadV2 | ItemizedSignaturePayloadV2 | PasskeyPublicKey | ClaimHandlePayload | AddKeyData | AuthorizedKeyData | AddProvider | SiwfSignedRequestPayload | SiwfLoginRequestPayload;
+export type SupportedPayload = PaginatedUpsertSignaturePayloadV2 | PaginatedDeleteSignaturePayloadV2 | ItemizedSignaturePayloadV2 | PasskeyPublicKey | ClaimHandlePayload | AddKeyData | AuthorizedKeyData | AddProvider | RecoveryCommitmentPayload | SiwfSignedRequestPayload | SiwfLoginRequestPayload;
 export type NormalizedSupportedPayload = Omit<SupportedPayload, 'type'>;
 export interface EipDomainPayload {
     name: string;

package/signature.d.ts

@@ -1,4 +1,4 @@
-import { AddKeyData, AuthorizedKeyData, AddProvider, ChainType, ClaimHandlePayload, EcdsaSignature, ItemizedSignaturePayloadV2, PaginatedDeleteSignaturePayloadV2, PaginatedUpsertSignaturePayloadV2, PasskeyPublicKey, SupportedPayload, HexString, AddItemizedAction, DeleteItemizedAction, ItemizedAction, EipDomainPayload, SiwfSignedRequestPayload, SiwfLoginRequestPayload } from './payloads.js';
+import { AddKeyData, AuthorizedKeyData, AddProvider, ChainType, ClaimHandlePayload, EcdsaSignature, ItemizedSignaturePayloadV2, PaginatedDeleteSignaturePayloadV2, PaginatedUpsertSignaturePayloadV2, PasskeyPublicKey, SupportedPayload, HexString, AddItemizedAction, DeleteItemizedAction, ItemizedAction, EipDomainPayload, RecoveryCommitmentPayload, SiwfSignedRequestPayload, SiwfLoginRequestPayload } from './payloads.js';
 import { KeyringPair } from '@polkadot/keyring/types';
 import { Signer } from '@polkadot/types/types';
 /**
@@ -40,6 +40,13 @@ export declare function createAuthorizedKeyData(msaId: string | bigint, newPubli
  * @param expirationBlock Block number after which this payload is invalid
  */
 export declare function createAddProvider(authorizedMsaId: string | bigint, schemaIds: number[], expirationBlock: number): AddProvider;
+/**
+ * Build a RecoveryCommitmentPayload for signature.
+ *
+ * @param recoveryCommitment The recovery commitment data as a HexString
+ * @param expirationBlock Block number after which this payload is invalid
+ */
+export declare function createRecoveryCommitmentPayload(recoveryCommitment: HexString, expirationBlock: number): RecoveryCommitmentPayload;
 /**
  * Build a ClaimHandlePayload for signature.
  *
@@ -124,6 +131,14 @@ export declare function getEip712BrowserRequestAuthorizedKeyData(msaId: string |
  * @param domain
  */
 export declare function getEip712BrowserRequestAddProvider(authorizedMsaId: string | bigint, schemaIds: number[], expirationBlock: number, domain?: EipDomainPayload): unknown;
+/**
+ * Returns the EIP-712 browser request for a RecoveryCommitmentPayload for signing.
+ *
+ * @param recoveryCommitment The recovery commitment data as a Uint8Array
+ * @param expirationBlock Block number after which this payload is invalid
+ * @param domain
+ */
+export declare function getEip712BrowserRequestRecoveryCommitmentPayload(recoveryCommitment: HexString, expirationBlock: number, domain?: EipDomainPayload): unknown;
 /**
  * Returns the EIP-712 browser request for a PaginatedUpsertSignaturePayloadV2 for signing.
  *

package/signature.definitions.d.ts

@@ -25,6 +25,12 @@ export declare const AUTHORIZED_KEY_DATA_DEFINITION: {
         type: string;
     }[];
 };
+export declare const RECOVERY_COMMITMENT_PAYLOAD_DEFINITION: {
+    RecoveryCommitmentPayload: {
+        name: string;
+        type: string;
+    }[];
+};
 export declare const CLAIM_HANDLE_PAYLOAD_DEFINITION: {
     ClaimHandlePayload: {
         name: string;
@@ -80,6 +86,11 @@ declare const PAYLOAD_DEFINITIONS: ({
         name: string;
         type: string;
     }[];
+} | {
+    RecoveryCommitmentPayload: {
+        name: string;
+        type: string;
+    }[];
 } | {
     ClaimHandlePayload: {
         name: string;