@snapshot-labs/snapshot.js 0.12.0-beta.0 → 0.12.0-beta.1

package/src/utils.spec.js

@@ -1,6 +1,6 @@
 import { describe, test, expect, vi, afterEach } from 'vitest';
 import * as crossFetch from 'cross-fetch';
-import { validate, getScores, getVp } from './utils';
+import { validate, getScores, getVp, getFormattedAddress } from './utils';
 
 vi.mock('cross-fetch', async () => {
   const actual = await vi.importActual('cross-fetch');
@@ -78,13 +78,14 @@ describe('utils', () => {
 
     describe('when passing valid args', () => {
       test('send a JSON-RPC payload to score-api', async () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_validate({})).resolves;
         expect(fetch).toHaveBeenCalledWith(
-          'https://score.snapshot.org',
+          'https://score.snapshot.org/',
           expect.objectContaining({
             body: JSON.stringify({
               jsonrpc: '2.0',
@@ -96,13 +97,14 @@ describe('utils', () => {
       });
 
       test('send a POST request with JSON content-type', async () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_validate({})).resolves;
         expect(fetch).toHaveBeenCalledWith(
-          'https://score.snapshot.org',
+          'https://score.snapshot.org/',
           expect.objectContaining({
             method: 'POST',
             headers: {
@@ -114,23 +116,28 @@ describe('utils', () => {
       });
 
       test('can customize the score-api url', () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(
           _validate({ options: { url: 'https://snapshot.org/?apiKey=xxx' } })
         ).resolves;
         expect(fetch).toHaveBeenCalledWith(
-          'https://snapshot.org/?apiKey=xxx',
-          expect.anything()
+          'https://snapshot.org/',
+          expect.objectContaining({
+            headers: expect.objectContaining({
+              'X-API-KEY': 'xxx'
+            })
+          })
         );
       });
 
       test('returns the JSON-RPC result property', () => {
         const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve(result))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_validate({})).resolves.toEqual('OK');
@@ -141,7 +148,7 @@ describe('utils', () => {
       test('rejects with the JSON-RPC error object', () => {
         const result = { error: { message: 'Oh no' } };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve(result))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_validate({})).rejects.toEqual(result.error);
@@ -152,7 +159,7 @@ describe('utils', () => {
       test('rejects with the error', () => {
         const result = new Error('Oh no');
         fetch.mockReturnValue({
-          json: () => {
+          text: () => {
             throw result;
           }
         });
@@ -196,7 +203,7 @@ describe('utils', () => {
         network ?? payload.network,
         addresses ?? payload.addresses,
         snapshot ?? payload.snapshot,
-        scoreApiUrl ?? 'https://score.snapshot.org',
+        scoreApiUrl ?? 'https://score.snapshot.org/',
         options ?? {}
       );
     }
@@ -239,8 +246,9 @@ describe('utils', () => {
 
     describe('when passing valid args', () => {
       test('send a JSON-RPC payload to score-api', async () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_getScores({})).resolves;
@@ -253,8 +261,9 @@ describe('utils', () => {
       });
 
       test('send a POST request with JSON content-type', async () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_getScores({})).resolves;
@@ -270,23 +279,29 @@ describe('utils', () => {
         );
       });
 
-      test('can customize the score-api url', () => {
+      test('can customize the score-api url and if apiKey should be passed in headers', () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_getScores({ scoreApiUrl: 'https://snapshot.org/?apiKey=xxx' }))
           .resolves;
         expect(fetch).toHaveBeenCalledWith(
-          'https://snapshot.org/api/scores?apiKey=xxx',
-          expect.anything()
+          'https://snapshot.org/api/scores',
+          expect.objectContaining({
+            headers: expect.objectContaining({
+              'X-API-KEY': 'xxx'
+            })
+          })
         );
       });
 
       test('returns the JSON-RPC result scores property', () => {
         const result = { scores: 'SCORES', other: 'Other' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result }))
+          text: () =>
+            new Promise((resolve) => resolve(JSON.stringify({ result })))
         });
 
         expect(_getScores({})).resolves.toEqual('SCORES');
@@ -295,7 +310,8 @@ describe('utils', () => {
       test('returns the JSON-RPC all properties', () => {
         const result = { scores: 'SCORES', other: 'Other' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result }))
+          text: () =>
+            new Promise((resolve) => resolve(JSON.stringify({ result })))
         });
 
         expect(
@@ -308,7 +324,7 @@ describe('utils', () => {
       test('rejects with the JSON-RPC error object', () => {
         const result = { error: { message: 'Oh no' } };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve(result))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_getScores({})).rejects.toEqual(result.error);
@@ -319,7 +335,7 @@ describe('utils', () => {
       test('rejects with the error', () => {
         const result = new Error('Oh no');
         fetch.mockReturnValue({
-          json: () => {
+          text: () => {
             throw result;
           }
         });
@@ -391,13 +407,14 @@ describe('utils', () => {
 
     describe('when passing valid args', () => {
       test('send a JSON-RPC payload to score-api', async () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_getVp({})).resolves;
         expect(fetch).toHaveBeenCalledWith(
-          'https://score.snapshot.org',
+          'https://score.snapshot.org/',
           expect.objectContaining({
             body: JSON.stringify({
               jsonrpc: '2.0',
@@ -409,13 +426,14 @@ describe('utils', () => {
       });
 
       test('send a POST request with JSON content-type', async () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_getVp({})).resolves;
         expect(fetch).toHaveBeenCalledWith(
-          'https://score.snapshot.org',
+          'https://score.snapshot.org/',
           expect.objectContaining({
             method: 'POST',
             headers: {
@@ -427,13 +445,14 @@ describe('utils', () => {
       });
 
       test('can customize the score-api url', () => {
+        const result = { result: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result: 'OK' }))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_getVp({ options: { url: 'https://snapshot.org' } })).resolves;
         expect(fetch).toHaveBeenCalledWith(
-          'https://snapshot.org',
+          'https://snapshot.org/',
           expect.anything()
         );
       });
@@ -441,7 +460,8 @@ describe('utils', () => {
       test('returns the JSON-RPC result property', () => {
         const result = { data: 'OK' };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve({ result }))
+          text: () =>
+            new Promise((resolve) => resolve(JSON.stringify({ result })))
         });
 
         expect(_getVp({})).resolves.toEqual(result);
@@ -452,7 +472,7 @@ describe('utils', () => {
       test('rejects with the JSON-RPC error object', () => {
         const result = { error: { message: 'Oh no' } };
         fetch.mockReturnValue({
-          json: () => new Promise((resolve) => resolve(result))
+          text: () => new Promise((resolve) => resolve(JSON.stringify(result)))
         });
 
         expect(_getVp({})).rejects.toEqual(result.error);
@@ -463,7 +483,7 @@ describe('utils', () => {
       test('rejects with the error', () => {
         const result = new Error('Oh no');
         fetch.mockReturnValue({
-          json: () => {
+          text: () => {
             throw result;
           }
         });
@@ -472,4 +492,39 @@ describe('utils', () => {
       });
     });
   });
+
+  describe('getFormattedAddress', () => {
+    test('returns a checksummed EVM address', () => {
+      const address = '0x91fd2c8d24767db4ece7069aa27832ffaf8590f3';
+      expect(getFormattedAddress(address, ['evm'])).toEqual(
+        '0x91FD2c8d24767db4Ece7069AA27832ffaf8590f3'
+      );
+    });
+
+    test('returns a padded and lowercased starknet address', () => {
+      const address =
+        '0x2a0a8f3b6097e7a6bd7649deb30715323072a159c0e6b71b689bd245c146cc0';
+      expect(getFormattedAddress(address, ['starknet'])).toEqual(
+        '0x02a0a8f3b6097e7a6bd7649deb30715323072a159c0e6b71b689bd245c146cc0'
+      );
+    });
+
+    test('returns an EVM address as starknet address', () => {
+      const address = '0x91FD2c8d24767db4Ece7069AA27832ffaf8590f3';
+      expect(getFormattedAddress(address, ['starknet'])).toEqual(
+        '0x00000000000000000000000091fd2c8d24767db4ece7069aa27832ffaf8590f3'
+      );
+    });
+
+    test('throws an error when the address is not a starknet address', () => {
+      const address = 'hello';
+      expect(() => getFormattedAddress(address, ['starknet'])).toThrow();
+    });
+
+    test('throws an error when the address is not an EVM address', () => {
+      const address =
+        '0x2a0a8f3b6097e7a6bd7649deb30715323072a159c0e6b71b689bd245c146cc0';
+      expect(() => getFormattedAddress(address, ['evm'])).toThrow();
+    });
+  });
 });

package/src/utils.ts

@@ -1,7 +1,7 @@
 import fetch from 'cross-fetch';
 import { Interface } from '@ethersproject/abi';
 import { Contract } from '@ethersproject/contracts';
-import { isAddress } from '@ethersproject/address';
+import { getAddress, isAddress } from '@ethersproject/address';
 import { parseUnits } from '@ethersproject/units';
 import { namehash, ensNormalize } from '@ethersproject/hash';
 import { jsonToGraphQLQuery } from 'json-to-graphql-query';
@@ -12,14 +12,16 @@ import Multicaller from './utils/multicaller';
 import { getSnapshots } from './utils/blockfinder';
 import getProvider from './utils/provider';
 import { signMessage, getBlockNumber } from './utils/web3';
-import { getHash, verify } from './sign/utils';
+import { getHash, verify } from './verify';
 import gateways from './gateways.json';
 import networks from './networks.json';
 import voting from './voting';
 import getDelegatesBySpace, { SNAPSHOT_SUBGRAPH_URL } from './utils/delegation';
+import { validateAndParseAddress } from 'starknet';
 
 interface Options {
   url?: string;
+  headers?: any;
 }
 
 interface Strategy {
@@ -38,6 +40,43 @@ const scoreApiHeaders = {
   'Content-Type': 'application/json'
 };
 
+const DEFAULT_SCORE_API_URL = 'https://score.snapshot.org';
+
+function formatScoreAPIUrl(
+  url = DEFAULT_SCORE_API_URL,
+  options = {
+    path: ''
+  }
+) {
+  const scoreURL = new URL(url);
+  if (options.path) scoreURL.pathname = options.path;
+  const apiKey = scoreURL.searchParams.get('apiKey');
+  let headers: any = { ...scoreApiHeaders };
+  if (apiKey) {
+    scoreURL.searchParams.delete('apiKey');
+    headers = { ...scoreApiHeaders, 'X-API-KEY': apiKey };
+  }
+  return {
+    url: scoreURL.toString(),
+    headers
+  };
+}
+
+async function parseScoreAPIResponse(res: any) {
+  let data: any = await res.text();
+  try {
+    data = JSON.parse(data);
+  } catch (e: any) {
+    return Promise.reject({
+      code: res.status || 500,
+      message: 'Failed to parse response from score API',
+      data
+    });
+  }
+  if (data.error) return Promise.reject(data.error);
+  return data;
+}
+
 const ajv = new Ajv({
   allErrors: true,
   allowUnionTypes: true,
@@ -52,7 +91,17 @@ ajv.addFormat('address', {
   validate: (value: string) => {
     try {
       return isAddress(value);
-    } catch (err) {
+    } catch (e: any) {
+      return false;
+    }
+  }
+});
+
+ajv.addFormat('starknetAddress', {
+  validate: (value: string) => {
+    try {
+      return isStarknetAddress(value);
+    } catch (e: any) {
       return false;
     }
   }
@@ -135,7 +184,6 @@ ajv.addKeyword({
   errors: true
 });
 
-
 // Custom URL format to allow empty string values
 // https://github.com/snapshot-labs/snapshot.js/pull/541/files
 ajv.addFormat('customUrl', {
@@ -157,7 +205,7 @@ export async function call(provider, abi: any[], call: any[], options?) {
   try {
     const params = call[2] || [];
     return await contract[call[1]](...params, options || {});
-  } catch (e) {
+  } catch (e: any) {
     return Promise.reject(e);
   }
 }
@@ -198,7 +246,7 @@ export async function multicall(
     return results.map((call, i) =>
       itf.decodeFunctionResult(calls[i][1], call)
     );
-  } catch (e) {
+  } catch (e: any) {
     return Promise.reject(e);
   }
 }
@@ -216,7 +264,7 @@ export async function subgraphRequest(url: string, query, options: any = {}) {
   let responseData: any = await res.text();
   try {
     responseData = JSON.parse(responseData);
-  } catch (e) {
+  } catch (e: any) {
     throw new Error(
       `Errors found in subgraphRequest: URL: ${url}, Status: ${
         res.status
@@ -287,7 +335,7 @@ export async function getScores(
   network: string,
   addresses: string[],
   snapshot: number | string = 'latest',
-  scoreApiUrl = 'https://score.snapshot.org',
+  scoreApiUrl = DEFAULT_SCORE_API_URL,
   options: any = {}
 ) {
   if (!Array.isArray(addresses)) {
@@ -317,9 +365,11 @@ export async function getScores(
     );
   }
 
-  const url = new URL(scoreApiUrl);
-  url.pathname = '/api/scores';
-  scoreApiUrl = url.toString();
+  const urlObject = new URL(scoreApiUrl);
+  urlObject.pathname = '/api/scores';
+  const { url, headers } = formatScoreAPIUrl(scoreApiUrl, {
+    path: '/api/scores'
+  });
 
   try {
     const params = {
@@ -329,21 +379,17 @@ export async function getScores(
       strategies,
       addresses
     };
-    const res = await fetch(scoreApiUrl, {
+    const res = await fetch(url, {
       method: 'POST',
-      headers: scoreApiHeaders,
+      headers,
       body: JSON.stringify({ params })
     });
-    const obj = await res.json();
-
-    if (obj.error) {
-      return Promise.reject(obj.error);
-    }
+    const response = await parseScoreAPIResponse(res);
 
     return options.returnValue === 'all'
-      ? obj.result
-      : obj.result[options.returnValue || 'scores'];
-  } catch (e) {
+      ? response.result
+      : response.result[options.returnValue || 'scores'];
+  } catch (e: any) {
     if (e.errno) {
       return Promise.reject({ code: e.errno, message: e.toString(), data: '' });
     }
@@ -360,8 +406,7 @@ export async function getVp(
   delegation: boolean,
   options?: Options
 ) {
-  if (!options) options = {};
-  if (!options.url) options.url = 'https://score.snapshot.org';
+  const { url, headers } = formatScoreAPIUrl(options?.url);
   if (!isValidAddress(address)) {
     return inputError(`Invalid voter address: ${address}`);
   }
@@ -385,7 +430,7 @@ export async function getVp(
 
   const init = {
     method: 'POST',
-    headers: scoreApiHeaders,
+    headers,
     body: JSON.stringify({
       jsonrpc: '2.0',
       method: 'get_vp',
@@ -401,11 +446,10 @@ export async function getVp(
   };
 
   try {
-    const res = await fetch(options.url, init);
-    const json = await res.json();
-    if (json.error) return Promise.reject(json.error);
-    if (json.result) return json.result;
-  } catch (e) {
+    const res = await fetch(url, init);
+    const response = await parseScoreAPIResponse(res);
+    return response.result;
+  } catch (e: any) {
     if (e.errno) {
       return Promise.reject({ code: e.errno, message: e.toString(), data: '' });
     }
@@ -420,7 +464,7 @@ export async function validate(
   network: string,
   snapshot: number | 'latest',
   params: any,
-  options: any
+  options?: Options
 ) {
   if (!isValidAddress(author)) {
     return inputError(`Invalid author: ${author}`);
@@ -436,10 +480,11 @@ export async function validate(
   }
 
   if (!options) options = {};
-  if (!options.url) options.url = 'https://score.snapshot.org';
+  const { url, headers } = formatScoreAPIUrl(options.url);
+
   const init = {
     method: 'POST',
-    headers: scoreApiHeaders,
+    headers,
     body: JSON.stringify({
       jsonrpc: '2.0',
       method: 'validate',
@@ -455,11 +500,10 @@ export async function validate(
   };
 
   try {
-    const res = await fetch(options.url, init);
-    const json = await res.json();
-    if (json.error) return Promise.reject(json.error);
-    return json.result;
-  } catch (e) {
+    const res = await fetch(url, init);
+    const response = await parseScoreAPIResponse(res);
+    return response.result;
+  } catch (e: any) {
     if (e.errno) {
       return Promise.reject({ code: e.errno, message: e.toString(), data: '' });
     }
@@ -520,7 +564,7 @@ export async function getSpaceUri(
 ): Promise<string | null> {
   try {
     return await getEnsTextRecord(id, 'snapshot', network, options);
-  } catch (e) {
+  } catch (e: any) {
     console.log(e);
     return null;
   }
@@ -604,6 +648,32 @@ function isValidSnapshot(snapshot: number | string, network: string) {
   );
 }
 
+export function isStarknetAddress(address: string): boolean {
+  if (!address) return false;
+
+  try {
+    validateAndParseAddress(address);
+    return true;
+  } catch (e: any) {
+    return false;
+  }
+}
+
+export function isEvmAddress(address: string): boolean {
+  return isAddress(address);
+}
+
+export function getFormattedAddress(
+  address: string,
+  format: string[] = ['evm', 'starknet']
+): string {
+  if (format.includes('evm') && isAddress(address)) return getAddress(address);
+  if (format.includes('starknet') && isStarknetAddress(address))
+    return validateAndParseAddress(address);
+
+  throw new Error(`Invalid address: ${address}`);
+}
+
 function inputError(message: string) {
   return Promise.reject(new Error(message));
 }
@@ -638,5 +708,8 @@ export default {
   getHash,
   verify,
   validate,
+  isStarknetAddress,
+  isEvmAddress,
+  getFormattedAddress,
   SNAPSHOT_SUBGRAPH_URL
 };

package/src/verify/evm.spec.ts

@@ -0,0 +1,32 @@
+import { test, expect, describe } from 'vitest';
+import evmMessage from '../../test/fixtures/evm/message-alias.json';
+import verify, { getHash } from './evm';
+
+describe('verify/evm', () => {
+  describe('getHash()', () => {
+    test('should return a hash string', () => {
+      const hash = getHash(evmMessage.data);
+      expect(hash).toBe(
+        '0x82ed8be33f43c86f9b83d14736e5762c89108fbc9b8b54f6e993818fc8a53525'
+      );
+    });
+  });
+
+  describe('verify()', () => {
+    test('should return true if the signature is valid', () => {
+      expect(
+        verify(evmMessage.address, evmMessage.sig, evmMessage.data)
+      ).resolves.toBe(true);
+    });
+
+    test('should throw an error if the signature is invalid', () => {
+      expect(
+        verify(
+          '0xDD983E11Cf84746f3b7589ee1Dc2081c08c40Cb3',
+          evmMessage.sig,
+          evmMessage.data
+        )
+      ).rejects.toThrowError(/isValidSignature/);
+    });
+  });
+});