@snapshot-labs/snapshot.js 0.12.0-beta.5 → 0.12.0-beta.6

package/dist/src/utils.d.ts

@@ -28,7 +28,7 @@ interface validateSchemaOptions {
     spaceType?: string;
 }
 export declare function validateSchema(schema: any, data: any, options?: validateSchemaOptions): true | import("ajv").ErrorObject<string, Record<string, any>, unknown>[] | null | undefined;
-export declare function getEnsTextRecord(ens: string, record: string, network?: string, options?: any): Promise<any>;
+export declare function getEnsTextRecord(ens: string, record: string, network?: string, options?: any): Promise<string | null>;
 export declare function getSpaceUri(id: string, network?: string, options?: any): Promise<string | null>;
 export declare function getEnsOwner(ens: string, network?: string, options?: any): Promise<string | null>;
 export declare function getSpaceController(id: string, network?: string, options?: any): Promise<string | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snapshot-labs/snapshot.js",
-  "version": "0.12.0-beta.5",
+  "version": "0.12.0-beta.6",
   "repository": "snapshot-labs/snapshot.js",
   "license": "MIT",
   "main": "dist/snapshot.cjs.js",
@@ -46,7 +46,7 @@
     "rollup-plugin-terser": "^7.0.0",
     "rollup-plugin-typescript2": "^0.27.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5",
+    "typescript": "^5.0.0",
     "vitest": "^0.33.0"
   },
   "scripts": {
@@ -55,7 +55,8 @@
     "test": "vitest",
     "test:once": "vitest run",
     "dev": "rollup -c -w",
-    "lint": "eslint . --ext .ts --fix",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "yarn lint --fix",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "yarn build"
   },

package/src/networks.json

@@ -151,7 +151,7 @@
   },
   "56": {
     "key": "56",
-    "name": "Binance Smart Chain",
+    "name": "BNB Smart Chain",
     "shortName": "BSC",
     "chainId": 56,
     "network": "mainnet",
@@ -168,7 +168,7 @@
       "url": "https://bscscan.com"
     },
     "start": 461230,
-    "logo": "ipfs://QmWQaQ4Tv28DwA4DRKjSDJFWY9mZboGvuu77J8nh7kucxv"
+    "logo": "ipfs://bafkreibll4la7wqerzs7zwxjne2j7ayynbg2wlenemssoahxxj5rbt6c64"
   },
   "61": {
     "key": "61",
@@ -254,7 +254,7 @@
   },
   "97": {
     "key": "97",
-    "name": "Binance Smart Chain Testnet",
+    "name": "BNB Smart Chain Testnet",
     "shortName": "BSC Testnet",
     "chainId": 97,
     "network": "testnet",
@@ -268,7 +268,7 @@
       "url": "https://testnet.bscscan.com"
     },
     "start": 3599656,
-    "logo": "ipfs://QmWQaQ4Tv28DwA4DRKjSDJFWY9mZboGvuu77J8nh7kucxv"
+    "logo": "ipfs://bafkreibll4la7wqerzs7zwxjne2j7ayynbg2wlenemssoahxxj5rbt6c64"
   },
   "100": {
     "key": "100",
@@ -1408,7 +1408,7 @@
       "url": "https://blastscan.io"
     },
     "start": 88189,
-    "logo": "ipfs://bafkreibfmkjg22cozxppzcoxswj45clvh2rqhxzax57cmmgudbtkf4dkce"
+    "logo": "ipfs://bafkreicqhrimt2zyp2kvhmbpvffxlmxovkg5vw6zkissyzibcfy45kbvrm"
   },
   "84532": {
     "key": "84532",
@@ -1622,4 +1622,4 @@
     "start": 7521509,
     "logo": "ipfs://QmNnGPr1CNvj12SSGzKARtUHv9FyEfE5nES73U4vBWQSJL"
   }
-}
+}

package/src/sign/hashedTypes.json

@@ -59,5 +59,6 @@
   "8ea9074bff3a30cb61f4f0f0f142c9335c6be828feba0571a45de3f1fd0319c0": "alias",
   "42f8858a21d4aa232721cb97074851e729829ea362b88bb21f3879899663b586": "follow",
   "2bb75450e28b06f259ea764cd669de6bde0ba70ce729b0ff05ab9df56e0ff21d": "unfollow",
-  "2ffbebcbd22ef48fd2f4a1182ff1feda7795b57689bd6f0dd73c89e925e7fefb": "profile"
+  "2ffbebcbd22ef48fd2f4a1182ff1feda7795b57689bd6f0dd73c89e925e7fefb": "profile",
+  "4288d50b713081aae77d60d596d75864bff7acf7791a00183401e58658ee9da5": "statement"
 }

package/src/sign/index.ts

@@ -75,7 +75,9 @@ export default class Client {
     // @ts-ignore
     const signer = web3?.getSigner ? web3.getSigner() : web3;
     const checksumAddress = getAddress(address);
-    message.from = message.from ? getAddress(message.from) : checksumAddress;
+    message.from = message.from
+      ? getAddress(message.from).toLowerCase()
+      : checksumAddress.toLowerCase();
     if (!message.timestamp)
       message.timestamp = parseInt((Date.now() / 1e3).toFixed());
 
@@ -88,7 +90,11 @@ export default class Client {
     }
     const data: any = { domain: domainData, types, message };
     const sig = await signer._signTypedData(domainData, data.types, message);
-    return await this.send({ address: checksumAddress, sig, data });
+    return await this.send({
+      address: checksumAddress.toLowerCase(),
+      sig,
+      data
+    });
   }
 
   async send(envelop) {

package/src/sign/types.ts

@@ -272,6 +272,7 @@ export const voteString2Types = {
 };
 
 export const followTypes = {
+
   Follow: [
     { name: 'from', type: 'address' },
     { name: 'network', type: 'string' },

package/src/utils.spec.js

@@ -1,6 +1,12 @@
 import { describe, test, expect, vi, afterEach } from 'vitest';
 import * as crossFetch from 'cross-fetch';
-import { validate, getScores, getVp, getFormattedAddress } from './utils';
+import {
+  validate,
+  validateSchema,
+  getScores,
+  getVp,
+  getFormattedAddress
+} from './utils';
 
 vi.mock('cross-fetch', async () => {
   const actual = await vi.importActual('cross-fetch');
@@ -527,4 +533,82 @@ describe('utils', () => {
       expect(() => getFormattedAddress(address, 'evm')).toThrow();
     });
   });
+
+  describe('address validation', () => {
+    const evmSchema = {
+      $schema: 'http://json-schema.org/draft-07/schema#',
+      $ref: '#/definitions/Envelope',
+      definitions: {
+        Envelope: {
+          type: 'object',
+          properties: {
+            address: {
+              type: 'string',
+              format: 'address'
+            }
+          }
+        }
+      }
+    };
+
+    const starknetSchema = {
+      $schema: 'http://json-schema.org/draft-07/schema#',
+      $ref: '#/definitions/Envelope',
+      definitions: {
+        Envelope: {
+          type: 'object',
+          properties: {
+            address: {
+              type: 'string',
+              format: 'starknetAddress'
+            }
+          }
+        }
+      }
+    };
+
+    test('should return true on checksummed EVM address', async () => {
+      const result = validateSchema(evmSchema, {
+        address: '0x91FD2c8d24767db4Ece7069AA27832ffaf8590f3'
+      });
+      expect(result).toBe(true);
+    });
+
+    test('should return an error on lowercase EVM address', async () => {
+      const result = validateSchema(evmSchema, {
+        address: '0x91FD2c8d24767db4Ece7069AA27832ffaf8590f3'.toLowerCase()
+      });
+      expect(result).not.toBe(true);
+    });
+
+    test('should return an error on empty address', async () => {
+      const result = validateSchema(evmSchema, {
+        address: ''
+      });
+      expect(result).not.toBe(true);
+    });
+
+    test('should return true on lowercase padded starknet address', async () => {
+      const result = validateSchema(starknetSchema, {
+        address:
+          '0x02a0a8f3b6097e7a6bd7649deb30715323072a159c0e6b71b689bd245c146cc0'
+      });
+      expect(result).toBe(true);
+    });
+
+    test('should return an error on non-padded starknet address', async () => {
+      const result = validateSchema(starknetSchema, {
+        address:
+          '0x2a0a8f3b6097e7a6bd7649deb30715323072a159c0e6b71b689bd245c146cc0'
+      });
+      expect(result).not.toBe(true);
+    });
+
+    test('should return an error on empty starknet address', async () => {
+      const result = validateSchema(starknetSchema, {
+        address: ''
+      });
+      expect(result).not.toBe(true);
+    });
+  });
 });

package/src/utils.ts

@@ -30,8 +30,10 @@ interface Strategy {
   params: any;
 }
 
-const ENS_RESOLVER_ABI = [
-  'function text(bytes32 node, string calldata key) external view returns (string memory)'
+const ENS_REGISTRY = '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e';
+const ENS_ABI = [
+  'function text(bytes32 node, string calldata key) external view returns (string memory)',
+  'function resolver(bytes32 node) view returns (address)' // ENS registry ABI
 ];
 const EMPTY_ADDRESS = '0x0000000000000000000000000000000000000000';
 
@@ -90,7 +92,7 @@ addErrors(ajv);
 ajv.addFormat('address', {
   validate: (value: string) => {
     try {
-      return isAddress(value);
+      return value === getAddress(value);
     } catch (e: any) {
       return false;
     }
@@ -100,7 +102,7 @@ ajv.addFormat('address', {
 ajv.addFormat('starknetAddress', {
   validate: (value: string) => {
     try {
-      return isStarknetAddress(value);
+      return validateAndParseAddress(value) === value;
     } catch (e: any) {
       return false;
     }
@@ -536,25 +538,34 @@ export async function getEnsTextRecord(
   options: any = {}
 ) {
   const {
-    ensResolvers: ensResolversOpt,
+    ensResolvers = networks[network]?.ensResolvers ||
+      networks['1'].ensResolvers,
     broviderUrl,
     ...multicallOptions
   } = options;
-  const ensResolvers =
-    ensResolversOpt ||
-    networks[network].ensResolvers ||
-    networks['1'].ensResolvers;
+
   const ensHash = namehash(ensNormalize(ens));
   const provider = getProvider(network, { broviderUrl });
 
-  const result = await multicall(
+  const calls = [
+    [ENS_REGISTRY, 'resolver', [ensHash]], // Query for resolver from registry
+    ...ensResolvers.map((address: string) => [
+      address,
+      'text',
+      [ensHash, record]
+    ]) // Query for text record from each resolver
+  ];
+
+  const [[resolverAddress], ...textRecords]: string[][] = await multicall(
     network,
     provider,
-    ENS_RESOLVER_ABI,
-    ensResolvers.map((address: any) => [address, 'text', [ensHash, record]]),
+    ENS_ABI,
+    calls,
     multicallOptions
   );
-  return result.flat().find((r: string) => r) || '';
+
+  const resolverIndex = ensResolvers.indexOf(resolverAddress);
+  return resolverIndex !== -1 ? textRecords[resolverIndex]?.[0] : null;
 }
 
 export async function getSpaceUri(
@@ -575,10 +586,9 @@ export async function getEnsOwner(
   network = '1',
   options: any = {}
 ): Promise<string | null> {
-  const registryAddress = '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e';
   const provider = getProvider(network, options);
   const ensRegistry = new Contract(
-    registryAddress,
+    ENS_REGISTRY,
     ['function owner(bytes32) view returns (address)'],
     provider
   );

package/src/verify/starknet.spec.ts

@@ -1,6 +1,7 @@
 import { test, expect, describe } from 'vitest';
 import starknetMessage from '../../test/fixtures/starknet/message-alias.json';
 import verify, { getHash } from './starknet';
+import { validateAndParseAddress } from 'starknet';
 
 describe('verify/starknet', () => {
   describe('getHash()', () => {
@@ -31,6 +32,17 @@ describe('verify/starknet', () => {
       ).resolves.toBe(true);
     });
 
+    test('should return true if the signature is valid with a padded address', () => {
+      expect(
+        verify(
+          validateAndParseAddress(starknetMessage.address),
+          starknetMessage.sig,
+          starknetMessage.data,
+          'SN_SEPOLIA'
+        )
+      ).resolves.toBe(true);
+    });
+
     test('should throw an error if message is on wrong network', () => {
       expect(
         verify(