@frequency-chain/ethereum-utils 1.17.0-rc4

package/index.d.ts

@@ -0,0 +1,85 @@
+import * as payloads from './payloads';
+export * from './payloads';
+export * from './signature';
+export * from './signature.definitions';
+export * from './address';
+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;
+    createAddKeyData(msaId: string | bigint, newPublicKey: payloads.HexString | Uint8Array, expirationBlock: number): payloads.AddKeyData;
+    createAddProvider(authorizedMsaId: string | bigint, schemaIds: number[], expirationBlock: number): payloads.AddProvider;
+    createClaimHandlePayload(handle: string, expirationBlock: number): payloads.ClaimHandlePayload;
+    createPasskeyPublicKey(publicKey: payloads.HexString | Uint8Array): payloads.PasskeyPublicKey;
+    createItemizedAddAction(data: payloads.HexString | Uint8Array): payloads.AddItemizedAction;
+    createItemizedDeleteAction(index: number): payloads.DeleteItemizedAction;
+    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;
+    getEip712BrowserRequestAddKeyData(msaId: string | bigint, newPublicKey: 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;
+    EIP712_DOMAIN_DEFINITION: {
+        EIP712Domain: {
+            name: string;
+            type: string;
+        }[];
+    };
+    EIP712_DOMAIN_DEFAULT: payloads.EipDomainPayload;
+    ADD_PROVIDER_DEFINITION: {
+        AddProvider: {
+            name: string;
+            type: string;
+        }[];
+    };
+    ADD_KEY_DATA_DEFINITION: {
+        AddKeyData: {
+            name: string;
+            type: string;
+        }[];
+    };
+    CLAIM_HANDLE_PAYLOAD_DEFINITION: {
+        ClaimHandlePayload: {
+            name: string;
+            type: string;
+        }[];
+    };
+    PASSKEY_PUBLIC_KEY_DEFINITION: {
+        PasskeyPublicKey: {
+            name: string;
+            type: string;
+        }[];
+    };
+    PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2: {
+        PaginatedDeleteSignaturePayloadV2: {
+            name: string;
+            type: string;
+        }[];
+    };
+    PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2: {
+        PaginatedUpsertSignaturePayloadV2: {
+            name: string;
+            type: string;
+        }[];
+    };
+    ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2: {
+        ItemizedSignaturePayloadV2: {
+            name: string;
+            type: string;
+        }[];
+        ItemAction: {
+            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;
+    reverseUnifiedAddressToEthereumAddress(unifiedAddress: payloads.HexString): payloads.HexString;
+    getSS58AccountFromEthereumAccount(accountId20Hex: string): string;
+};
+export default _default;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@frequency-chain/ethereum-utils",
+  "version": "1.17.0-rc4",
+  "bugs": {
+    "url": "https://github.com/frequency-chain/frequency/issues"
+  },
+  "description": "A package which facilitates use of Ethereum addresses, signatures and standards with Frequency chain.",
+  "main": "./cjs/index.js",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/frequency-chain/frequency.git",
+    "directory": "js/ethereum-utils"
+  },
+  "author": "frequency-chain",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@polkadot/api": "^15.10.2",
+    "@polkadot/util": "13.4.4",
+    "ethers": "^6.14.0"
+  },
+  "module": "./esm/index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./cjs/index.js",
+      "import": "./esm/index.js",
+      "default": "./esm/index.js"
+    }
+  }
+}

package/payloads.d.ts

@@ -0,0 +1,77 @@
+export type HexString = `0x${string}`;
+export interface EcdsaSignature {
+    Ecdsa: HexString;
+}
+export type ChainType = 'Mainnet-Frequency' | 'Paseo-Testnet-Frequency' | 'Dev';
+export interface AddressWrapper {
+    ethereumAddress: HexString;
+    unifiedAddress: HexString;
+    unifiedAddressSS58: string;
+}
+export interface EthereumKeyPair {
+    privateKey: HexString;
+    publicKey: HexString;
+    address: AddressWrapper;
+    mnemonic: string;
+}
+export interface PaginatedUpsertSignaturePayloadV2 {
+    type: 'PaginatedUpsertSignaturePayloadV2';
+    schemaId: number;
+    pageId: number;
+    targetHash: number;
+    expiration: number;
+    payload: HexString;
+}
+export interface PaginatedDeleteSignaturePayloadV2 {
+    type: 'PaginatedDeleteSignaturePayloadV2';
+    schemaId: number;
+    pageId: number;
+    targetHash: number;
+    expiration: number;
+}
+export interface AddItemizedAction {
+    actionType: 'Add';
+    data: HexString;
+    index: 0;
+}
+export interface DeleteItemizedAction {
+    actionType: 'Delete';
+    data: '0x';
+    index: number;
+}
+export type ItemizedAction = AddItemizedAction | DeleteItemizedAction;
+export interface ItemizedSignaturePayloadV2 {
+    type: 'ItemizedSignaturePayloadV2';
+    schemaId: number;
+    targetHash: number;
+    expiration: number;
+    actions: ItemizedAction[];
+}
+export interface PasskeyPublicKey {
+    type: 'PasskeyPublicKey';
+    publicKey: HexString;
+}
+export interface ClaimHandlePayload {
+    type: 'ClaimHandlePayload';
+    handle: string;
+    expiration: number;
+}
+export interface AddKeyData {
+    type: 'AddKeyData';
+    msaId: string;
+    expiration: number;
+    newPublicKey: HexString;
+}
+export interface AddProvider {
+    type: 'AddProvider';
+    authorizedMsaId: string;
+    schemaIds: number[];
+    expiration: number;
+}
+export type SupportedPayload = PaginatedUpsertSignaturePayloadV2 | PaginatedDeleteSignaturePayloadV2 | ItemizedSignaturePayloadV2 | PasskeyPublicKey | ClaimHandlePayload | AddKeyData | AddProvider;
+export interface EipDomainPayload {
+    name: string;
+    version: string;
+    chainId: HexString;
+    verifyingContract: HexString;
+}

package/signature.d.ts

@@ -0,0 +1,139 @@
+import { AddKeyData, AddProvider, ChainType, ClaimHandlePayload, EcdsaSignature, ItemizedSignaturePayloadV2, PaginatedDeleteSignaturePayloadV2, PaginatedUpsertSignaturePayloadV2, PasskeyPublicKey, SupportedPayload, HexString, AddItemizedAction, DeleteItemizedAction, ItemizedAction, EipDomainPayload } from './payloads';
+/**
+ * Signing EIP-712 compatible signature for payload
+ * @param secretKey
+ * @param payload
+ * @param chain
+ */
+export declare function signEip712(secretKey: HexString, payload: SupportedPayload, chain?: ChainType): Promise<EcdsaSignature>;
+/**
+ * Verify EIP-712 signatures
+ * @param ethereumAddress
+ * @param signature
+ * @param payload
+ * @param chain
+ */
+export declare function verifyEip712Signature(ethereumAddress: HexString, signature: HexString, payload: SupportedPayload, chain?: ChainType): boolean;
+/**
+ * Build an AddKeyData payload for signature.
+ *
+ * @param msaId           MSA ID (uint64) to add the key
+ * @param newPublicKey    32 bytes public key to add in hex or Uint8Array
+ * @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 AddProvider payload for signature.
+ *
+ * @param authorizedMsaId MSA ID (uint64) that will be granted provider rights
+ * @param schemaIds       One or more schema IDs (uint16) the provider may use
+ * @param expirationBlock Block number after which this payload is invalid
+ */
+export declare function createAddProvider(authorizedMsaId: string | bigint, schemaIds: number[], expirationBlock: number): AddProvider;
+/**
+ * Build a ClaimHandlePayload for signature.
+ *
+ * @param handle          The handle the user wishes to claim
+ * @param expirationBlock Block number after which this payload is invalid
+ */
+export declare function createClaimHandlePayload(handle: string, expirationBlock: number): ClaimHandlePayload;
+/**
+ * Build a PasskeyPublicKey payload for signature.
+ *
+ * @param publicKey The passkey’s public key (hex string or raw bytes)
+ */
+export declare function createPasskeyPublicKey(publicKey: HexString | Uint8Array): PasskeyPublicKey;
+export declare function createItemizedAddAction(data: HexString | Uint8Array): AddItemizedAction;
+export declare function createItemizedDeleteAction(index: number): DeleteItemizedAction;
+/**
+ * Build an ItemizedSignaturePayloadV2 for signing.
+ *
+ * @param schemaId   uint16 schema identifier
+ * @param targetHash uint32 page hash
+ * @param expiration uint32 expiration block
+ * @param actions    Array of Add/Delete itemized actions
+ */
+export declare function createItemizedSignaturePayloadV2(schemaId: number, targetHash: number, expiration: number, actions: ItemizedAction[]): ItemizedSignaturePayloadV2;
+/**
+ * Build a PaginatedDeleteSignaturePayloadV2 for signing.
+ *
+ * @param schemaId   uint16 schema identifier
+ * @param pageId     uint16 page identifier
+ * @param targetHash uint32 page hash
+ * @param expiration uint32 expiration block
+ */
+export declare function createPaginatedDeleteSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number): PaginatedDeleteSignaturePayloadV2;
+/**
+ * Build a PaginatedUpsertSignaturePayloadV2 for signing.
+ *
+ * @param schemaId   uint16 schema identifier
+ * @param pageId     uint16 page identifier
+ * @param targetHash uint32 page hash
+ * @param expiration uint32 expiration block
+ * @param payload    HexString or Uint8Array data to upsert
+ */
+export declare function createPaginatedUpsertSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number, payload: HexString | Uint8Array): PaginatedUpsertSignaturePayloadV2;
+/**
+ * Returns the EIP-712 browser request for a AddKeyData for signing.
+ *
+ * @param msaId           MSA ID (uint64) to add the key
+ * @param newPublicKey    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 getEip712BrowserRequestAddKeyData(msaId: string | bigint, newPublicKey: HexString | Uint8Array, expirationBlock: number, domain?: EipDomainPayload): unknown;
+/**
+ * Returns the EIP-712 browser request for a AddProvider for signing.
+ *
+ * @param authorizedMsaId MSA ID (uint64) that will be granted provider rights
+ * @param schemaIds       One or more schema IDs (uint16) the provider may use
+ * @param expirationBlock Block number after which this payload is invalid
+ * @param domain
+ */
+export declare function getEip712BrowserRequestAddProvider(authorizedMsaId: string | bigint, schemaIds: number[], expirationBlock: number, domain?: EipDomainPayload): unknown;
+/**
+ * Returns the EIP-712 browser request for a PaginatedUpsertSignaturePayloadV2 for signing.
+ *
+ * @param schemaId   uint16 schema identifier
+ * @param pageId     uint16 page identifier
+ * @param targetHash uint32 page hash
+ * @param expiration uint32 expiration block
+ * @param payload    HexString or Uint8Array data to upsert
+ * @param domain
+ */
+export declare function getEip712BrowserRequestPaginatedUpsertSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number, payload: HexString | Uint8Array, domain?: EipDomainPayload): unknown;
+/**
+ * Returns the EIP-712 browser request for a PaginatedDeleteSignaturePayloadV2 for signing.
+ *
+ * @param schemaId   uint16 schema identifier
+ * @param pageId     uint16 page identifier
+ * @param targetHash uint32 page hash
+ * @param expiration uint32 expiration block
+ * @param domain
+ */
+export declare function getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2(schemaId: number, pageId: number, targetHash: number, expiration: number, domain?: EipDomainPayload): unknown;
+/**
+ * Returns the EIP-712 browser request for a ItemizedSignaturePayloadV2 for signing.
+ *
+ * @param schemaId   uint16 schema identifier
+ * @param targetHash uint32 page hash
+ * @param expiration uint32 expiration block
+ * @param actions    Array of Add/Delete itemized actions
+ * @param domain
+ */
+export declare function getEip712BrowserRequestItemizedSignaturePayloadV2(schemaId: number, targetHash: number, expiration: number, actions: ItemizedAction[], domain?: EipDomainPayload): unknown;
+/**
+ * Returns the EIP-712 browser request for a ClaimHandlePayload for signing.
+ *
+ * @param handle          The handle the user wishes to claim
+ * @param expirationBlock Block number after which this payload is invalid
+ * @param domain
+ */
+export declare function getEip712BrowserRequestClaimHandlePayload(handle: string, expirationBlock: number, domain?: EipDomainPayload): unknown;
+/**
+ * Returns the EIP-712 browser request for a PasskeyPublicKey for signing.
+ *
+ * @param publicKey The passkey’s public key (hex string or raw bytes)
+ * @param domain
+ */
+export declare function getEip712BrowserRequestPasskeyPublicKey(publicKey: HexString | Uint8Array, domain?: EipDomainPayload): unknown;

package/signature.definitions.d.ts

@@ -0,0 +1,54 @@
+import { EipDomainPayload } from './payloads';
+export declare const EIP712_DOMAIN_DEFINITION: {
+    EIP712Domain: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const EIP712_DOMAIN_DEFAULT: EipDomainPayload;
+export declare const ADD_PROVIDER_DEFINITION: {
+    AddProvider: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const ADD_KEY_DATA_DEFINITION: {
+    AddKeyData: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const CLAIM_HANDLE_PAYLOAD_DEFINITION: {
+    ClaimHandlePayload: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const PASSKEY_PUBLIC_KEY_DEFINITION: {
+    PasskeyPublicKey: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const PAGINATED_DELETE_SIGNATURE_PAYLOAD_DEFINITION_V2: {
+    PaginatedDeleteSignaturePayloadV2: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const PAGINATED_UPSERT_SIGNATURE_PAYLOAD_DEFINITION_V2: {
+    PaginatedUpsertSignaturePayloadV2: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const ITEMIZED_SIGNATURE_PAYLOAD_DEFINITION_V2: {
+    ItemizedSignaturePayloadV2: {
+        name: string;
+        type: string;
+    }[];
+    ItemAction: {
+        name: string;
+        type: string;
+    }[];
+};

package/utils.d.ts

@@ -0,0 +1,23 @@
+import { HexString } from './payloads';
+/**
+ * Validate that a number is a valid uint16 (0 to 65535)
+ */
+export declare function isValidUint16(value: number): boolean;
+/**
+ * Validate that a number is a valid uint32 (0 to 4294967295)
+ */
+export declare function isValidUint32(value: number): boolean;
+/**
+ * Validate that a number is a valid uint64 (0 to 18446744073709551615n)
+ */
+export declare function isValidUint64String(value: bigint | string): boolean;
+/**
+ * Validate that a string is a valid hex string
+ */
+export declare function isHexString(value: string): value is HexString;
+/**
+ * Universal assert function
+ * @param condition
+ * @param message
+ */
+export declare function assert(condition: boolean, message?: string): asserts condition;