Skip to content

Commit 73ed7c2

Browse files
committed
fix: aux data
1 parent 7905507 commit 73ed7c2

File tree

13 files changed

+833
-345
lines changed

13 files changed

+833
-345
lines changed

docs/content/docs/modules/core/AuxiliaryData.mdx

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -491,7 +491,19 @@ export declare const FromCBORBytes: (
491491
Schema.Array$<Schema.suspend<CBOR.CBOR, CBOR.CBOR, never>>,
492492
Schema.MapFromSelf<
493493
typeof Schema.BigIntFromSelf,
494-
Schema.suspend<TransactionMetadatum, TransactionMetadatumEncoded, never>
494+
Schema.suspend<
495+
| string
496+
| bigint
497+
| Uint8Array
498+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
499+
| readonly TransactionMetadatum.TransactionMetadatum[],
500+
| string
501+
| bigint
502+
| Uint8Array
503+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
504+
| readonly TransactionMetadatum.TransactionMetadatum[],
505+
never
506+
>
495507
>
496508
]
497509
>,
@@ -538,7 +550,19 @@ export declare const FromCBORHex: (
538550
Schema.Array$<Schema.suspend<CBOR.CBOR, CBOR.CBOR, never>>,
539551
Schema.MapFromSelf<
540552
typeof Schema.BigIntFromSelf,
541-
Schema.suspend<TransactionMetadatum, TransactionMetadatumEncoded, never>
553+
Schema.suspend<
554+
| string
555+
| bigint
556+
| Uint8Array
557+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
558+
| readonly TransactionMetadatum.TransactionMetadatum[],
559+
| string
560+
| bigint
561+
| Uint8Array
562+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
563+
| readonly TransactionMetadatum.TransactionMetadatum[],
564+
never
565+
>
542566
>
543567
]
544568
>,
@@ -575,7 +599,19 @@ export declare const FromCDDL: Schema.transformOrFail<
575599
Schema.Array$<Schema.suspend<CBOR.CBOR, CBOR.CBOR, never>>,
576600
Schema.MapFromSelf<
577601
typeof Schema.BigIntFromSelf,
578-
Schema.suspend<TransactionMetadatum, TransactionMetadatumEncoded, never>
602+
Schema.suspend<
603+
| string
604+
| bigint
605+
| Uint8Array
606+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
607+
| readonly TransactionMetadatum.TransactionMetadatum[],
608+
| string
609+
| bigint
610+
| Uint8Array
611+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
612+
| readonly TransactionMetadatum.TransactionMetadatum[],
613+
never
614+
>
579615
>
580616
]
581617
>,

docs/content/docs/modules/core/Metadata.mdx

Lines changed: 210 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,17 @@ Convert Metadata to CBOR bytes.
111111
```ts
112112
export declare const toCBORBytes: (
113113
options?: CBOR.CodecOptions
114-
) => (a: Map<bigint, TransactionMetadatum.TransactionMetadatum>, overrideOptions?: ParseOptions) => any
114+
) => (
115+
a: Map<
116+
bigint,
117+
| string
118+
| bigint
119+
| Uint8Array
120+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
121+
| readonly TransactionMetadatum.TransactionMetadatum[]
122+
>,
123+
overrideOptions?: ParseOptions
124+
) => any
115125
```
116126
117127
Added in v2.0.0
@@ -125,7 +135,17 @@ Convert Metadata to CBOR hex string.
125135
```ts
126136
export declare const toCBORHex: (
127137
options?: CBOR.CodecOptions
128-
) => (a: Map<bigint, TransactionMetadatum.TransactionMetadatum>, overrideOptions?: ParseOptions) => string
138+
) => (
139+
a: Map<
140+
bigint,
141+
| string
142+
| bigint
143+
| Uint8Array
144+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
145+
| readonly TransactionMetadatum.TransactionMetadatum[]
146+
>,
147+
overrideOptions?: ParseOptions
148+
) => string
129149
```
130150
131151
Added in v2.0.0
@@ -155,7 +175,17 @@ Parse Metadata from CBOR bytes.
155175
```ts
156176
export declare const fromCBORBytes: (
157177
options?: CBOR.CodecOptions
158-
) => (i: any, overrideOptions?: ParseOptions) => Map<bigint, TransactionMetadatum.TransactionMetadatum>
178+
) => (
179+
i: any,
180+
overrideOptions?: ParseOptions
181+
) => Map<
182+
bigint,
183+
| string
184+
| bigint
185+
| Uint8Array
186+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
187+
| readonly TransactionMetadatum.TransactionMetadatum[]
188+
>
159189
```
160190
161191
Added in v2.0.0
@@ -169,7 +199,17 @@ Parse Metadata from CBOR hex string.
169199
```ts
170200
export declare const fromCBORHex: (
171201
options?: CBOR.CodecOptions
172-
) => (i: string, overrideOptions?: ParseOptions) => Map<bigint, TransactionMetadatum.TransactionMetadatum>
202+
) => (
203+
i: string,
204+
overrideOptions?: ParseOptions
205+
) => Map<
206+
bigint,
207+
| string
208+
| bigint
209+
| Uint8Array
210+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
211+
| readonly TransactionMetadatum.TransactionMetadatum[]
212+
>
173213
```
174214
175215
Added in v2.0.0
@@ -179,14 +219,29 @@ Added in v2.0.0
179219
## CDDLSchema
180220
181221
CDDL schema for Metadata (CBOR-compatible representation).
182-
Maps bigint labels to encoded transaction metadatum values.
222+
Maps bigint labels to transaction metadatum values.
223+
224+
Uses Schema.typeSchema(TransactionMetadatumSchema) because CBOR decoding
225+
returns runtime types (bigint, Uint8Array, Map) directly.
183226
184227
**Signature**
185228
186229
```ts
187230
export declare const CDDLSchema: Schema.MapFromSelf<
188231
typeof Schema.BigIntFromSelf,
189-
Schema.suspend<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatumEncoded, never>
232+
Schema.suspend<
233+
| string
234+
| bigint
235+
| Uint8Array
236+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
237+
| readonly TransactionMetadatum.TransactionMetadatum[],
238+
| string
239+
| bigint
240+
| Uint8Array
241+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
242+
| readonly TransactionMetadatum.TransactionMetadatum[],
243+
never
244+
>
190245
>
191246
```
192247
@@ -210,11 +265,37 @@ export declare const FromCBORBytes: (
210265
Schema.transformOrFail<
211266
Schema.MapFromSelf<
212267
typeof Schema.BigIntFromSelf,
213-
Schema.suspend<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatumEncoded, never>
268+
Schema.suspend<
269+
| string
270+
| bigint
271+
| Uint8Array
272+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
273+
| readonly TransactionMetadatum.TransactionMetadatum[],
274+
| string
275+
| bigint
276+
| Uint8Array
277+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
278+
| readonly TransactionMetadatum.TransactionMetadatum[],
279+
never
280+
>
214281
>,
215282
Schema.SchemaClass<
216-
Map<bigint, TransactionMetadatum.TransactionMetadatum>,
217-
Map<bigint, TransactionMetadatum.TransactionMetadatum>,
283+
Map<
284+
bigint,
285+
| string
286+
| bigint
287+
| Uint8Array
288+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
289+
| readonly TransactionMetadatum.TransactionMetadatum[]
290+
>,
291+
Map<
292+
bigint,
293+
| string
294+
| bigint
295+
| Uint8Array
296+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
297+
| readonly TransactionMetadatum.TransactionMetadatum[]
298+
>,
218299
never
219300
>,
220301
never
@@ -245,14 +326,36 @@ export declare const FromCBORHex: (
245326
Schema.MapFromSelf<
246327
typeof Schema.BigIntFromSelf,
247328
Schema.suspend<
248-
TransactionMetadatum.TransactionMetadatum,
249-
TransactionMetadatum.TransactionMetadatumEncoded,
329+
| string
330+
| bigint
331+
| Uint8Array
332+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
333+
| readonly TransactionMetadatum.TransactionMetadatum[],
334+
| string
335+
| bigint
336+
| Uint8Array
337+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
338+
| readonly TransactionMetadatum.TransactionMetadatum[],
250339
never
251340
>
252341
>,
253342
Schema.SchemaClass<
254-
Map<bigint, TransactionMetadatum.TransactionMetadatum>,
255-
Map<bigint, TransactionMetadatum.TransactionMetadatum>,
343+
Map<
344+
bigint,
345+
| string
346+
| bigint
347+
| Uint8Array
348+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
349+
| readonly TransactionMetadatum.TransactionMetadatum[]
350+
>,
351+
Map<
352+
bigint,
353+
| string
354+
| bigint
355+
| Uint8Array
356+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
357+
| readonly TransactionMetadatum.TransactionMetadatum[]
358+
>,
256359
never
257360
>,
258361
never
@@ -273,11 +376,37 @@ Transform schema from CDDL to Metadata.
273376
export declare const FromCDDL: Schema.transformOrFail<
274377
Schema.MapFromSelf<
275378
typeof Schema.BigIntFromSelf,
276-
Schema.suspend<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatumEncoded, never>
379+
Schema.suspend<
380+
| string
381+
| bigint
382+
| Uint8Array
383+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
384+
| readonly TransactionMetadatum.TransactionMetadatum[],
385+
| string
386+
| bigint
387+
| Uint8Array
388+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
389+
| readonly TransactionMetadatum.TransactionMetadatum[],
390+
never
391+
>
277392
>,
278393
Schema.SchemaClass<
279-
Map<bigint, TransactionMetadatum.TransactionMetadatum>,
280-
Map<bigint, TransactionMetadatum.TransactionMetadatum>,
394+
Map<
395+
bigint,
396+
| string
397+
| bigint
398+
| Uint8Array
399+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
400+
| readonly TransactionMetadatum.TransactionMetadatum[]
401+
>,
402+
Map<
403+
bigint,
404+
| string
405+
| bigint
406+
| Uint8Array
407+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
408+
| readonly TransactionMetadatum.TransactionMetadatum[]
409+
>,
281410
never
282411
>,
283412
never
@@ -301,12 +430,65 @@ export declare const Metadata: Schema.transform<
301430
Schema.Array$<
302431
Schema.Tuple2<
303432
Schema.refine<bigint, typeof Schema.BigInt>,
304-
Schema.Schema<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatumEncoded, never>
433+
Schema.Union<
434+
[
435+
Schema.transform<
436+
Schema.Array$<
437+
Schema.Tuple2<
438+
Schema.suspend<
439+
TransactionMetadatum.TransactionMetadatum,
440+
TransactionMetadatum.TransactionMetadatumEncoded,
441+
never
442+
>,
443+
Schema.suspend<
444+
TransactionMetadatum.TransactionMetadatum,
445+
TransactionMetadatum.TransactionMetadatumEncoded,
446+
never
447+
>
448+
>
449+
>,
450+
Schema.MapFromSelf<
451+
Schema.SchemaClass<
452+
TransactionMetadatum.TransactionMetadatum,
453+
TransactionMetadatum.TransactionMetadatum,
454+
never
455+
>,
456+
Schema.SchemaClass<
457+
TransactionMetadatum.TransactionMetadatum,
458+
TransactionMetadatum.TransactionMetadatum,
459+
never
460+
>
461+
>
462+
>,
463+
Schema.Array$<
464+
Schema.suspend<
465+
TransactionMetadatum.TransactionMetadatum,
466+
TransactionMetadatum.TransactionMetadatumEncoded,
467+
never
468+
>
469+
>,
470+
Schema.refine<bigint, typeof Schema.BigInt>,
471+
Schema.Schema<Uint8Array, string, never>,
472+
Schema.SchemaClass<string, string, never>
473+
]
474+
>
305475
>
306476
>,
307477
Schema.MapFromSelf<
308478
Schema.SchemaClass<bigint, bigint, never>,
309-
Schema.SchemaClass<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum, never>
479+
Schema.SchemaClass<
480+
| string
481+
| bigint
482+
| Uint8Array
483+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
484+
| readonly TransactionMetadatum.TransactionMetadatum[],
485+
| string
486+
| bigint
487+
| Uint8Array
488+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
489+
| readonly TransactionMetadatum.TransactionMetadatum[],
490+
never
491+
>
310492
>
311493
>
312494
```
@@ -335,7 +517,16 @@ FastCheck arbitrary for generating random Metadata instances.
335517
**Signature**
336518
337519
```ts
338-
export declare const arbitrary: FastCheck.Arbitrary<Map<bigint, TransactionMetadatum.TransactionMetadatum>>
520+
export declare const arbitrary: FastCheck.Arbitrary<
521+
Map<
522+
bigint,
523+
| string
524+
| bigint
525+
| Uint8Array
526+
| Map<TransactionMetadatum.TransactionMetadatum, TransactionMetadatum.TransactionMetadatum>
527+
| readonly TransactionMetadatum.TransactionMetadatum[]
528+
>
529+
>
339530
```
340531
341532
Added in v2.0.0

0 commit comments

Comments
 (0)