-
Notifications
You must be signed in to change notification settings - Fork 3
/
space.ts
487 lines (445 loc) · 15 KB
/
space.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
import { System } from '../systemCalls';
import { chain } from 'koinos-proto-as';
import { Protobuf, Reader, Writer } from 'as-proto';
import { StringBytes } from './stringBytes';
export namespace Space {
export enum Direction {
Ascending,
Descending
}
export class Space<TKey, TValue> {
private space: chain.object_space;
private valueDecoder: (reader: Reader, length: i32) => TValue;
private valueEncoder: (message: TValue, writer: Writer) => void;
/**
* Initialize a Space object with TKey the type of the keys and TValue the type of the values
* @param contractId the id of the contract
* @param spaceId the id of the space
* @param valueDecoder the protobuf decoder for the values
* @param valueEncoder the protobuf encoder for the values
* @param system is system space
* @example
* ```ts
* const contractId = Base58.decode('1DQzuCcTKacbs9GGScFTU1Hc8BsyARTPqe');
* const spaceId = 1;
* const Objects = new Space.Space<String, test_object>(contractId, spaceId, test_object.decode, test_object.encode);
* ```
*/
constructor(
contractId: Uint8Array,
spaceId: u32,
valueDecoder: (reader: Reader, length: i32) => TValue,
valueEncoder: (message: TValue, writer: Writer) => void,
system: bool = false) {
this.space = new chain.object_space(system, contractId, spaceId);
this.valueDecoder = valueDecoder;
this.valueEncoder = valueEncoder;
}
/**
* Check if `key` exists in the space
* @param key key to check
* @example
* ```ts
* const exists = Objects.has('key1');
*
* if (exists) {
* ...
* }
* ```
*/
has(key: TKey): boolean {
const object = this.get(key);
return object ? true : false;
}
/**
* Get an object from the space
* @param key key to get
* @returns the object if exists, null otherwise
* @example
* ```ts
* const obj = Objects.get('key1');
*
* if (obj != null) {
* ...
* }
* ```
*/
get(key: TKey): TValue | null {
return System.getObject<TKey, TValue>(this.space, key, this.valueDecoder);
}
/**
* Get many objects from the space
* @param offsetKey key used as the offset
* @param limit number of objects to return
* @param direction direction of the get, Ascending or Descending
* @returns an array with the objects retrieved
* @example
* ```ts
* const objs = Objects.getMany('key1', 10, Space.Direction.Descending);
*
* for (let index = 0; index < objs.length; index++) {
* const obj = objs[index];
* }
* ```
*/
getMany(offsetKey: TKey, limit: i32 = i32.MAX_VALUE, direction: Direction = Direction.Ascending): System.ProtoDatabaseObject<TValue>[] {
const result: System.ProtoDatabaseObject<TValue>[] = [];
let key: Uint8Array;
if (offsetKey instanceof Uint8Array) {
key = offsetKey;
} else if (typeof offsetKey == 'string') {
key = StringBytes.stringToBytes(offsetKey);
}
let done = false;
do {
// @ts-ignore key is always initialized when reaching this code
const obj = direction == Direction.Ascending ? System.getNextObject<Uint8Array, TValue>(this.space, key, this.valueDecoder) : System.getPrevObject<Uint8Array, TValue>(this.space, key, this.valueDecoder);
if (obj) {
result.push(obj);
key = obj.key!;
}
done = obj == null || result.length >= limit;
} while (!done);
return result;
}
/**
* Get many keys from the space
* @param offsetKey key used as the offset
* @param limit number of keys to return
* @param direction direction of the get, Ascending or Descending
* @returns an array with the keys retrieved
* @example
* ```ts
* const keys = Objects.getManyKeys('key1', 10, Space.Direction.Descending);
*
* for (let index = 0; index < keys.length; index++) {
* const key = keys[index];
* }
* ```
*/
getManyKeys(offsetKey: TKey, limit: i32 = i32.MAX_VALUE, direction: Direction = Direction.Ascending): TKey[] {
const result: TKey[] = [];
let key: Uint8Array;
if (offsetKey instanceof Uint8Array) {
key = offsetKey;
} else if (typeof offsetKey == 'string') {
key = StringBytes.stringToBytes(offsetKey);
}
let done = false;
do {
// @ts-ignore key is always initialized when reaching this code
const obj = direction == Direction.Ascending ? System.getNextObject<Uint8Array, TValue>(this.space, key, this.valueDecoder) : System.getPrevObject<Uint8Array, TValue>(this.space, key, this.valueDecoder);
if (obj) {
key = obj.key!;
if (offsetKey instanceof Uint8Array) {
// @ts-ignore key here is a Uint8Array
result.push(key);
} else if (typeof offsetKey == 'string') {
// @ts-ignore key here is a string
result.push(StringBytes.bytesToString(key)!);
}
}
done = obj == null || result.length >= limit;
} while (!done);
return result;
}
/**
* Get many values from the space
* @param offsetKey key used as the offset
* @param limit number of values to return
* @param direction direction of the get, Ascending or Descending
* @returns an array with the values retrieved
* @example
* ```ts
* const values = Objects.getManyValues('key1', 10, Space.Direction.Descending);
*
* for (let index = 0; index < values.length; index++) {
* const values = values[index];
* }
* ```
*/
getManyValues(offsetKey: TKey, limit: i32 = i32.MAX_VALUE, direction: Direction = Direction.Ascending): TValue[] {
const result: TValue[] = [];
let key: Uint8Array;
if (offsetKey instanceof Uint8Array) {
key = offsetKey;
} else if (typeof offsetKey == 'string') {
key = StringBytes.stringToBytes(offsetKey);
}
let done = false;
do {
// @ts-ignore key is always initialized when reaching this code
const obj = direction == Direction.Ascending ? System.getNextObject<Uint8Array, TValue>(this.space, key, this.valueDecoder) : System.getPrevObject<Uint8Array, TValue>(this.space, key, this.valueDecoder);
if (obj) {
result.push(obj.value);
key = obj.key!;
}
done = obj == null || result.length >= limit;
} while (!done);
return result;
}
/**
* Get the next object from the space
* @param key key to get next
* @returns a System.ProtoDatabaseObject if exists, null otherwise
* @example
* ```ts
* const obj = Objects.getNext('key1');
*
* if (obj != null) {
* const key = obj.key;
* const val = obj.value;
* }
* ```
*/
getNext(key: TKey): System.ProtoDatabaseObject<TValue> | null {
return System.getNextObject<TKey, TValue>(this.space, key, this.valueDecoder);
}
/**
* Get the previous object from the space
* @param key key to get previous
* @returns a System.ProtoDatabaseObject if exists, null otherwise
* @example
* ```ts
* const obj = Objects.getPrev('key1');
*
* if (obj != null) {
* const key = obj.key;
* const val = obj.value;
* }
* ```
*/
getPrev(key: TKey): System.ProtoDatabaseObject<TValue> | null {
return System.getPrevObject<TKey, TValue>(this.space, key, this.valueDecoder);
}
/**
* Put an object in the space
* @param key key of the object
* @param message object to put
* @returns number of bytes that were written in the space
* @example
* ```ts
* const nbBytesWritten = Objects.put('key1', new test_object(42));
*
* System.log(nbBytesWritten.toString());
* ```
*/
put(key: TKey, object: TValue): i32 {
return System.putObject(this.space, key, object, this.valueEncoder);
}
/**
* Remove an object from the space
* @param key key of the object
* @example
* ```ts
* Objects.remove('key1');
* ```
*/
remove(key: TKey): void {
System.removeObject(this.space, key);
}
}
export class SpaceProtoKey<TKey, TValue> extends Space<Uint8Array, TValue> {
private keyDecoder: (reader: Reader, length: i32) => TKey;
private keyEncoder: (message: TKey, writer: Writer) => void;
/**
* Initialize a Space object with TKey (a protobuf type) the type of the keys and TValue the type of the values
* @param contractId the id of the contract
* @param spaceId the id of the space
* @param keyEncoder the protobuf encoder for the keys
* @param valueDecoder the protobuf decoder for the values
* @param valueEncoder the protobuf encoder for the values
* @param system is system space
* @example
* ```ts
* const contractId = Base58.decode('1DQzuCcTKacbs9GGScFTU1Hc8BsyARTPqe');
* const spaceId = 1;
* const Objects = new Space.SpaceProtoKey<String, test_object>(contractId, spaceId, test_key.encode, test_object.decode, test_object.encode);
* ```
*/
constructor(
contractId: Uint8Array,
spaceId: u32,
keyDecoder: (reader: Reader, length: i32) => TKey,
keyEncoder: (message: TKey, writer: Writer) => void,
valueDecoder: (reader: Reader, length: i32) => TValue,
valueEncoder: (message: TValue, writer: Writer) => void,
system: bool = false) {
super(contractId, spaceId, valueDecoder, valueEncoder, system);
this.keyDecoder = keyDecoder;
this.keyEncoder = keyEncoder;
}
/**
* Check if `key` exists in the space
* @param key key to check
* @example
* ```ts
* const exists = Objects.has(new test_key(1));
*
* if (exists) {
* ...
* }
* ```
*/
// @ts-ignore valid in AS
has(key: TKey): boolean {
const finalKey = Protobuf.encode(key, this.keyEncoder);
const object = super.get(finalKey);
return object ? true : false;
}
/**
* Get an object from the space
* @param key key to get
* @returns the object if exists, null otherwise
* @example
* ```ts
* const obj = Objects.get(new test_key(1));
*
* if (obj != null) {
* ...
* }
* ```
*/
// @ts-ignore valid in AS
get(key: TKey): TValue | null {
const finalKey = Protobuf.encode(key, this.keyEncoder);
return super.get(finalKey);
}
/**
* Get many objects from the space
* @param offsetKey key used as the offset
* @param limit number of objects to return
* @param direction direction of the get, Ascending or Descending
* @returns an array with the objects retrieved
* @example
* ```ts
* const objs = Objects.getManyObj(new test_key(1), 10, Space.Direction.Descending);
*
* for (let index = 0; index < objs.length; index++) {
* const obj = objs[index];
* }
* ```
*/
getManyObj(offsetKey: TKey, limit: i32 = i32.MAX_VALUE, direction: Direction = Direction.Ascending): System.ProtoDatabaseObject<TValue>[] {
const finalKey = Protobuf.encode(offsetKey, this.keyEncoder);
return super.getMany(finalKey, limit, direction);
}
/**
* Get many values from the space
* @param offsetKey key used as the offset
* @param limit number of objects to return
* @param direction direction of the get, Ascending or Descending
* @returns an array with the objects retrieved
* @example
* ```ts
* const values = Objects.getManyObjValues(new test_key(1), 10, Space.Direction.Descending);
*
* for (let index = 0; index < values.length; index++) {
* const value = values[index];
* }
* ```
*/
getManyObjValues(offsetKey: TKey, limit: i32 = i32.MAX_VALUE, direction: Direction = Direction.Ascending): TValue[] {
const finalKey = Protobuf.encode(offsetKey, this.keyEncoder);
return super.getManyValues(finalKey, limit, direction);
}
/**
* Get many keys from the space
* @param offsetKey key used as the offset
* @param limit number of keys to return
* @param direction direction of the get, Ascending or Descending
* @returns an array with the keys retrieved
* @example
* ```ts
* const keys = Objects.getManyObjKeys(new test_key(1), 10, Space.Direction.Descending);
*
* for (let index = 0; index < keys.length; index++) {
* const key = keys[index];
* }
* ```
*/
getManyObjKeys(offsetKey: TKey, limit: i32 = i32.MAX_VALUE, direction: Direction = Direction.Ascending): TKey[] {
const result: TKey[] = [];
let key = Protobuf.encode(offsetKey, this.keyEncoder);
let done = false;
do {
// @ts-ignore key is always initialized when reaching this code
const obj = direction == Direction.Ascending ? System.getNextObject<Uint8Array, TValue>(this.space, key, this.valueDecoder) : System.getPrevObject<Uint8Array, TValue>(this.space, key, this.valueDecoder);
if (obj) {
key = obj.key!;
result.push(Protobuf.decode(key, this.keyDecoder));
}
done = obj == null || result.length >= limit;
} while (!done);
return result;
}
/**
* Get the next object from the space
* @param key key to get next
* @returns a System.ProtoDatabaseObject if exists, null otherwise
* @example
* ```ts
* const obj = Objects.getNext(new test_key(1));
*
* if (obj != null) {
* const key = obj.key;
* const val = obj.value;
* }
* ```
*/
// @ts-ignore valid in AS
getNext(key: TKey): System.ProtoDatabaseObject<TValue> | null {
const finalKey = Protobuf.encode(key, this.keyEncoder);
return super.getNext(finalKey);
}
/**
* Get the previous object from the space
* @param key key to get previous
* @returns a System.ProtoDatabaseObject if exists, null otherwise
* @example
* ```ts
* const obj = Objects.getPrev(new test_key(1));
*
* if (obj != null) {
* const key = obj.key;
* const val = obj.value;
* }
* ```
*/
// @ts-ignore valid in AS
getPrev(key: TKey): System.ProtoDatabaseObject<TValue> | null {
const finalKey = Protobuf.encode(key, this.keyEncoder);
return super.getPrev(finalKey);
}
/**
* Put an object in the space
* @param key key of the object
* @param message object to put
* @returns number of bytes that were written in the space
* @example
* ```ts
* const nbBytesWritten = Objects.put(new test_key(1), new test_object(42));
*
* System.log(nbBytesWritten.toString());
* ```
*/
// @ts-ignore valid in AS
put(key: TKey, object: TValue): i32 {
const finalKey = Protobuf.encode(key, this.keyEncoder);
return super.put(finalKey, object);
}
/**
* Remove an object from the space
* @param key key of the object
* @example
* ```ts
* Objects.remove(new test_key(1));
* ```
*/
// @ts-ignore valid in AS
remove(key: TKey): void {
const finalKey = Protobuf.encode(key, this.keyEncoder);
super.remove(finalKey);
}
}
}