Merge pull request #193 from KeystoneHQ/eth-batch-tx

feat: support eth batch transaction

Author: soralit

packages/ur-registry-eth/__tests__/EthBatchSignRequest.test.ts

@@ -0,0 +1,14 @@
+import { ETHBatchSignRequest } from "../src/EthBatchSignRequest";
+import { EthSignRequest } from "../src/EthSignRequest";
+describe("EthBatchSignRequest", () => {
+  it("should create a new EthBatchSignRequest", () => {
+    const cbor = Buffer.from("a601d825509b1deb4d3b7d4bad9bdd2b0d7b3dcb6d02584bf849808609184e72a00082271094000000000000000000000000000000000000000080a47f74657374320000000000000000000000000000000000000000000000000000006000578080800301040105d90130a2018a182cf501f501f500f401f4021a1234567807686d6574616d61736b", 'hex');
+    const request = EthSignRequest.fromCBOR(cbor);
+    const ethBatchSignRequest = new ETHBatchSignRequest([request]);
+    const ur = ethBatchSignRequest.toUREncoder(1000).nextPart();
+    expect(ur).toBe(
+      "ur:eth-batch-sign-request/oyadlytaadmeoladtpdagdndcawmgtfrkigrpmndutdnbtkgfssbjnaohdgryagalalnascsgljpnbaelfdibemwaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaelaoxlbjyihjkjyeyaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaeaehnaehglalalaaxadaaadahtaaddyoeadlecsdwykadykadykaewkadwkaocybgeehfksatisjnihjyhsjnhsjkjekoamykvw"
+    );
+  });
+});
+

packages/ur-registry-eth/__tests__/EthBatchSignature.test.ts

@@ -0,0 +1,10 @@
+import { ETHBatchSignature } from "../src/EthBatchSignature";
+
+describe("EthBatchSignature", () => {
+  it("should create a new EthBatchSignature", () => {
+    const cbor = Buffer.from("a10181d90192a301d825509b1deb4d3b7d4bad9bdd2b0d7b3dcb6d0258416ff1602c5074594261319e77d58697565aeebebac538628434b13c939b9ac7f52d8fb08e7892e26ebcf901bf8c5b38d5900dbc6466b9b9e976287324e92c1aa12403686b657973746f6e65", 'hex');
+    const ethBatchSignature = ETHBatchSignature.fromCBOR(cbor);
+    expect(ethBatchSignature.getSignatures().length).toBe(1);
+    expect(ethBatchSignature.getSignatures()[0].getSignature().toString('hex')).toBe("6ff1602c5074594261319e77d58697565aeebebac538628434b13c939b9ac7f52d8fb08e7892e26ebcf901bf8c5b38d5900dbc6466b9b9e976287324e92c1aa124");
+  });
+});

packages/ur-registry-eth/src/EthBatchSignRequest.ts

@@ -0,0 +1,53 @@
+import {
+  extend,
+  DataItem,
+  RegistryItem,
+  DataItemMap,
+} from "@keystonehq/bc-ur-registry";
+import { ExtendedRegistryTypes } from "./RegistryType";
+import { EthSignRequest } from "EthSignRequest";
+
+const { decodeToDataItem, RegistryTypes } = extend;
+
+enum Keys {
+  requests = 1,
+}
+
+export class ETHBatchSignRequest extends RegistryItem {
+  private requests: EthSignRequest[];
+
+  getRegistryType = () => ExtendedRegistryTypes.ETH_BATCH_SIGN_REQUEST;
+
+  constructor(args: EthSignRequest[]) {
+    super();
+    this.requests = args;
+  }
+
+  public getRequests = () => this.requests;
+
+  public toDataItem = () => {
+    const map: DataItemMap = {};
+    if (this.requests) {
+      map[Keys.requests] = this.requests.map((request) => {
+        const dataItem = request.toDataItem();
+        dataItem.setTag(request.getRegistryType().getTag());
+        return dataItem;
+      });
+    }
+    return new DataItem(map);
+  };
+
+  public static fromDataItem = (dataItem: DataItem) => {
+    const map = dataItem.getData();
+    const requests = map[Keys.requests].map((request: DataItem) => {
+      return EthSignRequest.fromDataItem(request);
+    });
+
+    return new ETHBatchSignRequest(requests);
+  };
+
+  public static fromCBOR = (_cborPayload: Buffer) => {
+    const dataItem = decodeToDataItem(_cborPayload);
+    return ETHBatchSignRequest.fromDataItem(dataItem);
+  };
+}

packages/ur-registry-eth/src/EthBatchSignature.ts

@@ -0,0 +1,52 @@
+import {
+  extend,
+  DataItem,
+  RegistryItem,
+  DataItemMap,
+} from "@keystonehq/bc-ur-registry";
+import { ExtendedRegistryTypes } from "./RegistryType";
+import { ETHSignature } from "./EthSignature";
+
+const { RegistryTypes, decodeToDataItem } = extend;
+
+enum Keys {
+  signatures = 1,
+}
+
+export class ETHBatchSignature extends RegistryItem {
+  private signatures: ETHSignature[];
+
+  getRegistryType = () => ExtendedRegistryTypes.ETH_BATCH_SIGNATURE;
+
+  constructor(signatures: ETHSignature[]) {
+    super();
+    this.signatures = signatures;
+  }
+
+  public getSignatures = () => this.signatures;
+
+  public toDataItem = () => {
+    const map: DataItemMap = {};
+    if (this.signatures) {
+      map[Keys.signatures] = this.signatures.map((signature) => {
+        const dataItem = signature.toDataItem();
+        dataItem.setTag(signature.getRegistryType().getTag());
+        return dataItem;
+      });
+    }
+    return new DataItem(map);
+  };
+
+  public static fromDataItem = (dataItem: DataItem) => {
+    const map = dataItem.getData();
+    const signatures = map[Keys.signatures].map((signature: DataItem) => {
+      return ETHSignature.fromDataItem(signature);
+    });
+    return new ETHBatchSignature(signatures);
+  };
+
+  public static fromCBOR = (_cborPayload: Buffer) => {
+    const dataItem = decodeToDataItem(_cborPayload);
+    return ETHBatchSignature.fromDataItem(dataItem);
+  };
+}

packages/ur-registry-eth/src/RegistryType.ts

@@ -4,4 +4,6 @@ export const ExtendedRegistryTypes = {
   ETH_SIGN_REQUEST: new RegistryType("eth-sign-request", 401),
   ETH_SIGNATURE: new RegistryType("eth-signature", 402),
   ETH_NFT_ITEM: new RegistryType("eth-nft-item", 403),
+  ETH_BATCH_SIGN_REQUEST: new RegistryType("eth-batch-sign-request", 40404),
+  ETH_BATCH_SIGNATURE: new RegistryType("eth-batch-signature", 40405),
 };

packages/ur-registry-eth/src/index.ts

@@ -11,5 +11,7 @@ patchTags(
 export { EthSignRequest, DataType } from "./EthSignRequest";
 export { ETHSignature } from "./EthSignature";
 export { ETHNFTItem } from "./ETHNFTItem";
+export { ETHBatchSignRequest } from "./EthBatchSignRequest";
+export { ETHBatchSignature } from "./EthBatchSignature";
 
 export { generateAddressFromXpub, findHDPathFromAddress } from "./utlis";