fix: lint codebase

Irys-xyz · Oct 8, 2024 · a10b324 · a10b324
1 parent 73a44af
commit a10b324
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 87 deletions.
diff --git a/src/DataItem.ts b/src/DataItem.ts
@@ -241,9 +241,9 @@ export class DataItem implements BundleItem {
     return await Signer.verify(item.rawOwner, signatureData, item.rawSignature);
   }
 
-    public async getSignatureData(): Promise<Uint8Array> {
-      return getSignatureData(this);
-    }
+  public async getSignatureData(): Promise<Uint8Array> {
+    return getSignatureData(this);
+  }
 
   /**
    * Returns the start byte of the tags section (number of tags)

diff --git a/src/__tests__/starknet.test.ts b/src/__tests__/starknet.test.ts
@@ -1,6 +1,7 @@
 jest.setTimeout(20000);
 import StarknetSigner from "../signing/chains/StarknetSigner";
-import { RpcProvider, shortString, TypedData } from "starknet";
+import type { TypedData } from "starknet";
+import { RpcProvider, shortString } from "starknet";
 import { createData } from "../../index";
 
 const tagsTestVariations = [
@@ -23,24 +24,24 @@ const sampleData: TypedData = {
       { name: "name", type: "felt" },
       { name: "version", type: "felt" },
       { name: "chainId", type: "felt" },
-      { name: "verifyingContract", type: "felt" }
+      { name: "verifyingContract", type: "felt" },
     ],
     Person: [
       { name: "name", type: "felt" },
-      { name: "wallet", type: "felt" }
-    ]
+      { name: "wallet", type: "felt" },
+    ],
   },
   domain: {
     name: "Starknet App",
     version: "1",
-    chainId: shortString.encodeShortString('SN_SEPOLIA'),
-    verifyingContract: "0x123456789abcdef"
+    chainId: shortString.encodeShortString("SN_SEPOLIA"),
+    verifyingContract: "0x123456789abcdef",
   },
   primaryType: "Person",
   message: {
     name: "Alice",
-    wallet: "0xabcdef"
-  }
+    wallet: "0xabcdef",
+  },
 };
 
 const sampleDataTwo: TypedData = {
@@ -54,19 +55,19 @@ const sampleDataTwo: TypedData = {
       { name: "voter", type: "felt" },
       { name: "proposalId", type: "felt" },
       { name: "support", type: "felt" },
-    ]
+    ],
   },
   primaryType: "Vote",
   domain: {
     name: "StarkDAO",
     version: "1",
-    chainId: shortString.encodeShortString('SN_SEPOLIA'),
+    chainId: shortString.encodeShortString("SN_SEPOLIA"),
   },
   message: {
     voter: "0x0123456789abcdef",
     proposalId: "0x42",
-    support: "1" 
-  }
+    support: "1",
+  },
 };
 
 const dataTestVariations = [
@@ -87,14 +88,10 @@ describe("Typed Starknet Signer", () => {
   });
 
   it("should sign a known value", async () => {
-   const expectedSignature = Buffer.from([
-    5,  45,  59, 233,  68,  46, 147, 175, 158,  76,   7,
-    25, 236,  54, 235, 204, 221, 208,  29,  65, 138, 221,
-    239, 130, 196, 101,  72, 112, 150,  36, 121,  59,   5,
-    128,  11, 178,  91,  23, 243, 106, 116, 103,  21,  15,
-    1, 183,  94,  58, 227,  92, 108, 158, 227,  27,  46,
-    234, 229, 112,  28,  91,  25,  30, 116, 231,   0
-  ]);
+    const expectedSignature = Buffer.from([
+      5, 45, 59, 233, 68, 46, 147, 175, 158, 76, 7, 25, 236, 54, 235, 204, 221, 208, 29, 65, 138, 221, 239, 130, 196, 101, 72, 112, 150, 36, 121, 59,
+      5, 128, 11, 178, 91, 23, 243, 106, 116, 103, 21, 15, 1, 183, 94, 58, 227, 92, 108, 158, 227, 27, 46, 234, 229, 112, 28, 91, 25, 30, 116, 231, 0,
+    ]);
 
     const buffer = Buffer.from(JSON.stringify(sampleData));
     const signature = await signer.sign(Uint8Array.from(buffer));
@@ -104,67 +101,61 @@ describe("Typed Starknet Signer", () => {
 
   it("should fail for an invalid signature", async () => {
     const expectedSignature = Buffer.from([
-      34,  56,  90, 120,  12,  45, 200,  99,  22, 134, 223,
-      75, 145,  64, 250, 231, 100, 190,  18,  33, 203, 147,
-      5,  230, 182, 110,  59,  49, 222, 172, 193, 120, 129,
-      10, 154,  43,  67, 183, 240, 199, 204, 101, 192,  56,
-      3,  234, 121,  46, 174, 113, 175, 134, 177,  77, 210,
-      55,  91,  42,  84,  69, 188,  12, 189, 120, 113
-   ]);
-
-     const buffer = Buffer.from(JSON.stringify(sampleData));
-     const signature = await signer.sign(Uint8Array.from(buffer));
-     const signatureBuffer = Buffer.from(signature);
-     expect(signatureBuffer).not.toEqual(expectedSignature);
-   });
+      34, 56, 90, 120, 12, 45, 200, 99, 22, 134, 223, 75, 145, 64, 250, 231, 100, 190, 18, 33, 203, 147, 5, 230, 182, 110, 59, 49, 222, 172, 193, 120,
+      129, 10, 154, 43, 67, 183, 240, 199, 204, 101, 192, 56, 3, 234, 121, 46, 174, 113, 175, 134, 177, 77, 210, 55, 91, 42, 84, 69, 188, 12, 189,
+      120, 113,
+    ]);
+
+    const buffer = Buffer.from(JSON.stringify(sampleData));
+    const signature = await signer.sign(Uint8Array.from(buffer));
+    const signatureBuffer = Buffer.from(signature);
+    expect(signatureBuffer).not.toEqual(expectedSignature);
+  });
 
   it("should verify a known value", async () => {
     const buffer = Buffer.from(JSON.stringify(sampleData));
     const signature = await signer.sign(Uint8Array.from(buffer));
 
-    const publicKey = (signer.publicKey).toString('hex');
+    const publicKey = signer.publicKey.toString("hex");
     const hexString = publicKey.startsWith("0x") ? publicKey.slice(2) : publicKey;
-    const isValid = await StarknetSigner.verify(Buffer.from(hexString, 'hex'), buffer, signature);
+    const isValid = await StarknetSigner.verify(Buffer.from(hexString, "hex"), buffer, signature);
     expect(isValid).toEqual(true);
   });
 
   it("should sign & verify", async () => {
     const buffer = Buffer.from(JSON.stringify(sampleData));
     const signature = await signer.sign(Uint8Array.from(buffer));
 
-    const publicKey = (signer.publicKey).toString('hex');
+    const publicKey = signer.publicKey.toString("hex");
     const hexString = publicKey.startsWith("0x") ? publicKey.slice(2) : publicKey;
-    const isValid = await StarknetSigner.verify(Buffer.from(hexString, 'hex'), buffer, signature);
+    const isValid = await StarknetSigner.verify(Buffer.from(hexString, "hex"), buffer, signature);
     expect(isValid).toEqual(true);
   });
 
   it("should evaulate to false for invalid signature", async () => {
     // generate invalid signature
     const signature = Uint8Array.from([
-      4, 182, 243, 200, 173, 166,  38,  42,  18, 165,  33,
-      59, 155, 164, 184, 207,  51,  68, 119,  38,  52, 132,
-      173, 106, 178, 135,  61, 161, 171,  37, 245,  52,  1,
-      105,  72, 184, 232,  25,  63, 181,  16, 106, 148,  94,
-      107, 138, 225, 225,  64,  36,  57,  90,  22,  66, 208,
-      251, 188,   5,  33, 205,  77,  24,  12, 250,   0
+      4, 182, 243, 200, 173, 166, 38, 42, 18, 165, 33, 59, 155, 164, 184, 207, 51, 68, 119, 38, 52, 132, 173, 106, 178, 135, 61, 161, 171, 37, 245,
+      52, 1, 105, 72, 184, 232, 25, 63, 181, 16, 106, 148, 94, 107, 138, 225, 225, 64, 36, 57, 90, 22, 66, 208, 251, 188, 5, 33, 205, 77, 24, 12, 250,
+      0,
     ]);
 
     // try verifying
-    const publicKey = (signer.publicKey).toString('hex');
+    const publicKey = signer.publicKey.toString("hex");
     const hexString = publicKey.startsWith("0x") ? publicKey.slice(2) : publicKey;
     const buffer = Buffer.from(JSON.stringify(sampleData));
-    const isValid = await StarknetSigner.verify(Buffer.from(hexString, 'hex'), buffer, signature);
+    const isValid = await StarknetSigner.verify(Buffer.from(hexString, "hex"), buffer, signature);
     expect(isValid).toEqual(false);
   });
 
   it("should evaulate to false for invalid message", async () => {
     const buffer = Buffer.from(JSON.stringify(sampleData));
     const signature = await signer.sign(Uint8Array.from(buffer));
 
-    const publicKey = (signer.publicKey).toString('hex');
+    const publicKey = signer.publicKey.toString("hex");
     const hexString = publicKey.startsWith("0x") ? publicKey.slice(2) : publicKey;
     const invalidBuffer = Buffer.from(JSON.stringify(sampleDataTwo));
-    const isValid = await StarknetSigner.verify(Buffer.from(hexString, 'hex'), invalidBuffer, signature);
+    const isValid = await StarknetSigner.verify(Buffer.from(hexString, "hex"), invalidBuffer, signature);
     expect(isValid).toEqual(false);
   });
 
@@ -183,9 +174,9 @@ describe("Typed Starknet Signer", () => {
         const buffer = Buffer.from(JSON.stringify(sampleData));
         const signature = await randSigner.sign(Uint8Array.from(buffer));
 
-        const publicKey = (signer.publicKey).toString('hex');
+        const publicKey = signer.publicKey.toString("hex");
         const hexString = publicKey.startsWith("0x") ? publicKey.slice(2) : publicKey;
-        const isValid = await StarknetSigner.verify(Buffer.from(hexString, 'hex'), buffer, signature);
+        const isValid = await StarknetSigner.verify(Buffer.from(hexString, "hex"), buffer, signature);
         expect(isValid).toEqual(true);
       });
     });

diff --git a/src/ar-data-base.ts b/src/ar-data-base.ts
@@ -22,4 +22,4 @@ async function getSignatureData(item: DataItem): Promise<Uint8Array> {
   ]);
 }
 
-export default getSignatureData;
+export default getSignatureData;
diff --git a/src/constants.ts b/src/constants.ts
@@ -51,9 +51,9 @@ export const SIG_CONFIG: Record<SignatureConfig, SignatureMeta> = {
     pubLength: 42,
     sigName: "typedEthereum",
   },
-  [SignatureConfig.STARKNET]:{
-    sigLength:65,
+  [SignatureConfig.STARKNET]: {
+    sigLength: 65,
     pubLength: 33,
-    sigName:'starknet'
-  }
+    sigName: "starknet",
+  },
 };
diff --git a/src/signing/chains/StarknetSigner.ts b/src/signing/chains/StarknetSigner.ts
@@ -1,12 +1,5 @@
-import {
-  Account,
-  RpcProvider,
-  WeierstrassSignatureType,
-  ec,
-  encode,
-  hash,
-  BigNumberish
-} from "starknet";
+import type { RpcProvider, WeierstrassSignatureType, BigNumberish } from "starknet";
+import { Account, ec, encode, hash } from "starknet";
 import type { Signer } from "../index";
 import { SignatureConfig, SIG_CONFIG } from "../../constants";
 
@@ -28,12 +21,12 @@ export default class StarknetSigner implements Signer {
     this.signer = new Account(provider, address, pKey);
   }
 
-  public async init() {
+  public async init(): Promise<void> {
     try {
       const pub_key = encode.addHexPrefix(encode.buf2hex(ec.starkCurve.getPublicKey(this.privateKey, true)));
-      let hexKey = pub_key.startsWith("0x") ? pub_key.slice(2) : pub_key;
+      const hexKey = pub_key.startsWith("0x") ? pub_key.slice(2) : pub_key;
 
-      this.publicKey = Buffer.from(hexKey, 'hex');
+      this.publicKey = Buffer.from(hexKey, "hex");
       this.chainId = await this.provider.getChainId();
     } catch (error) {
       console.error("Error setting public key or chain ID:", error);
@@ -53,13 +46,13 @@ export default class StarknetSigner implements Signer {
 
     const r = BigInt(signature.r).toString(16).padStart(64, "0"); // Convert BigInt to hex string
     const s = BigInt(signature.s).toString(16).padStart(64, "0"); // Convert BigInt to hex string
-    // @ts-ignore
+    if (!signature.recovery) throw new Error("signature is missing required recovery component");
     const recovery = signature.recovery.toString(16).padStart(2, "0"); // Convert recovery to hex string
 
     const rArray = Uint8Array.from(Buffer.from(r, "hex"));
     const sArray = Uint8Array.from(Buffer.from(s, "hex"));
     const recoveryArray = Uint8Array.from(Buffer.from(recovery, "hex"));
-    
+
     // Concatenate the arrays
     const result = new Uint8Array(rArray.length + sArray.length + recoveryArray.length);
     result.set(rArray);
@@ -85,17 +78,17 @@ function uint8ArrayToBigNumberishArray(uint8Arr: Uint8Array): BigNumberish[] {
   const bigNumberishArray: BigNumberish[] = [];
 
   for (let i = 0; i < uint8Arr.length; i += chunkSize) {
-      // Extract a chunk of size 31 bytes
-      const chunk = uint8Arr.slice(i, i + chunkSize);
-      
-      // Convert the chunk to a bigint
-      let bigIntValue = BigInt(0);
-      for (let j = 0; j < chunk.length; j++) {
-          bigIntValue = (bigIntValue << BigInt(8)) + BigInt(chunk[j]);
-      }
-
-      bigNumberishArray.push(bigIntValue);
+    // Extract a chunk of size 31 bytes
+    const chunk = uint8Arr.slice(i, i + chunkSize);
+
+    // Convert the chunk to a bigint
+    let bigIntValue = BigInt(0);
+    for (let j = 0; j < chunk.length; j++) {
+      bigIntValue = (bigIntValue << BigInt(8)) + BigInt(chunk[j]);
+    }
+
+    bigNumberishArray.push(bigIntValue);
   }
 
   return bigNumberishArray;
-}
+}
diff --git a/src/signing/chains/injectedSolanaSigner.ts b/src/signing/chains/injectedSolanaSigner.ts
@@ -1,7 +1,7 @@
 import type { Signer } from "../index";
 import base64url from "base64url";
 import { SIG_CONFIG } from "../../constants";
-// eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
+// eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error, @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import type { MessageSignerWalletAdapter } from "@solana/wallet-adapter-base";
 import { verify } from "@noble/ed25519";

diff --git a/src/signing/constants.ts b/src/signing/constants.ts
@@ -8,7 +8,7 @@ import {
   InjectedAptosSigner,
   MultiSignatureAptosSigner,
   TypedEthereumSigner,
-  StarknetSigner
+  StarknetSigner,
 } from "./chains/index";
 
 export type IndexToType = Record<
@@ -43,8 +43,7 @@ export const indexToType: IndexToType = {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-expect-error
   7: TypedEthereumSigner,
-   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-expect-error
-  8: StarknetSigner
-
+  8: StarknetSigner,
 };
-Original file line number
+Diff line change
@@ Expand Up @@
       ]);
     }
-    export default getSignatureData;
+    export default getSignatureData;