@snapshot-labs/snapshot.js 0.4.95 → 0.4.97

package/README.md

@@ -2,31 +2,57 @@
 
 [![npm](https://img.shields.io/npm/v/@snapshot-labs/snapshot.js?label=npm)](https://www.npmjs.com/package/@snapshot-labs/snapshot.js)
 
-### Install
+## Install
+
 Snapshot.js was designed to work both in the browser and in Node.js.
 
-#### Node.js
+### In Node Applications
+
 To install Snapshot.js on Node.js, open your terminal and run:
-```
+
+```bash
 npm i @snapshot-labs/snapshot.js
 ```
 
 #### Browser
+
 You can create an index.html file and include Snapshot.js with:
+
 ```html
 <script src="https://cdn.jsdelivr.net/npm/@snapshot-labs/snapshot.js"></script>
 ```
+
 ### Development
 
 #### Install dependencies
+
 ```bash
 yarn
 ```
 
 #### Build package
+
 ```bash
 yarn build
 ```
 
+#### Test cases
+
+```bash
+yarn test
+# or
+yarn test:once
+```
+
+#### Other useful scripts
+
+```bash
+# Format ABI
+ts-node scripts/abi.ts
+# Generate hash for types
+ts-node scripts/generateHashWithTypes.ts
+```
+
 ### License
+
 [MIT](LICENSE).

package/dist/index.d.ts

@@ -235,8 +235,35 @@ declare const _default: {
                     required: string[];
                     additionalProperties: boolean;
                 };
-                delegation: {
+                delegationPortal: {
                     type: string;
+                    properties: {
+                        delegationType: {
+                            type: string;
+                            title: string;
+                            description: string;
+                            anyOf: {
+                                const: string;
+                                title: string;
+                            }[];
+                        };
+                        delegationContract: {
+                            type: string;
+                            format: string;
+                            title: string;
+                            description: string;
+                            examples: string[];
+                        };
+                        delegationApi: {
+                            type: string;
+                            format: string;
+                            title: string;
+                            description: string;
+                            examples: string[];
+                        };
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
                 };
                 allowAlias: {
                     type: string;

package/dist/schemas/index.d.ts

@@ -231,8 +231,35 @@ declare const _default: {
                 required: string[];
                 additionalProperties: boolean;
             };
-            delegation: {
+            delegationPortal: {
                 type: string;
+                properties: {
+                    delegationType: {
+                        type: string;
+                        title: string;
+                        description: string;
+                        anyOf: {
+                            const: string;
+                            title: string;
+                        }[];
+                    };
+                    delegationContract: {
+                        type: string;
+                        format: string;
+                        title: string;
+                        description: string;
+                        examples: string[];
+                    };
+                    delegationApi: {
+                        type: string;
+                        format: string;
+                        title: string;
+                        description: string;
+                        examples: string[];
+                    };
+                };
+                required: string[];
+                additionalProperties: boolean;
             };
             allowAlias: {
                 type: string;

package/dist/snapshot.cjs.js

@@ -4,6 +4,7 @@ var fetch = require('cross-fetch');
 var address = require('@ethersproject/address');
 var abi = require('@ethersproject/abi');
 var contracts = require('@ethersproject/contracts');
+var units = require('@ethersproject/units');
 var ethEnsNamehash = require('@ensdomains/eth-ens-namehash');
 var jsonToGraphqlQuery = require('json-to-graphql-query');
 var Ajv = require('ajv');
@@ -751,8 +752,45 @@ var definitions = {
 				],
 				additionalProperties: false
 			},
-			delegation: {
-				type: "boolean"
+			delegationPortal: {
+				type: "object",
+				properties: {
+					delegationType: {
+						type: "string",
+						title: "Delegation type",
+						description: "Specify the type of delegation that you are using",
+						anyOf: [
+							{
+								"const": "compound-governor",
+								title: "Compound governor"
+							}
+						]
+					},
+					delegationContract: {
+						type: "string",
+						format: "address",
+						title: "Contract address",
+						description: "The address of your delegation contract",
+						examples: [
+							"0x3901D0fDe202aF1427216b79f5243f8A022d68cf"
+						]
+					},
+					delegationApi: {
+						type: "string",
+						format: "uri",
+						title: "Delegation API",
+						description: "The URL of your delegation API (e.g a subgraph)",
+						examples: [
+							"https://api.thegraph.com/subgraphs/name/arr00/uniswap-governance-v2"
+						]
+					}
+				},
+				required: [
+					"delegationType",
+					"delegationApi",
+					"delegationContract"
+				],
+				additionalProperties: false
 			},
 			allowAlias: {
 				type: "boolean"
@@ -3986,6 +4024,32 @@ var ENS_RESOLVER_ABI = [
 var ajv = new Ajv__default['default']({ allErrors: true, allowUnionTypes: true, $data: true });
 // @ts-ignore
 addFormats__default['default'](ajv);
+ajv.addFormat('address', {
+    validate: function (value) {
+        try {
+            return address.isAddress(value);
+        }
+        catch (err) {
+            return false;
+        }
+    }
+});
+ajv.addFormat('long', {
+    validate: function () { return true; }
+});
+ajv.addFormat('ethValue', {
+    validate: function (value) {
+        if (!value.match(/^([0-9]|[1-9][0-9]+)(\.[0-9]+)?$/))
+            return false;
+        try {
+            units.parseUnits(value, 18);
+            return true;
+        }
+        catch (_a) {
+            return false;
+        }
+    }
+});
 // Custom URL format to allow empty string values
 // https://github.com/snapshot-labs/snapshot.js/pull/541/files
 ajv.addFormat('customUrl', {

package/dist/snapshot.esm.js

@@ -2,6 +2,7 @@ import fetch from 'cross-fetch';
 import { getAddress, isAddress } from '@ethersproject/address';
 import { Interface } from '@ethersproject/abi';
 import { Contract } from '@ethersproject/contracts';
+import { parseUnits } from '@ethersproject/units';
 import { hash, normalize } from '@ensdomains/eth-ens-namehash';
 import { jsonToGraphQLQuery } from 'json-to-graphql-query';
 import Ajv from 'ajv';
@@ -742,8 +743,45 @@ var definitions = {
 				],
 				additionalProperties: false
 			},
-			delegation: {
-				type: "boolean"
+			delegationPortal: {
+				type: "object",
+				properties: {
+					delegationType: {
+						type: "string",
+						title: "Delegation type",
+						description: "Specify the type of delegation that you are using",
+						anyOf: [
+							{
+								"const": "compound-governor",
+								title: "Compound governor"
+							}
+						]
+					},
+					delegationContract: {
+						type: "string",
+						format: "address",
+						title: "Contract address",
+						description: "The address of your delegation contract",
+						examples: [
+							"0x3901D0fDe202aF1427216b79f5243f8A022d68cf"
+						]
+					},
+					delegationApi: {
+						type: "string",
+						format: "uri",
+						title: "Delegation API",
+						description: "The URL of your delegation API (e.g a subgraph)",
+						examples: [
+							"https://api.thegraph.com/subgraphs/name/arr00/uniswap-governance-v2"
+						]
+					}
+				},
+				required: [
+					"delegationType",
+					"delegationApi",
+					"delegationContract"
+				],
+				additionalProperties: false
 			},
 			allowAlias: {
 				type: "boolean"
@@ -3977,6 +4015,32 @@ var ENS_RESOLVER_ABI = [
 var ajv = new Ajv({ allErrors: true, allowUnionTypes: true, $data: true });
 // @ts-ignore
 addFormats(ajv);
+ajv.addFormat('address', {
+    validate: function (value) {
+        try {
+            return isAddress(value);
+        }
+        catch (err) {
+            return false;
+        }
+    }
+});
+ajv.addFormat('long', {
+    validate: function () { return true; }
+});
+ajv.addFormat('ethValue', {
+    validate: function (value) {
+        if (!value.match(/^([0-9]|[1-9][0-9]+)(\.[0-9]+)?$/))
+            return false;
+        try {
+            parseUnits(value, 18);
+            return true;
+        }
+        catch (_a) {
+            return false;
+        }
+    }
+});
 // Custom URL format to allow empty string values
 // https://github.com/snapshot-labs/snapshot.js/pull/541/files
 ajv.addFormat('customUrl', {