@snapshot-labs/snapshot.js 0.11.14 → 0.12.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,677 @@
1
+ import Client712 from './sign';
2
+ declare const _default: {
3
+ Client: typeof Client712;
4
+ Client712: typeof Client712;
5
+ schemas: {
6
+ space: {
7
+ title: string;
8
+ type: string;
9
+ properties: {
10
+ name: {
11
+ type: string;
12
+ title: string;
13
+ minLength: number;
14
+ maxLength: number;
15
+ };
16
+ private: {
17
+ type: string;
18
+ };
19
+ about: {
20
+ type: string;
21
+ title: string;
22
+ maxLength: number;
23
+ };
24
+ guidelines: {
25
+ type: string;
26
+ format: string;
27
+ title: string;
28
+ maxLength: number;
29
+ };
30
+ template: {
31
+ type: string;
32
+ title: string;
33
+ maxLength: number;
34
+ };
35
+ terms: {
36
+ type: string;
37
+ title: string;
38
+ format: string;
39
+ maxLength: number;
40
+ };
41
+ avatar: {
42
+ type: string;
43
+ title: string;
44
+ format: string;
45
+ maxLength: number;
46
+ };
47
+ location: {
48
+ type: string;
49
+ title: string;
50
+ maxLength: number;
51
+ };
52
+ website: {
53
+ type: string;
54
+ title: string;
55
+ format: string;
56
+ maxLength: number;
57
+ };
58
+ twitter: {
59
+ type: string;
60
+ title: string;
61
+ pattern: string;
62
+ maxLength: number;
63
+ };
64
+ coingecko: {
65
+ type: string;
66
+ title: string;
67
+ pattern: string;
68
+ maxLength: number;
69
+ };
70
+ github: {
71
+ type: string;
72
+ title: string;
73
+ pattern: string;
74
+ maxLength: number;
75
+ };
76
+ email: {
77
+ type: string;
78
+ title: string;
79
+ maxLength: number;
80
+ };
81
+ network: {
82
+ type: string;
83
+ snapshotNetwork: boolean;
84
+ title: string;
85
+ minLength: number;
86
+ maxLength: number;
87
+ };
88
+ symbol: {
89
+ type: string;
90
+ title: string;
91
+ minLength: number;
92
+ maxLength: number;
93
+ };
94
+ skin: {
95
+ type: string;
96
+ title: string;
97
+ maxLength: number;
98
+ };
99
+ domain: {
100
+ type: string;
101
+ title: string;
102
+ maxLength: number;
103
+ };
104
+ strategies: {
105
+ type: string;
106
+ minItems: number;
107
+ maxItemsWithSpaceType: {
108
+ default: number;
109
+ turbo: number;
110
+ };
111
+ uniqueItems: boolean;
112
+ items: {
113
+ type: string;
114
+ properties: {
115
+ name: {
116
+ type: string;
117
+ maxLength: number;
118
+ title: string;
119
+ };
120
+ network: {
121
+ type: string;
122
+ maxLength: number;
123
+ title: string;
124
+ snapshotNetwork: boolean;
125
+ };
126
+ params: {
127
+ type: string;
128
+ title: string;
129
+ };
130
+ };
131
+ required: string[];
132
+ additionalProperties: boolean;
133
+ };
134
+ title: string;
135
+ };
136
+ members: {
137
+ type: string;
138
+ maxItems: number;
139
+ items: {
140
+ type: string;
141
+ pattern: string;
142
+ minLength: number;
143
+ maxLength: number;
144
+ };
145
+ title: string;
146
+ uniqueItems: boolean;
147
+ };
148
+ admins: {
149
+ type: string;
150
+ maxItems: number;
151
+ items: {
152
+ type: string;
153
+ pattern: string;
154
+ minLength: number;
155
+ maxLength: number;
156
+ };
157
+ title: string;
158
+ uniqueItems: boolean;
159
+ };
160
+ moderators: {
161
+ type: string;
162
+ maxItems: number;
163
+ items: {
164
+ type: string;
165
+ pattern: string;
166
+ minLength: number;
167
+ maxLength: number;
168
+ };
169
+ title: string;
170
+ uniqueItems: boolean;
171
+ };
172
+ filters: {
173
+ type: string;
174
+ properties: {
175
+ defaultTab: {
176
+ type: string;
177
+ };
178
+ minScore: {
179
+ type: string;
180
+ minimum: number;
181
+ };
182
+ onlyMembers: {
183
+ type: string;
184
+ };
185
+ invalids: {
186
+ type: string;
187
+ items: {
188
+ type: string;
189
+ maxLength: number;
190
+ };
191
+ title: string;
192
+ };
193
+ };
194
+ additionalProperties: boolean;
195
+ };
196
+ validation: {
197
+ type: string;
198
+ properties: {
199
+ name: {
200
+ type: string;
201
+ maxLength: number;
202
+ title: string;
203
+ };
204
+ params: {
205
+ type: string;
206
+ title: string;
207
+ };
208
+ };
209
+ required: string[];
210
+ additionalProperties: boolean;
211
+ };
212
+ voteValidation: {
213
+ type: string;
214
+ properties: {
215
+ name: {
216
+ type: string;
217
+ maxLength: number;
218
+ title: string;
219
+ };
220
+ params: {
221
+ type: string;
222
+ title: string;
223
+ };
224
+ };
225
+ required: string[];
226
+ additionalProperties: boolean;
227
+ };
228
+ followValidation: {
229
+ type: string;
230
+ properties: {
231
+ name: {
232
+ type: string;
233
+ maxLength: number;
234
+ title: string;
235
+ };
236
+ params: {
237
+ type: string;
238
+ title: string;
239
+ };
240
+ };
241
+ required: string[];
242
+ additionalProperties: boolean;
243
+ };
244
+ delegationPortal: {
245
+ type: string;
246
+ properties: {
247
+ delegationType: {
248
+ type: string;
249
+ title: string;
250
+ description: string;
251
+ anyOf: {
252
+ const: string;
253
+ title: string;
254
+ }[];
255
+ };
256
+ delegationContract: {
257
+ type: string;
258
+ format: string;
259
+ title: string;
260
+ description: string;
261
+ examples: string[];
262
+ };
263
+ delegationApi: {
264
+ type: string;
265
+ format: string;
266
+ title: string;
267
+ description: string;
268
+ examples: string[];
269
+ };
270
+ };
271
+ required: string[];
272
+ additionalProperties: boolean;
273
+ };
274
+ allowAlias: {
275
+ type: string;
276
+ };
277
+ plugins: {
278
+ type: string;
279
+ };
280
+ voting: {
281
+ type: string;
282
+ properties: {
283
+ delay: {
284
+ type: string;
285
+ minimum: number;
286
+ maximum: number;
287
+ errorMessage: {
288
+ maximum: string;
289
+ };
290
+ };
291
+ period: {
292
+ type: string;
293
+ minimum: number;
294
+ maximum: number;
295
+ errorMessage: {
296
+ maximum: string;
297
+ };
298
+ };
299
+ type: {
300
+ type: string;
301
+ title: string;
302
+ };
303
+ quorum: {
304
+ type: string;
305
+ minimum: number;
306
+ optimisticMinimum: number;
307
+ };
308
+ quorumType: {
309
+ type: string;
310
+ enum: string[];
311
+ };
312
+ blind: {
313
+ type: string;
314
+ };
315
+ hideAbstain: {
316
+ type: string;
317
+ };
318
+ aliased: {
319
+ type: string;
320
+ };
321
+ privacy: {
322
+ type: string;
323
+ enum: string[];
324
+ };
325
+ };
326
+ additionalProperties: boolean;
327
+ };
328
+ categories: {
329
+ type: string;
330
+ maxItems: number;
331
+ items: {
332
+ type: string;
333
+ enum: string[];
334
+ };
335
+ };
336
+ treasuries: {
337
+ type: string;
338
+ maxItems: number;
339
+ items: {
340
+ type: string;
341
+ properties: {
342
+ name: {
343
+ type: string;
344
+ title: string;
345
+ examples: string[];
346
+ minLength: number;
347
+ maxLength: number;
348
+ };
349
+ address: {
350
+ type: string;
351
+ title: string;
352
+ examples: string[];
353
+ pattern: string;
354
+ minLength: number;
355
+ maxLength: number;
356
+ };
357
+ network: {
358
+ type: string;
359
+ snapshotNetwork: boolean;
360
+ title: string;
361
+ maxLength: number;
362
+ };
363
+ };
364
+ required: string[];
365
+ additionalProperties: boolean;
366
+ };
367
+ };
368
+ parent: {
369
+ type: string;
370
+ title: string;
371
+ };
372
+ children: {
373
+ type: string;
374
+ maxItems: number;
375
+ title: string;
376
+ items: {
377
+ type: string;
378
+ };
379
+ };
380
+ boost: {
381
+ type: string;
382
+ properties: {
383
+ enabled: {
384
+ type: string;
385
+ };
386
+ bribeEnabled: {
387
+ type: string;
388
+ };
389
+ };
390
+ required: string[];
391
+ additionalProperties: boolean;
392
+ };
393
+ };
394
+ required: string[];
395
+ additionalProperties: boolean;
396
+ };
397
+ proposal: {
398
+ title: string;
399
+ type: string;
400
+ properties: {
401
+ name: {
402
+ type: string;
403
+ title: string;
404
+ minLength: number;
405
+ maxLength: number;
406
+ };
407
+ body: {
408
+ type: string;
409
+ title: string;
410
+ minLength: number;
411
+ maxLengthWithSpaceType: {
412
+ default: number;
413
+ turbo: number;
414
+ };
415
+ };
416
+ discussion: {
417
+ type: string;
418
+ format: string;
419
+ title: string;
420
+ maxLength: number;
421
+ };
422
+ choices: {
423
+ type: string;
424
+ title: string;
425
+ minItems: number;
426
+ maxItems: number;
427
+ };
428
+ type: {
429
+ type: string;
430
+ enum: string[];
431
+ };
432
+ snapshot: {
433
+ type: string;
434
+ title: string;
435
+ };
436
+ start: {
437
+ type: string;
438
+ title: string;
439
+ minimum: number;
440
+ maximum: number;
441
+ };
442
+ end: {
443
+ type: string;
444
+ title: string;
445
+ minimum: number;
446
+ maximum: number;
447
+ };
448
+ metadata: {
449
+ type: string;
450
+ title: string;
451
+ };
452
+ app: {
453
+ type: string;
454
+ title: string;
455
+ maxLength: number;
456
+ };
457
+ };
458
+ required: string[];
459
+ additionalProperties: boolean;
460
+ };
461
+ updateProposal: {
462
+ title: string;
463
+ type: string;
464
+ properties: {
465
+ proposal: {
466
+ type: string;
467
+ title: string;
468
+ };
469
+ name: {
470
+ type: string;
471
+ title: string;
472
+ minLength: number;
473
+ maxLength: number;
474
+ };
475
+ body: {
476
+ type: string;
477
+ title: string;
478
+ minLength: number;
479
+ maxLengthWithSpaceType: {
480
+ default: number;
481
+ turbo: number;
482
+ };
483
+ };
484
+ discussion: {
485
+ type: string;
486
+ format: string;
487
+ title: string;
488
+ maxLength: number;
489
+ };
490
+ choices: {
491
+ type: string;
492
+ title: string;
493
+ minItems: number;
494
+ maxItems: number;
495
+ };
496
+ type: {
497
+ enum: string[];
498
+ };
499
+ metadata: {
500
+ type: string;
501
+ title: string;
502
+ };
503
+ };
504
+ required: string[];
505
+ additionalProperties: boolean;
506
+ };
507
+ vote: {
508
+ title: string;
509
+ type: string;
510
+ properties: {
511
+ proposal: {
512
+ type: string;
513
+ title: string;
514
+ };
515
+ choice: {
516
+ type: string[];
517
+ title: string;
518
+ };
519
+ metadata: {
520
+ type: string;
521
+ title: string;
522
+ };
523
+ reason: {
524
+ type: string;
525
+ title: string;
526
+ maxLength: number;
527
+ };
528
+ app: {
529
+ type: string;
530
+ title: string;
531
+ maxLength: number;
532
+ };
533
+ };
534
+ required: string[];
535
+ additionalProperties: boolean;
536
+ };
537
+ profile: {
538
+ title: string;
539
+ type: string;
540
+ properties: {
541
+ name: {
542
+ type: string;
543
+ title: string;
544
+ maxLength: number;
545
+ };
546
+ about: {
547
+ type: string;
548
+ title: string;
549
+ maxLength: number;
550
+ };
551
+ avatar: {
552
+ type: string;
553
+ title: string;
554
+ format: string;
555
+ maxLength: number;
556
+ };
557
+ };
558
+ required: never[];
559
+ additionalProperties: boolean;
560
+ };
561
+ statement: {
562
+ title: string;
563
+ type: string;
564
+ properties: {
565
+ about: {
566
+ type: string;
567
+ format: string;
568
+ title: string;
569
+ minLength: number;
570
+ maxLength: number;
571
+ };
572
+ statement: {
573
+ type: string;
574
+ format: string;
575
+ title: string;
576
+ maxLength: number;
577
+ };
578
+ };
579
+ required: string[];
580
+ additionalProperties: boolean;
581
+ };
582
+ zodiac: {
583
+ title: string;
584
+ type: string;
585
+ properties: {
586
+ safes: {
587
+ title: string;
588
+ type: string;
589
+ maxItems: number;
590
+ items: {
591
+ type: string;
592
+ properties: {
593
+ network: {
594
+ title: string;
595
+ type: string;
596
+ snapshotNetwork: boolean;
597
+ };
598
+ multisend: {
599
+ title: string;
600
+ type: string;
601
+ };
602
+ realityAddress: {
603
+ title: string;
604
+ type: string;
605
+ };
606
+ umaAddress: {
607
+ title: string;
608
+ type: string;
609
+ };
610
+ };
611
+ additionalProperties: boolean;
612
+ };
613
+ };
614
+ additionalProperties: boolean;
615
+ };
616
+ };
617
+ alias: {
618
+ title: string;
619
+ type: string;
620
+ properties: {
621
+ alias: {
622
+ type: string;
623
+ format: string;
624
+ };
625
+ };
626
+ required: string[];
627
+ additionalProperties: boolean;
628
+ };
629
+ };
630
+ utils: {
631
+ call: typeof import("./utils").call;
632
+ multicall: typeof import("./utils").multicall;
633
+ subgraphRequest: typeof import("./utils").subgraphRequest;
634
+ ipfsGet: typeof import("./utils").ipfsGet;
635
+ getUrl: typeof import("./utils").getUrl;
636
+ getJSON: typeof import("./utils").getJSON;
637
+ sendTransaction: typeof import("./utils").sendTransaction;
638
+ getScores: typeof import("./utils").getScores;
639
+ getVp: typeof import("./utils").getVp;
640
+ validateSchema: typeof import("./utils").validateSchema;
641
+ getEnsTextRecord: typeof import("./utils").getEnsTextRecord;
642
+ getSpaceUri: typeof import("./utils").getSpaceUri;
643
+ getEnsOwner: typeof import("./utils").getEnsOwner;
644
+ getSpaceController: typeof import("./utils").getSpaceController;
645
+ getDelegatesBySpace: typeof import("./utils").getDelegatesBySpace;
646
+ clone: typeof import("./utils").clone;
647
+ sleep: typeof import("./utils").sleep;
648
+ getNumberWithOrdinal: typeof import("./utils").getNumberWithOrdinal;
649
+ voting: {
650
+ 'single-choice': typeof import("./voting/singleChoice").default;
651
+ approval: typeof import("./voting/approval").default;
652
+ quadratic: typeof import("./voting/quadratic").default;
653
+ 'ranked-choice': typeof import("./voting/rankedChoice").default;
654
+ weighted: typeof import("./voting/weighted").default;
655
+ basic: typeof import("./voting/singleChoice").default;
656
+ };
657
+ getProvider: typeof import("./utils/provider").default;
658
+ signMessage: typeof import("./utils/web3").signMessage;
659
+ getBlockNumber: typeof import("./utils/web3").getBlockNumber;
660
+ Multicaller: typeof import("./utils/multicaller").default;
661
+ getSnapshots: typeof import("./utils/blockfinder").getSnapshots;
662
+ getHash: typeof import("./sign/utils").getHash;
663
+ verify: typeof import("./sign/utils").verify;
664
+ validate: typeof import("./utils").validate;
665
+ SNAPSHOT_SUBGRAPH_URL: {
666
+ 1: string;
667
+ 5: string;
668
+ 10: string;
669
+ 56: string;
670
+ 100: string;
671
+ 137: string;
672
+ 250: string;
673
+ 42161: string;
674
+ };
675
+ };
676
+ };
677
+ export default _default;
@@ -0,0 +1,28 @@
1
+ import { Web3Provider } from '@ethersproject/providers';
2
+ import { Wallet } from '@ethersproject/wallet';
3
+ import { Space, Proposal, UpdateProposal, FlagProposal, CancelProposal, Vote, Follow, Unfollow, Subscribe, Unsubscribe, Profile, Alias, DeleteSpace, Statement } from './types';
4
+ export declare const domain: {
5
+ name: string;
6
+ version: string;
7
+ };
8
+ export default class Client {
9
+ readonly address: string;
10
+ readonly options: any;
11
+ constructor(address?: string, options?: {});
12
+ sign(web3: Web3Provider | Wallet, address: string, message: any, types: any): Promise<unknown>;
13
+ send(envelop: any): Promise<unknown>;
14
+ space(web3: Web3Provider | Wallet, address: string, message: Space): Promise<unknown>;
15
+ proposal(web3: Web3Provider | Wallet, address: string, message: Proposal): Promise<unknown>;
16
+ updateProposal(web3: Web3Provider | Wallet, address: string, message: UpdateProposal): Promise<unknown>;
17
+ flagProposal(web3: Web3Provider | Wallet, address: string, message: FlagProposal): Promise<unknown>;
18
+ cancelProposal(web3: Web3Provider | Wallet, address: string, message: CancelProposal): Promise<unknown>;
19
+ vote(web3: Web3Provider | Wallet, address: string, message: Vote): Promise<unknown>;
20
+ follow(web3: Web3Provider | Wallet, address: string, message: Follow): Promise<unknown>;
21
+ unfollow(web3: Web3Provider | Wallet, address: string, message: Unfollow): Promise<unknown>;
22
+ subscribe(web3: Web3Provider | Wallet, address: string, message: Subscribe): Promise<unknown>;
23
+ unsubscribe(web3: Web3Provider | Wallet, address: string, message: Unsubscribe): Promise<unknown>;
24
+ profile(web3: Web3Provider | Wallet, address: string, message: Profile): Promise<unknown>;
25
+ statement(web3: Web3Provider | Wallet, address: string, message: Statement): Promise<unknown>;
26
+ alias(web3: Web3Provider | Wallet, address: string, message: Alias): Promise<unknown>;
27
+ deleteSpace(web3: Web3Provider | Wallet, address: string, message: DeleteSpace): Promise<unknown>;
28
+ }