feat(config): add ability to define brovider URL (#886)

* feat(brovider): add extra param for configuring brovider

* fix(lint): fix lint issues

* fix(options): change namings

* Update src/utils.ts

* Update src/utils.ts

* v0.5.6

---------

Co-authored-by: Chaitanya <[email protected]>

Author: Todmy

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snapshot-labs/snapshot.js",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "repository": "snapshot-labs/snapshot.js",
   "license": "MIT",
   "main": "dist/snapshot.cjs.js",

src/sign/eip1271.ts

@@ -48,8 +48,8 @@ export async function verifyOldVersion(
   return returnValue.toLowerCase() === magicValue.toLowerCase();
 }
 
-export async function verify(address, sig, hash, network = '1') {
-  const provider = getProvider(network);
+export async function verify(address, sig, hash, network = '1', options = {}) {
+  const provider = getProvider(network, options);
   if (await verifyDefault(address, sig, hash, provider)) return true;
   return await verifyOldVersion(address, sig, hash, provider);
 }

src/sign/utils.ts

@@ -7,7 +7,7 @@ export function getHash(data) {
   return _TypedDataEncoder.hash(domain, types, message);
 }
 
-export async function verify(address, sig, data, network = '1') {
+export async function verify(address, sig, data, network = '1', options = {}) {
   const { domain, types, message } = data;
 
   const hash = getHash(data);
@@ -23,5 +23,5 @@ export async function verify(address, sig, data, network = '1') {
   }
 
   // console.log('Check EIP1271 signature');
-  return await verifyEIP1271(address, sig, hash, network);
+  return await verifyEIP1271(address, sig, hash, network, options);
 }

src/utils.ts

@@ -104,11 +104,9 @@ export async function multicall(
   const multicallAbi = [
     'function aggregate(tuple(address target, bytes callData)[] calls) view returns (uint256 blockNumber, bytes[] returnData)'
   ];
-  const multi = new Contract(
-    networks[network].multicall,
-    multicallAbi,
-    provider
-  );
+  const multicallAddress =
+    options?.multicallAddress || networks[network].multicall;
+  const multi = new Contract(multicallAddress, multicallAbi, provider);
   const itf = new Interface(abi);
   try {
     const max = options?.limit || 500;
@@ -184,8 +182,8 @@ export function getUrl(uri, gateway = gateways[0]) {
   return uri;
 }
 
-export async function getJSON(uri) {
-  const url = getUrl(uri);
+export async function getJSON(uri, options: any = {}) {
+  const url = getUrl(uri, options.gateways);
   return fetch(url).then((res) => res.json());
 }
 
@@ -323,28 +321,33 @@ export function validateSchema(schema, data) {
 export async function getEnsTextRecord(
   ens: string,
   record: string,
-  network = '1'
+  network = '1',
+  options: any = {}
 ) {
   const ensResolvers =
-    networks[network].ensResolvers || networks['1'].ensResolvers;
+    options.ensResolvers ||
+    networks[network].ensResolvers ||
+    networks['1'].ensResolvers;
   const ensHash = namehash(ensNormalize(ens));
-  const provider = getProvider(network);
+  const provider = getProvider(network, options);
 
   const result = await multicall(
     network,
     provider,
     ENS_RESOLVER_ABI,
-    ensResolvers.map((address: any) => [address, 'text', [ensHash, record]])
+    ensResolvers.map((address: any) => [address, 'text', [ensHash, record]]),
+    options
   );
   return result.flat().find((r: string) => r) || '';
 }
 
 export async function getSpaceUri(
   id: string,
-  network = '1'
+  network = '1',
+  options: any = {}
 ): Promise<string | null> {
   try {
-    return await getEnsTextRecord(id, 'snapshot', network);
+    return await getEnsTextRecord(id, 'snapshot', network, options);
   } catch (e) {
     console.log(e);
     return null;
@@ -353,16 +356,18 @@ export async function getSpaceUri(
 
 export async function getEnsOwner(
   ens: string,
-  network = '1'
+  network = '1',
+  options: any = {}
 ): Promise<string | null> {
   const registryAddress = '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e';
-  const provider = getProvider(network);
+  const provider = getProvider(network, options);
   const ensRegistry = new Contract(
     registryAddress,
     ['function owner(bytes32) view returns (address)'],
     provider
   );
-  const ensNameWrapper = networks[network].ensNameWrapper;
+  const ensNameWrapper =
+    options.ensNameWrapper || networks[network].ensNameWrapper;
   const ensHash = namehash(ensNormalize(ens));
   let owner = await ensRegistry.owner(ensHash);
   // If owner is the ENSNameWrapper contract, resolve the owner of the name
@@ -379,9 +384,10 @@ export async function getEnsOwner(
 
 export async function getSpaceController(
   id: string,
-  network = '1'
+  network = '1',
+  options: any = {}
 ): Promise<string | null> {
-  const spaceUri = await getSpaceUri(id, network);
+  const spaceUri = await getSpaceUri(id, network, options);
   if (spaceUri) {
     let isUriAddress = isAddress(spaceUri);
     if (isUriAddress) return spaceUri;
@@ -392,15 +398,18 @@ export async function getSpaceController(
     isUriAddress = isAddress(address);
     if (isUriAddress) return address;
   }
-  return await getEnsOwner(id, network);
+  return await getEnsOwner(id, network, options);
 }
 
 export async function getDelegatesBySpace(
   network: string,
   space: string,
-  snapshot = 'latest'
+  snapshot = 'latest',
+  options: any = {}
 ) {
-  if (!delegationSubgraphs[network]) {
+  const subgraphUrl =
+    options.subgraphUrl || SNAPSHOT_SUBGRAPH_URL[network];
+  if (!subgraphUrl) {
     return Promise.reject(
       `Delegation subgraph not available for network ${network}`
     );
@@ -432,10 +441,7 @@ export async function getDelegatesBySpace(
   while (true) {
     params.delegations.__args.skip = page * PAGE_SIZE;
 
-    const pageResult = await subgraphRequest(
-      delegationSubgraphs[network],
-      params
-    );
+    const pageResult = await subgraphRequest(subgraphUrl, params);
     const pageDelegations = pageResult.delegations || [];
     result = result.concat(pageDelegations);
     page++;

src/utils/blockfinder.ts

@@ -3,7 +3,13 @@ import { subgraphRequest } from '../utils';
 let cache: Record<string, any> = {};
 let expirationTime = 0;
 
-export async function getSnapshots(network, snapshot, provider, networks) {
+export async function getSnapshots(
+  network,
+  snapshot,
+  provider,
+  networks,
+  options: any = {}
+) {
   // If snapshot is latest, return all latest
   const snapshots = {};
   networks.forEach((n) => (snapshots[n] = 'latest'));
@@ -39,7 +45,7 @@ export async function getSnapshots(network, snapshot, provider, networks) {
       number: true
     }
   };
-  const url = 'https://blockfinder.snapshot.org';
+  const url = options.blockFinderUrl || 'https://blockfinder.snapshot.org';
   const data = await subgraphRequest(url, query);
   data.blocks.forEach((block) => (snapshots[block.network] = block.number));
   cache[cacheKey] = snapshots;

src/utils/provider.ts

@@ -6,8 +6,11 @@ import {
 const providers = {};
 const batchedProviders = {};
 
-export default function getProvider(network) {
-  const url = `https://rpc.snapshot.org/${network}`;
+export default function getProvider(
+  network,
+  { broviderUrl = 'https://rpc.snapshot.org' } = {}
+) {
+  const url = `${broviderUrl}/${network}`;
   if (!providers[network])
     providers[network] = new StaticJsonRpcProvider(
       {
@@ -20,8 +23,11 @@ export default function getProvider(network) {
   return providers[network];
 }
 
-export function getBatchedProvider(network) {
-  const url = `https://rpc.snapshot.org/${network}`;
+export function getBatchedProvider(
+  network,
+  { broviderUrl = 'https://rpc.snapshot.org' } = {}
+) {
+  const url = `${broviderUrl}/${network}`;
   if (!batchedProviders[network])
     batchedProviders[network] = new JsonRpcBatchProvider({
       url,