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

package/esm/signature.js

@@ -1,36 +1,56 @@
-import { assert, isHexString, isValidUint16, isValidUint32, isValidUint64String } from './utils';
-import { reverseUnifiedAddressToEthereumAddress } from './address';
+import { assert, isHexString, isValidUint16, isValidUint32, isValidUint64String } from './utils.js';
+import { reverseUnifiedAddressToEthereumAddress } from './address.js';
 import { ethers } from 'ethers';
 import { u8aToHex } from '@polkadot/util';
-import { ADD_KEY_DATA_DEFINITION, ADD_PROVIDER_DEFINITION, CLAIM_HANDLE_PAYLOAD_DEFINITION, EIP712_DOMAIN_DEFAULT, EIP712_DOMAIN_DEFINITION, ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2, PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2, PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2, PASSKEY_PUBLIC_KEY_DEFINITION, } from './signature.definitions';
+import { ADD_KEY_DATA_DEFINITION, ADD_PROVIDER_DEFINITION, AUTHORIZED_KEY_DATA_DEFINITION, CLAIM_HANDLE_PAYLOAD_DEFINITION, EIP712_DOMAIN_DEFAULT, 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, } from './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
  */
-export async function signEip712(secretKey, payload, chain = 'Mainnet-Frequency') {
-    const types = getTypesFor(payload.type);
+export async function sign(secretKey, payload, chain = 'Mainnet-Frequency') {
+    const signatureType = getSignatureType(payload.type);
     const normalizedPayload = normalizePayload(payload);
     const wallet = new ethers.Wallet(secretKey);
-    // TODO: use correct chainID for different networks
-    // TODO: use correct contract address for different payloads
-    const signature = await wallet.signTypedData(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(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
  */
-export function verifyEip712Signature(ethereumAddress, signature, payload, chain = 'Mainnet-Frequency') {
-    const types = getTypesFor(payload.type);
+export 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.verifyTypedData(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.verifyTypedData(EIP712_DOMAIN_DEFAULT, getTypesFor(payload.type), normalizedPayload, signature);
+            break;
+        case 'EIP-191':
+            recoveredAddress = ethers.verifyMessage(payload.message, signature);
+            break;
+        default:
+            throw new Error(`Unsupported signature type : ${signatureType}`);
+    }
     return recoveredAddress.toLowerCase() === ethereumAddress.toLowerCase();
 }
 function normalizePayload(payload) {
@@ -42,6 +62,7 @@ function normalizePayload(payload) {
         case 'PasskeyPublicKey':
         case 'ClaimHandlePayload':
         case 'AddProvider':
+        case 'SiwfLoginRequestPayload':
             break;
         case 'AddKeyData':
             // convert to 20 bytes ethereum address for signature
@@ -50,6 +71,18 @@ function normalizePayload(payload) {
             }
             clonedPayload.newPublicKey = clonedPayload.newPublicKey.toLowerCase();
             break;
+        case 'AuthorizedKeyData':
+            // convert to 20 bytes ethereum address for signature
+            if (clonedPayload.authorizedPublicKey.length !== 42) {
+                clonedPayload.authorizedPublicKey = 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)}`);
     }
@@ -65,7 +98,10 @@ function getTypesFor(payloadType) {
         PasskeyPublicKey: PASSKEY_PUBLIC_KEY_DEFINITION,
         ClaimHandlePayload: CLAIM_HANDLE_PAYLOAD_DEFINITION,
         AddKeyData: ADD_KEY_DATA_DEFINITION,
+        AuthorizedKeyData: AUTHORIZED_KEY_DATA_DEFINITION,
         AddProvider: ADD_PROVIDER_DEFINITION,
+        // offchain signatures
+        SiwfSignedRequestPayload: SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION,
     };
     const definition = PAYLOAD_TYPE_DEFINITIONS[payloadType];
     if (!definition) {
@@ -73,6 +109,12 @@ function getTypesFor(payloadType) {
     }
     return definition;
 }
+function getSignatureType(payloadType) {
+    if (payloadType === 'SiwfLoginRequestPayload') {
+        return 'EIP-191';
+    }
+    return 'EIP-712';
+}
 /**
  * Build an AddKeyData payload for signature.
  *
@@ -93,6 +135,26 @@ export 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
+ */
+export function createAuthorizedKeyData(msaId, newPublicKey, expirationBlock) {
+    const parsedMsaId = typeof msaId === 'string' ? msaId : `${msaId}`;
+    const parsedNewPublicKey = typeof newPublicKey === 'object' ? u8aToHex(newPublicKey) : newPublicKey;
+    assert(isValidUint64String(parsedMsaId), 'msaId should be a valid uint64');
+    assert(isValidUint32(expirationBlock), 'expiration should be a valid uint32');
+    assert(isHexString(parsedNewPublicKey), 'newPublicKey should be valid hex');
+    return {
+        type: 'AuthorizedKeyData',
+        msaId: parsedMsaId,
+        expiration: expirationBlock,
+        authorizedPublicKey: parsedNewPublicKey,
+    };
+}
 /**
  * Build an AddProvider payload for signature.
  *
@@ -217,6 +279,35 @@ export function createPaginatedUpsertSignaturePayloadV2(schemaId, pageId, target
         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.
+ */
+export function createSiwfSignedRequestPayload(callback, permissions, userIdentifierAdminUrl) {
+    permissions.forEach((schemaId) => {
+        assert(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
+ */
+export function createSiwfLoginRequestPayload(message) {
+    return {
+        type: 'SiwfLoginRequestPayload',
+        message,
+    };
+}
 /**
  * Returns the EIP-712 browser request for a AddKeyData for signing.
  *
@@ -230,6 +321,19 @@ export function getEip712BrowserRequestAddKeyData(msaId, newPublicKey, expiratio
     const normalized = normalizePayload(message);
     return createEip712Payload(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
+ */
+export function getEip712BrowserRequestAuthorizedKeyData(msaId, authorizedPublicKey, expirationBlock, domain = EIP712_DOMAIN_DEFAULT) {
+    const message = createAuthorizedKeyData(msaId, authorizedPublicKey, expirationBlock);
+    const normalized = normalizePayload(message);
+    return createEip712Payload(AUTHORIZED_KEY_DATA_DEFINITION, message.type, domain, normalized);
+}
 /**
  * Returns the EIP-712 browser request for a AddProvider for signing.
  *
@@ -309,6 +413,19 @@ export function getEip712BrowserRequestPasskeyPublicKey(publicKey, domain = EIP7
     const normalized = normalizePayload(message);
     return createEip712Payload(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
+ */
+export function getEip712BrowserRequestSiwfSignedRequestPayload(callback, permissions, userIdentifierAdminUrl, domain = EIP712_DOMAIN_DEFAULT) {
+    const message = createSiwfSignedRequestPayload(callback, permissions, userIdentifierAdminUrl);
+    const normalized = normalizePayload(message);
+    return createEip712Payload(SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION, message.type, domain, normalized);
+}
 function createEip712Payload(typeDefinition, primaryType, domain, message) {
     return {
         types: {

package/index.d.ts

@@ -1,12 +1,13 @@
-import * as payloads from './payloads';
-export * from './payloads';
-export * from './signature';
-export * from './signature.definitions';
-export * from './address';
+import * as payloads from './payloads.js';
+export * from './payloads.js';
+export * from './signature.js';
+export * from './signature.definitions.js';
+export * from './address.js';
 declare const _default: {
-    signEip712(secretKey: payloads.HexString, payload: payloads.SupportedPayload, chain?: payloads.ChainType): Promise<payloads.EcdsaSignature>;
-    verifyEip712Signature(ethereumAddress: payloads.HexString, signature: payloads.HexString, payload: payloads.SupportedPayload, chain?: payloads.ChainType): boolean;
+    sign(secretKey: payloads.HexString, payload: payloads.SupportedPayload, chain?: payloads.ChainType): Promise<payloads.EcdsaSignature>;
+    verifySignature(ethereumAddress: payloads.HexString, signature: payloads.HexString, payload: payloads.SupportedPayload, chain?: payloads.ChainType): boolean;
     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;
     createClaimHandlePayload(handle: string, expirationBlock: number): payloads.ClaimHandlePayload;
     createPasskeyPublicKey(publicKey: payloads.HexString | Uint8Array): payloads.PasskeyPublicKey;
@@ -15,15 +16,19 @@ declare const _default: {
     createItemizedSignaturePayloadV2(schemaId: number, targetHash: number, expiration: number, actions: payloads.ItemizedAction[]): payloads.ItemizedSignaturePayloadV2;
     createPaginatedDeleteSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number): payloads.PaginatedDeleteSignaturePayloadV2;
     createPaginatedUpsertSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number, payload: payloads.HexString | Uint8Array): payloads.PaginatedUpsertSignaturePayloadV2;
+    createSiwfSignedRequestPayload(callback: string, permissions: number[], userIdentifierAdminUrl?: string): payloads.SiwfSignedRequestPayload;
+    createSiwfLoginRequestPayload(message: string): payloads.SiwfLoginRequestPayload;
     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;
     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;
     getEip712BrowserRequestClaimHandlePayload(handle: string, expirationBlock: number, domain?: payloads.EipDomainPayload): unknown;
     getEip712BrowserRequestPasskeyPublicKey(publicKey: payloads.HexString | Uint8Array, domain?: payloads.EipDomainPayload): unknown;
-    getEthereumRegularSigner(ethereumPair: import("@polkadot/keyring/types").KeyringPair): import("@polkadot/types/types").Signer;
-    getEthereumMessageSigner(ethereumPair: import("@polkadot/keyring/types").KeyringPair): import("@polkadot/types/types").Signer;
+    getEip712BrowserRequestSiwfSignedRequestPayload(callback: string, permissions: number[], userIdentifierAdminUrl?: string, domain?: payloads.EipDomainPayload): unknown;
+    getEthereumRegularSigner(ethereumPair: import("@polkadot/keyring/types.js").KeyringPair): import("@polkadot/types/types/extrinsic.js").Signer;
+    getEthereumMessageSigner(ethereumPair: import("@polkadot/keyring/types.js").KeyringPair): import("@polkadot/types/types/extrinsic.js").Signer;
     EIP712_DOMAIN_DEFINITION: {
         EIP712Domain: {
             name: string;
@@ -43,6 +48,12 @@ declare const _default: {
             type: string;
         }[];
     };
+    AUTHORIZED_KEY_DATA_DEFINITION: {
+        AuthorizedKeyData: {
+            name: string;
+            type: string;
+        }[];
+    };
     CLAIM_HANDLE_PAYLOAD_DEFINITION: {
         ClaimHandlePayload: {
             name: string;
@@ -77,13 +88,19 @@ declare const _default: {
             type: string;
         }[];
     };
+    SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION: {
+        SiwfSignedRequestPayload: {
+            name: string;
+            type: string;
+        }[];
+    };
     createRandomKey(): payloads.EthereumKeyPair;
-    ethereumAddressToKeyringPair(ethereumAddress: import("@polkadot/types/interfaces").H160): import("@polkadot/keyring/types").KeyringPair;
-    getUnifiedAddress(pair: import("@polkadot/keyring/types").KeyringPair): string;
-    getUnifiedPublicKey(pair: import("@polkadot/keyring/types").KeyringPair): Uint8Array;
+    ethereumAddressToKeyringPair(ethereumAddress: import("@polkadot/types/interfaces/types.js").H160): import("@polkadot/keyring/types.js").KeyringPair;
+    getUnifiedAddress(pair: import("@polkadot/keyring/types.js").KeyringPair): string;
+    getUnifiedPublicKey(pair: import("@polkadot/keyring/types.js").KeyringPair): Uint8Array;
     reverseUnifiedAddressToEthereumAddress(unifiedAddress: payloads.HexString): payloads.HexString;
     getSS58AccountFromEthereumAccount(accountId20Hex: string): string;
-    getKeyringPairFromSecp256k1PrivateKey(secretKey: Uint8Array): import("@polkadot/keyring/types").KeyringPair;
-    getAccountId20MultiAddress(pair: import("@polkadot/keyring/types").KeyringPair): payloads.Address20MultiAddress;
+    getKeyringPairFromSecp256k1PrivateKey(secretKey: Uint8Array): import("@polkadot/keyring/types.js").KeyringPair;
+    getAccountId20MultiAddress(pair: import("@polkadot/keyring/types.js").KeyringPair): payloads.Address20MultiAddress;
 };
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frequency-chain/ethereum-utils",
-  "version": "1.17.0-rc5",
+  "version": "1.17.0-rc6",
   "bugs": {
     "url": "https://github.com/frequency-chain/frequency/issues"
   },
@@ -15,9 +15,12 @@
   "author": "frequency-chain",
   "license": "Apache-2.0",
   "dependencies": {
-    "@polkadot/api": "^16.1.1",
-    "@polkadot/util": "13.5.1",
-    "ethers": "^6.14.3"
+    "@polkadot/api": "^16.2.1",
+    "@polkadot/util": "13.5.2",
+    "ethers": "^6.14.4"
+  },
+  "optionalDependencies": {
+    "@rollup/rollup-linux-x64-gnu": "^4.43.0"
   },
   "module": "./esm/index.js",
   "types": "index.d.ts",

package/payloads.d.ts

@@ -65,16 +65,35 @@ export interface AddKeyData {
     expiration: number;
     newPublicKey: HexString;
 }
+export interface AuthorizedKeyData {
+    type: 'AuthorizedKeyData';
+    msaId: string;
+    expiration: number;
+    authorizedPublicKey: HexString;
+}
 export interface AddProvider {
     type: 'AddProvider';
     authorizedMsaId: string;
     schemaIds: number[];
     expiration: number;
 }
-export type SupportedPayload = PaginatedUpsertSignaturePayloadV2 | PaginatedDeleteSignaturePayloadV2 | ItemizedSignaturePayloadV2 | PasskeyPublicKey | ClaimHandlePayload | AddKeyData | AddProvider;
+export interface SiwfSignedRequestPayload {
+    type: 'SiwfSignedRequestPayload';
+    callback: string;
+    permissions: number[];
+    userIdentifierAdminUrl?: string;
+}
+export interface SiwfLoginRequestPayload {
+    type: 'SiwfLoginRequestPayload';
+    message: string;
+}
+export type SupportedPayload = PaginatedUpsertSignaturePayloadV2 | PaginatedDeleteSignaturePayloadV2 | ItemizedSignaturePayloadV2 | PasskeyPublicKey | ClaimHandlePayload | AddKeyData | AuthorizedKeyData | AddProvider | SiwfSignedRequestPayload | SiwfLoginRequestPayload;
+export type NormalizedSupportedPayload = Omit<SupportedPayload, 'type'>;
 export interface EipDomainPayload {
     name: string;
     version: string;
     chainId: HexString;
     verifyingContract: HexString;
 }
+export type SupportedPayloadTypes = SupportedPayload['type'];
+export type SignatureType = 'EIP-712' | 'EIP-191';

package/signature.d.ts

@@ -1,21 +1,21 @@
-import { AddKeyData, AddProvider, ChainType, ClaimHandlePayload, EcdsaSignature, ItemizedSignaturePayloadV2, PaginatedDeleteSignaturePayloadV2, PaginatedUpsertSignaturePayloadV2, PasskeyPublicKey, SupportedPayload, HexString, AddItemizedAction, DeleteItemizedAction, ItemizedAction, EipDomainPayload } from './payloads';
+import { AddKeyData, AuthorizedKeyData, AddProvider, ChainType, ClaimHandlePayload, EcdsaSignature, ItemizedSignaturePayloadV2, PaginatedDeleteSignaturePayloadV2, PaginatedUpsertSignaturePayloadV2, PasskeyPublicKey, SupportedPayload, HexString, AddItemizedAction, DeleteItemizedAction, ItemizedAction, EipDomainPayload, SiwfSignedRequestPayload, SiwfLoginRequestPayload } from './payloads.js';
 import { KeyringPair } from '@polkadot/keyring/types';
 import { Signer } from '@polkadot/types/types';
 /**
- * Signing EIP-712 compatible signature for payload
+ * Signing EIP-712 or ERC-191 compatible signature based on payload
  * @param secretKey
  * @param payload
  * @param chain
  */
-export declare function signEip712(secretKey: HexString, payload: SupportedPayload, chain?: ChainType): Promise<EcdsaSignature>;
+export declare function sign(secretKey: HexString, payload: SupportedPayload, chain?: ChainType): Promise<EcdsaSignature>;
 /**
- * Verify EIP-712 signatures
+ * Verify EIP-712 and ERC-191 signatures based on payload
  * @param ethereumAddress
  * @param signature
  * @param payload
  * @param chain
  */
-export declare function verifyEip712Signature(ethereumAddress: HexString, signature: HexString, payload: SupportedPayload, chain?: ChainType): boolean;
+export declare function verifySignature(ethereumAddress: HexString, signature: HexString, payload: SupportedPayload, chain?: ChainType): boolean;
 /**
  * Build an AddKeyData payload for signature.
  *
@@ -24,6 +24,14 @@ export declare function verifyEip712Signature(ethereumAddress: HexString, signat
  * @param expirationBlock Block number after which this payload is invalid
  */
 export declare function createAddKeyData(msaId: string | bigint, newPublicKey: HexString | Uint8Array, expirationBlock: number): AddKeyData;
+/**
+ * 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
+ */
+export declare function createAuthorizedKeyData(msaId: string | bigint, newPublicKey: HexString | Uint8Array, expirationBlock: number): AuthorizedKeyData;
 /**
  * Build an AddProvider payload for signature.
  *
@@ -75,6 +83,20 @@ export declare function createPaginatedDeleteSignaturePayloadV2(schemaId: number
  * @param payload    HexString or Uint8Array data to upsert
  */
 export declare function createPaginatedUpsertSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number, payload: HexString | Uint8Array): PaginatedUpsertSignaturePayloadV2;
+/**
+ * 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.
+ */
+export declare function createSiwfSignedRequestPayload(callback: string, permissions: number[], userIdentifierAdminUrl?: string): SiwfSignedRequestPayload;
+/**
+ * Build an SiwfLoginRequestPayload payload for signature.
+ *
+ * @param message        login message
+ */
+export declare function createSiwfLoginRequestPayload(message: string): SiwfLoginRequestPayload;
 /**
  * Returns the EIP-712 browser request for a AddKeyData for signing.
  *
@@ -84,6 +106,15 @@ export declare function createPaginatedUpsertSignaturePayloadV2(schemaId: number
  * @param domain
  */
 export declare function getEip712BrowserRequestAddKeyData(msaId: string | bigint, newPublicKey: HexString | Uint8Array, expirationBlock: number, domain?: EipDomainPayload): unknown;
+/**
+ * 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
+ */
+export declare function getEip712BrowserRequestAuthorizedKeyData(msaId: string | bigint, authorizedPublicKey: HexString | Uint8Array, expirationBlock: number, domain?: EipDomainPayload): unknown;
 /**
  * Returns the EIP-712 browser request for a AddProvider for signing.
  *
@@ -139,6 +170,15 @@ export declare function getEip712BrowserRequestClaimHandlePayload(handle: string
  * @param domain
  */
 export declare function getEip712BrowserRequestPasskeyPublicKey(publicKey: HexString | Uint8Array, domain?: EipDomainPayload): unknown;
+/**
+ * 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
+ */
+export declare function getEip712BrowserRequestSiwfSignedRequestPayload(callback: string, permissions: number[], userIdentifierAdminUrl?: string, domain?: EipDomainPayload): unknown;
 /**
  * Returns An ethereum compatible signature for the extrinsic
  * @param ethereumPair

package/signature.definitions.d.ts

@@ -1,4 +1,4 @@
-import { EipDomainPayload } from './payloads';
+import { EipDomainPayload } from './payloads.js';
 export declare const EIP712_DOMAIN_DEFINITION: {
     EIP712Domain: {
         name: string;
@@ -18,6 +18,12 @@ export declare const ADD_KEY_DATA_DEFINITION: {
         type: string;
     }[];
 };
+export declare const AUTHORIZED_KEY_DATA_DEFINITION: {
+    AuthorizedKeyData: {
+        name: string;
+        type: string;
+    }[];
+};
 export declare const CLAIM_HANDLE_PAYLOAD_DEFINITION: {
     ClaimHandlePayload: {
         name: string;
@@ -52,3 +58,61 @@ export declare const ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2: {
         type: string;
     }[];
 };
+export declare const SIWF_SIGNED_REQUEST_PAYLOAD_DEFINITION: {
+    SiwfSignedRequestPayload: {
+        name: string;
+        type: string;
+    }[];
+};
+declare const PAYLOAD_DEFINITIONS: ({
+    AddProvider: {
+        name: string;
+        type: string;
+    }[];
+} | {
+    AddKeyData: {
+        name: string;
+        type: string;
+    }[];
+} | {
+    AuthorizedKeyData: {
+        name: string;
+        type: string;
+    }[];
+} | {
+    ClaimHandlePayload: {
+        name: string;
+        type: string;
+    }[];
+} | {
+    PasskeyPublicKey: {
+        name: string;
+        type: string;
+    }[];
+} | {
+    PaginatedDeleteSignaturePayloadV2: {
+        name: string;
+        type: string;
+    }[];
+} | {
+    PaginatedUpsertSignaturePayloadV2: {
+        name: string;
+        type: string;
+    }[];
+} | {
+    ItemizedSignaturePayloadV2: {
+        name: string;
+        type: string;
+    }[];
+    ItemAction: {
+        name: string;
+        type: string;
+    }[];
+} | {
+    SiwfSignedRequestPayload: {
+        name: string;
+        type: string;
+    }[];
+})[];
+export type SupportedPayloadDefinitions = (typeof PAYLOAD_DEFINITIONS)[number];
+export {};

package/utils.d.ts

@@ -1,4 +1,4 @@
-import { HexString } from './payloads';
+import { HexString } from './payloads.js';
 /**
  * Validate that a number is a valid uint16 (0 to 65535)
  */