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

package/cjs/address.js

@@ -6,9 +6,12 @@ exports.getUnifiedAddress = getUnifiedAddress;
 exports.getUnifiedPublicKey = getUnifiedPublicKey;
 exports.reverseUnifiedAddressToEthereumAddress = reverseUnifiedAddressToEthereumAddress;
 exports.getSS58AccountFromEthereumAccount = getSS58AccountFromEthereumAccount;
+exports.getKeyringPairFromSecp256k1PrivateKey = getKeyringPairFromSecp256k1PrivateKey;
+exports.getAccountId20MultiAddress = getAccountId20MultiAddress;
 const util_crypto_1 = require("@polkadot/util-crypto");
 const util_1 = require("@polkadot/util");
 const ethers_1 = require("ethers");
+const api_1 = require("@polkadot/api");
 /**
  * Creates a Random Ethereum key
  */
@@ -81,6 +84,30 @@ function getSS58AccountFromEthereumAccount(accountId20Hex) {
     result.set(suffix, 20);
     return (0, util_crypto_1.encodeAddress)(result);
 }
+/**
+ *
+ * @param secretKey of secp256k1 keypair exported from any wallet (should be 32 bytes)
+ */
+function getKeyringPairFromSecp256k1PrivateKey(secretKey) {
+    const publicKey = ethers_1.ethers.SigningKey.computePublicKey(secretKey, true);
+    const keypair = {
+        secretKey,
+        publicKey: (0, util_1.hexToU8a)(publicKey),
+    };
+    return new api_1.Keyring({ type: 'ethereum' }).createFromPair(keypair, undefined, 'ethereum');
+}
+/**
+ * Convert a keyPair into a 20 byte ethereum address
+ * @param pair
+ */
+function getAccountId20MultiAddress(pair) {
+    if (pair.type !== 'ethereum') {
+        throw new Error(`Only ethereum keys are supported!`);
+    }
+    const etheAddress = (0, util_crypto_1.ethereumEncode)(pair.publicKey || pair.address);
+    const ethAddress20 = Array.from((0, util_1.hexToU8a)(etheAddress));
+    return { Address20: ethAddress20 };
+}
 function getUnified32BytesAddress(ethAddressOrPublicKey) {
     const ethAddressBytes = (0, util_1.hexToU8a)((0, util_crypto_1.ethereumEncode)(ethAddressOrPublicKey));
     const suffix = new Uint8Array(12).fill(0xee);

package/cjs/signature.js

@@ -18,6 +18,8 @@ exports.getEip712BrowserRequestPaginatedDeleteSignaturePayloadV2 = getEip712Brow
 exports.getEip712BrowserRequestItemizedSignaturePayloadV2 = getEip712BrowserRequestItemizedSignaturePayloadV2;
 exports.getEip712BrowserRequestClaimHandlePayload = getEip712BrowserRequestClaimHandlePayload;
 exports.getEip712BrowserRequestPasskeyPublicKey = getEip712BrowserRequestPasskeyPublicKey;
+exports.getEthereumRegularSigner = getEthereumRegularSigner;
+exports.getEthereumMessageSigner = getEthereumMessageSigner;
 const utils_1 = require("./utils");
 const address_1 = require("./address");
 const ethers_1 = require("ethers");
@@ -340,3 +342,49 @@ function createEip712Payload(typeDefinition, primaryType, domain, message) {
         message,
     };
 }
+/**
+ * Returns An ethereum compatible signature for the extrinsic
+ * @param ethereumPair
+ */
+function getEthereumRegularSigner(ethereumPair) {
+    return {
+        signRaw: async (payload) => {
+            const sig = ethereumPair.sign(payload.data);
+            const prefixedSignature = new Uint8Array(sig.length + 1);
+            prefixedSignature[0] = 2;
+            prefixedSignature.set(sig, 1);
+            const hex = (0, util_1.u8aToHex)(prefixedSignature);
+            return {
+                signature: hex,
+            };
+        },
+    };
+}
+/**
+ * This custom signer can get used to mimic EIP-191 message signing. By replacing the `ethereumPair.sign` with
+ * any wallet call we can sign any extrinsic with any wallet
+ * @param ethereumPair
+ */
+function getEthereumMessageSigner(ethereumPair) {
+    return {
+        signRaw: async (payload) => {
+            const sig = ethereumPair.sign(prefixEthereumTags(payload.data));
+            const prefixedSignature = new Uint8Array(sig.length + 1);
+            prefixedSignature[0] = 2;
+            prefixedSignature.set(sig, 1);
+            const hex = (0, util_1.u8aToHex)(prefixedSignature);
+            return {
+                signature: hex,
+            };
+        },
+    };
+}
+/**
+ * prefixing with the EIP-191 for personal_sign messages (this gets wrapped automatically in Metamask)
+ * @param hexPayload
+ */
+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);
+}

package/esm/address.js

@@ -1,6 +1,7 @@
 import { encodeAddress, ethereumEncode } from '@polkadot/util-crypto';
 import { hexToU8a, u8aToHex } from '@polkadot/util';
 import { ethers } from 'ethers';
+import { Keyring } from '@polkadot/api';
 /**
  * Creates a Random Ethereum key
  */
@@ -73,6 +74,30 @@ export function getSS58AccountFromEthereumAccount(accountId20Hex) {
     result.set(suffix, 20);
     return encodeAddress(result);
 }
+/**
+ *
+ * @param secretKey of secp256k1 keypair exported from any wallet (should be 32 bytes)
+ */
+export function getKeyringPairFromSecp256k1PrivateKey(secretKey) {
+    const publicKey = ethers.SigningKey.computePublicKey(secretKey, true);
+    const keypair = {
+        secretKey,
+        publicKey: hexToU8a(publicKey),
+    };
+    return new Keyring({ type: 'ethereum' }).createFromPair(keypair, undefined, 'ethereum');
+}
+/**
+ * Convert a keyPair into a 20 byte ethereum address
+ * @param pair
+ */
+export function getAccountId20MultiAddress(pair) {
+    if (pair.type !== 'ethereum') {
+        throw new Error(`Only ethereum keys are supported!`);
+    }
+    const etheAddress = ethereumEncode(pair.publicKey || pair.address);
+    const ethAddress20 = Array.from(hexToU8a(etheAddress));
+    return { Address20: ethAddress20 };
+}
 function getUnified32BytesAddress(ethAddressOrPublicKey) {
     const ethAddressBytes = hexToU8a(ethereumEncode(ethAddressOrPublicKey));
     const suffix = new Uint8Array(12).fill(0xee);

package/esm/signature.js

@@ -320,3 +320,49 @@ function createEip712Payload(typeDefinition, primaryType, domain, message) {
         message,
     };
 }
+/**
+ * Returns An ethereum compatible signature for the extrinsic
+ * @param ethereumPair
+ */
+export function getEthereumRegularSigner(ethereumPair) {
+    return {
+        signRaw: async (payload) => {
+            const sig = ethereumPair.sign(payload.data);
+            const prefixedSignature = new Uint8Array(sig.length + 1);
+            prefixedSignature[0] = 2;
+            prefixedSignature.set(sig, 1);
+            const hex = u8aToHex(prefixedSignature);
+            return {
+                signature: hex,
+            };
+        },
+    };
+}
+/**
+ * This custom signer can get used to mimic EIP-191 message signing. By replacing the `ethereumPair.sign` with
+ * any wallet call we can sign any extrinsic with any wallet
+ * @param ethereumPair
+ */
+export function getEthereumMessageSigner(ethereumPair) {
+    return {
+        signRaw: async (payload) => {
+            const sig = ethereumPair.sign(prefixEthereumTags(payload.data));
+            const prefixedSignature = new Uint8Array(sig.length + 1);
+            prefixedSignature[0] = 2;
+            prefixedSignature.set(sig, 1);
+            const hex = u8aToHex(prefixedSignature);
+            return {
+                signature: hex,
+            };
+        },
+    };
+}
+/**
+ * prefixing with the EIP-191 for personal_sign messages (this gets wrapped automatically in Metamask)
+ * @param hexPayload
+ */
+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);
+}

package/index.d.ts

@@ -22,6 +22,8 @@ declare const _default: {
     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;
     EIP712_DOMAIN_DEFINITION: {
         EIP712Domain: {
             name: string;
@@ -81,5 +83,7 @@ declare const _default: {
     getUnifiedPublicKey(pair: import("@polkadot/keyring/types").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;
 };
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frequency-chain/ethereum-utils",
-  "version": "1.17.0-rc4",
+  "version": "1.17.0-rc5",
   "bugs": {
     "url": "https://github.com/frequency-chain/frequency/issues"
   },
@@ -15,9 +15,9 @@
   "author": "frequency-chain",
   "license": "Apache-2.0",
   "dependencies": {
-    "@polkadot/api": "^15.10.2",
-    "@polkadot/util": "13.4.4",
-    "ethers": "^6.14.0"
+    "@polkadot/api": "^16.1.1",
+    "@polkadot/util": "13.5.1",
+    "ethers": "^6.14.3"
   },
   "module": "./esm/index.js",
   "types": "index.d.ts",

package/payloads.d.ts

@@ -2,6 +2,9 @@ export type HexString = `0x${string}`;
 export interface EcdsaSignature {
     Ecdsa: HexString;
 }
+export interface Address20MultiAddress {
+    Address20: number[];
+}
 export type ChainType = 'Mainnet-Frequency' | 'Paseo-Testnet-Frequency' | 'Dev';
 export interface AddressWrapper {
     ethereumAddress: HexString;

package/signature.d.ts

@@ -1,4 +1,6 @@
 import { AddKeyData, AddProvider, ChainType, ClaimHandlePayload, EcdsaSignature, ItemizedSignaturePayloadV2, PaginatedDeleteSignaturePayloadV2, PaginatedUpsertSignaturePayloadV2, PasskeyPublicKey, SupportedPayload, HexString, AddItemizedAction, DeleteItemizedAction, ItemizedAction, EipDomainPayload } from './payloads';
+import { KeyringPair } from '@polkadot/keyring/types';
+import { Signer } from '@polkadot/types/types';
 /**
  * Signing EIP-712 compatible signature for payload
  * @param secretKey
@@ -137,3 +139,14 @@ export declare function getEip712BrowserRequestClaimHandlePayload(handle: string
  * @param domain
  */
 export declare function getEip712BrowserRequestPasskeyPublicKey(publicKey: HexString | Uint8Array, domain?: EipDomainPayload): unknown;
+/**
+ * Returns An ethereum compatible signature for the extrinsic
+ * @param ethereumPair
+ */
+export declare function getEthereumRegularSigner(ethereumPair: KeyringPair): Signer;
+/**
+ * This custom signer can get used to mimic EIP-191 message signing. By replacing the `ethereumPair.sign` with
+ * any wallet call we can sign any extrinsic with any wallet
+ * @param ethereumPair
+ */
+export declare function getEthereumMessageSigner(ethereumPair: KeyringPair): Signer;