@frequency-chain/ethereum-utils 1.17.0-rc5 → 1.17.0-rc6

package/cjs/index.js

@@ -36,12 +36,12 @@ 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 });
-const address = __importStar(require("./address"));
-const payloads = __importStar(require("./payloads"));
-const signature = __importStar(require("./signature"));
-const signatureDefinitions = __importStar(require("./signature.definitions"));
-__exportStar(require("./payloads"), exports);
-__exportStar(require("./signature"), exports);
-__exportStar(require("./signature.definitions"), exports);
-__exportStar(require("./address"), exports);
+const address = __importStar(require("./address.js"));
+const payloads = __importStar(require("./payloads.js"));
+const signature = __importStar(require("./signature.js"));
+const signatureDefinitions = __importStar(require("./signature.definitions.js"));
+__exportStar(require("./payloads.js"), exports);
+__exportStar(require("./signature.js"), exports);
+__exportStar(require("./signature.definitions.js"), exports);
+__exportStar(require("./address.js"), exports);
 exports.default = { ...payloads, ...address, ...signatureDefinitions, ...signature };

package/cjs/signature.definitions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.ADD_KEY_DATA_DEFINITION = exports.ADD_PROVIDER_DEFINITION = exports.EIP712_DOMAIN_DEFAULT = 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.AUTHORIZED_KEY_DATA_DEFINITION = exports.ADD_KEY_DATA_DEFINITION = exports.ADD_PROVIDER_DEFINITION = exports.EIP712_DOMAIN_DEFAULT = exports.EIP712_DOMAIN_DEFINITION = void 0;
 exports.EIP712_DOMAIN_DEFINITION = {
     EIP712Domain: [
         {
@@ -60,6 +60,22 @@ exports.ADD_KEY_DATA_DEFINITION = {
         },
     ],
 };
+exports.AUTHORIZED_KEY_DATA_DEFINITION = {
+    AuthorizedKeyData: [
+        {
+            name: 'msaId',
+            type: 'uint64',
+        },
+        {
+            name: 'expiration',
+            type: 'uint32',
+        },
+        {
+            name: 'authorizedPublicKey',
+            type: 'address',
+        },
+    ],
+};
 exports.CLAIM_HANDLE_PAYLOAD_DEFINITION = {
     ClaimHandlePayload: [
         {
@@ -149,3 +165,30 @@ exports.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2 = {
         { name: 'index', type: 'uint16' },
     ],
 };
+exports.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION = {
+    SiwfSignedRequestPayload: [
+        {
+            name: 'callback',
+            type: 'string',
+        },
+        {
+            name: 'permissions',
+            type: 'uint16[]',
+        },
+        {
+            name: 'userIdentifierAdminUrl',
+            type: 'string',
+        },
+    ],
+};
+const PAYLOAD_DEFINITIONS = [
+    exports.ADD_PROVIDER_DEFINITION,
+    exports.ADD_KEY_DATA_DEFINITION,
+    exports.AUTHORIZED_KEY_DATA_DEFINITION,
+    exports.CLAIM_HANDLE_PAYLOAD_DEFINITION,
+    exports.PASSKEY_PUBLIC_KEY_DEFINITION,
+    exports.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,
+    exports.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,
+    exports.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,
+    exports.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
+];

package/cjs/signature.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.signEip712 = signEip712;
-exports.verifyEip712Signature = verifyEip712Signature;
+exports.sign = sign;
+exports.verifySignature = verifySignature;
 exports.createAddKeyData = createAddKeyData;
+exports.createAuthorizedKeyData = createAuthorizedKeyData;
 exports.createAddProvider = createAddProvider;
 exports.createClaimHandlePayload = createClaimHandlePayload;
 exports.createPasskeyPublicKey = createPasskeyPublicKey;
@@ -11,48 +12,72 @@ exports.createItemizedDeleteAction = createItemizedDeleteAction;
 exports.createItemizedSignaturePayloadV2 = createItemizedSignaturePayloadV2;
 exports.createPaginatedDeleteSignaturePayloadV2 = createPaginatedDeleteSignaturePayloadV2;
 exports.createPaginatedUpsertSignaturePayloadV2 = createPaginatedUpsertSignaturePayloadV2;
+exports.createSiwfSignedRequestPayload = createSiwfSignedRequestPayload;
+exports.createSiwfLoginRequestPayload = createSiwfLoginRequestPayload;
 exports.getEip712BrowserRequestAddKeyData = getEip712BrowserRequestAddKeyData;
+exports.getEip712BrowserRequestAuthorizedKeyData = getEip712BrowserRequestAuthorizedKeyData;
 exports.getEip712BrowserRequestAddProvider = getEip712BrowserRequestAddProvider;
 exports.getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2 = getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2;
 exports.getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2 = getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2;
 exports.getEip712BrowserRequestItemizedSignaturePayloadV2 = getEip712BrowserRequestItemizedSignaturePayloadV2;
 exports.getEip712BrowserRequestClaimHandlePayload = getEip712BrowserRequestClaimHandlePayload;
 exports.getEip712BrowserRequestPasskeyPublicKey = getEip712BrowserRequestPasskeyPublicKey;
+exports.getEip712BrowserRequestSiwfSignedRequestPayload = getEip712BrowserRequestSiwfSignedRequestPayload;
 exports.getEthereumRegularSigner = getEthereumRegularSigner;
 exports.getEthereumMessageSigner = getEthereumMessageSigner;
-const utils_1 = require("./utils");
-const address_1 = require("./address");
+const utils_js_1 = require("./utils.js");
+const address_js_1 = require("./address.js");
 const ethers_1 = require("ethers");
 const util_1 = require("@polkadot/util");
-const signature_definitions_1 = require("./signature.definitions");
+const signature_definitions_js_1 = require("./signature.definitions.js");
 /**
- * Signing EIP-712 compatible signature for payload
+ * Signing EIP-712 or ERC-191 compatible signature based on payload
  * @param secretKey
  * @param payload
  * @param chain
  */
-async function signEip712(secretKey, payload, chain = 'Mainnet-Frequency') {
-    const types = getTypesFor(payload.type);
+async function sign(secretKey, payload, chain = 'Mainnet-Frequency') {
+    const signatureType = getSignatureType(payload.type);
     const normalizedPayload = normalizePayload(payload);
     const wallet = new ethers_1.ethers.Wallet(secretKey);
-    // TODO: use correct chainID for different networks
-    // TODO: use correct contract address for different payloads
-    const signature = await wallet.signTypedData(signature_definitions_1.EIP712_DOMAIN_DEFAULT, types, normalizedPayload);
+    let signature;
+    switch (signatureType) {
+        case 'EIP-712':
+            // TODO: use correct chainID for different networks
+            // TODO: use correct contract address for different payloads
+            signature = await wallet.signTypedData(signature_definitions_js_1.EIP712_DOMAIN_DEFAULT, getTypesFor(payload.type), normalizedPayload);
+            break;
+        case 'EIP-191':
+            signature = await wallet.signMessage(payload.message);
+            break;
+        default:
+            throw new Error(`Unsupported signature type : ${signatureType}`);
+    }
     return { Ecdsa: signature };
 }
 /**
- * Verify EIP-712 signatures
+ * Verify EIP-712 and ERC-191 signatures based on payload
  * @param ethereumAddress
  * @param signature
  * @param payload
  * @param chain
  */
-function verifyEip712Signature(ethereumAddress, signature, payload, chain = 'Mainnet-Frequency') {
-    const types = getTypesFor(payload.type);
+function verifySignature(ethereumAddress, signature, payload, chain = 'Mainnet-Frequency') {
+    const signatureType = getSignatureType(payload.type);
     const normalizedPayload = normalizePayload(payload);
-    // TODO: use correct chainID for different networks
-    // TODO: use correct contract address for different payloads
-    const recoveredAddress = ethers_1.ethers.verifyTypedData(signature_definitions_1.EIP712_DOMAIN_DEFAULT, types, normalizedPayload, signature);
+    let recoveredAddress;
+    switch (signatureType) {
+        case 'EIP-712':
+            // TODO: use correct chainID for different networks
+            // TODO: use correct contract address for different payloads
+            recoveredAddress = ethers_1.ethers.verifyTypedData(signature_definitions_js_1.EIP712_DOMAIN_DEFAULT, getTypesFor(payload.type), normalizedPayload, signature);
+            break;
+        case 'EIP-191':
+            recoveredAddress = ethers_1.ethers.verifyMessage(payload.message, signature);
+            break;
+        default:
+            throw new Error(`Unsupported signature type : ${signatureType}`);
+    }
     return recoveredAddress.toLowerCase() === ethereumAddress.toLowerCase();
 }
 function normalizePayload(payload) {
@@ -64,14 +89,27 @@ function normalizePayload(payload) {
         case 'PasskeyPublicKey':
         case 'ClaimHandlePayload':
         case 'AddProvider':
+        case 'SiwfLoginRequestPayload':
             break;
         case 'AddKeyData':
             // convert to 20 bytes ethereum address for signature
             if (clonedPayload.newPublicKey.length !== 42) {
-                clonedPayload.newPublicKey = (0, address_1.reverseUnifiedAddressToEthereumAddress)(payload.newPublicKey);
+                clonedPayload.newPublicKey = (0, address_js_1.reverseUnifiedAddressToEthereumAddress)(payload.newPublicKey);
             }
             clonedPayload.newPublicKey = clonedPayload.newPublicKey.toLowerCase();
             break;
+        case 'AuthorizedKeyData':
+            // convert to 20 bytes ethereum address for signature
+            if (clonedPayload.authorizedPublicKey.length !== 42) {
+                clonedPayload.authorizedPublicKey = (0, address_js_1.reverseUnifiedAddressToEthereumAddress)(payload.authorizedPublicKey);
+            }
+            clonedPayload.authorizedPublicKey = clonedPayload.authorizedPublicKey.toLowerCase();
+            break;
+        case 'SiwfSignedRequestPayload':
+            if (clonedPayload.userIdentifierAdminUrl == null) {
+                clonedPayload.userIdentifierAdminUrl = '';
+            }
+            break;
         default:
             throw new Error(`Unsupported payload type: ${JSON.stringify(payload)}`);
     }
@@ -81,13 +119,16 @@ function normalizePayload(payload) {
 }
 function getTypesFor(payloadType) {
     const PAYLOAD_TYPE_DEFINITIONS = {
-        PaginatedUpsertSignaturePayloadV2: signature_definitions_1.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,
-        PaginatedDeleteSignaturePayloadV2: signature_definitions_1.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,
-        ItemizedSignaturePayloadV2: signature_definitions_1.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,
-        PasskeyPublicKey: signature_definitions_1.PASSKEY_PUBLIC_KEY_DEFINITION,
-        ClaimHandlePayload: signature_definitions_1.CLAIM_HANDLE_PAYLOAD_DEFINITION,
-        AddKeyData: signature_definitions_1.ADD_KEY_DATA_DEFINITION,
-        AddProvider: signature_definitions_1.ADD_PROVIDER_DEFINITION,
+        PaginatedUpsertSignaturePayloadV2: signature_definitions_js_1.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,
+        PaginatedDeleteSignaturePayloadV2: signature_definitions_js_1.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,
+        ItemizedSignaturePayloadV2: signature_definitions_js_1.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,
+        PasskeyPublicKey: signature_definitions_js_1.PASSKEY_PUBLIC_KEY_DEFINITION,
+        ClaimHandlePayload: signature_definitions_js_1.CLAIM_HANDLE_PAYLOAD_DEFINITION,
+        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,
+        // offchain signatures
+        SiwfSignedRequestPayload: signature_definitions_js_1.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
     };
     const definition = PAYLOAD_TYPE_DEFINITIONS[payloadType];
     if (!definition) {
@@ -95,6 +136,12 @@ function getTypesFor(payloadType) {
     }
     return definition;
 }
+function getSignatureType(payloadType) {
+    if (payloadType === 'SiwfLoginRequestPayload') {
+        return 'EIP-191';
+    }
+    return 'EIP-712';
+}
 /**
  * Build an AddKeyData payload for signature.
  *
@@ -105,9 +152,9 @@ function getTypesFor(payloadType) {
 function createAddKeyData(msaId, newPublicKey, expirationBlock) {
     const parsedMsaId = typeof msaId === 'string' ? msaId : `${msaId}`;
     const parsedNewPublicKey = typeof newPublicKey === 'object' ? (0, util_1.u8aToHex)(newPublicKey) : newPublicKey;
-    (0, utils_1.assert)((0, utils_1.isValidUint64String)(parsedMsaId), 'msaId should be a valid uint64');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(expirationBlock), 'expiration should be a valid uint32');
-    (0, utils_1.assert)((0, utils_1.isHexString)(parsedNewPublicKey), 'newPublicKey should be valid hex');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint64String)(parsedMsaId), 'msaId should be a valid uint64');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(expirationBlock), 'expiration should be a valid uint32');
+    (0, utils_js_1.assert)((0, utils_js_1.isHexString)(parsedNewPublicKey), 'newPublicKey should be valid hex');
     return {
         type: 'AddKeyData',
         msaId: parsedMsaId,
@@ -115,6 +162,26 @@ function createAddKeyData(msaId, newPublicKey, expirationBlock) {
         newPublicKey: parsedNewPublicKey,
     };
 }
+/**
+ * Build an AuthorizedKeyData payload for signature.
+ *
+ * @param msaId                  MSA ID (uint64) to add the key
+ * @param authorizedPublicKey    32 bytes public key to authorize in hex or Uint8Array
+ * @param expirationBlock        Block number after which this payload is invalid
+ */
+function createAuthorizedKeyData(msaId, newPublicKey, expirationBlock) {
+    const parsedMsaId = typeof msaId === 'string' ? msaId : `${msaId}`;
+    const parsedNewPublicKey = typeof newPublicKey === 'object' ? (0, util_1.u8aToHex)(newPublicKey) : newPublicKey;
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint64String)(parsedMsaId), 'msaId should be a valid uint64');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(expirationBlock), 'expiration should be a valid uint32');
+    (0, utils_js_1.assert)((0, utils_js_1.isHexString)(parsedNewPublicKey), 'newPublicKey should be valid hex');
+    return {
+        type: 'AuthorizedKeyData',
+        msaId: parsedMsaId,
+        expiration: expirationBlock,
+        authorizedPublicKey: parsedNewPublicKey,
+    };
+}
 /**
  * Build an AddProvider payload for signature.
  *
@@ -123,10 +190,10 @@ function createAddKeyData(msaId, newPublicKey, expirationBlock) {
  * @param expirationBlock Block number after which this payload is invalid
  */
 function createAddProvider(authorizedMsaId, schemaIds, expirationBlock) {
-    (0, utils_1.assert)((0, utils_1.isValidUint64String)(authorizedMsaId), 'authorizedMsaId should be a valid uint64');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(expirationBlock), 'expiration should be a valid uint32');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint64String)(authorizedMsaId), 'authorizedMsaId should be a valid uint64');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(expirationBlock), 'expiration should be a valid uint32');
     schemaIds.forEach((schemaId) => {
-        (0, utils_1.assert)((0, utils_1.isValidUint16)(schemaId), 'schemaId should be a valid uint16');
+        (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(schemaId), 'schemaId should be a valid uint16');
     });
     return {
         type: 'AddProvider',
@@ -142,8 +209,8 @@ function createAddProvider(authorizedMsaId, schemaIds, expirationBlock) {
  * @param expirationBlock Block number after which this payload is invalid
  */
 function createClaimHandlePayload(handle, expirationBlock) {
-    (0, utils_1.assert)(handle.length > 0, 'handle should be a valid string');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(expirationBlock), 'expiration should be a valid uint32');
+    (0, utils_js_1.assert)(handle.length > 0, 'handle should be a valid string');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(expirationBlock), 'expiration should be a valid uint32');
     return {
         type: 'ClaimHandlePayload',
         handle,
@@ -157,7 +224,7 @@ function createClaimHandlePayload(handle, expirationBlock) {
  */
 function createPasskeyPublicKey(publicKey) {
     const parsedNewPublicKey = typeof publicKey === 'object' ? (0, util_1.u8aToHex)(publicKey) : publicKey;
-    (0, utils_1.assert)((0, utils_1.isHexString)(parsedNewPublicKey), 'publicKey should be valid hex');
+    (0, utils_js_1.assert)((0, utils_js_1.isHexString)(parsedNewPublicKey), 'publicKey should be valid hex');
     return {
         type: 'PasskeyPublicKey',
         publicKey: parsedNewPublicKey,
@@ -165,11 +232,11 @@ function createPasskeyPublicKey(publicKey) {
 }
 function createItemizedAddAction(data) {
     const parsedData = typeof data === 'object' ? (0, util_1.u8aToHex)(data) : data;
-    (0, utils_1.assert)((0, utils_1.isHexString)(parsedData), 'itemized data should be valid hex');
+    (0, utils_js_1.assert)((0, utils_js_1.isHexString)(parsedData), 'itemized data should be valid hex');
     return { actionType: 'Add', data, index: 0 };
 }
 function createItemizedDeleteAction(index) {
-    (0, utils_1.assert)((0, utils_1.isValidUint16)(index), 'itemized index should be a valid uint16');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(index), 'itemized index should be a valid uint16');
     return { actionType: 'Delete', data: '0x', index };
 }
 /**
@@ -181,10 +248,10 @@ function createItemizedDeleteAction(index) {
  * @param actions    Array of Add/Delete itemized actions
  */
 function createItemizedSignaturePayloadV2(schemaId, targetHash, expiration, actions) {
-    (0, utils_1.assert)((0, utils_1.isValidUint16)(schemaId), 'schemaId should be a valid uint16');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(targetHash), 'targetHash should be a valid uint32');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(expiration), 'expiration should be a valid uint32');
-    (0, utils_1.assert)(actions.length > 0, 'At least one action is required for ItemizedSignaturePayloadV2');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(schemaId), 'schemaId should be a valid uint16');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(targetHash), 'targetHash should be a valid uint32');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(expiration), 'expiration should be a valid uint32');
+    (0, utils_js_1.assert)(actions.length > 0, 'At least one action is required for ItemizedSignaturePayloadV2');
     return {
         type: 'ItemizedSignaturePayloadV2',
         schemaId,
@@ -202,10 +269,10 @@ function createItemizedSignaturePayloadV2(schemaId, targetHash, expiration, acti
  * @param expiration uint32 expiration block
  */
 function createPaginatedDeleteSignaturePayloadV2(schemaId, pageId, targetHash, expiration) {
-    (0, utils_1.assert)((0, utils_1.isValidUint16)(schemaId), 'schemaId should be a valid uint16');
-    (0, utils_1.assert)((0, utils_1.isValidUint16)(pageId), 'pageId should be a valid uint16');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(targetHash), 'targetHash should be a valid uint32');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(expiration), 'expiration should be a valid uint32');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(schemaId), 'schemaId should be a valid uint16');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(pageId), 'pageId should be a valid uint16');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(targetHash), 'targetHash should be a valid uint32');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(expiration), 'expiration should be a valid uint32');
     return {
         type: 'PaginatedDeleteSignaturePayloadV2',
         schemaId,
@@ -225,11 +292,11 @@ function createPaginatedDeleteSignaturePayloadV2(schemaId, pageId, targetHash, e
  */
 function createPaginatedUpsertSignaturePayloadV2(schemaId, pageId, targetHash, expiration, payload) {
     const parsedPayload = typeof payload === 'object' ? (0, util_1.u8aToHex)(payload) : payload;
-    (0, utils_1.assert)((0, utils_1.isValidUint16)(schemaId), 'schemaId should be a valid uint16');
-    (0, utils_1.assert)((0, utils_1.isValidUint16)(pageId), 'pageId should be a valid uint16');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(targetHash), 'targetHash should be a valid uint32');
-    (0, utils_1.assert)((0, utils_1.isValidUint32)(expiration), 'expiration should be a valid uint32');
-    (0, utils_1.assert)((0, utils_1.isHexString)(parsedPayload), 'payload should be valid hex');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(schemaId), 'schemaId should be a valid uint16');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(pageId), 'pageId should be a valid uint16');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(targetHash), 'targetHash should be a valid uint32');
+    (0, utils_js_1.assert)((0, utils_js_1.isValidUint32)(expiration), 'expiration should be a valid uint32');
+    (0, utils_js_1.assert)((0, utils_js_1.isHexString)(parsedPayload), 'payload should be valid hex');
     return {
         type: 'PaginatedUpsertSignaturePayloadV2',
         schemaId,
@@ -239,6 +306,35 @@ function createPaginatedUpsertSignaturePayloadV2(schemaId, pageId, targetHash, e
         payload: parsedPayload,
     };
 }
+/**
+ * Build an SiwfSignedRequestPayload payload for signature.
+ *
+ * @param callback        Callback URL for login
+ * @param permissions       One or more schema IDs (uint16) the provider may use
+ * @param userIdentifierAdminUrl Only used for custom integration situations.
+ */
+function createSiwfSignedRequestPayload(callback, permissions, userIdentifierAdminUrl) {
+    permissions.forEach((schemaId) => {
+        (0, utils_js_1.assert)((0, utils_js_1.isValidUint16)(schemaId), 'permission should be a valid uint16');
+    });
+    return {
+        type: 'SiwfSignedRequestPayload',
+        callback: callback,
+        permissions,
+        userIdentifierAdminUrl,
+    };
+}
+/**
+ * Build an SiwfLoginRequestPayload payload for signature.
+ *
+ * @param message        login message
+ */
+function createSiwfLoginRequestPayload(message) {
+    return {
+        type: 'SiwfLoginRequestPayload',
+        message,
+    };
+}
 /**
  * Returns the EIP-712 browser request for a AddKeyData for signing.
  *
@@ -247,10 +343,23 @@ function createPaginatedUpsertSignaturePayloadV2(schemaId, pageId, targetHash, e
  * @param expirationBlock Block number after which this payload is invalid
  * @param domain
  */
-function getEip712BrowserRequestAddKeyData(msaId, newPublicKey, expirationBlock, domain = signature_definitions_1.EIP712_DOMAIN_DEFAULT) {
+function getEip712BrowserRequestAddKeyData(msaId, newPublicKey, expirationBlock, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
     const message = createAddKeyData(msaId, newPublicKey, expirationBlock);
     const normalized = normalizePayload(message);
-    return createEip712Payload(signature_definitions_1.ADD_KEY_DATA_DEFINITION, message.type, domain, normalized);
+    return createEip712Payload(signature_definitions_js_1.ADD_KEY_DATA_DEFINITION, message.type, domain, normalized);
+}
+/**
+ * Returns the EIP-712 browser request for a AuthorizedKeyData for signing.
+ *
+ * @param msaId           MSA ID (uint64) to add the key
+ * @param authorizedPublicKey    32 bytes public key to add in hex or Uint8Array
+ * @param expirationBlock Block number after which this payload is invalid
+ * @param domain
+ */
+function getEip712BrowserRequestAuthorizedKeyData(msaId, authorizedPublicKey, expirationBlock, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
+    const message = createAuthorizedKeyData(msaId, authorizedPublicKey, expirationBlock);
+    const normalized = normalizePayload(message);
+    return createEip712Payload(signature_definitions_js_1.AUTHORIZED_KEY_DATA_DEFINITION, message.type, domain, normalized);
 }
 /**
  * Returns the EIP-712 browser request for a AddProvider for signing.
@@ -260,10 +369,10 @@ function getEip712BrowserRequestAddKeyData(msaId, newPublicKey, expirationBlock,
  * @param expirationBlock Block number after which this payload is invalid
  * @param domain
  */
-function getEip712BrowserRequestAddProvider(authorizedMsaId, schemaIds, expirationBlock, domain = signature_definitions_1.EIP712_DOMAIN_DEFAULT) {
+function getEip712BrowserRequestAddProvider(authorizedMsaId, schemaIds, expirationBlock, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
     const message = createAddProvider(authorizedMsaId, schemaIds, expirationBlock);
     const normalized = normalizePayload(message);
-    return createEip712Payload(signature_definitions_1.ADD_PROVIDER_DEFINITION, message.type, domain, normalized);
+    return createEip712Payload(signature_definitions_js_1.ADD_PROVIDER_DEFINITION, message.type, domain, normalized);
 }
 /**
  * Returns the EIP-712 browser request for a PaginatedUpsertSignaturePayloadV2 for signing.
@@ -275,10 +384,10 @@ function getEip712BrowserRequestAddProvider(authorizedMsaId, schemaIds, expirati
  * @param payload    HexString or Uint8Array data to upsert
  * @param domain
  */
-function getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2(schemaId, pageId, targetHash, expiration, payload, domain = signature_definitions_1.EIP712_DOMAIN_DEFAULT) {
+function getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2(schemaId, pageId, targetHash, expiration, payload, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
     const message = createPaginatedUpsertSignaturePayloadV2(schemaId, pageId, targetHash, expiration, payload);
     const normalized = normalizePayload(message);
-    return createEip712Payload(signature_definitions_1.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2, message.type, domain, normalized);
+    return createEip712Payload(signature_definitions_js_1.PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2, message.type, domain, normalized);
 }
 /**
  * Returns the EIP-712 browser request for a PaginatedDeleteSignaturePayloadV2 for signing.
@@ -289,10 +398,10 @@ function getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2(schemaId, page
  * @param expiration uint32 expiration block
  * @param domain
  */
-function getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2(schemaId, pageId, targetHash, expiration, domain = signature_definitions_1.EIP712_DOMAIN_DEFAULT) {
+function getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2(schemaId, pageId, targetHash, expiration, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
     const message = createPaginatedDeleteSignaturePayloadV2(schemaId, pageId, targetHash, expiration);
     const normalized = normalizePayload(message);
-    return createEip712Payload(signature_definitions_1.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2, message.type, domain, normalized);
+    return createEip712Payload(signature_definitions_js_1.PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2, message.type, domain, normalized);
 }
 /**
  * Returns the EIP-712 browser request for a ItemizedSignaturePayloadV2 for signing.
@@ -303,10 +412,10 @@ function getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2(schemaId, page
  * @param actions    Array of Add/Delete itemized actions
  * @param domain
  */
-function getEip712BrowserRequestItemizedSignaturePayloadV2(schemaId, targetHash, expiration, actions, domain = signature_definitions_1.EIP712_DOMAIN_DEFAULT) {
+function getEip712BrowserRequestItemizedSignaturePayloadV2(schemaId, targetHash, expiration, actions, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
     const message = createItemizedSignaturePayloadV2(schemaId, targetHash, expiration, actions);
     const normalized = normalizePayload(message);
-    return createEip712Payload(signature_definitions_1.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2, message.type, domain, normalized);
+    return createEip712Payload(signature_definitions_js_1.ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2, message.type, domain, normalized);
 }
 /**
  * Returns the EIP-712 browser request for a ClaimHandlePayload for signing.
@@ -315,10 +424,10 @@ function getEip712BrowserRequestItemizedSignaturePayloadV2(schemaId, targetHash,
  * @param expirationBlock Block number after which this payload is invalid
  * @param domain
  */
-function getEip712BrowserRequestClaimHandlePayload(handle, expirationBlock, domain = signature_definitions_1.EIP712_DOMAIN_DEFAULT) {
+function getEip712BrowserRequestClaimHandlePayload(handle, expirationBlock, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
     const message = createClaimHandlePayload(handle, expirationBlock);
     const normalized = normalizePayload(message);
-    return createEip712Payload(signature_definitions_1.CLAIM_HANDLE_PAYLOAD_DEFINITION, message.type, domain, normalized);
+    return createEip712Payload(signature_definitions_js_1.CLAIM_HANDLE_PAYLOAD_DEFINITION, message.type, domain, normalized);
 }
 /**
  * Returns the EIP-712 browser request for a PasskeyPublicKey for signing.
@@ -326,15 +435,28 @@ function getEip712BrowserRequestClaimHandlePayload(handle, expirationBlock, doma
  * @param publicKey The passkey’s public key (hex string or raw bytes)
  * @param domain
  */
-function getEip712BrowserRequestPasskeyPublicKey(publicKey, domain = signature_definitions_1.EIP712_DOMAIN_DEFAULT) {
+function getEip712BrowserRequestPasskeyPublicKey(publicKey, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
     const message = createPasskeyPublicKey(publicKey);
     const normalized = normalizePayload(message);
-    return createEip712Payload(signature_definitions_1.PASSKEY_PUBLIC_KEY_DEFINITION, message.type, domain, normalized);
+    return createEip712Payload(signature_definitions_js_1.PASSKEY_PUBLIC_KEY_DEFINITION, message.type, domain, normalized);
+}
+/**
+ * Returns the EIP-712 browser request for a SiwfSignedRequestPayload for signing.
+ *
+ * @param callback        Callback URL for login
+ * @param permissions       One or more schema IDs (uint16) the provider may use
+ * @param userIdentifierAdminUrl Only used for custom integration situations.
+ * @param domain
+ */
+function getEip712BrowserRequestSiwfSignedRequestPayload(callback, permissions, userIdentifierAdminUrl, domain = signature_definitions_js_1.EIP712_DOMAIN_DEFAULT) {
+    const message = createSiwfSignedRequestPayload(callback, permissions, userIdentifierAdminUrl);
+    const normalized = normalizePayload(message);
+    return createEip712Payload(signature_definitions_js_1.SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION, message.type, domain, normalized);
 }
 function createEip712Payload(typeDefinition, primaryType, domain, message) {
     return {
         types: {
-            ...signature_definitions_1.EIP712_DOMAIN_DEFINITION,
+            ...signature_definitions_js_1.EIP712_DOMAIN_DEFINITION,
             ...typeDefinition,
         },
         primaryType,

package/esm/index.js

@@ -1,9 +1,9 @@
-import * as address from './address';
-import * as payloads from './payloads';
-import * as signature from './signature';
-import * as signatureDefinitions from './signature.definitions';
-export * from './payloads';
-export * from './signature';
-export * from './signature.definitions';
-export * from './address';
+import * as address from './address.js';
+import * as payloads from './payloads.js';
+import * as signature from './signature.js';
+import * as signatureDefinitions from './signature.definitions.js';
+export * from './payloads.js';
+export * from './signature.js';
+export * from './signature.definitions.js';
+export * from './address.js';
 export default { ...payloads, ...address, ...signatureDefinitions, ...signature };

package/esm/signature.definitions.js

@@ -57,6 +57,22 @@ export const ADD_KEY_DATA_DEFINITION = {
         },
     ],
 };
+export const AUTHORIZED_KEY_DATA_DEFINITION = {
+    AuthorizedKeyData: [
+        {
+            name: 'msaId',
+            type: 'uint64',
+        },
+        {
+            name: 'expiration',
+            type: 'uint32',
+        },
+        {
+            name: 'authorizedPublicKey',
+            type: 'address',
+        },
+    ],
+};
 export const CLAIM_HANDLE_PAYLOAD_DEFINITION = {
     ClaimHandlePayload: [
         {
@@ -146,3 +162,30 @@ export const ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2 = {
         { name: 'index', type: 'uint16' },
     ],
 };
+export const SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION = {
+    SiwfSignedRequestPayload: [
+        {
+            name: 'callback',
+            type: 'string',
+        },
+        {
+            name: 'permissions',
+            type: 'uint16[]',
+        },
+        {
+            name: 'userIdentifierAdminUrl',
+            type: 'string',
+        },
+    ],
+};
+const PAYLOAD_DEFINITIONS = [
+    ADD_PROVIDER_DEFINITION,
+    ADD_KEY_DATA_DEFINITION,
+    AUTHORIZED_KEY_DATA_DEFINITION,
+    CLAIM_HANDLE_PAYLOAD_DEFINITION,
+    PASSKEY_PUBLIC_KEY_DEFINITION,
+    PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2,
+    PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2,
+    ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2,
+    SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
+];