done.zone 0.1.18

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.
package/README.md ADDED
@@ -0,0 +1,11 @@
1
+ # done.zone
2
+
3
+ TypeScript declarations for authoring Done smart contracts with first-class editor support.
4
+
5
+ These types are generated by the `cw-js` build script. Run:
6
+
7
+ ```sh
8
+ cargo build -p cw-js --features ts-bindings
9
+ ```
10
+
11
+ and point your contract project's `tsconfig.json` at `done.zone` (via `compilerOptions.types` or an explicit import).
package/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ /// <reference types="./types/done.zone" />
2
+ export * from "./types/done.zone";
package/package.json ADDED
@@ -0,0 +1,14 @@
1
+ {
2
+ "name": "done.zone",
3
+ "version": "0.1.18",
4
+ "description": "Type declarations for Done smart contract authors.",
5
+ "type": "module",
6
+ "types": "index.d.ts",
7
+ "files": [
8
+ "index.d.ts",
9
+ "types"
10
+ ],
11
+ "publishConfig": {
12
+ "access": "public"
13
+ }
14
+ }
File without changes
@@ -0,0 +1,456 @@
1
+
2
+ declare global {
3
+ interface DoneCollectionSelector {
4
+ _id?: {
5
+ $startingAfter?: string;
6
+ $startingFrom?: string;
7
+ $endingBefore?: string;
8
+ $endingAt?: string;
9
+ };
10
+ }
11
+
12
+ interface DoneCollectionQuery<V, Mode = [string, V]> {
13
+ limit(count: number): DoneCollectionQuery<V, Mode>;
14
+ keys(): DoneCollectionQuery<V, string>;
15
+ values(): DoneCollectionQuery<V, V>;
16
+ entries(): DoneCollectionQuery<V, [string, V]>;
17
+ toArray(): Promise<Mode[]>;
18
+ }
19
+
20
+ interface DoneCollection<V = unknown> {
21
+ save(key: string, value: V): Promise<void>;
22
+ load(key: string): Promise<V>;
23
+ may_load(key: string): Promise<V | undefined>;
24
+ has(key: string): Promise<boolean>;
25
+ remove(key: string): Promise<void>;
26
+ find(selector?: DoneCollectionSelector): DoneCollectionQuery<V>;
27
+ }
28
+
29
+ interface DoneItem<T = unknown> {
30
+ save(value: T): Promise<void>;
31
+ load(): Promise<T>;
32
+ exists(): Promise<boolean>;
33
+ remove(): Promise<void>;
34
+ }
35
+
36
+ interface DoneRunOptions {
37
+ path?: string;
38
+ query?: Record<string, unknown>;
39
+ search?: Record<string, string | number>;
40
+ body?: unknown;
41
+ funds?: Array<{ denom: string; amount: string | number }> | Record<string, string | number>;
42
+ memo?: string;
43
+ traceId?: string;
44
+ gasLimit?: number;
45
+ metadata?: Record<string, unknown>;
46
+ }
47
+
48
+ interface DoneRouteSchema {
49
+ body?: JsonSchema;
50
+ query?: JsonSchema;
51
+ response?: JsonSchema;
52
+ funds?: JsonSchema;
53
+ requiresAuth?: boolean;
54
+ }
55
+
56
+ interface DoneBlockInfo {
57
+ height: string;
58
+ time: string;
59
+ }
60
+
61
+ interface DoneEnv {
62
+ block: DoneBlockInfo;
63
+ }
64
+
65
+ interface DoneContext<Body = unknown, Query = unknown> {
66
+ sender: string;
67
+ funds: Record<string, string>;
68
+ env: DoneEnv;
69
+ body: Body;
70
+ query: Query;
71
+ params: Record<string, string>;
72
+ deps: DoneDeps;
73
+ event(type: string, attributes?: Record<string, string | number | boolean>): void;
74
+ }
75
+
76
+ type DoneHandler<TResult = unknown> = (ctx: DoneContext) => Promise<TResult> | TResult;
77
+
78
+ interface DoneServeBuilder {
79
+ instantiate(handler: () => Promise<void> | void): DoneServeBuilder;
80
+ migrate(handler: () => Promise<void> | void): DoneServeBuilder;
81
+ transaction(path: string, handler: DoneHandler, schema?: DoneRouteSchema): DoneServeBuilder;
82
+ query(path: string, handler: DoneHandler, schema?: DoneRouteSchema): DoneServeBuilder;
83
+ }
84
+
85
+ interface DoneApi extends DoneTypeFactories {
86
+ readonly owner?: string;
87
+ serve(): DoneServeBuilder;
88
+ publish(type: string, attributes?: Record<string, string | number | boolean>): void;
89
+ send(recipient: string, funds: Record<string, string>): void;
90
+ collection<V = unknown>(namespace: string): DoneCollection<V>;
91
+ item<T = unknown>(key: string): DoneItem<T>;
92
+ run(route: string, options?: DoneRunOptions | unknown): Promise<void>;
93
+ }
94
+
95
+ const Done: DoneApi;
96
+ }
97
+
98
+ export type JsonSchema = Record<string, unknown> | boolean;
99
+
100
+ export interface DoneTypeFactories {
101
+ readonly Any: JsonSchema;
102
+ readonly Never: JsonSchema;
103
+ readonly String: JsonSchema;
104
+ readonly Boolean: JsonSchema;
105
+ readonly Number: JsonSchema;
106
+ readonly Integer: JsonSchema;
107
+ readonly Addr: JsonSchema;
108
+ readonly Address: JsonSchema;
109
+ readonly Binary: JsonSchema;
110
+ readonly Decimal: JsonSchema;
111
+ readonly Decimal128: JsonSchema;
112
+ readonly Decimal256: JsonSchema;
113
+ readonly Uint64: JsonSchema;
114
+ readonly Uint128: JsonSchema;
115
+ readonly Uint256: JsonSchema;
116
+ readonly Uint512: JsonSchema;
117
+ readonly Int64: JsonSchema;
118
+ readonly Int128: JsonSchema;
119
+ readonly Int256: JsonSchema;
120
+ readonly Int512: JsonSchema;
121
+ readonly Timestamp: JsonSchema;
122
+ readonly Coin: JsonSchema;
123
+ readonly Coins: JsonSchema;
124
+ }
125
+
126
+ declare global {
127
+ interface DoneStorage {
128
+ get<T = unknown>(key: string): Promise<T | undefined>;
129
+ set(key: string, value: unknown): Promise<void>;
130
+ }
131
+
132
+ interface DoneQuerier {
133
+ query_wasm_smart<T = unknown>(address: string, msg: unknown): Promise<T>;
134
+ query_balance(address: string, denom: string): Promise<unknown>;
135
+ query_wasm_contract_info(address: string): Promise<unknown>;
136
+ }
137
+
138
+ interface DoneApiHelper {
139
+ addr_validate(address: string): string;
140
+ addr_canonicalize(value: string): unknown;
141
+ addr_humanize(value: unknown): string;
142
+ debug(value: unknown): void;
143
+ }
144
+
145
+ interface DoneDeps {
146
+ storage: DoneStorage;
147
+ querier: DoneQuerier;
148
+ api: DoneApiHelper;
149
+ }
150
+
151
+ const deps: DoneDeps;
152
+ }
153
+
154
+ export interface NumericWrapper<TSelf> {
155
+ add(value: unknown): TSelf;
156
+ sub(value: unknown): TSelf;
157
+ mul(value: unknown): TSelf;
158
+ div(value: unknown): TSelf;
159
+ rem(value: unknown): TSelf;
160
+ checkedAdd(value: unknown): Promise<TSelf>;
161
+ checkedSub(value: unknown): Promise<TSelf>;
162
+ checkedMul(value: unknown): Promise<TSelf>;
163
+ checkedDiv(value: unknown): Promise<TSelf>;
164
+ lt(value: unknown): boolean;
165
+ lte(value: unknown): boolean;
166
+ gt(value: unknown): boolean;
167
+ gte(value: unknown): boolean;
168
+ eq(value: unknown): boolean;
169
+ neq(value: unknown): boolean;
170
+ ceil(): TSelf;
171
+ floor(): TSelf;
172
+ trunc(): TSelf;
173
+ toString(): string;
174
+ toJSON(): string;
175
+ }
176
+
177
+ export class Uint64 implements NumericWrapper<Uint64> {
178
+ constructor(value: unknown);
179
+ static from(value: unknown): Uint64;
180
+ static tryFrom(value: unknown): Uint64 | null;
181
+ static is(value: unknown): value is Uint64;
182
+ add(value: unknown): Uint64;
183
+ sub(value: unknown): Uint64;
184
+ mul(value: unknown): Uint64;
185
+ div(value: unknown): Uint64;
186
+ rem(value: unknown): Uint64;
187
+ checkedAdd(value: unknown): Promise<Uint64>;
188
+ checkedSub(value: unknown): Promise<Uint64>;
189
+ checkedMul(value: unknown): Promise<Uint64>;
190
+ checkedDiv(value: unknown): Promise<Uint64>;
191
+ lt(value: unknown): boolean;
192
+ lte(value: unknown): boolean;
193
+ gt(value: unknown): boolean;
194
+ gte(value: unknown): boolean;
195
+ eq(value: unknown): boolean;
196
+ neq(value: unknown): boolean;
197
+ ceil(): Uint64;
198
+ floor(): Uint64;
199
+ trunc(): Uint64;
200
+ toString(): string;
201
+ toJSON(): string;
202
+ }
203
+
204
+ export class Uint128 implements NumericWrapper<Uint128> {
205
+ constructor(value: unknown);
206
+ static from(value: unknown): Uint128;
207
+ static tryFrom(value: unknown): Uint128 | null;
208
+ static is(value: unknown): value is Uint128;
209
+ add(value: unknown): Uint128;
210
+ sub(value: unknown): Uint128;
211
+ mul(value: unknown): Uint128;
212
+ div(value: unknown): Uint128;
213
+ rem(value: unknown): Uint128;
214
+ checkedAdd(value: unknown): Promise<Uint128>;
215
+ checkedSub(value: unknown): Promise<Uint128>;
216
+ checkedMul(value: unknown): Promise<Uint128>;
217
+ checkedDiv(value: unknown): Promise<Uint128>;
218
+ lt(value: unknown): boolean;
219
+ lte(value: unknown): boolean;
220
+ gt(value: unknown): boolean;
221
+ gte(value: unknown): boolean;
222
+ eq(value: unknown): boolean;
223
+ neq(value: unknown): boolean;
224
+ ceil(): Uint128;
225
+ floor(): Uint128;
226
+ trunc(): Uint128;
227
+ toString(): string;
228
+ toJSON(): string;
229
+ }
230
+
231
+ export class Uint256 implements NumericWrapper<Uint256> {
232
+ constructor(value: unknown);
233
+ static from(value: unknown): Uint256;
234
+ static tryFrom(value: unknown): Uint256 | null;
235
+ static is(value: unknown): value is Uint256;
236
+ add(value: unknown): Uint256;
237
+ sub(value: unknown): Uint256;
238
+ mul(value: unknown): Uint256;
239
+ div(value: unknown): Uint256;
240
+ rem(value: unknown): Uint256;
241
+ checkedAdd(value: unknown): Promise<Uint256>;
242
+ checkedSub(value: unknown): Promise<Uint256>;
243
+ checkedMul(value: unknown): Promise<Uint256>;
244
+ checkedDiv(value: unknown): Promise<Uint256>;
245
+ lt(value: unknown): boolean;
246
+ lte(value: unknown): boolean;
247
+ gt(value: unknown): boolean;
248
+ gte(value: unknown): boolean;
249
+ eq(value: unknown): boolean;
250
+ neq(value: unknown): boolean;
251
+ ceil(): Uint256;
252
+ floor(): Uint256;
253
+ trunc(): Uint256;
254
+ toString(): string;
255
+ toJSON(): string;
256
+ }
257
+
258
+ export class Uint512 implements NumericWrapper<Uint512> {
259
+ constructor(value: unknown);
260
+ static from(value: unknown): Uint512;
261
+ static tryFrom(value: unknown): Uint512 | null;
262
+ static is(value: unknown): value is Uint512;
263
+ add(value: unknown): Uint512;
264
+ sub(value: unknown): Uint512;
265
+ mul(value: unknown): Uint512;
266
+ div(value: unknown): Uint512;
267
+ rem(value: unknown): Uint512;
268
+ checkedAdd(value: unknown): Promise<Uint512>;
269
+ checkedSub(value: unknown): Promise<Uint512>;
270
+ checkedMul(value: unknown): Promise<Uint512>;
271
+ checkedDiv(value: unknown): Promise<Uint512>;
272
+ lt(value: unknown): boolean;
273
+ lte(value: unknown): boolean;
274
+ gt(value: unknown): boolean;
275
+ gte(value: unknown): boolean;
276
+ eq(value: unknown): boolean;
277
+ neq(value: unknown): boolean;
278
+ ceil(): Uint512;
279
+ floor(): Uint512;
280
+ trunc(): Uint512;
281
+ toString(): string;
282
+ toJSON(): string;
283
+ }
284
+
285
+ export class Int64 implements NumericWrapper<Int64> {
286
+ constructor(value: unknown);
287
+ static from(value: unknown): Int64;
288
+ static tryFrom(value: unknown): Int64 | null;
289
+ static is(value: unknown): value is Int64;
290
+ add(value: unknown): Int64;
291
+ sub(value: unknown): Int64;
292
+ mul(value: unknown): Int64;
293
+ div(value: unknown): Int64;
294
+ rem(value: unknown): Int64;
295
+ checkedAdd(value: unknown): Promise<Int64>;
296
+ checkedSub(value: unknown): Promise<Int64>;
297
+ checkedMul(value: unknown): Promise<Int64>;
298
+ checkedDiv(value: unknown): Promise<Int64>;
299
+ lt(value: unknown): boolean;
300
+ lte(value: unknown): boolean;
301
+ gt(value: unknown): boolean;
302
+ gte(value: unknown): boolean;
303
+ eq(value: unknown): boolean;
304
+ neq(value: unknown): boolean;
305
+ ceil(): Int64;
306
+ floor(): Int64;
307
+ trunc(): Int64;
308
+ toString(): string;
309
+ toJSON(): string;
310
+ }
311
+
312
+ export class Int128 implements NumericWrapper<Int128> {
313
+ constructor(value: unknown);
314
+ static from(value: unknown): Int128;
315
+ static tryFrom(value: unknown): Int128 | null;
316
+ static is(value: unknown): value is Int128;
317
+ add(value: unknown): Int128;
318
+ sub(value: unknown): Int128;
319
+ mul(value: unknown): Int128;
320
+ div(value: unknown): Int128;
321
+ rem(value: unknown): Int128;
322
+ checkedAdd(value: unknown): Promise<Int128>;
323
+ checkedSub(value: unknown): Promise<Int128>;
324
+ checkedMul(value: unknown): Promise<Int128>;
325
+ checkedDiv(value: unknown): Promise<Int128>;
326
+ lt(value: unknown): boolean;
327
+ lte(value: unknown): boolean;
328
+ gt(value: unknown): boolean;
329
+ gte(value: unknown): boolean;
330
+ eq(value: unknown): boolean;
331
+ neq(value: unknown): boolean;
332
+ ceil(): Int128;
333
+ floor(): Int128;
334
+ trunc(): Int128;
335
+ toString(): string;
336
+ toJSON(): string;
337
+ }
338
+
339
+ export class Int256 implements NumericWrapper<Int256> {
340
+ constructor(value: unknown);
341
+ static from(value: unknown): Int256;
342
+ static tryFrom(value: unknown): Int256 | null;
343
+ static is(value: unknown): value is Int256;
344
+ add(value: unknown): Int256;
345
+ sub(value: unknown): Int256;
346
+ mul(value: unknown): Int256;
347
+ div(value: unknown): Int256;
348
+ rem(value: unknown): Int256;
349
+ checkedAdd(value: unknown): Promise<Int256>;
350
+ checkedSub(value: unknown): Promise<Int256>;
351
+ checkedMul(value: unknown): Promise<Int256>;
352
+ checkedDiv(value: unknown): Promise<Int256>;
353
+ lt(value: unknown): boolean;
354
+ lte(value: unknown): boolean;
355
+ gt(value: unknown): boolean;
356
+ gte(value: unknown): boolean;
357
+ eq(value: unknown): boolean;
358
+ neq(value: unknown): boolean;
359
+ ceil(): Int256;
360
+ floor(): Int256;
361
+ trunc(): Int256;
362
+ toString(): string;
363
+ toJSON(): string;
364
+ }
365
+
366
+ export class Int512 implements NumericWrapper<Int512> {
367
+ constructor(value: unknown);
368
+ static from(value: unknown): Int512;
369
+ static tryFrom(value: unknown): Int512 | null;
370
+ static is(value: unknown): value is Int512;
371
+ add(value: unknown): Int512;
372
+ sub(value: unknown): Int512;
373
+ mul(value: unknown): Int512;
374
+ div(value: unknown): Int512;
375
+ rem(value: unknown): Int512;
376
+ checkedAdd(value: unknown): Promise<Int512>;
377
+ checkedSub(value: unknown): Promise<Int512>;
378
+ checkedMul(value: unknown): Promise<Int512>;
379
+ checkedDiv(value: unknown): Promise<Int512>;
380
+ lt(value: unknown): boolean;
381
+ lte(value: unknown): boolean;
382
+ gt(value: unknown): boolean;
383
+ gte(value: unknown): boolean;
384
+ eq(value: unknown): boolean;
385
+ neq(value: unknown): boolean;
386
+ ceil(): Int512;
387
+ floor(): Int512;
388
+ trunc(): Int512;
389
+ toString(): string;
390
+ toJSON(): string;
391
+ }
392
+
393
+ export class Decimal implements NumericWrapper<Decimal> {
394
+ constructor(value: unknown);
395
+ static from(value: unknown): Decimal;
396
+ static tryFrom(value: unknown): Decimal | null;
397
+ static is(value: unknown): value is Decimal;
398
+ add(value: unknown): Decimal;
399
+ sub(value: unknown): Decimal;
400
+ mul(value: unknown): Decimal;
401
+ div(value: unknown): Decimal;
402
+ rem(value: unknown): Decimal;
403
+ checkedAdd(value: unknown): Promise<Decimal>;
404
+ checkedSub(value: unknown): Promise<Decimal>;
405
+ checkedMul(value: unknown): Promise<Decimal>;
406
+ checkedDiv(value: unknown): Promise<Decimal>;
407
+ lt(value: unknown): boolean;
408
+ lte(value: unknown): boolean;
409
+ gt(value: unknown): boolean;
410
+ gte(value: unknown): boolean;
411
+ eq(value: unknown): boolean;
412
+ neq(value: unknown): boolean;
413
+ ceil(): Decimal;
414
+ floor(): Decimal;
415
+ trunc(): Decimal;
416
+ toString(): string;
417
+ toJSON(): string;
418
+ }
419
+
420
+ export class Decimal256 implements NumericWrapper<Decimal256> {
421
+ constructor(value: unknown);
422
+ static from(value: unknown): Decimal256;
423
+ static tryFrom(value: unknown): Decimal256 | null;
424
+ static is(value: unknown): value is Decimal256;
425
+ add(value: unknown): Decimal256;
426
+ sub(value: unknown): Decimal256;
427
+ mul(value: unknown): Decimal256;
428
+ div(value: unknown): Decimal256;
429
+ rem(value: unknown): Decimal256;
430
+ checkedAdd(value: unknown): Promise<Decimal256>;
431
+ checkedSub(value: unknown): Promise<Decimal256>;
432
+ checkedMul(value: unknown): Promise<Decimal256>;
433
+ checkedDiv(value: unknown): Promise<Decimal256>;
434
+ lt(value: unknown): boolean;
435
+ lte(value: unknown): boolean;
436
+ gt(value: unknown): boolean;
437
+ gte(value: unknown): boolean;
438
+ eq(value: unknown): boolean;
439
+ neq(value: unknown): boolean;
440
+ ceil(): Decimal256;
441
+ floor(): Decimal256;
442
+ trunc(): Decimal256;
443
+ toString(): string;
444
+ toJSON(): string;
445
+ }
446
+
447
+ declare function uint64(value: unknown): Uint64;
448
+ declare function uint128(value: unknown): Uint128;
449
+ declare function uint256(value: unknown): Uint256;
450
+ declare function uint512(value: unknown): Uint512;
451
+ declare function int64(value: unknown): Int64;
452
+ declare function int128(value: unknown): Int128;
453
+ declare function int256(value: unknown): Int256;
454
+ declare function int512(value: unknown): Int512;
455
+ declare function dec(value: unknown): Decimal;
456
+ declare function dec256(value: unknown): Decimal256;
@@ -0,0 +1 @@
1
+ export * from "./done.zone";