Skip to content

Commit a9f0068

Browse files
solidsnakedevsolidsnakedev
committed
docs: update docs
1 parent c2a113b commit a9f0068

File tree

16 files changed

+160
-136
lines changed

16 files changed

+160
-136
lines changed

‎docs/content/docs/modules/core/CBOR.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,7 @@ export declare const isRecord: (
536536
export declare const isTag: (
537537
u: unknown,
538538
overrideOptions?: ParseOptions | number
539-
) => u is { readonly _tag: "Tag"; readonly tag: number; readonly value: CBOR }
539+
) => u is { readonly _tag: "Tag"; readonly value: CBOR; readonly tag: number }
540540
```
541541
542542
## map

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -299,12 +299,24 @@ Represents: metadata = {* transaction_metadatum_label => transaction_metadatum}
299299
**Signature**
300300

301301
```ts
302-
export declare const Metadata: Schema.MapFromSelf<
303-
Schema.refine<bigint, typeof Schema.BigInt>,
304-
Schema.Schema<
305-
TransactionMetadatum.TransactionMetadatumVariants,
306-
TransactionMetadatum.TransactionMetadatumVariantsEncoded,
307-
never
302+
export declare const Metadata: Schema.transform<
303+
Schema.Array$<
304+
Schema.Tuple2<
305+
Schema.refine<bigint, typeof Schema.BigInt>,
306+
Schema.Schema<
307+
TransactionMetadatum.TransactionMetadatumVariants,
308+
TransactionMetadatum.TransactionMetadatumVariantsEncoded,
309+
never
310+
>
311+
>
312+
>,
313+
Schema.MapFromSelf<
314+
Schema.SchemaClass<bigint, bigint, never>,
315+
Schema.SchemaClass<
316+
TransactionMetadatum.TransactionMetadatumVariants,
317+
TransactionMetadatum.TransactionMetadatumVariants,
318+
never
319+
>
308320
>
309321
>
310322
```

‎docs/content/docs/modules/core/ProposalProcedure.mdx‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -191,10 +191,10 @@ export declare const CDDLSchema: Schema.Tuple<
191191
readonly [any, bigint] | null,
192192
(
193193
| readonly (readonly [0n | 1n, any])[]
194-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
194+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
195195
),
196196
ReadonlyMap<readonly [0n | 1n, any], bigint>,
197-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
197+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
198198
]
199199
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
200200
| readonly [6n],
@@ -207,10 +207,10 @@ export declare const CDDLSchema: Schema.Tuple<
207207
readonly [any, bigint] | null,
208208
(
209209
| readonly (readonly [0n | 1n, any])[]
210-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
210+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
211211
),
212212
ReadonlyMap<readonly [0n | 1n, any], bigint>,
213-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
213+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
214214
]
215215
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
216216
| readonly [6n],
@@ -253,10 +253,10 @@ export declare const FromCBORBytes: (
253253
readonly [any, bigint] | null,
254254
(
255255
| readonly (readonly [0n | 1n, any])[]
256-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
256+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
257257
),
258258
ReadonlyMap<readonly [0n | 1n, any], bigint>,
259-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
259+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
260260
]
261261
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
262262
| readonly [6n],
@@ -269,10 +269,10 @@ export declare const FromCBORBytes: (
269269
readonly [any, bigint] | null,
270270
(
271271
| readonly (readonly [0n | 1n, any])[]
272-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
272+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
273273
),
274274
ReadonlyMap<readonly [0n | 1n, any], bigint>,
275-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
275+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
276276
]
277277
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
278278
| readonly [6n],
@@ -321,10 +321,10 @@ export declare const FromCBORHex: (
321321
readonly [any, bigint] | null,
322322
(
323323
| readonly (readonly [0n | 1n, any])[]
324-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
324+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
325325
),
326326
ReadonlyMap<readonly [0n | 1n, any], bigint>,
327-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
327+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
328328
]
329329
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
330330
| readonly [6n],
@@ -337,10 +337,10 @@ export declare const FromCBORHex: (
337337
readonly [any, bigint] | null,
338338
(
339339
| readonly (readonly [0n | 1n, any])[]
340-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
340+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
341341
),
342342
ReadonlyMap<readonly [0n | 1n, any], bigint>,
343-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
343+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
344344
]
345345
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
346346
| readonly [6n],
@@ -380,10 +380,10 @@ export declare const FromCDDL: Schema.transformOrFail<
380380
readonly [any, bigint] | null,
381381
(
382382
| readonly (readonly [0n | 1n, any])[]
383-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
383+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
384384
),
385385
ReadonlyMap<readonly [0n | 1n, any], bigint>,
386-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
386+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
387387
]
388388
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
389389
| readonly [6n],
@@ -396,10 +396,10 @@ export declare const FromCDDL: Schema.transformOrFail<
396396
readonly [any, bigint] | null,
397397
(
398398
| readonly (readonly [0n | 1n, any])[]
399-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
399+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
400400
),
401401
ReadonlyMap<readonly [0n | 1n, any], bigint>,
402-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
402+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
403403
]
404404
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
405405
| readonly [6n],

‎docs/content/docs/modules/core/ProposalProcedures.mdx‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,10 @@ export declare const CDDLSchema: Schema.Array$<
181181
readonly [any, bigint] | null,
182182
(
183183
| readonly (readonly [0n | 1n, any])[]
184-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
184+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
185185
),
186186
ReadonlyMap<readonly [0n | 1n, any], bigint>,
187-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
187+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
188188
]
189189
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
190190
| readonly [6n],
@@ -197,10 +197,10 @@ export declare const CDDLSchema: Schema.Array$<
197197
readonly [any, bigint] | null,
198198
(
199199
| readonly (readonly [0n | 1n, any])[]
200-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
200+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
201201
),
202202
ReadonlyMap<readonly [0n | 1n, any], bigint>,
203-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
203+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
204204
]
205205
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
206206
| readonly [6n],
@@ -245,10 +245,10 @@ export declare const FromCBORBytes: (
245245
readonly [any, bigint] | null,
246246
(
247247
| readonly (readonly [0n | 1n, any])[]
248-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
248+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
249249
),
250250
ReadonlyMap<readonly [0n | 1n, any], bigint>,
251-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
251+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
252252
]
253253
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
254254
| readonly [6n],
@@ -261,10 +261,10 @@ export declare const FromCBORBytes: (
261261
readonly [any, bigint] | null,
262262
(
263263
| readonly (readonly [0n | 1n, any])[]
264-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
264+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
265265
),
266266
ReadonlyMap<readonly [0n | 1n, any], bigint>,
267-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
267+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
268268
]
269269
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
270270
| readonly [6n],
@@ -315,10 +315,10 @@ export declare const FromCBORHex: (
315315
readonly [any, bigint] | null,
316316
(
317317
| readonly (readonly [0n | 1n, any])[]
318-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
318+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
319319
),
320320
ReadonlyMap<readonly [0n | 1n, any], bigint>,
321-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
321+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
322322
]
323323
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
324324
| readonly [6n],
@@ -331,10 +331,10 @@ export declare const FromCBORHex: (
331331
readonly [any, bigint] | null,
332332
(
333333
| readonly (readonly [0n | 1n, any])[]
334-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
334+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
335335
),
336336
ReadonlyMap<readonly [0n | 1n, any], bigint>,
337-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
337+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
338338
]
339339
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
340340
| readonly [6n],
@@ -376,10 +376,10 @@ export declare const FromCDDL: Schema.transformOrFail<
376376
readonly [any, bigint] | null,
377377
(
378378
| readonly (readonly [0n | 1n, any])[]
379-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
379+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
380380
),
381381
ReadonlyMap<readonly [0n | 1n, any], bigint>,
382-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
382+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
383383
]
384384
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
385385
| readonly [6n],
@@ -392,10 +392,10 @@ export declare const FromCDDL: Schema.transformOrFail<
392392
readonly [any, bigint] | null,
393393
(
394394
| readonly (readonly [0n | 1n, any])[]
395-
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
395+
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
396396
),
397397
ReadonlyMap<readonly [0n | 1n, any], bigint>,
398-
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
398+
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
399399
]
400400
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
401401
| readonly [6n],

‎docs/content/docs/modules/core/TransactionMetadatum.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ Encoded type for transaction metadata (wire format with string for bigint)
201201
export type TransactionMetadatumVariantsEncoded =
202202
| { readonly _tag: "TextMetadatum"; readonly value: string }
203203
| { readonly _tag: "IntMetadatum"; readonly value: string }
204-
| { readonly _tag: "BytesMetadatum"; readonly value: Uint8Array }
204+
| { readonly _tag: "BytesMetadatum"; readonly value: string }
205205
| {
206206
readonly _tag: "MetadatumMap"
207207
readonly value: ReadonlyArray<readonly [TransactionMetadatumVariantsEncoded, TransactionMetadatumVariantsEncoded]>

‎docs/content/docs/modules/sdk/Credential.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export type ScriptHash = typeof CoreScriptHash.ScriptHash.Encoded
5353
export declare const fromCoreCredential: (
5454
a: CoreKeyHash.KeyHash | CoreScriptHash.ScriptHash,
5555
overrideOptions?: ParseOptions
56-
) => { readonly _tag: "KeyHash"; readonly hash: string } | { readonly _tag: "ScriptHash"; readonly hash: string }
56+
) => { readonly hash: string; readonly _tag: "KeyHash" } | { readonly hash: string; readonly _tag: "ScriptHash" }
5757
```
5858
5959
## toCoreCredential
@@ -62,7 +62,7 @@ export declare const fromCoreCredential: (
6262
6363
```ts
6464
export declare const toCoreCredential: (
65-
i: { readonly _tag: "KeyHash"; readonly hash: string } | { readonly _tag: "ScriptHash"; readonly hash: string },
65+
i: { readonly hash: string; readonly _tag: "KeyHash" } | { readonly hash: string; readonly _tag: "ScriptHash" },
6666
overrideOptions?: ParseOptions
6767
) => CoreKeyHash.KeyHash | CoreScriptHash.ScriptHash
6868
```

‎docs/content/docs/modules/sdk/PoolParams.mdx‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,19 @@ export declare const fromCore: (
3636
overrideOptions?: ParseOptions
3737
) => {
3838
readonly _tag: "PoolParams"
39-
readonly operator: { readonly _tag: "PoolKeyHash"; readonly hash: string }
40-
readonly vrfKeyhash: { readonly _tag: "VrfKeyHash"; readonly hash: string }
39+
readonly operator: { readonly hash: string; readonly _tag: "PoolKeyHash" }
40+
readonly vrfKeyhash: { readonly hash: string; readonly _tag: "VrfKeyHash" }
4141
readonly pledge: string
4242
readonly cost: string
4343
readonly margin: { readonly numerator: string; readonly denominator: string }
4444
readonly rewardAccount: {
45-
readonly _tag: "RewardAccount"
4645
readonly networkId: number
4746
readonly stakeCredential:
48-
| { readonly _tag: "KeyHash"; readonly hash: string }
49-
| { readonly _tag: "ScriptHash"; readonly hash: string }
47+
| { readonly hash: string; readonly _tag: "KeyHash" }
48+
| { readonly hash: string; readonly _tag: "ScriptHash" }
49+
readonly _tag: "RewardAccount"
5050
}
51-
readonly poolOwners: readonly { readonly _tag: "KeyHash"; readonly hash: string }[]
51+
readonly poolOwners: readonly { readonly hash: string; readonly _tag: "KeyHash" }[]
5252
readonly relays: readonly (
5353
| {
5454
readonly _tag: "SingleHostAddr"
@@ -61,8 +61,8 @@ export declare const fromCore: (
6161
)[]
6262
readonly poolMetadata?:
6363
| {
64-
readonly _tag: "PoolMetadata"
6564
readonly hash: any
65+
readonly _tag: "PoolMetadata"
6666
readonly url: { readonly _tag: "Url"; readonly href: string }
6767
}
6868
| null
@@ -82,19 +82,19 @@ Convert from SDK PoolParams to Core PoolParams (decode to strict form).
8282
export declare const toCore: (
8383
i: {
8484
readonly _tag: "PoolParams"
85-
readonly operator: { readonly _tag: "PoolKeyHash"; readonly hash: string }
86-
readonly vrfKeyhash: { readonly _tag: "VrfKeyHash"; readonly hash: string }
85+
readonly operator: { readonly hash: string; readonly _tag: "PoolKeyHash" }
86+
readonly vrfKeyhash: { readonly hash: string; readonly _tag: "VrfKeyHash" }
8787
readonly pledge: string
8888
readonly cost: string
8989
readonly margin: { readonly numerator: string; readonly denominator: string }
9090
readonly rewardAccount: {
91-
readonly _tag: "RewardAccount"
9291
readonly networkId: number
9392
readonly stakeCredential:
94-
| { readonly _tag: "KeyHash"; readonly hash: string }
95-
| { readonly _tag: "ScriptHash"; readonly hash: string }
93+
| { readonly hash: string; readonly _tag: "KeyHash" }
94+
| { readonly hash: string; readonly _tag: "ScriptHash" }
95+
readonly _tag: "RewardAccount"
9696
}
97-
readonly poolOwners: readonly { readonly _tag: "KeyHash"; readonly hash: string }[]
97+
readonly poolOwners: readonly { readonly hash: string; readonly _tag: "KeyHash" }[]
9898
readonly relays: readonly (
9999
| {
100100
readonly _tag: "SingleHostAddr"
@@ -107,8 +107,8 @@ export declare const toCore: (
107107
)[]
108108
readonly poolMetadata?:
109109
| {
110-
readonly _tag: "PoolMetadata"
111110
readonly hash: any
111+
readonly _tag: "PoolMetadata"
112112
readonly url: { readonly _tag: "Url"; readonly href: string }
113113
}
114114
| null

0 commit comments

Comments
 (0)