@snapshot-labs/snapshot.js 0.8.3 → 0.9.0

package/dist/utils.d.ts

@@ -31,7 +31,9 @@ export declare function sendTransaction(web3: any, contractAddress: string, abi:
 export declare function getScores(space: string, strategies: Strategy[], network: string, addresses: string[], snapshot?: number | string, scoreApiUrl?: string, options?: any): 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 validateSchema(schema: any, data: any): true | import("ajv").ErrorObject<string, Record<string, any>, unknown>[] | null | undefined;
+export declare function validateSchema(schema: any, data: any, options?: {
+    snapshotEnv: string;
+}): 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>;
 export declare function getEnsOwner(ens: string, network?: string, options?: any): Promise<string | null>;

package/package.json

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

package/src/schemas/space.json

@@ -79,6 +79,7 @@
         },
         "network": {
           "type": "string",
+          "snapshotNetwork": true,
           "title": "network",
           "minLength": 1,
           "maxLength": 32
@@ -114,7 +115,8 @@
               "network": {
                 "type": "string",
                 "maxLength": 12,
-                "title": "network"
+                "title": "network",
+                "snapshotNetwork": true
               },
               "params": {
                 "type": "object",
@@ -346,6 +348,7 @@
               },
               "network": {
                 "type": "string",
+                "snapshotNetwork": true,
                 "title": "Network",
                 "maxLength": 12
               }

package/src/schemas/zodiac.json

@@ -15,7 +15,8 @@
             "properties": {
               "network": {
                 "title": "Network",
-                "type": "string"
+                "type": "string",
+                "snapshotNetwork": true
               },
               "multisend": {
                 "title": "Multisend contract address",

package/src/utils.ts

@@ -37,7 +37,12 @@ const scoreApiHeaders = {
   'Content-Type': 'application/json'
 };
 
-const ajv = new Ajv({ allErrors: true, allowUnionTypes: true, $data: true });
+const ajv = new Ajv({
+  allErrors: true,
+  allowUnionTypes: true,
+  $data: true,
+  passContext: true
+});
 // @ts-ignore
 addFormats(ajv);
 
@@ -68,6 +73,28 @@ ajv.addFormat('ethValue', {
   }
 });
 
+const networksIds = Object.keys(networks);
+const mainnetNetworkIds = Object.keys(networks).filter(
+  (id) => !networks[id].testnet
+);
+const testnetNetworkIds = Object.keys(networks).filter(
+  (id) => networks[id].testnet
+);
+
+ajv.addKeyword({
+  keyword: 'snapshotNetwork',
+  validate: function (schema, data) {
+    // @ts-ignore
+    const snapshotEnv = this.snapshotEnv || 'default';
+    if (snapshotEnv === 'mainnet') return mainnetNetworkIds.includes(data);
+    if (snapshotEnv === 'testnet') return testnetNetworkIds.includes(data);
+    return networksIds.includes(data);
+  },
+  error: {
+    message: 'must be a valid network used by snapshot'
+  }
+});
+
 // Custom URL format to allow empty string values
 // https://github.com/snapshot-labs/snapshot.js/pull/541/files
 ajv.addFormat('customUrl', {
@@ -338,9 +365,15 @@ export async function validate(
   }
 }
 
-export function validateSchema(schema, data) {
+export function validateSchema(
+  schema,
+  data,
+  options = {
+    snapshotEnv: 'default'
+  }
+) {
   const ajvValidate = ajv.compile(schema);
-  const valid = ajvValidate(data);
+  const valid = ajvValidate.call(options, data);
   return valid ? valid : ajvValidate.errors;
 }