@snapshot-labs/snapshot.js 0.3.9 → 0.3.13

package/dist/index.d.ts

@@ -1,6 +1,8 @@
+import Client712 from './sign';
 import Client from './client';
 declare const _default: {
     Client: typeof Client;
+    Client712: typeof Client712;
     schemas: {
         space: {
             title: string;
@@ -311,6 +313,7 @@ declare const _default: {
         validations: {
             basic: typeof import("./validations/basic").default;
             aave: typeof import("./validations/aave").default;
+            nouns: typeof import("./validations/nouns").default;
         };
         getHash: typeof import("./sign/utils").getHash;
         verify: typeof import("./sign/utils").verify;

package/dist/snapshot.cjs.js

@@ -1,6 +1,8 @@
 'use strict';
 
 var fetch = require('cross-fetch');
+var providers$1 = require('@ethersproject/providers');
+var wallet = require('@ethersproject/wallet');
 var bytes = require('@ethersproject/bytes');
 var abi = require('@ethersproject/abi');
 var contracts = require('@ethersproject/contracts');
@@ -9,8 +11,6 @@ var jsonToGraphqlQuery = require('json-to-graphql-query');
 var Ajv = require('ajv');
 var addFormats = require('ajv-formats');
 var set = require('lodash.set');
-var providers$1 = require('@ethersproject/providers');
-var wallet = require('@ethersproject/wallet');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -106,6 +106,314 @@ function __spread() {
     return ar;
 }
 
+var spaceTypes = {
+    Space: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'settings', type: 'string' }
+    ]
+};
+var proposalTypes = {
+    Proposal: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'type', type: 'string' },
+        { name: 'title', type: 'string' },
+        { name: 'body', type: 'string' },
+        { name: 'choices', type: 'string[]' },
+        { name: 'start', type: 'uint64' },
+        { name: 'end', type: 'uint64' },
+        { name: 'snapshot', type: 'uint64' },
+        { name: 'network', type: 'string' },
+        { name: 'strategies', type: 'string' },
+        { name: 'plugins', type: 'string' },
+        { name: 'metadata', type: 'string' }
+    ]
+};
+var cancelProposalTypes = {
+    CancelProposal: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'proposal', type: 'string' }
+    ]
+};
+var cancelProposal2Types = {
+    CancelProposal: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'proposal', type: 'bytes32' }
+    ]
+};
+var voteTypes = {
+    Vote: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'proposal', type: 'string' },
+        { name: 'choice', type: 'uint32' },
+        { name: 'metadata', type: 'string' }
+    ]
+};
+var voteArrayTypes = {
+    Vote: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'proposal', type: 'string' },
+        { name: 'choice', type: 'uint32[]' },
+        { name: 'metadata', type: 'string' }
+    ]
+};
+var voteStringTypes = {
+    Vote: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'proposal', type: 'string' },
+        { name: 'choice', type: 'string' },
+        { name: 'metadata', type: 'string' }
+    ]
+};
+var vote2Types = {
+    Vote: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'proposal', type: 'bytes32' },
+        { name: 'choice', type: 'uint32' },
+        { name: 'metadata', type: 'string' }
+    ]
+};
+var voteArray2Types = {
+    Vote: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'proposal', type: 'bytes32' },
+        { name: 'choice', type: 'uint32[]' },
+        { name: 'metadata', type: 'string' }
+    ]
+};
+var voteString2Types = {
+    Vote: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' },
+        { name: 'timestamp', type: 'uint64' },
+        { name: 'proposal', type: 'bytes32' },
+        { name: 'choice', type: 'string' },
+        { name: 'metadata', type: 'string' }
+    ]
+};
+var followTypes = {
+    Follow: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' }
+    ]
+};
+var unfollowTypes = {
+    Unfollow: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' }
+    ]
+};
+var subscribeTypes = {
+    Subscribe: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' }
+    ]
+};
+var unsubscribeTypes = {
+    Unsubscribe: [
+        { name: 'from', type: 'address' },
+        { name: 'space', type: 'string' }
+    ]
+};
+var aliasTypes = {
+    Alias: [
+        { name: 'from', type: 'address' },
+        { name: 'alias', type: 'address' }
+    ]
+};
+
+var hubs = [
+	"https://hub.snapshot.org",
+	"https://testnet.snapshot.org"
+];
+
+var NAME = 'snapshot';
+var VERSION = '0.1.4';
+var domain = {
+    name: NAME,
+    version: VERSION
+    // chainId: 1
+};
+var Client = /** @class */ (function () {
+    function Client(address) {
+        if (address === void 0) { address = hubs[0]; }
+        this.address = address;
+    }
+    Client.prototype.sign = function (web3, address, message, types) {
+        return __awaiter(this, void 0, void 0, function () {
+            var signer, data, sig;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (web3 instanceof wallet.Wallet)
+                            signer = web3;
+                        if (web3 instanceof providers$1.Web3Provider)
+                            signer = web3.getSigner();
+                        if (!message.from)
+                            message.from = address;
+                        if (!message.timestamp)
+                            message.timestamp = parseInt((Date.now() / 1e3).toFixed());
+                        data = { domain: domain, types: types, message: message };
+                        return [4 /*yield*/, signer._signTypedData(domain, data.types, message)];
+                    case 1:
+                        sig = _a.sent();
+                        console.log('Sign', { address: address, sig: sig, data: data });
+                        return [4 /*yield*/, this.send({ address: address, sig: sig, data: data })];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.send = function (envelop) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, init;
+            return __generator(this, function (_a) {
+                url = this.address + "/api/msg";
+                init = {
+                    method: 'POST',
+                    headers: {
+                        Accept: 'application/json',
+                        'Content-Type': 'application/json'
+                    },
+                    body: JSON.stringify(envelop)
+                };
+                return [2 /*return*/, new Promise(function (resolve, reject) {
+                        fetch__default['default'](url, init)
+                            .then(function (res) {
+                            if (res.ok)
+                                return resolve(res.json());
+                            throw res;
+                        })
+                            .catch(function (e) { return e.json().then(function (json) { return reject(json); }); });
+                    })];
+            });
+        });
+    };
+    Client.prototype.space = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sign(web3, address, message, spaceTypes)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.proposal = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sign(web3, address, message, proposalTypes)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.cancelProposal = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            var type2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        type2 = message.proposal.startsWith('0x');
+                        return [4 /*yield*/, this.sign(web3, address, message, type2 ? cancelProposal2Types : cancelProposalTypes)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.vote = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            var type2, type;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        type2 = message.proposal.startsWith('0x');
+                        type = type2 ? vote2Types : voteTypes;
+                        if (['approval', 'ranked-choice'].includes(message.type))
+                            type = type2 ? voteArray2Types : voteArrayTypes;
+                        if (['quadratic', 'weighted'].includes(message.type)) {
+                            type = type2 ? voteString2Types : voteStringTypes;
+                            message.choice = JSON.stringify(message.choice);
+                        }
+                        // @ts-ignore
+                        delete message.type;
+                        return [4 /*yield*/, this.sign(web3, address, message, type)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.follow = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sign(web3, address, message, followTypes)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.unfollow = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sign(web3, address, message, unfollowTypes)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.subscribe = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sign(web3, address, message, subscribeTypes)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.unsubscribe = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sign(web3, address, message, unsubscribeTypes)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Client.prototype.alias = function (web3, address, message) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sign(web3, address, message, aliasTypes)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return Client;
+}());
+
 function signMessage(web3, msg, address) {
     return __awaiter(this, void 0, void 0, function () {
         return __generator(this, function (_a) {
@@ -138,14 +446,9 @@ function getBlockNumber(provider) {
     });
 }
 
-var hubs = [
-	"https://hub.snapshot.org",
-	"https://testnet.snapshot.org"
-];
-
 var version = "0.1.3";
 
-var Client = /** @class */ (function () {
+var Client$1 = /** @class */ (function () {
     function Client(address) {
         if (address === void 0) { address = hubs[0]; }
         this.address = address;
@@ -814,6 +1117,18 @@ var networks = {
 		"wss://eth-kovan.ws.alchemyapi.io/v2/QCsM2iU0bQ49eGDmZ7-Y--Wpu0lVWXSO"
 	],
 	explorer: "https://kovan.etherscan.io"
+},
+	"44": {
+	key: "44",
+	name: "Crab Network",
+	shortName: "Crab",
+	chainId: 44,
+	network: "mainnet",
+	multicall: "0x4617D470F847Ce166019d19a7944049ebB017400",
+	rpc: [
+		"https://crab-rpc.darwinia.network"
+	],
+	explorer: "https://crab.subscan.io/"
 },
 	"50": {
 	key: "50",
@@ -1417,9 +1732,56 @@ function validate$1(author, space, proposal, options) {
     });
 }
 
+/**
+ * Nouns Space Validation proposal validation uses:
+ *
+ * The current validation implementation mutates the "strategies" field of the space
+ * to be able to use proposition power instead of voting power for "nouns-rfp-power".
+ *
+ */
+function validate$2(author, space, proposal, options) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function () {
+        var onlyMembers, minScore, members, strategies, nounsRFPStrategyIndex, scores, totalScore;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    onlyMembers = options.onlyMembers || ((_a = space.filters) === null || _a === void 0 ? void 0 : _a.onlyMembers);
+                    minScore = options.minScore || ((_b = space.filters) === null || _b === void 0 ? void 0 : _b.minScore);
+                    members = (space.members || []).map(function (address) { return address.toLowerCase(); });
+                    strategies = __spread(space.strategies);
+                    nounsRFPStrategyIndex = strategies.findIndex(function (_a) {
+                        var name = _a.name;
+                        return name === 'nouns-rfp-power';
+                    });
+                    // Use the proposition power instead of the voting power
+                    if (nounsRFPStrategyIndex >= 0) {
+                        strategies[nounsRFPStrategyIndex].params.powerType = 'proposition';
+                    }
+                    if (members.includes(author.toLowerCase()))
+                        return [2 /*return*/, true];
+                    if (onlyMembers)
+                        return [2 /*return*/, false];
+                    if (!minScore) return [3 /*break*/, 2];
+                    return [4 /*yield*/, getScores(space.id || space.key, strategies, space.network, [author])];
+                case 1:
+                    scores = _c.sent();
+                    totalScore = scores
+                        .map(function (score) { return Object.values(score).reduce(function (a, b) { return a + b; }, 0); })
+                        .reduce(function (a, b) { return a + b; }, 0);
+                    if (totalScore < minScore)
+                        return [2 /*return*/, false];
+                    _c.label = 2;
+                case 2: return [2 /*return*/, true];
+            }
+        });
+    });
+}
+
 var validations = {
     basic: validate,
-    aave: validate$1
+    aave: validate$1,
+    nouns: validate$2
 };
 
 function verifyDefault(address, sig, hash, provider) {
@@ -1594,6 +1956,8 @@ var ApprovalVoting = /** @class */ (function () {
     };
     ApprovalVoting.prototype.getChoiceString = function () {
         var _this = this;
+        if (!this.selected)
+            return '';
         return this.proposal.choices
             .filter(function (choice, i) { return _this.selected.includes(i + 1); })
             .join(', ');
@@ -2059,7 +2423,8 @@ var utils = {
 };
 
 var index = {
-    Client: Client,
+    Client: Client$1,
+    Client712: Client,
     schemas: schemas,
     utils: utils
 };