@snapshot-labs/snapshot.js 0.7.2 → 0.8.0-beta.0

package/dist/utils.d.ts

@@ -5,6 +5,8 @@ import { signMessage, getBlockNumber } from './utils/web3';
 import { getHash, verify } from './sign/utils';
 interface Options {
     url?: string;
+    timeout?: number;
+    headers?: any;
 }
 interface Strategy {
     name: string;
@@ -23,14 +25,19 @@ export declare const SNAPSHOT_SUBGRAPH_URL: {
 };
 export declare function call(provider: any, abi: any[], call: any[], options?: any): Promise<any>;
 export declare function multicall(network: string, provider: any, abi: any[], calls: any[], options?: any): Promise<any>;
-export declare function subgraphRequest(url: string, query: any, options?: any): Promise<any>;
-export declare function getUrl(uri: any, gateway?: string): any;
-export declare function getJSON(uri: any, options?: any): Promise<any>;
-export declare function ipfsGet(gateway: string, ipfsHash: string, protocolType?: string): Promise<any>;
+export declare function subgraphRequest(url: string, query: any, options?: Options): Promise<any>;
+export declare function getUrl(uri: string, gateway?: string): string | null;
+export declare function getJSON(uri: string, options?: Options & {
+    gateways?: string;
+}): Promise<any>;
+export declare function ipfsGet(gateway: string, ipfsHash: string, protocolType?: string, options?: Options): Promise<any>;
 export declare function sendTransaction(web3: any, contractAddress: string, abi: any[], action: string, params: any[], overrides?: {}): Promise<any>;
-export declare function getScores(space: string, strategies: Strategy[], network: string, addresses: string[], snapshot?: number | string, scoreApiUrl?: string, options?: any): Promise<any>;
+export declare function getScores(space: string, strategies: Strategy[], network: string, addresses: string[], snapshot?: number | string, scoreApiUrl?: string, options?: Options & {
+    returnValue?: string;
+    pathname?: string;
+}): Promise<any>;
 export declare function getVp(address: string, network: string, strategies: Strategy[], snapshot: number | 'latest', space: string, delegation: boolean, options?: Options): Promise<any>;
-export declare function validate(validation: string, author: string, space: string, network: string, snapshot: number | 'latest', params: any, options: any): Promise<any>;
+export declare function validate(validation: string, author: string, space: string, network: string, snapshot: number | 'latest', params: any, options?: Options): Promise<any>;
 export declare function validateSchema(schema: any, data: any): 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 getSpaceUri(id: string, network?: string, options?: any): Promise<string | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snapshot-labs/snapshot.js",
-  "version": "0.7.2",
+  "version": "0.8.0-beta.0",
   "repository": "snapshot-labs/snapshot.js",
   "license": "MIT",
   "main": "dist/snapshot.cjs.js",
@@ -19,9 +19,9 @@
     "@ethersproject/wallet": "^5.6.2",
     "ajv": "^8.11.0",
     "ajv-formats": "^2.1.1",
-    "cross-fetch": "^3.1.6",
     "json-to-graphql-query": "^2.2.4",
-    "lodash.set": "^4.3.2"
+    "lodash.set": "^4.3.2",
+    "ofetch": "^1.3.3"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^18.1.0",

package/src/schemas/alias.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Alias",
+  "definitions": {
+    "Alias": {
+      "title": "Alias",
+      "type": "object",
+      "properties": {
+        "alias": {
+          "type": "string",
+          "format": "address"
+        }
+      },
+      "required": ["alias"],
+      "additionalProperties": false
+    }
+  }
+}

package/src/schemas/index.ts

@@ -5,6 +5,7 @@ import vote from './vote.json';
 import profile from './profile.json';
 import statement from './statement.json';
 import zodiac from './zodiac.json';
+import alias from './alias.json';
 
 export default {
   space: space.definitions.Space,
@@ -13,5 +14,6 @@ export default {
   vote: vote.definitions.Vote,
   profile: profile.definitions.Profile,
   statement: statement.definitions.Statement,
-  zodiac: zodiac.definitions.Zodiac
+  zodiac: zodiac.definitions.Zodiac,
+  alias: alias.definitions.Alias
 };

package/src/sign/index.ts

@@ -1,4 +1,4 @@
-import fetch from 'cross-fetch';
+import { ofetch as fetch } from 'ofetch';
 import { Web3Provider } from '@ethersproject/providers';
 import { Wallet } from '@ethersproject/wallet';
 import { getAddress } from '@ethersproject/address';
@@ -89,16 +89,18 @@ export default class Client {
         Accept: 'application/json',
         'Content-Type': 'application/json'
       },
-      body: JSON.stringify(envelop)
+      timeout: this.options.timeout || 20e3,
+      body: envelop
     };
-    return new Promise((resolve, reject) => {
-      fetch(address, init)
-        .then((res) => {
-          if (res.ok) return resolve(res.json());
-          throw res;
-        })
-        .catch((e) => e.json().then((json) => reject(json)));
-    });
+
+    try {
+      return await fetch(address, init);
+    } catch (e) {
+      const isSequencerError =
+        e.data?.hasOwnProperty('error') &&
+        e.data?.hasOwnProperty('error_description');
+      return Promise.reject(isSequencerError ? e.data : e);
+    }
   }
 
   async space(web3: Web3Provider | Wallet, address: string, message: Space) {

package/src/utils/dist/provider.js

@@ -0,0 +1,47 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+exports.__esModule = true;
+exports.getBatchedProvider = void 0;
+var providers_1 = require("@ethersproject/providers");
+var networks_json_1 = require("../networks.json");
+var providers = {};
+function getProvider(network, type) {
+    var _a;
+    if (type === void 0) { type = 'archive'; }
+    var url = networks_json_1["default"][network].rpc[0];
+    if (type === 'light' && ((_a = networks_json_1["default"][network].light) === null || _a === void 0 ? void 0 : _a.length))
+        url = networks_json_1["default"][network].light[0];
+    var connectionInfo = typeof url === 'object'
+        ? __assign(__assign({}, url), { timeout: 25000 }) : { url: url, timeout: 25000 };
+    if (!providers[network] || !providers[network][type]) {
+        providers[network] = __assign({}, providers[network]);
+        providers[network][type] = new providers_1.StaticJsonRpcProvider(connectionInfo);
+    }
+    return providers[network][type];
+}
+exports["default"] = getProvider;
+function getBatchedProvider(network, type) {
+    var _a;
+    if (type === void 0) { type = 'archive'; }
+    var url = networks_json_1["default"][network].rpc[0];
+    if (type === 'light' && ((_a = networks_json_1["default"][network].light) === null || _a === void 0 ? void 0 : _a.length))
+        url = networks_json_1["default"][network].light[0];
+    var connectionInfo = typeof url === 'object'
+        ? __assign(__assign({}, url), { timeout: 25000 }) : { url: url, timeout: 25000 };
+    if (!providers[network] || !providers[network][type]) {
+        providers[network] = __assign({}, providers[network]);
+        providers[network][type] = new providers_1.JsonRpcBatchProvider(connectionInfo);
+    }
+    return providers[network][type];
+}
+exports.getBatchedProvider = getBatchedProvider;

package/src/utils.ts

@@ -1,4 +1,4 @@
-import fetch from 'cross-fetch';
+import { ofetch as fetch } from 'ofetch';
 import { Interface } from '@ethersproject/abi';
 import { Contract } from '@ethersproject/contracts';
 import { isAddress } from '@ethersproject/address';
@@ -19,6 +19,8 @@ import voting from './voting';
 
 interface Options {
   url?: string;
+  timeout?: number;
+  headers?: any;
 }
 
 interface Strategy {
@@ -135,38 +137,56 @@ export async function multicall(
   }
 }
 
-export async function subgraphRequest(url: string, query, options: any = {}) {
-  const res = await fetch(url, {
-    method: 'POST',
-    headers: {
-      Accept: 'application/json',
-      'Content-Type': 'application/json',
-      ...options?.headers
-    },
-    body: JSON.stringify({ query: jsonToGraphQLQuery({ query }) })
-  });
-  let responseData: any = await res.text();
+export async function subgraphRequest(url: string, query, options?: Options) {
   try {
-    responseData = JSON.parse(responseData);
+    const init = {
+      method: 'POST',
+      headers: {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+        ...options?.headers
+      },
+      timeout: options?.timeout || 20e3,
+      body: { query: jsonToGraphQLQuery({ query }) }
+    };
+
+    const body = await fetch(url, init);
+
+    if (typeof body === 'string') {
+      return Promise.reject({
+        errors: [
+          {
+            message: 'Body is not a JSON object',
+            extensions: { code: 'INVALID_JSON' }
+          }
+        ]
+      });
+    }
+
+    if (body.errors) {
+      return Promise.reject(body);
+    }
+
+    return body.data;
   } catch (e) {
-    throw new Error(
-      `Errors found in subgraphRequest: URL: ${url}, Status: ${
-        res.status
-      }, Response: ${responseData.substring(0, 400)}`
-    );
-  }
-  if (responseData.errors) {
-    throw new Error(
-      `Errors found in subgraphRequest: URL: ${url}, Status: ${
-        res.status
-      },  Response: ${JSON.stringify(responseData.errors).substring(0, 400)}`
+    return Promise.reject(
+      e.data?.errors
+        ? e.data
+        : {
+            errors: [
+              {
+                message: e.statusText || e.toString(),
+                extensions: {
+                  code: e.status || 0
+                }
+              }
+            ]
+          }
     );
   }
-  const { data } = responseData;
-  return data || {};
 }
 
-export function getUrl(uri, gateway = gateways[0]) {
+export function getUrl(uri: string, gateway = gateways[0]) {
   const ipfsGateway = `https://${gateway}`;
   if (!uri) return null;
   if (
@@ -184,18 +204,40 @@ export function getUrl(uri, gateway = gateways[0]) {
   return uri;
 }
 
-export async function getJSON(uri, options: any = {}) {
-  const url = getUrl(uri, options.gateways);
-  return fetch(url).then((res) => res.json());
+export async function getJSON(
+  uri: string,
+  options: Options & { gateways?: string } = {}
+) {
+  const url = getUrl(uri, options.gateways) || '';
+  const body = await fetch(url, {
+    timeout: options.timeout || 30e3,
+    headers: {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+      ...options?.headers
+    }
+  });
+
+  return typeof body === 'string' ? JSON.parse(body) : body;
 }
 
 export async function ipfsGet(
   gateway: string,
   ipfsHash: string,
-  protocolType = 'ipfs'
+  protocolType = 'ipfs',
+  options: Options = {}
 ) {
   const url = `https://${gateway}/${protocolType}/${ipfsHash}`;
-  return fetch(url).then((res) => res.json());
+  const body = await fetch(url, {
+    timeout: options.timeout || 20e3,
+    headers: {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+      ...options.headers
+    }
+  });
+
+  return typeof body === 'string' ? JSON.parse(body) : body;
 }
 
 export async function sendTransaction(
@@ -220,10 +262,10 @@ export async function getScores(
   addresses: string[],
   snapshot: number | string = 'latest',
   scoreApiUrl = 'https://score.snapshot.org',
-  options: any = {}
+  options: Options & { returnValue?: string; pathname?: string } = {}
 ) {
   const url = new URL(scoreApiUrl);
-  url.pathname = '/api/scores';
+  url.pathname = options.pathname || '/api/scores';
   scoreApiUrl = url.toString();
 
   try {
@@ -234,25 +276,25 @@ export async function getScores(
       strategies,
       addresses
     };
-    const res = await fetch(scoreApiUrl, {
+
+    const body = await fetch(scoreApiUrl, {
       method: 'POST',
       headers: scoreApiHeaders,
-      body: JSON.stringify({ params })
+      timeout: options.timeout || 60e3,
+      body: { params }
     });
-    const obj = await res.json();
-
-    if (obj.error) {
-      return Promise.reject(obj.error);
-    }
 
     return options.returnValue === 'all'
-      ? obj.result
-      : obj.result[options.returnValue || 'scores'];
+      ? body.result
+      : body.result[options.returnValue || 'scores'];
   } catch (e) {
-    if (e.errno) {
-      return Promise.reject({ code: e.errno, message: e.toString(), data: '' });
-    }
-    return Promise.reject(e);
+    return Promise.reject(
+      e.data?.error || {
+        code: e.status || 0,
+        message: e.statusText || e.toString(),
+        data: e.data || ''
+      }
+    );
   }
 }
 
@@ -263,14 +305,14 @@ export async function getVp(
   snapshot: number | 'latest',
   space: string,
   delegation: boolean,
-  options?: Options
+  options: Options = {}
 ) {
-  if (!options) options = {};
-  if (!options.url) options.url = 'https://score.snapshot.org';
+  const url = options.url || 'https://score.snapshot.org';
   const init = {
     method: 'POST',
     headers: scoreApiHeaders,
-    body: JSON.stringify({
+    timeout: options.timeout || 60e3,
+    body: {
       jsonrpc: '2.0',
       method: 'get_vp',
       params: {
@@ -281,19 +323,20 @@ export async function getVp(
         space,
         delegation
       }
-    })
+    }
   };
 
   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;
+    const body = await fetch(url, init);
+    return body.result;
   } catch (e) {
-    if (e.errno) {
-      return Promise.reject({ code: e.errno, message: e.toString(), data: '' });
-    }
-    return Promise.reject(e);
+    return Promise.reject(
+      e.data?.error || {
+        code: e.status || 0,
+        message: e.statusText || e.toString(),
+        data: e.data || ''
+      }
+    );
   }
 }
 
@@ -304,14 +347,14 @@ export async function validate(
   network: string,
   snapshot: number | 'latest',
   params: any,
-  options: any
+  options: Options = {}
 ) {
-  if (!options) options = {};
-  if (!options.url) options.url = 'https://score.snapshot.org';
+  const url = options.url || 'https://score.snapshot.org';
   const init = {
     method: 'POST',
     headers: scoreApiHeaders,
-    body: JSON.stringify({
+    timeout: options.timeout || 30e3,
+    body: {
       jsonrpc: '2.0',
       method: 'validate',
       params: {
@@ -322,19 +365,20 @@ export async function validate(
         snapshot,
         params
       }
-    })
+    }
   };
 
   try {
-    const res = await fetch(options.url, init);
-    const json = await res.json();
-    if (json.error) return Promise.reject(json.error);
-    return json.result;
+    const body = await fetch(url, init);
+    return body.result;
   } catch (e) {
-    if (e.errno) {
-      return Promise.reject({ code: e.errno, message: e.toString(), data: '' });
-    }
-    return Promise.reject(e);
+    return Promise.reject(
+      e.data?.error || {
+        code: e.status || 0,
+        message: e.statusText || e.toString(),
+        data: e.data || ''
+      }
+    );
   }
 }