From 1cf2720f14de32802827545d6d1ec55dd8f8d11e Mon Sep 17 00:00:00 2001 From: solidsnakedev Date: Tue, 11 Nov 2025 13:32:02 -0700 Subject: [PATCH 1/2] fix(docs): update TSchema examples to use Core.TSchema namespace The docgen was failing because examples in TSchema.ts were importing TSchema directly from the package root, but after moving everything to the Core namespace, it's now available as Core.TSchema. Fixed all @example blocks to use: import { Core } from "@evolution-sdk/evolution" Core.TSchema.Struct(...) This fixes the CI failure in the docs build step. --- docs/next-env.d.ts | 2 +- .../{AddressStructure.ts.md => Address.ts.md} | 46 ++-- .../docs/modules/core/AddressEras.ts.md | 6 +- .../docs/modules/core/AddressTag.ts.md | 2 +- .../evolution/docs/modules/core/Anchor.ts.md | 2 +- .../docs/modules/core/AssetName.ts.md | 2 +- .../docs/modules/core/AuxiliaryData.ts.md | 2 +- .../docs/modules/core/AuxiliaryDataHash.ts.md | 2 +- .../docs/modules/core/BaseAddress.ts.md | 2 +- .../evolution/docs/modules/core/Bech32.ts.md | 2 +- .../evolution/docs/modules/core/BigInt.ts.md | 2 +- .../docs/modules/core/Bip32PrivateKey.ts.md | 2 +- .../docs/modules/core/Bip32PublicKey.ts.md | 2 +- .../evolution/docs/modules/core/Block.ts.md | 2 +- .../docs/modules/core/BlockBodyHash.ts.md | 2 +- .../docs/modules/core/BlockHeaderHash.ts.md | 2 +- .../docs/modules/core/BootstrapWitness.ts.md | 2 +- .../docs/modules/core/BoundedBytes.ts.md | 2 +- .../docs/modules/core/ByronAddress.ts.md | 2 +- .../evolution/docs/modules/core/Bytes.ts.md | 2 +- .../docs/modules/core/Bytes128.ts.md | 2 +- .../evolution/docs/modules/core/Bytes16.ts.md | 2 +- .../evolution/docs/modules/core/Bytes29.ts.md | 2 +- .../evolution/docs/modules/core/Bytes32.ts.md | 2 +- .../evolution/docs/modules/core/Bytes4.ts.md | 2 +- .../docs/modules/core/Bytes448.ts.md | 2 +- .../evolution/docs/modules/core/Bytes57.ts.md | 2 +- .../evolution/docs/modules/core/Bytes64.ts.md | 2 +- .../evolution/docs/modules/core/Bytes80.ts.md | 2 +- .../evolution/docs/modules/core/Bytes96.ts.md | 2 +- .../evolution/docs/modules/core/CBOR.ts.md | 2 +- .../docs/modules/core/Certificate.ts.md | 2 +- .../evolution/docs/modules/core/Codec.ts.md | 2 +- .../evolution/docs/modules/core/Coin.ts.md | 2 +- .../docs/modules/core/Combinator.ts.md | 2 +- .../core/CommitteeColdCredential.ts.md | 2 +- .../modules/core/CommitteeHotCredential.ts.md | 2 +- .../docs/modules/core/Constitution.ts.md | 2 +- .../docs/modules/core/CostModel.ts.md | 2 +- .../docs/modules/core/Credential.ts.md | 2 +- .../evolution/docs/modules/core/DRep.ts.md | 2 +- .../docs/modules/core/DRepCredential.ts.md | 2 +- .../evolution/docs/modules/core/Data.ts.md | 2 +- .../docs/modules/core/DataJson.ts.md | 2 +- .../docs/modules/core/DatumOption.ts.md | 2 +- .../evolution/docs/modules/core/DnsName.ts.md | 2 +- .../docs/modules/core/Ed25519Signature.ts.md | 2 +- .../docs/modules/core/EnterpriseAddress.ts.md | 2 +- .../evolution/docs/modules/core/EpochNo.ts.md | 2 +- .../docs/modules/core/FormatError.ts.md | 2 +- .../docs/modules/core/Function.ts.md | 2 +- .../docs/modules/core/GovernanceAction.ts.md | 2 +- .../evolution/docs/modules/core/Hash28.ts.md | 2 +- .../evolution/docs/modules/core/Header.ts.md | 2 +- .../docs/modules/core/HeaderBody.ts.md | 2 +- .../evolution/docs/modules/core/IPv4.ts.md | 2 +- .../evolution/docs/modules/core/IPv6.ts.md | 2 +- .../evolution/docs/modules/core/KESVkey.ts.md | 2 +- .../docs/modules/core/KesSignature.ts.md | 2 +- .../evolution/docs/modules/core/KeyHash.ts.md | 4 +- .../docs/modules/core/Language.ts.md | 2 +- .../docs/modules/core/Metadata.ts.md | 2 +- .../evolution/docs/modules/core/Mint.ts.md | 59 +++--- .../docs/modules/core/MultiAsset.ts.md | 2 +- .../docs/modules/core/MultiHostName.ts.md | 2 +- .../docs/modules/core/NativeScriptJSON.ts.md | 2 +- .../docs/modules/core/NativeScripts.ts.md | 2 +- .../docs/modules/core/NativeScriptsOLD.ts.md | 2 +- .../evolution/docs/modules/core/Natural.ts.md | 2 +- .../evolution/docs/modules/core/Network.ts.md | 2 +- .../docs/modules/core/NetworkId.ts.md | 2 +- .../docs/modules/core/NonZeroInt64.ts.md | 18 +- .../modules/core/NonnegativeInterval.ts.md | 2 +- .../evolution/docs/modules/core/Numeric.ts.md | 2 +- .../docs/modules/core/OperationalCert.ts.md | 2 +- .../docs/modules/core/PaymentAddress.ts.md | 2 +- .../docs/modules/core/PlutusV1.ts.md | 2 +- .../docs/modules/core/PlutusV2.ts.md | 2 +- .../docs/modules/core/PlutusV3.ts.md | 2 +- .../evolution/docs/modules/core/Pointer.ts.md | 2 +- .../docs/modules/core/PointerAddress.ts.md | 2 +- .../docs/modules/core/PolicyId.ts.md | 2 +- .../docs/modules/core/PoolKeyHash.ts.md | 2 +- .../docs/modules/core/PoolMetadata.ts.md | 2 +- .../docs/modules/core/PoolParams.ts.md | 2 +- .../evolution/docs/modules/core/Port.ts.md | 2 +- .../docs/modules/core/PositiveCoin.ts.md | 2 +- .../docs/modules/core/PrivateKey.ts.md | 2 +- .../docs/modules/core/ProposalProcedure.ts.md | 2 +- .../modules/core/ProposalProcedures.ts.md | 2 +- .../modules/core/ProtocolParamUpdate.ts.md | 2 +- .../docs/modules/core/ProtocolVersion.ts.md | 2 +- .../docs/modules/core/Redeemer.ts.md | 2 +- .../evolution/docs/modules/core/Relay.ts.md | 2 +- .../docs/modules/core/RewardAccount.ts.md | 2 +- .../docs/modules/core/RewardAddress.ts.md | 2 +- .../evolution/docs/modules/core/Script.ts.md | 2 +- .../docs/modules/core/ScriptDataHash.ts.md | 2 +- .../docs/modules/core/ScriptHash.ts.md | 2 +- .../docs/modules/core/ScriptRef.ts.md | 2 +- .../docs/modules/core/SingleHostAddr.ts.md | 2 +- .../docs/modules/core/SingleHostName.ts.md | 2 +- .../docs/modules/core/StakeReference.ts.md | 2 +- .../evolution/docs/modules/core/TSchema.ts.md | 38 ++-- .../evolution/docs/modules/core/Text.ts.md | 2 +- .../evolution/docs/modules/core/Text128.ts.md | 2 +- .../docs/modules/core/Transaction.ts.md | 2 +- .../docs/modules/core/TransactionBody.ts.md | 4 +- .../docs/modules/core/TransactionHash.ts.md | 2 +- .../docs/modules/core/TransactionIndex.ts.md | 2 +- .../docs/modules/core/TransactionInput.ts.md | 2 +- .../modules/core/TransactionMetadatum.ts.md | 2 +- .../core/TransactionMetadatumLabels.ts.md | 2 +- .../docs/modules/core/TransactionOutput.ts.md | 2 +- .../modules/core/TransactionWitnessSet.ts.md | 2 +- .../docs/modules/core/UnitInterval.ts.md | 2 +- .../evolution/docs/modules/core/Url.ts.md | 2 +- .../evolution/docs/modules/core/VKey.ts.md | 2 +- .../evolution/docs/modules/core/Value.ts.md | 2 +- .../docs/modules/core/VotingProcedures.ts.md | 2 +- .../evolution/docs/modules/core/VrfCert.ts.md | 2 +- .../docs/modules/core/VrfKeyHash.ts.md | 2 +- .../evolution/docs/modules/core/VrfVkey.ts.md | 2 +- .../docs/modules/core/Withdrawals.ts.md | 2 +- .../evolution/docs/modules/sdk/Address.ts.md | 108 +--------- .../{core => sdk}/AddressDetails.ts.md | 76 +------ .../evolution/docs/modules/sdk/Assets.ts.md | 198 +++++++++++++++++- .../docs/modules/sdk/Credential.ts.md | 22 +- packages/evolution/src/core/TSchema.ts | 40 ++-- 129 files changed, 438 insertions(+), 415 deletions(-) rename packages/evolution/docs/modules/core/{AddressStructure.ts.md => Address.ts.md} (69%) rename packages/evolution/docs/modules/{core => sdk}/AddressDetails.ts.md (55%) diff --git a/docs/next-env.d.ts b/docs/next-env.d.ts index 24c7c901..9edff1c7 100644 --- a/docs/next-env.d.ts +++ b/docs/next-env.d.ts @@ -1,6 +1,6 @@ /// /// -import "./out/dev/types/routes.d.ts"; +import "./.next/types/routes.d.ts"; // NOTE: This file should not be edited // see https://nextjs.org/docs/app/api-reference/config/typescript for more information. diff --git a/packages/evolution/docs/modules/core/AddressStructure.ts.md b/packages/evolution/docs/modules/core/Address.ts.md similarity index 69% rename from packages/evolution/docs/modules/core/AddressStructure.ts.md rename to packages/evolution/docs/modules/core/Address.ts.md index c4b2b49c..830a22fe 100644 --- a/packages/evolution/docs/modules/core/AddressStructure.ts.md +++ b/packages/evolution/docs/modules/core/Address.ts.md @@ -1,10 +1,10 @@ --- -title: core/AddressStructure.ts -nav_order: 3 +title: core/Address.ts +nav_order: 1 parent: Modules --- -## AddressStructure overview +## Address overview Added in v1.0.0 @@ -17,7 +17,7 @@ Added in v1.0.0 - [Functions](#functions) - [fromBech32](#frombech32) - [Schema](#schema) - - [AddressStructure (class)](#addressstructure-class) + - [Address (class)](#address-class) - [toString (method)](#tostring-method) - [[Symbol.for("nodejs.util.inspect.custom")] (method)](#symbolfornodejsutilinspectcustom-method) - [Transformations](#transformations) @@ -30,7 +30,7 @@ Added in v1.0.0 - [hasStakingCredential](#hasstakingcredential) - [isEnterprise](#isenterprise) - [utils](#utils-1) - - [AddressStructureError (class)](#addressstructureerror-class) + - [AddressError (class)](#addresserror-class) - [Either (namespace)](#either-namespace) - [fromBytes](#frombytes-1) - [fromHex](#fromhex-1) @@ -49,7 +49,7 @@ FastCheck arbitrary generator for testing **Signature** ```ts -export declare const arbitrary: FastCheck.Arbitrary +export declare const arbitrary: FastCheck.Arbitrary
``` Added in v1.0.0 @@ -63,19 +63,19 @@ Sync functions using Function module utilities **Signature** ```ts -export declare const fromBech32: (input: string) => AddressStructure +export declare const fromBech32: (input: string) => Address ``` Added in v1.0.0 # Schema -## AddressStructure (class) +## Address (class) **Signature** ```ts -export declare class AddressStructure +export declare class Address ``` Added in v1.0.0 @@ -107,7 +107,7 @@ Transform from Bech32 string to AddressStructure ```ts export declare const FromBech32: Schema.transformOrFail< typeof Schema.String, - Schema.SchemaClass, + Schema.SchemaClass, never > ``` @@ -124,7 +124,7 @@ Handles both BaseAddress (57 bytes) and EnterpriseAddress (29 bytes) ```ts export declare const FromBytes: Schema.transformOrFail< Schema.Union<[Schema.filter, Schema.filter]>, - Schema.SchemaClass, + Schema.SchemaClass, never > ``` @@ -142,7 +142,7 @@ export declare const FromHex: Schema.transform< Schema.transform, Schema.Schema>, Schema.transformOrFail< Schema.Union<[Schema.filter, Schema.filter]>, - Schema.SchemaClass, + Schema.SchemaClass, never > > @@ -159,7 +159,7 @@ Check if two AddressStructure instances are equal. **Signature** ```ts -export declare const equals: (a: AddressStructure, b: AddressStructure) => boolean +export declare const equals: (a: Address, b: Address) => boolean ``` Added in v1.0.0 @@ -171,7 +171,7 @@ Get network ID from AddressStructure **Signature** ```ts -export declare const getNetworkId: (address: AddressStructure) => NetworkId.NetworkId +export declare const getNetworkId: (address: Address) => NetworkId.NetworkId ``` Added in v1.0.0 @@ -183,7 +183,7 @@ Check if AddressStructure has staking credential (BaseAddress-like) **Signature** ```ts -export declare const hasStakingCredential: (address: AddressStructure) => boolean +export declare const hasStakingCredential: (address: Address) => boolean ``` Added in v1.0.0 @@ -195,19 +195,19 @@ Check if AddressStructure is enterprise-like (no staking credential) **Signature** ```ts -export declare const isEnterprise: (address: AddressStructure) => boolean +export declare const isEnterprise: (address: Address) => boolean ``` Added in v1.0.0 # utils -## AddressStructureError (class) +## AddressError (class) **Signature** ```ts -export declare class AddressStructureError +export declare class AddressError ``` ## Either (namespace) @@ -217,7 +217,7 @@ export declare class AddressStructureError **Signature** ```ts -export declare const fromBytes: (input: any) => AddressStructure +export declare const fromBytes: (input: any) => Address ``` ## fromHex @@ -225,7 +225,7 @@ export declare const fromBytes: (input: any) => AddressStructure **Signature** ```ts -export declare const fromHex: (input: string) => AddressStructure +export declare const fromHex: (input: string) => Address ``` ## toBech32 @@ -233,7 +233,7 @@ export declare const fromHex: (input: string) => AddressStructure **Signature** ```ts -export declare const toBech32: (input: AddressStructure) => string +export declare const toBech32: (input: Address) => string ``` ## toBytes @@ -241,7 +241,7 @@ export declare const toBech32: (input: AddressStructure) => string **Signature** ```ts -export declare const toBytes: (input: AddressStructure) => any +export declare const toBytes: (input: Address) => any ``` ## toHex @@ -249,5 +249,5 @@ export declare const toBytes: (input: AddressStructure) => any **Signature** ```ts -export declare const toHex: (input: AddressStructure) => string +export declare const toHex: (input: Address) => string ``` diff --git a/packages/evolution/docs/modules/core/AddressEras.ts.md b/packages/evolution/docs/modules/core/AddressEras.ts.md index 8fee6a8c..b8bc7818 100644 --- a/packages/evolution/docs/modules/core/AddressEras.ts.md +++ b/packages/evolution/docs/modules/core/AddressEras.ts.md @@ -21,7 +21,7 @@ parent: Modules - [model](#model) - [AddressEras](#addresseras) - [AddressEras (type alias)](#addresseras-type-alias) - - [AddressError (class)](#addresserror-class) + - [AddressErasError (class)](#addresseraserror-class) - [parsing](#parsing) - [fromBech32](#frombech32) - [fromBytes](#frombytes) @@ -156,14 +156,14 @@ export type AddressEras = typeof AddressEras.Type Added in v2.0.0 -## AddressError (class) +## AddressErasError (class) Error thrown when address operations fail **Signature** ```ts -export declare class AddressError +export declare class AddressErasError ``` Added in v2.0.0 diff --git a/packages/evolution/docs/modules/core/AddressTag.ts.md b/packages/evolution/docs/modules/core/AddressTag.ts.md index 96e3f00c..11fd4212 100644 --- a/packages/evolution/docs/modules/core/AddressTag.ts.md +++ b/packages/evolution/docs/modules/core/AddressTag.ts.md @@ -1,6 +1,6 @@ --- title: core/AddressTag.ts -nav_order: 4 +nav_order: 3 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Anchor.ts.md b/packages/evolution/docs/modules/core/Anchor.ts.md index 8c3329ae..f5a08da6 100644 --- a/packages/evolution/docs/modules/core/Anchor.ts.md +++ b/packages/evolution/docs/modules/core/Anchor.ts.md @@ -1,6 +1,6 @@ --- title: core/Anchor.ts -nav_order: 5 +nav_order: 4 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/AssetName.ts.md b/packages/evolution/docs/modules/core/AssetName.ts.md index 717ac341..d6cbb5c0 100644 --- a/packages/evolution/docs/modules/core/AssetName.ts.md +++ b/packages/evolution/docs/modules/core/AssetName.ts.md @@ -1,6 +1,6 @@ --- title: core/AssetName.ts -nav_order: 6 +nav_order: 5 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/AuxiliaryData.ts.md b/packages/evolution/docs/modules/core/AuxiliaryData.ts.md index 7b1e84f6..3a3ac31f 100644 --- a/packages/evolution/docs/modules/core/AuxiliaryData.ts.md +++ b/packages/evolution/docs/modules/core/AuxiliaryData.ts.md @@ -1,6 +1,6 @@ --- title: core/AuxiliaryData.ts -nav_order: 7 +nav_order: 6 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/AuxiliaryDataHash.ts.md b/packages/evolution/docs/modules/core/AuxiliaryDataHash.ts.md index e70eeee5..7352718c 100644 --- a/packages/evolution/docs/modules/core/AuxiliaryDataHash.ts.md +++ b/packages/evolution/docs/modules/core/AuxiliaryDataHash.ts.md @@ -1,6 +1,6 @@ --- title: core/AuxiliaryDataHash.ts -nav_order: 8 +nav_order: 7 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/BaseAddress.ts.md b/packages/evolution/docs/modules/core/BaseAddress.ts.md index 330638f3..a219fb07 100644 --- a/packages/evolution/docs/modules/core/BaseAddress.ts.md +++ b/packages/evolution/docs/modules/core/BaseAddress.ts.md @@ -1,6 +1,6 @@ --- title: core/BaseAddress.ts -nav_order: 9 +nav_order: 8 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bech32.ts.md b/packages/evolution/docs/modules/core/Bech32.ts.md index 46bb9e01..73701020 100644 --- a/packages/evolution/docs/modules/core/Bech32.ts.md +++ b/packages/evolution/docs/modules/core/Bech32.ts.md @@ -1,6 +1,6 @@ --- title: core/Bech32.ts -nav_order: 10 +nav_order: 9 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/BigInt.ts.md b/packages/evolution/docs/modules/core/BigInt.ts.md index a63d681b..952baca2 100644 --- a/packages/evolution/docs/modules/core/BigInt.ts.md +++ b/packages/evolution/docs/modules/core/BigInt.ts.md @@ -1,6 +1,6 @@ --- title: core/BigInt.ts -nav_order: 11 +nav_order: 10 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bip32PrivateKey.ts.md b/packages/evolution/docs/modules/core/Bip32PrivateKey.ts.md index fd3a7152..92611c0d 100644 --- a/packages/evolution/docs/modules/core/Bip32PrivateKey.ts.md +++ b/packages/evolution/docs/modules/core/Bip32PrivateKey.ts.md @@ -1,6 +1,6 @@ --- title: core/Bip32PrivateKey.ts -nav_order: 12 +nav_order: 11 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bip32PublicKey.ts.md b/packages/evolution/docs/modules/core/Bip32PublicKey.ts.md index 61162474..c7a501ac 100644 --- a/packages/evolution/docs/modules/core/Bip32PublicKey.ts.md +++ b/packages/evolution/docs/modules/core/Bip32PublicKey.ts.md @@ -1,6 +1,6 @@ --- title: core/Bip32PublicKey.ts -nav_order: 13 +nav_order: 12 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Block.ts.md b/packages/evolution/docs/modules/core/Block.ts.md index 3fa36b7b..11ecffbd 100644 --- a/packages/evolution/docs/modules/core/Block.ts.md +++ b/packages/evolution/docs/modules/core/Block.ts.md @@ -1,6 +1,6 @@ --- title: core/Block.ts -nav_order: 14 +nav_order: 13 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/BlockBodyHash.ts.md b/packages/evolution/docs/modules/core/BlockBodyHash.ts.md index 3da78492..1e80ca39 100644 --- a/packages/evolution/docs/modules/core/BlockBodyHash.ts.md +++ b/packages/evolution/docs/modules/core/BlockBodyHash.ts.md @@ -1,6 +1,6 @@ --- title: core/BlockBodyHash.ts -nav_order: 15 +nav_order: 14 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/BlockHeaderHash.ts.md b/packages/evolution/docs/modules/core/BlockHeaderHash.ts.md index 2bb7c7f1..5298ea68 100644 --- a/packages/evolution/docs/modules/core/BlockHeaderHash.ts.md +++ b/packages/evolution/docs/modules/core/BlockHeaderHash.ts.md @@ -1,6 +1,6 @@ --- title: core/BlockHeaderHash.ts -nav_order: 16 +nav_order: 15 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/BootstrapWitness.ts.md b/packages/evolution/docs/modules/core/BootstrapWitness.ts.md index 573226bf..bd194b4a 100644 --- a/packages/evolution/docs/modules/core/BootstrapWitness.ts.md +++ b/packages/evolution/docs/modules/core/BootstrapWitness.ts.md @@ -1,6 +1,6 @@ --- title: core/BootstrapWitness.ts -nav_order: 17 +nav_order: 16 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/BoundedBytes.ts.md b/packages/evolution/docs/modules/core/BoundedBytes.ts.md index a02e701c..b3eed121 100644 --- a/packages/evolution/docs/modules/core/BoundedBytes.ts.md +++ b/packages/evolution/docs/modules/core/BoundedBytes.ts.md @@ -1,6 +1,6 @@ --- title: core/BoundedBytes.ts -nav_order: 18 +nav_order: 17 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/ByronAddress.ts.md b/packages/evolution/docs/modules/core/ByronAddress.ts.md index 1d00c9e4..1716c655 100644 --- a/packages/evolution/docs/modules/core/ByronAddress.ts.md +++ b/packages/evolution/docs/modules/core/ByronAddress.ts.md @@ -1,6 +1,6 @@ --- title: core/ByronAddress.ts -nav_order: 19 +nav_order: 18 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes.ts.md b/packages/evolution/docs/modules/core/Bytes.ts.md index 1972ce90..e16eb42a 100644 --- a/packages/evolution/docs/modules/core/Bytes.ts.md +++ b/packages/evolution/docs/modules/core/Bytes.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes.ts -nav_order: 20 +nav_order: 19 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes128.ts.md b/packages/evolution/docs/modules/core/Bytes128.ts.md index 4b6d734e..f1a543ee 100644 --- a/packages/evolution/docs/modules/core/Bytes128.ts.md +++ b/packages/evolution/docs/modules/core/Bytes128.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes128.ts -nav_order: 21 +nav_order: 20 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes16.ts.md b/packages/evolution/docs/modules/core/Bytes16.ts.md index b593acef..45e6be0c 100644 --- a/packages/evolution/docs/modules/core/Bytes16.ts.md +++ b/packages/evolution/docs/modules/core/Bytes16.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes16.ts -nav_order: 22 +nav_order: 21 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes29.ts.md b/packages/evolution/docs/modules/core/Bytes29.ts.md index d7543721..426800f8 100644 --- a/packages/evolution/docs/modules/core/Bytes29.ts.md +++ b/packages/evolution/docs/modules/core/Bytes29.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes29.ts -nav_order: 23 +nav_order: 22 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes32.ts.md b/packages/evolution/docs/modules/core/Bytes32.ts.md index b9db0e07..7972d33e 100644 --- a/packages/evolution/docs/modules/core/Bytes32.ts.md +++ b/packages/evolution/docs/modules/core/Bytes32.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes32.ts -nav_order: 24 +nav_order: 23 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes4.ts.md b/packages/evolution/docs/modules/core/Bytes4.ts.md index d7a7d51a..4666bc63 100644 --- a/packages/evolution/docs/modules/core/Bytes4.ts.md +++ b/packages/evolution/docs/modules/core/Bytes4.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes4.ts -nav_order: 25 +nav_order: 24 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes448.ts.md b/packages/evolution/docs/modules/core/Bytes448.ts.md index 0d998874..39824770 100644 --- a/packages/evolution/docs/modules/core/Bytes448.ts.md +++ b/packages/evolution/docs/modules/core/Bytes448.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes448.ts -nav_order: 26 +nav_order: 25 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes57.ts.md b/packages/evolution/docs/modules/core/Bytes57.ts.md index 652652bc..ad668e8f 100644 --- a/packages/evolution/docs/modules/core/Bytes57.ts.md +++ b/packages/evolution/docs/modules/core/Bytes57.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes57.ts -nav_order: 27 +nav_order: 26 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes64.ts.md b/packages/evolution/docs/modules/core/Bytes64.ts.md index 61ed9423..9bc2fd67 100644 --- a/packages/evolution/docs/modules/core/Bytes64.ts.md +++ b/packages/evolution/docs/modules/core/Bytes64.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes64.ts -nav_order: 28 +nav_order: 27 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes80.ts.md b/packages/evolution/docs/modules/core/Bytes80.ts.md index 496f9a25..3795cfca 100644 --- a/packages/evolution/docs/modules/core/Bytes80.ts.md +++ b/packages/evolution/docs/modules/core/Bytes80.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes80.ts -nav_order: 29 +nav_order: 28 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Bytes96.ts.md b/packages/evolution/docs/modules/core/Bytes96.ts.md index 5a4853e5..8cbda38e 100644 --- a/packages/evolution/docs/modules/core/Bytes96.ts.md +++ b/packages/evolution/docs/modules/core/Bytes96.ts.md @@ -1,6 +1,6 @@ --- title: core/Bytes96.ts -nav_order: 30 +nav_order: 29 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/CBOR.ts.md b/packages/evolution/docs/modules/core/CBOR.ts.md index 043b7fcb..d5bc82f1 100644 --- a/packages/evolution/docs/modules/core/CBOR.ts.md +++ b/packages/evolution/docs/modules/core/CBOR.ts.md @@ -1,6 +1,6 @@ --- title: core/CBOR.ts -nav_order: 31 +nav_order: 30 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Certificate.ts.md b/packages/evolution/docs/modules/core/Certificate.ts.md index b6b15ed4..14ceed9e 100644 --- a/packages/evolution/docs/modules/core/Certificate.ts.md +++ b/packages/evolution/docs/modules/core/Certificate.ts.md @@ -1,6 +1,6 @@ --- title: core/Certificate.ts -nav_order: 32 +nav_order: 31 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Codec.ts.md b/packages/evolution/docs/modules/core/Codec.ts.md index 63c5d7df..3fea0ddb 100644 --- a/packages/evolution/docs/modules/core/Codec.ts.md +++ b/packages/evolution/docs/modules/core/Codec.ts.md @@ -1,6 +1,6 @@ --- title: core/Codec.ts -nav_order: 33 +nav_order: 32 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Coin.ts.md b/packages/evolution/docs/modules/core/Coin.ts.md index c93c906f..934207b0 100644 --- a/packages/evolution/docs/modules/core/Coin.ts.md +++ b/packages/evolution/docs/modules/core/Coin.ts.md @@ -1,6 +1,6 @@ --- title: core/Coin.ts -nav_order: 34 +nav_order: 33 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Combinator.ts.md b/packages/evolution/docs/modules/core/Combinator.ts.md index f7ce67d4..126b808e 100644 --- a/packages/evolution/docs/modules/core/Combinator.ts.md +++ b/packages/evolution/docs/modules/core/Combinator.ts.md @@ -1,6 +1,6 @@ --- title: core/Combinator.ts -nav_order: 35 +nav_order: 34 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/CommitteeColdCredential.ts.md b/packages/evolution/docs/modules/core/CommitteeColdCredential.ts.md index f2f6618c..a4de700a 100644 --- a/packages/evolution/docs/modules/core/CommitteeColdCredential.ts.md +++ b/packages/evolution/docs/modules/core/CommitteeColdCredential.ts.md @@ -1,6 +1,6 @@ --- title: core/CommitteeColdCredential.ts -nav_order: 36 +nav_order: 35 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/CommitteeHotCredential.ts.md b/packages/evolution/docs/modules/core/CommitteeHotCredential.ts.md index 318653bc..b3bca55c 100644 --- a/packages/evolution/docs/modules/core/CommitteeHotCredential.ts.md +++ b/packages/evolution/docs/modules/core/CommitteeHotCredential.ts.md @@ -1,6 +1,6 @@ --- title: core/CommitteeHotCredential.ts -nav_order: 37 +nav_order: 36 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Constitution.ts.md b/packages/evolution/docs/modules/core/Constitution.ts.md index b0ff25c7..1fa703b4 100644 --- a/packages/evolution/docs/modules/core/Constitution.ts.md +++ b/packages/evolution/docs/modules/core/Constitution.ts.md @@ -1,6 +1,6 @@ --- title: core/Constitution.ts -nav_order: 38 +nav_order: 37 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/CostModel.ts.md b/packages/evolution/docs/modules/core/CostModel.ts.md index 7bbb9db3..4d56b582 100644 --- a/packages/evolution/docs/modules/core/CostModel.ts.md +++ b/packages/evolution/docs/modules/core/CostModel.ts.md @@ -1,6 +1,6 @@ --- title: core/CostModel.ts -nav_order: 39 +nav_order: 38 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Credential.ts.md b/packages/evolution/docs/modules/core/Credential.ts.md index f83d517f..7a563794 100644 --- a/packages/evolution/docs/modules/core/Credential.ts.md +++ b/packages/evolution/docs/modules/core/Credential.ts.md @@ -1,6 +1,6 @@ --- title: core/Credential.ts -nav_order: 40 +nav_order: 39 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/DRep.ts.md b/packages/evolution/docs/modules/core/DRep.ts.md index ebeac248..7072faa4 100644 --- a/packages/evolution/docs/modules/core/DRep.ts.md +++ b/packages/evolution/docs/modules/core/DRep.ts.md @@ -1,6 +1,6 @@ --- title: core/DRep.ts -nav_order: 45 +nav_order: 44 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/DRepCredential.ts.md b/packages/evolution/docs/modules/core/DRepCredential.ts.md index 37c3fa48..670a1687 100644 --- a/packages/evolution/docs/modules/core/DRepCredential.ts.md +++ b/packages/evolution/docs/modules/core/DRepCredential.ts.md @@ -1,6 +1,6 @@ --- title: core/DRepCredential.ts -nav_order: 46 +nav_order: 45 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Data.ts.md b/packages/evolution/docs/modules/core/Data.ts.md index ed652b8b..1a7265b3 100644 --- a/packages/evolution/docs/modules/core/Data.ts.md +++ b/packages/evolution/docs/modules/core/Data.ts.md @@ -1,6 +1,6 @@ --- title: core/Data.ts -nav_order: 41 +nav_order: 40 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/DataJson.ts.md b/packages/evolution/docs/modules/core/DataJson.ts.md index 7f1ac651..949e8e74 100644 --- a/packages/evolution/docs/modules/core/DataJson.ts.md +++ b/packages/evolution/docs/modules/core/DataJson.ts.md @@ -1,6 +1,6 @@ --- title: core/DataJson.ts -nav_order: 42 +nav_order: 41 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/DatumOption.ts.md b/packages/evolution/docs/modules/core/DatumOption.ts.md index 644b43f0..a7acbac3 100644 --- a/packages/evolution/docs/modules/core/DatumOption.ts.md +++ b/packages/evolution/docs/modules/core/DatumOption.ts.md @@ -1,6 +1,6 @@ --- title: core/DatumOption.ts -nav_order: 43 +nav_order: 42 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/DnsName.ts.md b/packages/evolution/docs/modules/core/DnsName.ts.md index a6566f4a..017f7d7f 100644 --- a/packages/evolution/docs/modules/core/DnsName.ts.md +++ b/packages/evolution/docs/modules/core/DnsName.ts.md @@ -1,6 +1,6 @@ --- title: core/DnsName.ts -nav_order: 44 +nav_order: 43 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Ed25519Signature.ts.md b/packages/evolution/docs/modules/core/Ed25519Signature.ts.md index 58d69d76..80c57f16 100644 --- a/packages/evolution/docs/modules/core/Ed25519Signature.ts.md +++ b/packages/evolution/docs/modules/core/Ed25519Signature.ts.md @@ -1,6 +1,6 @@ --- title: core/Ed25519Signature.ts -nav_order: 47 +nav_order: 46 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/EnterpriseAddress.ts.md b/packages/evolution/docs/modules/core/EnterpriseAddress.ts.md index f2100258..71048f7e 100644 --- a/packages/evolution/docs/modules/core/EnterpriseAddress.ts.md +++ b/packages/evolution/docs/modules/core/EnterpriseAddress.ts.md @@ -1,6 +1,6 @@ --- title: core/EnterpriseAddress.ts -nav_order: 48 +nav_order: 47 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/EpochNo.ts.md b/packages/evolution/docs/modules/core/EpochNo.ts.md index fa5f3f20..3ee075b1 100644 --- a/packages/evolution/docs/modules/core/EpochNo.ts.md +++ b/packages/evolution/docs/modules/core/EpochNo.ts.md @@ -1,6 +1,6 @@ --- title: core/EpochNo.ts -nav_order: 49 +nav_order: 48 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/FormatError.ts.md b/packages/evolution/docs/modules/core/FormatError.ts.md index 9e12021c..782168dc 100644 --- a/packages/evolution/docs/modules/core/FormatError.ts.md +++ b/packages/evolution/docs/modules/core/FormatError.ts.md @@ -1,6 +1,6 @@ --- title: core/FormatError.ts -nav_order: 50 +nav_order: 49 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Function.ts.md b/packages/evolution/docs/modules/core/Function.ts.md index 5cdf002b..48d27c49 100644 --- a/packages/evolution/docs/modules/core/Function.ts.md +++ b/packages/evolution/docs/modules/core/Function.ts.md @@ -1,6 +1,6 @@ --- title: core/Function.ts -nav_order: 51 +nav_order: 50 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/GovernanceAction.ts.md b/packages/evolution/docs/modules/core/GovernanceAction.ts.md index e188550c..fa5140b2 100644 --- a/packages/evolution/docs/modules/core/GovernanceAction.ts.md +++ b/packages/evolution/docs/modules/core/GovernanceAction.ts.md @@ -1,6 +1,6 @@ --- title: core/GovernanceAction.ts -nav_order: 52 +nav_order: 51 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Hash28.ts.md b/packages/evolution/docs/modules/core/Hash28.ts.md index dba5611e..f477912b 100644 --- a/packages/evolution/docs/modules/core/Hash28.ts.md +++ b/packages/evolution/docs/modules/core/Hash28.ts.md @@ -1,6 +1,6 @@ --- title: core/Hash28.ts -nav_order: 53 +nav_order: 52 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Header.ts.md b/packages/evolution/docs/modules/core/Header.ts.md index 8f207d85..2e93484c 100644 --- a/packages/evolution/docs/modules/core/Header.ts.md +++ b/packages/evolution/docs/modules/core/Header.ts.md @@ -1,6 +1,6 @@ --- title: core/Header.ts -nav_order: 54 +nav_order: 53 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/HeaderBody.ts.md b/packages/evolution/docs/modules/core/HeaderBody.ts.md index cfa66cd0..43fc4c88 100644 --- a/packages/evolution/docs/modules/core/HeaderBody.ts.md +++ b/packages/evolution/docs/modules/core/HeaderBody.ts.md @@ -1,6 +1,6 @@ --- title: core/HeaderBody.ts -nav_order: 55 +nav_order: 54 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/IPv4.ts.md b/packages/evolution/docs/modules/core/IPv4.ts.md index 29f0f13b..37fae94c 100644 --- a/packages/evolution/docs/modules/core/IPv4.ts.md +++ b/packages/evolution/docs/modules/core/IPv4.ts.md @@ -1,6 +1,6 @@ --- title: core/IPv4.ts -nav_order: 56 +nav_order: 55 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/IPv6.ts.md b/packages/evolution/docs/modules/core/IPv6.ts.md index 4e5c5f61..ac2c8208 100644 --- a/packages/evolution/docs/modules/core/IPv6.ts.md +++ b/packages/evolution/docs/modules/core/IPv6.ts.md @@ -1,6 +1,6 @@ --- title: core/IPv6.ts -nav_order: 57 +nav_order: 56 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/KESVkey.ts.md b/packages/evolution/docs/modules/core/KESVkey.ts.md index 65d29168..1ec7a3c7 100644 --- a/packages/evolution/docs/modules/core/KESVkey.ts.md +++ b/packages/evolution/docs/modules/core/KESVkey.ts.md @@ -1,6 +1,6 @@ --- title: core/KESVkey.ts -nav_order: 59 +nav_order: 58 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/KesSignature.ts.md b/packages/evolution/docs/modules/core/KesSignature.ts.md index 518ac33d..d2396b1d 100644 --- a/packages/evolution/docs/modules/core/KesSignature.ts.md +++ b/packages/evolution/docs/modules/core/KesSignature.ts.md @@ -1,6 +1,6 @@ --- title: core/KesSignature.ts -nav_order: 58 +nav_order: 57 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/KeyHash.ts.md b/packages/evolution/docs/modules/core/KeyHash.ts.md index 2763c067..50c5be3a 100644 --- a/packages/evolution/docs/modules/core/KeyHash.ts.md +++ b/packages/evolution/docs/modules/core/KeyHash.ts.md @@ -1,6 +1,6 @@ --- title: core/KeyHash.ts -nav_order: 60 +nav_order: 59 parent: Modules --- @@ -200,7 +200,7 @@ Added in v2.0.0 **Signature** ```ts -toJSON(): string +toJSON() ``` ### toString (method) diff --git a/packages/evolution/docs/modules/core/Language.ts.md b/packages/evolution/docs/modules/core/Language.ts.md index e74cd6a6..9af999b9 100644 --- a/packages/evolution/docs/modules/core/Language.ts.md +++ b/packages/evolution/docs/modules/core/Language.ts.md @@ -1,6 +1,6 @@ --- title: core/Language.ts -nav_order: 61 +nav_order: 60 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Metadata.ts.md b/packages/evolution/docs/modules/core/Metadata.ts.md index 90678f58..d0800936 100644 --- a/packages/evolution/docs/modules/core/Metadata.ts.md +++ b/packages/evolution/docs/modules/core/Metadata.ts.md @@ -1,6 +1,6 @@ --- title: core/Metadata.ts -nav_order: 62 +nav_order: 61 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Mint.ts.md b/packages/evolution/docs/modules/core/Mint.ts.md index ce549c2f..99133a28 100644 --- a/packages/evolution/docs/modules/core/Mint.ts.md +++ b/packages/evolution/docs/modules/core/Mint.ts.md @@ -1,6 +1,6 @@ --- title: core/Mint.ts -nav_order: 63 +nav_order: 62 parent: Modules --- @@ -61,9 +61,7 @@ FastCheck arbitrary for generating random Mint instances. **Signature** ```ts -export declare const arbitrary: FastCheck.Arbitrary< - Map> & Brand<"Mint"> -> +export declare const arbitrary: FastCheck.Arbitrary>> ``` Added in v2.0.0 @@ -130,7 +128,7 @@ Encode Mint to CBOR bytes. ```ts export declare const toCBORBytes: ( - input: Map> & Brand<"Mint">, + input: Map>, options?: CBOR.CodecOptions ) => Uint8Array ``` @@ -145,7 +143,7 @@ Encode Mint to CBOR hex string. ```ts export declare const toCBORHex: ( - input: Map> & Brand<"Mint">, + input: Map>, options?: CBOR.CodecOptions ) => string ``` @@ -208,7 +206,7 @@ Parse Mint from CBOR bytes. export declare const fromCBORBytes: ( bytes: Uint8Array, options?: CBOR.CodecOptions -) => Map> & Brand<"Mint"> +) => Map> ``` Added in v2.0.0 @@ -223,7 +221,7 @@ Parse Mint from CBOR hex string. export declare const fromCBORHex: ( hex: string, options?: CBOR.CodecOptions -) => Map> & Brand<"Mint"> +) => Map> ``` Added in v2.0.0 @@ -252,7 +250,7 @@ Check if a value is a valid Mint. export declare const is: ( u: unknown, overrideOptions?: ParseOptions | number -) => u is Map> & Brand<"Mint"> +) => u is Map> ``` Added in v2.0.0 @@ -317,8 +315,8 @@ export declare const FromCBORBytes: ( Schema.transformOrFail< Schema.SchemaClass>, ReadonlyMap>, never>, Schema.SchemaClass< - Map> & Brand<"Mint">, - Map> & Brand<"Mint">, + Map>, + Map>, never >, never @@ -349,8 +347,8 @@ export declare const FromCBORHex: ( Schema.transformOrFail< Schema.SchemaClass>, ReadonlyMap>, never>, Schema.SchemaClass< - Map> & Brand<"Mint">, - Map> & Brand<"Mint">, + Map>, + Map>, never >, never @@ -381,8 +379,8 @@ Where: export declare const FromCDDL: Schema.transformOrFail< Schema.SchemaClass>, ReadonlyMap>, never>, Schema.SchemaClass< - Map> & Brand<"Mint">, - Map> & Brand<"Mint">, + Map>, + Map>, never >, never @@ -406,23 +404,28 @@ The structure is: policy_id => { asset_name => nonZeroInt64 } **Signature** ```ts -export declare const Mint: Schema.brand< - Schema.Map$< - typeof PolicyId.PolicyId, - Schema.transform< - Schema.Array$< - Schema.Tuple2< - typeof AssetName.AssetName, - Schema.Union<[Schema.refine, Schema.refine]> +export declare const Mint: Schema.transform< + Schema.Array$< + Schema.Tuple2< + typeof PolicyId.PolicyId, + Schema.transform< + Schema.Array$< + Schema.Tuple2< + typeof AssetName.AssetName, + Schema.Union<[Schema.refine, Schema.refine]> + > + >, + Schema.MapFromSelf< + Schema.SchemaClass, + Schema.SchemaClass > - >, - Schema.MapFromSelf< - Schema.SchemaClass, - Schema.SchemaClass > > >, - "Mint" + Schema.MapFromSelf< + Schema.SchemaClass, + Schema.SchemaClass, Map, never> + > > ``` diff --git a/packages/evolution/docs/modules/core/MultiAsset.ts.md b/packages/evolution/docs/modules/core/MultiAsset.ts.md index 4881dbf1..5fa6ffe5 100644 --- a/packages/evolution/docs/modules/core/MultiAsset.ts.md +++ b/packages/evolution/docs/modules/core/MultiAsset.ts.md @@ -1,6 +1,6 @@ --- title: core/MultiAsset.ts -nav_order: 64 +nav_order: 63 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/MultiHostName.ts.md b/packages/evolution/docs/modules/core/MultiHostName.ts.md index e3e63674..742cb26d 100644 --- a/packages/evolution/docs/modules/core/MultiHostName.ts.md +++ b/packages/evolution/docs/modules/core/MultiHostName.ts.md @@ -1,6 +1,6 @@ --- title: core/MultiHostName.ts -nav_order: 65 +nav_order: 64 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/NativeScriptJSON.ts.md b/packages/evolution/docs/modules/core/NativeScriptJSON.ts.md index ae415fb0..50cbb82c 100644 --- a/packages/evolution/docs/modules/core/NativeScriptJSON.ts.md +++ b/packages/evolution/docs/modules/core/NativeScriptJSON.ts.md @@ -1,6 +1,6 @@ --- title: core/NativeScriptJSON.ts -nav_order: 66 +nav_order: 65 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/NativeScripts.ts.md b/packages/evolution/docs/modules/core/NativeScripts.ts.md index 27e39a55..e012d718 100644 --- a/packages/evolution/docs/modules/core/NativeScripts.ts.md +++ b/packages/evolution/docs/modules/core/NativeScripts.ts.md @@ -1,6 +1,6 @@ --- title: core/NativeScripts.ts -nav_order: 67 +nav_order: 66 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/NativeScriptsOLD.ts.md b/packages/evolution/docs/modules/core/NativeScriptsOLD.ts.md index ae87a92a..a85d0369 100644 --- a/packages/evolution/docs/modules/core/NativeScriptsOLD.ts.md +++ b/packages/evolution/docs/modules/core/NativeScriptsOLD.ts.md @@ -1,6 +1,6 @@ --- title: core/NativeScriptsOLD.ts -nav_order: 68 +nav_order: 67 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Natural.ts.md b/packages/evolution/docs/modules/core/Natural.ts.md index 3b3fdcbd..d63308f1 100644 --- a/packages/evolution/docs/modules/core/Natural.ts.md +++ b/packages/evolution/docs/modules/core/Natural.ts.md @@ -1,6 +1,6 @@ --- title: core/Natural.ts -nav_order: 69 +nav_order: 68 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Network.ts.md b/packages/evolution/docs/modules/core/Network.ts.md index bef2b455..8643663c 100644 --- a/packages/evolution/docs/modules/core/Network.ts.md +++ b/packages/evolution/docs/modules/core/Network.ts.md @@ -1,6 +1,6 @@ --- title: core/Network.ts -nav_order: 70 +nav_order: 69 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/NetworkId.ts.md b/packages/evolution/docs/modules/core/NetworkId.ts.md index df1495c9..2ab0a62e 100644 --- a/packages/evolution/docs/modules/core/NetworkId.ts.md +++ b/packages/evolution/docs/modules/core/NetworkId.ts.md @@ -1,6 +1,6 @@ --- title: core/NetworkId.ts -nav_order: 71 +nav_order: 70 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/NonZeroInt64.ts.md b/packages/evolution/docs/modules/core/NonZeroInt64.ts.md index 1754dc46..b1314e40 100644 --- a/packages/evolution/docs/modules/core/NonZeroInt64.ts.md +++ b/packages/evolution/docs/modules/core/NonZeroInt64.ts.md @@ -1,6 +1,6 @@ --- title: core/NonZeroInt64.ts -nav_order: 73 +nav_order: 72 parent: Modules --- @@ -14,8 +14,6 @@ parent: Modules - [arbitrary](#arbitrary-1) - [constants](#constants) - [NEG_INT64_MIN](#neg_int64_min) -- [constructors](#constructors) - - [make](#make) - [equality](#equality) - [equals](#equals) - [errors](#errors) @@ -73,20 +71,6 @@ export declare const NEG_INT64_MIN: -9223372036854775808n Added in v2.0.0 -# constructors - -## make - -Smart constructor for creating NonZeroInt64 values. - -**Signature** - -```ts -export declare const make: (i: string, overrideOptions?: ParseOptions) => bigint -``` - -Added in v2.0.0 - # equality ## equals diff --git a/packages/evolution/docs/modules/core/NonnegativeInterval.ts.md b/packages/evolution/docs/modules/core/NonnegativeInterval.ts.md index 11948c8e..cee10044 100644 --- a/packages/evolution/docs/modules/core/NonnegativeInterval.ts.md +++ b/packages/evolution/docs/modules/core/NonnegativeInterval.ts.md @@ -1,6 +1,6 @@ --- title: core/NonnegativeInterval.ts -nav_order: 72 +nav_order: 71 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Numeric.ts.md b/packages/evolution/docs/modules/core/Numeric.ts.md index abb47423..c10bcaf5 100644 --- a/packages/evolution/docs/modules/core/Numeric.ts.md +++ b/packages/evolution/docs/modules/core/Numeric.ts.md @@ -1,6 +1,6 @@ --- title: core/Numeric.ts -nav_order: 74 +nav_order: 73 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/OperationalCert.ts.md b/packages/evolution/docs/modules/core/OperationalCert.ts.md index f1a2fcb3..2e5fec6e 100644 --- a/packages/evolution/docs/modules/core/OperationalCert.ts.md +++ b/packages/evolution/docs/modules/core/OperationalCert.ts.md @@ -1,6 +1,6 @@ --- title: core/OperationalCert.ts -nav_order: 75 +nav_order: 74 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PaymentAddress.ts.md b/packages/evolution/docs/modules/core/PaymentAddress.ts.md index 6b807e91..5a3ee901 100644 --- a/packages/evolution/docs/modules/core/PaymentAddress.ts.md +++ b/packages/evolution/docs/modules/core/PaymentAddress.ts.md @@ -1,6 +1,6 @@ --- title: core/PaymentAddress.ts -nav_order: 76 +nav_order: 75 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PlutusV1.ts.md b/packages/evolution/docs/modules/core/PlutusV1.ts.md index ae48603c..f7fdb20b 100644 --- a/packages/evolution/docs/modules/core/PlutusV1.ts.md +++ b/packages/evolution/docs/modules/core/PlutusV1.ts.md @@ -1,6 +1,6 @@ --- title: core/PlutusV1.ts -nav_order: 77 +nav_order: 76 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PlutusV2.ts.md b/packages/evolution/docs/modules/core/PlutusV2.ts.md index f03cc7e0..3668d6b2 100644 --- a/packages/evolution/docs/modules/core/PlutusV2.ts.md +++ b/packages/evolution/docs/modules/core/PlutusV2.ts.md @@ -1,6 +1,6 @@ --- title: core/PlutusV2.ts -nav_order: 78 +nav_order: 77 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PlutusV3.ts.md b/packages/evolution/docs/modules/core/PlutusV3.ts.md index bd02ef46..b644711c 100644 --- a/packages/evolution/docs/modules/core/PlutusV3.ts.md +++ b/packages/evolution/docs/modules/core/PlutusV3.ts.md @@ -1,6 +1,6 @@ --- title: core/PlutusV3.ts -nav_order: 79 +nav_order: 78 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Pointer.ts.md b/packages/evolution/docs/modules/core/Pointer.ts.md index d9eca3bb..350bc2a6 100644 --- a/packages/evolution/docs/modules/core/Pointer.ts.md +++ b/packages/evolution/docs/modules/core/Pointer.ts.md @@ -1,6 +1,6 @@ --- title: core/Pointer.ts -nav_order: 80 +nav_order: 79 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PointerAddress.ts.md b/packages/evolution/docs/modules/core/PointerAddress.ts.md index 60c80633..402196b1 100644 --- a/packages/evolution/docs/modules/core/PointerAddress.ts.md +++ b/packages/evolution/docs/modules/core/PointerAddress.ts.md @@ -1,6 +1,6 @@ --- title: core/PointerAddress.ts -nav_order: 81 +nav_order: 80 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PolicyId.ts.md b/packages/evolution/docs/modules/core/PolicyId.ts.md index 92d993d4..8025b4b5 100644 --- a/packages/evolution/docs/modules/core/PolicyId.ts.md +++ b/packages/evolution/docs/modules/core/PolicyId.ts.md @@ -1,6 +1,6 @@ --- title: core/PolicyId.ts -nav_order: 82 +nav_order: 81 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PoolKeyHash.ts.md b/packages/evolution/docs/modules/core/PoolKeyHash.ts.md index eedd51d3..6d2ad32f 100644 --- a/packages/evolution/docs/modules/core/PoolKeyHash.ts.md +++ b/packages/evolution/docs/modules/core/PoolKeyHash.ts.md @@ -1,6 +1,6 @@ --- title: core/PoolKeyHash.ts -nav_order: 83 +nav_order: 82 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PoolMetadata.ts.md b/packages/evolution/docs/modules/core/PoolMetadata.ts.md index 7906ce63..dd8ac840 100644 --- a/packages/evolution/docs/modules/core/PoolMetadata.ts.md +++ b/packages/evolution/docs/modules/core/PoolMetadata.ts.md @@ -1,6 +1,6 @@ --- title: core/PoolMetadata.ts -nav_order: 84 +nav_order: 83 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PoolParams.ts.md b/packages/evolution/docs/modules/core/PoolParams.ts.md index f2953e9b..16901972 100644 --- a/packages/evolution/docs/modules/core/PoolParams.ts.md +++ b/packages/evolution/docs/modules/core/PoolParams.ts.md @@ -1,6 +1,6 @@ --- title: core/PoolParams.ts -nav_order: 85 +nav_order: 84 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Port.ts.md b/packages/evolution/docs/modules/core/Port.ts.md index 2f7dd8c3..9c9bd0be 100644 --- a/packages/evolution/docs/modules/core/Port.ts.md +++ b/packages/evolution/docs/modules/core/Port.ts.md @@ -1,6 +1,6 @@ --- title: core/Port.ts -nav_order: 86 +nav_order: 85 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PositiveCoin.ts.md b/packages/evolution/docs/modules/core/PositiveCoin.ts.md index 4b56cd2c..8adb63d9 100644 --- a/packages/evolution/docs/modules/core/PositiveCoin.ts.md +++ b/packages/evolution/docs/modules/core/PositiveCoin.ts.md @@ -1,6 +1,6 @@ --- title: core/PositiveCoin.ts -nav_order: 87 +nav_order: 86 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/PrivateKey.ts.md b/packages/evolution/docs/modules/core/PrivateKey.ts.md index c0bf2aeb..133e4613 100644 --- a/packages/evolution/docs/modules/core/PrivateKey.ts.md +++ b/packages/evolution/docs/modules/core/PrivateKey.ts.md @@ -1,6 +1,6 @@ --- title: core/PrivateKey.ts -nav_order: 88 +nav_order: 87 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/ProposalProcedure.ts.md b/packages/evolution/docs/modules/core/ProposalProcedure.ts.md index 9f91fea5..2f3400a2 100644 --- a/packages/evolution/docs/modules/core/ProposalProcedure.ts.md +++ b/packages/evolution/docs/modules/core/ProposalProcedure.ts.md @@ -1,6 +1,6 @@ --- title: core/ProposalProcedure.ts -nav_order: 89 +nav_order: 88 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/ProposalProcedures.ts.md b/packages/evolution/docs/modules/core/ProposalProcedures.ts.md index f2a97b8b..41b67b2f 100644 --- a/packages/evolution/docs/modules/core/ProposalProcedures.ts.md +++ b/packages/evolution/docs/modules/core/ProposalProcedures.ts.md @@ -1,6 +1,6 @@ --- title: core/ProposalProcedures.ts -nav_order: 90 +nav_order: 89 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/ProtocolParamUpdate.ts.md b/packages/evolution/docs/modules/core/ProtocolParamUpdate.ts.md index 9b79c133..4a4ff77c 100644 --- a/packages/evolution/docs/modules/core/ProtocolParamUpdate.ts.md +++ b/packages/evolution/docs/modules/core/ProtocolParamUpdate.ts.md @@ -1,6 +1,6 @@ --- title: core/ProtocolParamUpdate.ts -nav_order: 91 +nav_order: 90 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/ProtocolVersion.ts.md b/packages/evolution/docs/modules/core/ProtocolVersion.ts.md index 76bd26a9..02a55535 100644 --- a/packages/evolution/docs/modules/core/ProtocolVersion.ts.md +++ b/packages/evolution/docs/modules/core/ProtocolVersion.ts.md @@ -1,6 +1,6 @@ --- title: core/ProtocolVersion.ts -nav_order: 92 +nav_order: 91 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Redeemer.ts.md b/packages/evolution/docs/modules/core/Redeemer.ts.md index f52b90ce..5e8dbf83 100644 --- a/packages/evolution/docs/modules/core/Redeemer.ts.md +++ b/packages/evolution/docs/modules/core/Redeemer.ts.md @@ -1,6 +1,6 @@ --- title: core/Redeemer.ts -nav_order: 93 +nav_order: 92 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Relay.ts.md b/packages/evolution/docs/modules/core/Relay.ts.md index 3fe1f4fa..3bae42d8 100644 --- a/packages/evolution/docs/modules/core/Relay.ts.md +++ b/packages/evolution/docs/modules/core/Relay.ts.md @@ -1,6 +1,6 @@ --- title: core/Relay.ts -nav_order: 94 +nav_order: 93 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/RewardAccount.ts.md b/packages/evolution/docs/modules/core/RewardAccount.ts.md index 077e122c..dddfeb12 100644 --- a/packages/evolution/docs/modules/core/RewardAccount.ts.md +++ b/packages/evolution/docs/modules/core/RewardAccount.ts.md @@ -1,6 +1,6 @@ --- title: core/RewardAccount.ts -nav_order: 95 +nav_order: 94 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/RewardAddress.ts.md b/packages/evolution/docs/modules/core/RewardAddress.ts.md index 296363fa..4ebb4d92 100644 --- a/packages/evolution/docs/modules/core/RewardAddress.ts.md +++ b/packages/evolution/docs/modules/core/RewardAddress.ts.md @@ -1,6 +1,6 @@ --- title: core/RewardAddress.ts -nav_order: 96 +nav_order: 95 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Script.ts.md b/packages/evolution/docs/modules/core/Script.ts.md index 40f8f36f..5f8d1530 100644 --- a/packages/evolution/docs/modules/core/Script.ts.md +++ b/packages/evolution/docs/modules/core/Script.ts.md @@ -1,6 +1,6 @@ --- title: core/Script.ts -nav_order: 97 +nav_order: 96 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/ScriptDataHash.ts.md b/packages/evolution/docs/modules/core/ScriptDataHash.ts.md index f68c3b44..ebe14653 100644 --- a/packages/evolution/docs/modules/core/ScriptDataHash.ts.md +++ b/packages/evolution/docs/modules/core/ScriptDataHash.ts.md @@ -1,6 +1,6 @@ --- title: core/ScriptDataHash.ts -nav_order: 98 +nav_order: 97 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/ScriptHash.ts.md b/packages/evolution/docs/modules/core/ScriptHash.ts.md index 17be22c4..b67ff273 100644 --- a/packages/evolution/docs/modules/core/ScriptHash.ts.md +++ b/packages/evolution/docs/modules/core/ScriptHash.ts.md @@ -1,6 +1,6 @@ --- title: core/ScriptHash.ts -nav_order: 99 +nav_order: 98 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/ScriptRef.ts.md b/packages/evolution/docs/modules/core/ScriptRef.ts.md index 77249b15..7999e649 100644 --- a/packages/evolution/docs/modules/core/ScriptRef.ts.md +++ b/packages/evolution/docs/modules/core/ScriptRef.ts.md @@ -1,6 +1,6 @@ --- title: core/ScriptRef.ts -nav_order: 100 +nav_order: 99 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/SingleHostAddr.ts.md b/packages/evolution/docs/modules/core/SingleHostAddr.ts.md index f0dadb04..3c16a860 100644 --- a/packages/evolution/docs/modules/core/SingleHostAddr.ts.md +++ b/packages/evolution/docs/modules/core/SingleHostAddr.ts.md @@ -1,6 +1,6 @@ --- title: core/SingleHostAddr.ts -nav_order: 101 +nav_order: 100 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/SingleHostName.ts.md b/packages/evolution/docs/modules/core/SingleHostName.ts.md index 9e783a1d..25334519 100644 --- a/packages/evolution/docs/modules/core/SingleHostName.ts.md +++ b/packages/evolution/docs/modules/core/SingleHostName.ts.md @@ -1,6 +1,6 @@ --- title: core/SingleHostName.ts -nav_order: 102 +nav_order: 101 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/StakeReference.ts.md b/packages/evolution/docs/modules/core/StakeReference.ts.md index 9b7e7813..61fa1492 100644 --- a/packages/evolution/docs/modules/core/StakeReference.ts.md +++ b/packages/evolution/docs/modules/core/StakeReference.ts.md @@ -1,6 +1,6 @@ --- title: core/StakeReference.ts -nav_order: 103 +nav_order: 102 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/TSchema.ts.md b/packages/evolution/docs/modules/core/TSchema.ts.md index fa6a8e9d..f03a551d 100644 --- a/packages/evolution/docs/modules/core/TSchema.ts.md +++ b/packages/evolution/docs/modules/core/TSchema.ts.md @@ -1,6 +1,6 @@ --- title: core/TSchema.ts -nav_order: 115 +nav_order: 114 parent: Modules --- @@ -191,29 +191,29 @@ export declare const Struct: ( **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Default: nested in Union, index 0 -TSchema.Struct({ name: TSchema.ByteArray, age: TSchema.Integer }) +Core.TSchema.Struct({ name: Core.TSchema.ByteArray, age: Core.TSchema.Integer }) ``` **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Flat union variants with custom indices -TSchema.Struct({ amount: TSchema.Integer }, { index: 121, flat: true }) -TSchema.Struct({ amount: TSchema.Integer }, { index: 122, flat: true }) +Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 121, flat: true }) +Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 122, flat: true }) ``` **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Custom index but stay nested (advanced use case) -TSchema.Struct({ data: TSchema.Integer }, { index: 10, flat: false }) +Core.TSchema.Struct({ data: Core.TSchema.Integer }, { index: 10, flat: false }) ``` Added in v2.0.0 @@ -287,22 +287,22 @@ export declare const Union: >(. **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Standard union with auto indices (nested) -TSchema.Union(TSchema.Struct({ a: TSchema.Integer }), TSchema.Struct({ b: TSchema.Integer })) +Core.TSchema.Union(Core.TSchema.Struct({ a: Core.TSchema.Integer }), Core.TSchema.Struct({ b: Core.TSchema.Integer })) // Encodes to: Constr(0, [Constr(0, [a])]) or Constr(1, [Constr(0, [b])]) ``` **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Union with flat Structs (single-level encoding) -TSchema.Union( - TSchema.Struct({ amount: TSchema.Integer }, { index: 121, flat: true }), - TSchema.Struct({ amount: TSchema.Integer }, { index: 122, flat: true }) +Core.TSchema.Union( + Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 121, flat: true }), + Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 122, flat: true }) ) // Encodes to: Constr(121, [amount]) or Constr(122, [amount]) - single level! ``` @@ -310,13 +310,13 @@ TSchema.Union( **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Mixed union: some nested, some flat -TSchema.Union( - TSchema.Struct({ a: TSchema.Integer }), // nested, auto index 0 - TSchema.Struct({ b: TSchema.Integer }, { flat: true }), // flat, auto index 1 - TSchema.Struct({ c: TSchema.Integer }, { index: 100, flat: true }) // flat, custom index 100 +Core.TSchema.Union( + Core.TSchema.Struct({ a: Core.TSchema.Integer }), // nested, auto index 0 + Core.TSchema.Struct({ b: Core.TSchema.Integer }, { flat: true }), // flat, auto index 1 + Core.TSchema.Struct({ c: Core.TSchema.Integer }, { index: 100, flat: true }) // flat, custom index 100 ) ``` diff --git a/packages/evolution/docs/modules/core/Text.ts.md b/packages/evolution/docs/modules/core/Text.ts.md index 534525ed..b5babb2f 100644 --- a/packages/evolution/docs/modules/core/Text.ts.md +++ b/packages/evolution/docs/modules/core/Text.ts.md @@ -1,6 +1,6 @@ --- title: core/Text.ts -nav_order: 104 +nav_order: 103 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Text128.ts.md b/packages/evolution/docs/modules/core/Text128.ts.md index 3b15f021..a05181c5 100644 --- a/packages/evolution/docs/modules/core/Text128.ts.md +++ b/packages/evolution/docs/modules/core/Text128.ts.md @@ -1,6 +1,6 @@ --- title: core/Text128.ts -nav_order: 105 +nav_order: 104 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Transaction.ts.md b/packages/evolution/docs/modules/core/Transaction.ts.md index 2056e41f..c5c46f2a 100644 --- a/packages/evolution/docs/modules/core/Transaction.ts.md +++ b/packages/evolution/docs/modules/core/Transaction.ts.md @@ -1,6 +1,6 @@ --- title: core/Transaction.ts -nav_order: 106 +nav_order: 105 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/TransactionBody.ts.md b/packages/evolution/docs/modules/core/TransactionBody.ts.md index 9ee85826..5f4509c1 100644 --- a/packages/evolution/docs/modules/core/TransactionBody.ts.md +++ b/packages/evolution/docs/modules/core/TransactionBody.ts.md @@ -1,6 +1,6 @@ --- title: core/TransactionBody.ts -nav_order: 107 +nav_order: 106 parent: Modules --- @@ -272,7 +272,7 @@ export declare const isTransactionBody: (u: unknown, overrideOptions?: ParseOpti ```ts export declare const make: ( props: { - readonly mint?: (Map> & Brand<"Mint">) | undefined + readonly mint?: Map> | undefined readonly networkId?: number | undefined readonly withdrawals?: Withdrawals.Withdrawals | undefined readonly fee: bigint diff --git a/packages/evolution/docs/modules/core/TransactionHash.ts.md b/packages/evolution/docs/modules/core/TransactionHash.ts.md index 2e6e7748..05d1346b 100644 --- a/packages/evolution/docs/modules/core/TransactionHash.ts.md +++ b/packages/evolution/docs/modules/core/TransactionHash.ts.md @@ -1,6 +1,6 @@ --- title: core/TransactionHash.ts -nav_order: 108 +nav_order: 107 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/TransactionIndex.ts.md b/packages/evolution/docs/modules/core/TransactionIndex.ts.md index 3171ed47..9be0fdc9 100644 --- a/packages/evolution/docs/modules/core/TransactionIndex.ts.md +++ b/packages/evolution/docs/modules/core/TransactionIndex.ts.md @@ -1,6 +1,6 @@ --- title: core/TransactionIndex.ts -nav_order: 109 +nav_order: 108 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/TransactionInput.ts.md b/packages/evolution/docs/modules/core/TransactionInput.ts.md index 0fdad64f..f77c4f86 100644 --- a/packages/evolution/docs/modules/core/TransactionInput.ts.md +++ b/packages/evolution/docs/modules/core/TransactionInput.ts.md @@ -1,6 +1,6 @@ --- title: core/TransactionInput.ts -nav_order: 110 +nav_order: 109 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/TransactionMetadatum.ts.md b/packages/evolution/docs/modules/core/TransactionMetadatum.ts.md index d2d01896..bd903d87 100644 --- a/packages/evolution/docs/modules/core/TransactionMetadatum.ts.md +++ b/packages/evolution/docs/modules/core/TransactionMetadatum.ts.md @@ -1,6 +1,6 @@ --- title: core/TransactionMetadatum.ts -nav_order: 111 +nav_order: 110 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/TransactionMetadatumLabels.ts.md b/packages/evolution/docs/modules/core/TransactionMetadatumLabels.ts.md index feefedb2..d520fd51 100644 --- a/packages/evolution/docs/modules/core/TransactionMetadatumLabels.ts.md +++ b/packages/evolution/docs/modules/core/TransactionMetadatumLabels.ts.md @@ -1,6 +1,6 @@ --- title: core/TransactionMetadatumLabels.ts -nav_order: 112 +nav_order: 111 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/TransactionOutput.ts.md b/packages/evolution/docs/modules/core/TransactionOutput.ts.md index 90dbd881..13b760b5 100644 --- a/packages/evolution/docs/modules/core/TransactionOutput.ts.md +++ b/packages/evolution/docs/modules/core/TransactionOutput.ts.md @@ -1,6 +1,6 @@ --- title: core/TransactionOutput.ts -nav_order: 113 +nav_order: 112 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/TransactionWitnessSet.ts.md b/packages/evolution/docs/modules/core/TransactionWitnessSet.ts.md index 3d389155..80d4bcc3 100644 --- a/packages/evolution/docs/modules/core/TransactionWitnessSet.ts.md +++ b/packages/evolution/docs/modules/core/TransactionWitnessSet.ts.md @@ -1,6 +1,6 @@ --- title: core/TransactionWitnessSet.ts -nav_order: 114 +nav_order: 113 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/UnitInterval.ts.md b/packages/evolution/docs/modules/core/UnitInterval.ts.md index e41b9dee..a5d10dec 100644 --- a/packages/evolution/docs/modules/core/UnitInterval.ts.md +++ b/packages/evolution/docs/modules/core/UnitInterval.ts.md @@ -1,6 +1,6 @@ --- title: core/UnitInterval.ts -nav_order: 116 +nav_order: 115 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Url.ts.md b/packages/evolution/docs/modules/core/Url.ts.md index 325489fa..4fbb9226 100644 --- a/packages/evolution/docs/modules/core/Url.ts.md +++ b/packages/evolution/docs/modules/core/Url.ts.md @@ -1,6 +1,6 @@ --- title: core/Url.ts -nav_order: 117 +nav_order: 116 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/VKey.ts.md b/packages/evolution/docs/modules/core/VKey.ts.md index 9267f136..ac5b89b6 100644 --- a/packages/evolution/docs/modules/core/VKey.ts.md +++ b/packages/evolution/docs/modules/core/VKey.ts.md @@ -1,6 +1,6 @@ --- title: core/VKey.ts -nav_order: 119 +nav_order: 118 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Value.ts.md b/packages/evolution/docs/modules/core/Value.ts.md index df8983e9..bf5e4c9e 100644 --- a/packages/evolution/docs/modules/core/Value.ts.md +++ b/packages/evolution/docs/modules/core/Value.ts.md @@ -1,6 +1,6 @@ --- title: core/Value.ts -nav_order: 118 +nav_order: 117 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/VotingProcedures.ts.md b/packages/evolution/docs/modules/core/VotingProcedures.ts.md index 504654dd..1fb292b5 100644 --- a/packages/evolution/docs/modules/core/VotingProcedures.ts.md +++ b/packages/evolution/docs/modules/core/VotingProcedures.ts.md @@ -1,6 +1,6 @@ --- title: core/VotingProcedures.ts -nav_order: 120 +nav_order: 119 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/VrfCert.ts.md b/packages/evolution/docs/modules/core/VrfCert.ts.md index 259941cc..32c9ed52 100644 --- a/packages/evolution/docs/modules/core/VrfCert.ts.md +++ b/packages/evolution/docs/modules/core/VrfCert.ts.md @@ -1,6 +1,6 @@ --- title: core/VrfCert.ts -nav_order: 121 +nav_order: 120 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/VrfKeyHash.ts.md b/packages/evolution/docs/modules/core/VrfKeyHash.ts.md index 40691246..0e202170 100644 --- a/packages/evolution/docs/modules/core/VrfKeyHash.ts.md +++ b/packages/evolution/docs/modules/core/VrfKeyHash.ts.md @@ -1,6 +1,6 @@ --- title: core/VrfKeyHash.ts -nav_order: 122 +nav_order: 121 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/VrfVkey.ts.md b/packages/evolution/docs/modules/core/VrfVkey.ts.md index 2195fe9d..b7c5cb88 100644 --- a/packages/evolution/docs/modules/core/VrfVkey.ts.md +++ b/packages/evolution/docs/modules/core/VrfVkey.ts.md @@ -1,6 +1,6 @@ --- title: core/VrfVkey.ts -nav_order: 123 +nav_order: 122 parent: Modules --- diff --git a/packages/evolution/docs/modules/core/Withdrawals.ts.md b/packages/evolution/docs/modules/core/Withdrawals.ts.md index 1c982625..afcc7318 100644 --- a/packages/evolution/docs/modules/core/Withdrawals.ts.md +++ b/packages/evolution/docs/modules/core/Withdrawals.ts.md @@ -1,6 +1,6 @@ --- title: core/Withdrawals.ts -nav_order: 124 +nav_order: 123 parent: Modules --- diff --git a/packages/evolution/docs/modules/sdk/Address.ts.md b/packages/evolution/docs/modules/sdk/Address.ts.md index a4790063..315ccbd4 100644 --- a/packages/evolution/docs/modules/sdk/Address.ts.md +++ b/packages/evolution/docs/modules/sdk/Address.ts.md @@ -1,23 +1,23 @@ --- title: sdk/Address.ts -nav_order: 125 +nav_order: 124 parent: Modules --- ## Address overview +SDK Address module - user-friendly Bech32 string representation + +Added in v2.0.0 + ---

Table of contents

- [utils](#utils) - [Address (type alias)](#address-type-alias) - - [addressToJson](#addresstojson) - - [fromAddressStructure](#fromaddressstructure) - - [fromAddressStructureToJson](#fromaddressstructuretojson) - - [fromJsonToAddressStructure](#fromjsontoaddressstructure) - - [jsonToAddress](#jsontoaddress) - - [toAddressStructure](#toaddressstructure) + - [fromCoreAddress](#fromcoreaddress) + - [toCoreAddress](#tocoreaddress) --- @@ -31,104 +31,18 @@ parent: Modules export type Address = string ``` -## addressToJson - -**Signature** - -```ts -export declare const addressToJson: ( - i: string, - overrideOptions?: ParseOptions | undefined -) => { - readonly networkId: number - readonly paymentCredential: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - readonly stakingCredential?: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - | undefined -} -``` - -## fromAddressStructure - -**Signature** - -```ts -export declare const fromAddressStructure: ( - a: CoreAddressStructure.AddressStructure, - overrideOptions?: ParseOptions -) => string -``` - -## fromAddressStructureToJson - -**Signature** - -```ts -export declare const fromAddressStructureToJson: ( - a: CoreAddressStructure.AddressStructure, - overrideOptions?: ParseOptions -) => { - readonly networkId: number - readonly paymentCredential: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - readonly stakingCredential?: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - | undefined -} -``` - -## fromJsonToAddressStructure - -**Signature** - -```ts -export declare const fromJsonToAddressStructure: ( - i: { - readonly networkId: number - readonly paymentCredential: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - readonly stakingCredential?: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - | undefined - }, - overrideOptions?: ParseOptions -) => CoreAddressStructure.AddressStructure -``` - -## jsonToAddress +## fromCoreAddress **Signature** ```ts -export declare const jsonToAddress: ( - i: { - readonly networkId: number - readonly paymentCredential: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - readonly stakingCredential?: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - | undefined - }, - overrideOptions?: ParseOptions | undefined -) => string +export declare const fromCoreAddress: (a: CoreAddress.Address, overrideOptions?: ParseOptions) => string ``` -## toAddressStructure +## toCoreAddress **Signature** ```ts -export declare const toAddressStructure: ( - i: string, - overrideOptions?: ParseOptions -) => CoreAddressStructure.AddressStructure +export declare const toCoreAddress: (i: string, overrideOptions?: ParseOptions) => CoreAddress.Address ``` diff --git a/packages/evolution/docs/modules/core/AddressDetails.ts.md b/packages/evolution/docs/modules/sdk/AddressDetails.ts.md similarity index 55% rename from packages/evolution/docs/modules/core/AddressDetails.ts.md rename to packages/evolution/docs/modules/sdk/AddressDetails.ts.md index 6c241854..504989c7 100644 --- a/packages/evolution/docs/modules/core/AddressDetails.ts.md +++ b/packages/evolution/docs/modules/sdk/AddressDetails.ts.md @@ -1,6 +1,6 @@ --- -title: core/AddressDetails.ts -nav_order: 1 +title: sdk/AddressDetails.ts +nav_order: 125 parent: Modules --- @@ -10,13 +10,6 @@ parent: Modules

Table of contents

-- [arbitrary](#arbitrary) - - [arbitrary](#arbitrary-1) -- [constructors](#constructors) - - [fromAddress](#fromaddress) - - [make](#make) -- [either](#either) - - [Either (namespace)](#either-namespace) - [encoding](#encoding) - [toBech32](#tobech32) - [toHex](#tohex) @@ -28,60 +21,11 @@ parent: Modules - [schemas](#schemas) - [AddressDetails (class)](#addressdetails-class) - [utils](#utils) - - [AddressDetailsError (class)](#addressdetailserror-class) - [FromBech32](#frombech32-1) - [FromHex](#fromhex-1) --- -# arbitrary - -## arbitrary - -FastCheck arbitrary for AddressDetails instances. - -**Signature** - -```ts -export declare const arbitrary: Arbitrary -``` - -Added in v2.0.0 - -# constructors - -## fromAddress - -Create AddressDetails from an Address. - -**Signature** - -```ts -export declare const fromAddress: (address: AddressEras.AddressEras) => AddressDetails -``` - -Added in v2.0.0 - -## make - -Create AddressDetails from an Address instance. - -**Signature** - -```ts -export declare const make: (this: C, ...args: ConstructorParameters) => InstanceType -``` - -Added in v2.0.0 - -# either - -## Either (namespace) - -Either-based error handling variants for functions that can fail. - -Added in v2.0.0 - # encoding ## toBech32 @@ -91,7 +35,7 @@ Convert AddressDetails to Bech32 string. **Signature** ```ts -export declare const toBech32: (input: AddressDetails) => string +export declare const toBech32: (a: AddressDetails, overrideOptions?: ParseOptions) => string ``` Added in v2.0.0 @@ -103,7 +47,7 @@ Convert AddressDetails to hex string. **Signature** ```ts -export declare const toHex: (input: AddressDetails) => string +export declare const toHex: (a: AddressDetails, overrideOptions?: ParseOptions) => string ``` Added in v2.0.0 @@ -131,7 +75,7 @@ Parse AddressDetails from Bech32 string. **Signature** ```ts -export declare const fromBech32: (input: string) => AddressDetails +export declare const fromBech32: (i: string, overrideOptions?: ParseOptions) => AddressDetails ``` Added in v2.0.0 @@ -143,7 +87,7 @@ Parse AddressDetails from hex string. **Signature** ```ts -export declare const fromHex: (input: string) => AddressDetails +export declare const fromHex: (i: string, overrideOptions?: ParseOptions) => AddressDetails ``` Added in v2.0.0 @@ -165,14 +109,6 @@ Added in v2.0.0 # utils -## AddressDetailsError (class) - -**Signature** - -```ts -export declare class AddressDetailsError -``` - ## FromBech32 **Signature** diff --git a/packages/evolution/docs/modules/sdk/Assets.ts.md b/packages/evolution/docs/modules/sdk/Assets.ts.md index 6de67ba9..65a0b3db 100644 --- a/packages/evolution/docs/modules/sdk/Assets.ts.md +++ b/packages/evolution/docs/modules/sdk/Assets.ts.md @@ -10,8 +10,22 @@ parent: Modules

Table of contents

+- [conversion](#conversion) + - [fromMint](#frommint) + - [fromValue](#fromvalue) + - [toMint](#tomint) + - [toValue](#tovalue) +- [helpers](#helpers) + - [addLovelace](#addlovelace) + - [getLovelace](#getlovelace) + - [setLovelace](#setlovelace) + - [subtractLovelace](#subtractlovelace) +- [schemas](#schemas) + - [MintFromAssets](#mintfromassets) + - [ValueFromAssets](#valuefromassets) - [utils](#utils) - - [Assets (interface)](#assets-interface) + - [Assets (type alias)](#assets-type-alias) + - [AssetsSchema](#assetsschema) - [add](#add) - [assetsToValue](#assetstovalue) - [empty](#empty) @@ -31,17 +45,189 @@ parent: Modules --- +# conversion + +## fromMint + +Convert Core Mint to SDK Assets format (without lovelace). + +**Signature** + +```ts +export declare const fromMint: ( + a: Map>, + overrideOptions?: ParseOptions +) => { readonly lovelace?: bigint | undefined } & { readonly [x: string]: bigint } +``` + +Added in v2.0.0 + +## fromValue + +Convert Core Value to SDK Assets format. + +**Signature** + +```ts +export declare const fromValue: ( + a: CoreValue.OnlyCoin | CoreValue.WithAssets, + overrideOptions?: ParseOptions +) => { readonly lovelace?: bigint | undefined } & { readonly [x: string]: bigint } +``` + +Added in v2.0.0 + +## toMint + +Convert SDK Assets to Core Mint (lovelace key will be rejected). + +**Signature** + +```ts +export declare const toMint: ( + i: { readonly lovelace?: bigint | undefined } & { readonly [x: string]: bigint }, + overrideOptions?: ParseOptions +) => Map> +``` + +Added in v2.0.0 + +## toValue + +Convert SDK Assets to Core Value. + +**Signature** + +```ts +export declare const toValue: ( + i: { readonly lovelace?: bigint | undefined } & { readonly [x: string]: bigint }, + overrideOptions?: ParseOptions +) => CoreValue.OnlyCoin | CoreValue.WithAssets +``` + +Added in v2.0.0 + +# helpers + +## addLovelace + +Add a lovelace amount to Assets. + +**Signature** + +```ts +export declare const addLovelace: (assets: Assets, amount: bigint) => Assets +``` + +Added in v2.0.0 + +## getLovelace + +Get the lovelace amount from Assets, defaulting to 0n if undefined. + +**Signature** + +```ts +export declare const getLovelace: (assets: Assets) => bigint +``` + +Added in v2.0.0 + +## setLovelace + +Set the lovelace amount in Assets. + +**Signature** + +```ts +export declare const setLovelace: (assets: Assets, amount: bigint) => Assets +``` + +Added in v2.0.0 + +## subtractLovelace + +Subtract a lovelace amount from Assets. + +**Signature** + +```ts +export declare const subtractLovelace: (assets: Assets, amount: bigint) => Assets +``` + +Added in v2.0.0 + +# schemas + +## MintFromAssets + +Transform between Assets (SDK-friendly) and Mint (Core). + +Encoded side: Assets format { [unit: string]: bigint } (non-zero values only) +Type side: Mint (Map>) + +Note: Unlike Value.FromAssets, this excludes "lovelace" since you cannot mint/burn ADA. + +**Signature** + +```ts +export declare const MintFromAssets: Schema.transformOrFail< + Schema.extend< + Schema.Struct<{ lovelace: Schema.optional }>, + Schema.Record$ + >, + Schema.SchemaClass< + Map>, + Map>, + never + >, + never +> +``` + +Added in v2.0.0 + +## ValueFromAssets + +Transform between Assets (SDK-friendly) and Value (Core). + +Encoded side: Assets format { lovelace?: bigint, [unit: string]: bigint } +Type side: Value (OnlyCoin | WithAssets) + +**Signature** + +```ts +export declare const ValueFromAssets: Schema.transformOrFail< + Schema.extend< + Schema.Struct<{ lovelace: Schema.optional }>, + Schema.Record$ + >, + Schema.SchemaClass, + never +> +``` + +Added in v2.0.0 + # utils -## Assets (interface) +## Assets (type alias) + +**Signature** + +```ts +export type Assets = typeof AssetsSchema.Type +``` + +## AssetsSchema **Signature** ```ts -export interface Assets { - lovelace: bigint - [key: string]: bigint -} +export declare const AssetsSchema: Schema.extend< + Schema.Struct<{ lovelace: Schema.optional }>, + Schema.Record$ +> ``` ## add diff --git a/packages/evolution/docs/modules/sdk/Credential.ts.md b/packages/evolution/docs/modules/sdk/Credential.ts.md index cfe6ba31..56b1e3bd 100644 --- a/packages/evolution/docs/modules/sdk/Credential.ts.md +++ b/packages/evolution/docs/modules/sdk/Credential.ts.md @@ -14,8 +14,8 @@ parent: Modules - [Credential (type alias)](#credential-type-alias) - [KeyHash (type alias)](#keyhash-type-alias) - [ScriptHash (type alias)](#scripthash-type-alias) - - [fromCredentialToJson](#fromcredentialtojson) - - [jsonToCredential](#jsontocredential) + - [fromCoreCredential](#fromcorecredential) + - [toCoreCredential](#tocorecredential) --- @@ -26,7 +26,7 @@ parent: Modules **Signature** ```ts -export type Credential = typeof _Credential.CredentialSchema.Encoded +export type Credential = typeof CoreCredential.CredentialSchema.Encoded ``` ## KeyHash (type alias) @@ -34,7 +34,7 @@ export type Credential = typeof _Credential.CredentialSchema.Encoded **Signature** ```ts -export type KeyHash = typeof _KeyHash.KeyHash.Encoded +export type KeyHash = typeof CoreKeyHash.KeyHash.Encoded ``` ## ScriptHash (type alias) @@ -42,27 +42,27 @@ export type KeyHash = typeof _KeyHash.KeyHash.Encoded **Signature** ```ts -export type ScriptHash = typeof _ScriptHash.ScriptHash.Encoded +export type ScriptHash = typeof CoreScriptHash.ScriptHash.Encoded ``` -## fromCredentialToJson +## fromCoreCredential **Signature** ```ts -export declare const fromCredentialToJson: ( - a: _KeyHash.KeyHash | _ScriptHash.ScriptHash, +export declare const fromCoreCredential: ( + a: CoreKeyHash.KeyHash | CoreScriptHash.ScriptHash, overrideOptions?: ParseOptions ) => { readonly _tag: "KeyHash"; readonly hash: string } | { readonly _tag: "ScriptHash"; readonly hash: string } ``` -## jsonToCredential +## toCoreCredential **Signature** ```ts -export declare const jsonToCredential: ( +export declare const toCoreCredential: ( i: { readonly _tag: "KeyHash"; readonly hash: string } | { readonly _tag: "ScriptHash"; readonly hash: string }, overrideOptions?: ParseOptions -) => _KeyHash.KeyHash | _ScriptHash.ScriptHash +) => CoreKeyHash.KeyHash | CoreScriptHash.ScriptHash ``` diff --git a/packages/evolution/src/core/TSchema.ts b/packages/evolution/src/core/TSchema.ts index ec0dd6fb..ce760353 100644 --- a/packages/evolution/src/core/TSchema.ts +++ b/packages/evolution/src/core/TSchema.ts @@ -229,27 +229,27 @@ export interface StructOptions { * * @example * ```typescript - * import { TSchema } from "@evolution-sdk/evolution" + * import { Core } from "@evolution-sdk/evolution" * * // Default: nested in Union, index 0 - * TSchema.Struct({ name: TSchema.ByteArray, age: TSchema.Integer }) + * Core.TSchema.Struct({ name: Core.TSchema.ByteArray, age: Core.TSchema.Integer }) * ``` * * @example * ```typescript - * import { TSchema } from "@evolution-sdk/evolution" + * import { Core } from "@evolution-sdk/evolution" * * // Flat union variants with custom indices - * TSchema.Struct({ amount: TSchema.Integer }, { index: 121, flat: true }) - * TSchema.Struct({ amount: TSchema.Integer }, { index: 122, flat: true }) + * Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 121, flat: true }) + * Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 122, flat: true }) * ``` * * @example * ```typescript - * import { TSchema } from "@evolution-sdk/evolution" + * import { Core } from "@evolution-sdk/evolution" * * // Custom index but stay nested (advanced use case) - * TSchema.Struct({ data: TSchema.Integer }, { index: 10, flat: false }) + * Core.TSchema.Struct({ data: Core.TSchema.Integer }, { index: 10, flat: false }) * ``` * * @since 2.0.0 @@ -306,37 +306,37 @@ interface Union> * * @example * ```typescript - * import { TSchema } from "@evolution-sdk/evolution" + * import { Core } from "@evolution-sdk/evolution" * * // Standard union with auto indices (nested) - * TSchema.Union( - * TSchema.Struct({ a: TSchema.Integer }), - * TSchema.Struct({ b: TSchema.Integer }) + * Core.TSchema.Union( + * Core.TSchema.Struct({ a: Core.TSchema.Integer }), + * Core.TSchema.Struct({ b: Core.TSchema.Integer }) * ) * // Encodes to: Constr(0, [Constr(0, [a])]) or Constr(1, [Constr(0, [b])]) * ``` * * @example * ```typescript - * import { TSchema } from "@evolution-sdk/evolution" + * import { Core } from "@evolution-sdk/evolution" * * // Union with flat Structs (single-level encoding) - * TSchema.Union( - * TSchema.Struct({ amount: TSchema.Integer }, { index: 121, flat: true }), - * TSchema.Struct({ amount: TSchema.Integer }, { index: 122, flat: true }) + * Core.TSchema.Union( + * Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 121, flat: true }), + * Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 122, flat: true }) * ) * // Encodes to: Constr(121, [amount]) or Constr(122, [amount]) - single level! * ``` * * @example * ```typescript - * import { TSchema } from "@evolution-sdk/evolution" + * import { Core } from "@evolution-sdk/evolution" * * // Mixed union: some nested, some flat - * TSchema.Union( - * TSchema.Struct({ a: TSchema.Integer }), // nested, auto index 0 - * TSchema.Struct({ b: TSchema.Integer }, { flat: true }), // flat, auto index 1 - * TSchema.Struct({ c: TSchema.Integer }, { index: 100, flat: true }) // flat, custom index 100 + * Core.TSchema.Union( + * Core.TSchema.Struct({ a: Core.TSchema.Integer }), // nested, auto index 0 + * Core.TSchema.Struct({ b: Core.TSchema.Integer }, { flat: true }), // flat, auto index 1 + * Core.TSchema.Struct({ c: Core.TSchema.Integer }, { index: 100, flat: true }) // flat, custom index 100 * ) * ``` * From ccadf1e11c9bcb4da4258c28ee78c04eba998a90 Mon Sep 17 00:00:00 2001 From: solidsnakedev Date: Tue, 11 Nov 2025 13:43:39 -0700 Subject: [PATCH 2/2] fix(docs): update post-Core refactoring --- .../{AddressStructure.mdx => Address.mdx} | 46 ++--- .../content/docs/modules/core/AddressEras.mdx | 6 +- docs/content/docs/modules/core/AddressTag.mdx | 2 +- docs/content/docs/modules/core/Anchor.mdx | 2 +- docs/content/docs/modules/core/AssetName.mdx | 2 +- .../docs/modules/core/AuxiliaryData.mdx | 2 +- .../docs/modules/core/AuxiliaryDataHash.mdx | 2 +- .../content/docs/modules/core/BaseAddress.mdx | 2 +- docs/content/docs/modules/core/Bech32.mdx | 2 +- docs/content/docs/modules/core/BigInt.mdx | 2 +- .../docs/modules/core/Bip32PrivateKey.mdx | 2 +- .../docs/modules/core/Bip32PublicKey.mdx | 2 +- docs/content/docs/modules/core/Block.mdx | 2 +- .../docs/modules/core/BlockBodyHash.mdx | 2 +- .../docs/modules/core/BlockHeaderHash.mdx | 2 +- .../docs/modules/core/BootstrapWitness.mdx | 2 +- .../docs/modules/core/BoundedBytes.mdx | 2 +- .../docs/modules/core/ByronAddress.mdx | 2 +- docs/content/docs/modules/core/Bytes.mdx | 2 +- docs/content/docs/modules/core/Bytes128.mdx | 2 +- docs/content/docs/modules/core/Bytes16.mdx | 2 +- docs/content/docs/modules/core/Bytes29.mdx | 2 +- docs/content/docs/modules/core/Bytes32.mdx | 2 +- docs/content/docs/modules/core/Bytes4.mdx | 2 +- docs/content/docs/modules/core/Bytes448.mdx | 2 +- docs/content/docs/modules/core/Bytes57.mdx | 2 +- docs/content/docs/modules/core/Bytes64.mdx | 2 +- docs/content/docs/modules/core/Bytes80.mdx | 2 +- docs/content/docs/modules/core/Bytes96.mdx | 2 +- docs/content/docs/modules/core/CBOR.mdx | 2 +- .../content/docs/modules/core/Certificate.mdx | 2 +- docs/content/docs/modules/core/Codec.mdx | 2 +- docs/content/docs/modules/core/Coin.mdx | 2 +- docs/content/docs/modules/core/Combinator.mdx | 2 +- .../modules/core/CommitteeColdCredential.mdx | 2 +- .../modules/core/CommitteeHotCredential.mdx | 2 +- .../docs/modules/core/Constitution.mdx | 2 +- docs/content/docs/modules/core/CostModel.mdx | 2 +- docs/content/docs/modules/core/Credential.mdx | 2 +- docs/content/docs/modules/core/DRep.mdx | 2 +- .../docs/modules/core/DRepCredential.mdx | 2 +- docs/content/docs/modules/core/Data.mdx | 2 +- docs/content/docs/modules/core/DataJson.mdx | 2 +- .../content/docs/modules/core/DatumOption.mdx | 2 +- docs/content/docs/modules/core/DnsName.mdx | 2 +- .../docs/modules/core/Ed25519Signature.mdx | 2 +- .../docs/modules/core/EnterpriseAddress.mdx | 2 +- docs/content/docs/modules/core/EpochNo.mdx | 2 +- .../content/docs/modules/core/FormatError.mdx | 2 +- docs/content/docs/modules/core/Function.mdx | 2 +- .../docs/modules/core/GovernanceAction.mdx | 2 +- docs/content/docs/modules/core/Hash28.mdx | 2 +- docs/content/docs/modules/core/Header.mdx | 2 +- docs/content/docs/modules/core/HeaderBody.mdx | 2 +- docs/content/docs/modules/core/IPv4.mdx | 2 +- docs/content/docs/modules/core/IPv6.mdx | 2 +- docs/content/docs/modules/core/KESVkey.mdx | 2 +- .../docs/modules/core/KesSignature.mdx | 2 +- docs/content/docs/modules/core/KeyHash.mdx | 4 +- docs/content/docs/modules/core/Language.mdx | 2 +- docs/content/docs/modules/core/Metadata.mdx | 2 +- docs/content/docs/modules/core/Mint.mdx | 59 +++--- docs/content/docs/modules/core/MultiAsset.mdx | 2 +- .../docs/modules/core/MultiHostName.mdx | 2 +- .../docs/modules/core/NativeScriptJSON.mdx | 2 +- .../docs/modules/core/NativeScripts.mdx | 2 +- .../docs/modules/core/NativeScriptsOLD.mdx | 2 +- docs/content/docs/modules/core/Natural.mdx | 2 +- docs/content/docs/modules/core/Network.mdx | 2 +- docs/content/docs/modules/core/NetworkId.mdx | 2 +- .../docs/modules/core/NonZeroInt64.mdx | 18 +- .../docs/modules/core/NonnegativeInterval.mdx | 2 +- docs/content/docs/modules/core/Numeric.mdx | 2 +- .../docs/modules/core/OperationalCert.mdx | 2 +- .../docs/modules/core/PaymentAddress.mdx | 2 +- docs/content/docs/modules/core/PlutusV1.mdx | 2 +- docs/content/docs/modules/core/PlutusV2.mdx | 2 +- docs/content/docs/modules/core/PlutusV3.mdx | 2 +- docs/content/docs/modules/core/Pointer.mdx | 2 +- .../docs/modules/core/PointerAddress.mdx | 2 +- docs/content/docs/modules/core/PolicyId.mdx | 2 +- .../content/docs/modules/core/PoolKeyHash.mdx | 2 +- .../docs/modules/core/PoolMetadata.mdx | 2 +- docs/content/docs/modules/core/PoolParams.mdx | 2 +- docs/content/docs/modules/core/Port.mdx | 2 +- .../docs/modules/core/PositiveCoin.mdx | 2 +- docs/content/docs/modules/core/PrivateKey.mdx | 2 +- .../docs/modules/core/ProposalProcedure.mdx | 2 +- .../docs/modules/core/ProposalProcedures.mdx | 2 +- .../docs/modules/core/ProtocolParamUpdate.mdx | 2 +- .../docs/modules/core/ProtocolVersion.mdx | 2 +- docs/content/docs/modules/core/Redeemer.mdx | 2 +- docs/content/docs/modules/core/Relay.mdx | 2 +- .../docs/modules/core/RewardAccount.mdx | 2 +- .../docs/modules/core/RewardAddress.mdx | 2 +- docs/content/docs/modules/core/Script.mdx | 2 +- .../docs/modules/core/ScriptDataHash.mdx | 2 +- docs/content/docs/modules/core/ScriptHash.mdx | 2 +- docs/content/docs/modules/core/ScriptRef.mdx | 2 +- .../docs/modules/core/SingleHostAddr.mdx | 2 +- .../docs/modules/core/SingleHostName.mdx | 2 +- .../docs/modules/core/StakeReference.mdx | 2 +- docs/content/docs/modules/core/TSchema.mdx | 38 ++-- docs/content/docs/modules/core/Text.mdx | 2 +- docs/content/docs/modules/core/Text128.mdx | 2 +- .../content/docs/modules/core/Transaction.mdx | 2 +- .../docs/modules/core/TransactionBody.mdx | 4 +- .../docs/modules/core/TransactionHash.mdx | 2 +- .../docs/modules/core/TransactionIndex.mdx | 2 +- .../docs/modules/core/TransactionInput.mdx | 2 +- .../modules/core/TransactionMetadatum.mdx | 2 +- .../core/TransactionMetadatumLabels.mdx | 2 +- .../docs/modules/core/TransactionOutput.mdx | 2 +- .../modules/core/TransactionWitnessSet.mdx | 2 +- .../docs/modules/core/UnitInterval.mdx | 2 +- docs/content/docs/modules/core/Url.mdx | 2 +- docs/content/docs/modules/core/VKey.mdx | 2 +- docs/content/docs/modules/core/Value.mdx | 2 +- .../docs/modules/core/VotingProcedures.mdx | 2 +- docs/content/docs/modules/core/VrfCert.mdx | 2 +- docs/content/docs/modules/core/VrfKeyHash.mdx | 2 +- docs/content/docs/modules/core/VrfVkey.mdx | 2 +- .../content/docs/modules/core/Withdrawals.mdx | 2 +- docs/content/docs/modules/sdk/Address.mdx | 108 +--------- .../modules/{core => sdk}/AddressDetails.mdx | 76 +------ docs/content/docs/modules/sdk/Assets.mdx | 190 +++++++++++++++++- docs/content/docs/modules/sdk/Credential.mdx | 22 +- .../evolution/docs/modules/sdk/Assets.ts.md | 8 - packages/evolution/src/sdk/Assets.ts | 8 - 129 files changed, 409 insertions(+), 410 deletions(-) rename docs/content/docs/modules/core/{AddressStructure.mdx => Address.mdx} (69%) rename docs/content/docs/modules/{core => sdk}/AddressDetails.mdx (56%) diff --git a/docs/content/docs/modules/core/AddressStructure.mdx b/docs/content/docs/modules/core/Address.mdx similarity index 69% rename from docs/content/docs/modules/core/AddressStructure.mdx rename to docs/content/docs/modules/core/Address.mdx index e652b71d..1ec9ad81 100644 --- a/docs/content/docs/modules/core/AddressStructure.mdx +++ b/docs/content/docs/modules/core/Address.mdx @@ -1,10 +1,10 @@ --- -title: core/AddressStructure.ts -nav_order: 3 +title: core/Address.ts +nav_order: 1 parent: Modules --- -## AddressStructure overview +## Address overview Added in v1.0.0 @@ -17,7 +17,7 @@ Added in v1.0.0 - [Functions](#functions) - [fromBech32](#frombech32) - [Schema](#schema) - - [AddressStructure (class)](#addressstructure-class) + - [Address (class)](#address-class) - [toString (method)](#tostring-method) - [[Symbol.for("nodejs.util.inspect.custom")] (method)](#symbolfornodejsutilinspectcustom-method) - [Transformations](#transformations) @@ -30,7 +30,7 @@ Added in v1.0.0 - [hasStakingCredential](#hasstakingcredential) - [isEnterprise](#isenterprise) - [utils](#utils-1) - - [AddressStructureError (class)](#addressstructureerror-class) + - [AddressError (class)](#addresserror-class) - [Either (namespace)](#either-namespace) - [fromBytes](#frombytes-1) - [fromHex](#fromhex-1) @@ -49,7 +49,7 @@ FastCheck arbitrary generator for testing **Signature** ```ts -export declare const arbitrary: FastCheck.Arbitrary +export declare const arbitrary: FastCheck.Arbitrary
``` Added in v1.0.0 @@ -63,19 +63,19 @@ Sync functions using Function module utilities **Signature** ```ts -export declare const fromBech32: (input: string) => AddressStructure +export declare const fromBech32: (input: string) => Address ``` Added in v1.0.0 # Schema -## AddressStructure (class) +## Address (class) **Signature** ```ts -export declare class AddressStructure +export declare class Address ``` Added in v1.0.0 @@ -107,7 +107,7 @@ Transform from Bech32 string to AddressStructure ```ts export declare const FromBech32: Schema.transformOrFail< typeof Schema.String, - Schema.SchemaClass, + Schema.SchemaClass, never > ``` @@ -124,7 +124,7 @@ Handles both BaseAddress (57 bytes) and EnterpriseAddress (29 bytes) ```ts export declare const FromBytes: Schema.transformOrFail< Schema.Union<[Schema.filter, Schema.filter]>, - Schema.SchemaClass, + Schema.SchemaClass, never > ``` @@ -142,7 +142,7 @@ export declare const FromHex: Schema.transform< Schema.transform, Schema.Schema>, Schema.transformOrFail< Schema.Union<[Schema.filter, Schema.filter]>, - Schema.SchemaClass, + Schema.SchemaClass, never > > @@ -159,7 +159,7 @@ Check if two AddressStructure instances are equal. **Signature** ```ts -export declare const equals: (a: AddressStructure, b: AddressStructure) => boolean +export declare const equals: (a: Address, b: Address) => boolean ``` Added in v1.0.0 @@ -171,7 +171,7 @@ Get network ID from AddressStructure **Signature** ```ts -export declare const getNetworkId: (address: AddressStructure) => NetworkId.NetworkId +export declare const getNetworkId: (address: Address) => NetworkId.NetworkId ``` Added in v1.0.0 @@ -183,7 +183,7 @@ Check if AddressStructure has staking credential (BaseAddress-like) **Signature** ```ts -export declare const hasStakingCredential: (address: AddressStructure) => boolean +export declare const hasStakingCredential: (address: Address) => boolean ``` Added in v1.0.0 @@ -195,19 +195,19 @@ Check if AddressStructure is enterprise-like (no staking credential) **Signature** ```ts -export declare const isEnterprise: (address: AddressStructure) => boolean +export declare const isEnterprise: (address: Address) => boolean ``` Added in v1.0.0 # utils -## AddressStructureError (class) +## AddressError (class) **Signature** ```ts -export declare class AddressStructureError +export declare class AddressError ``` ## Either (namespace) @@ -217,7 +217,7 @@ export declare class AddressStructureError **Signature** ```ts -export declare const fromBytes: (input: any) => AddressStructure +export declare const fromBytes: (input: any) => Address ``` ## fromHex @@ -225,7 +225,7 @@ export declare const fromBytes: (input: any) => AddressStructure **Signature** ```ts -export declare const fromHex: (input: string) => AddressStructure +export declare const fromHex: (input: string) => Address ``` ## toBech32 @@ -233,7 +233,7 @@ export declare const fromHex: (input: string) => AddressStructure **Signature** ```ts -export declare const toBech32: (input: AddressStructure) => string +export declare const toBech32: (input: Address) => string ``` ## toBytes @@ -241,7 +241,7 @@ export declare const toBech32: (input: AddressStructure) => string **Signature** ```ts -export declare const toBytes: (input: AddressStructure) => any +export declare const toBytes: (input: Address) => any ``` ## toHex @@ -249,5 +249,5 @@ export declare const toBytes: (input: AddressStructure) => any **Signature** ```ts -export declare const toHex: (input: AddressStructure) => string +export declare const toHex: (input: Address) => string ``` diff --git a/docs/content/docs/modules/core/AddressEras.mdx b/docs/content/docs/modules/core/AddressEras.mdx index 73ec7192..7f5c19ac 100644 --- a/docs/content/docs/modules/core/AddressEras.mdx +++ b/docs/content/docs/modules/core/AddressEras.mdx @@ -21,7 +21,7 @@ parent: Modules - [model](#model) - [AddressEras](#addresseras) - [AddressEras (type alias)](#addresseras-type-alias) - - [AddressError (class)](#addresserror-class) + - [AddressErasError (class)](#addresseraserror-class) - [parsing](#parsing) - [fromBech32](#frombech32) - [fromBytes](#frombytes) @@ -156,14 +156,14 @@ export type AddressEras = typeof AddressEras.Type Added in v2.0.0 -## AddressError (class) +## AddressErasError (class) Error thrown when address operations fail **Signature** ```ts -export declare class AddressError +export declare class AddressErasError ``` Added in v2.0.0 diff --git a/docs/content/docs/modules/core/AddressTag.mdx b/docs/content/docs/modules/core/AddressTag.mdx index 44e5a172..9a3a1789 100644 --- a/docs/content/docs/modules/core/AddressTag.mdx +++ b/docs/content/docs/modules/core/AddressTag.mdx @@ -1,6 +1,6 @@ --- title: core/AddressTag.ts -nav_order: 4 +nav_order: 3 parent: Modules --- diff --git a/docs/content/docs/modules/core/Anchor.mdx b/docs/content/docs/modules/core/Anchor.mdx index e7d26960..9a09230f 100644 --- a/docs/content/docs/modules/core/Anchor.mdx +++ b/docs/content/docs/modules/core/Anchor.mdx @@ -1,6 +1,6 @@ --- title: core/Anchor.ts -nav_order: 5 +nav_order: 4 parent: Modules --- diff --git a/docs/content/docs/modules/core/AssetName.mdx b/docs/content/docs/modules/core/AssetName.mdx index 0d3b2566..f8a5dd00 100644 --- a/docs/content/docs/modules/core/AssetName.mdx +++ b/docs/content/docs/modules/core/AssetName.mdx @@ -1,6 +1,6 @@ --- title: core/AssetName.ts -nav_order: 6 +nav_order: 5 parent: Modules --- diff --git a/docs/content/docs/modules/core/AuxiliaryData.mdx b/docs/content/docs/modules/core/AuxiliaryData.mdx index c4315236..569212bf 100644 --- a/docs/content/docs/modules/core/AuxiliaryData.mdx +++ b/docs/content/docs/modules/core/AuxiliaryData.mdx @@ -1,6 +1,6 @@ --- title: core/AuxiliaryData.ts -nav_order: 7 +nav_order: 6 parent: Modules --- diff --git a/docs/content/docs/modules/core/AuxiliaryDataHash.mdx b/docs/content/docs/modules/core/AuxiliaryDataHash.mdx index 8c3225a9..1f8e0e93 100644 --- a/docs/content/docs/modules/core/AuxiliaryDataHash.mdx +++ b/docs/content/docs/modules/core/AuxiliaryDataHash.mdx @@ -1,6 +1,6 @@ --- title: core/AuxiliaryDataHash.ts -nav_order: 8 +nav_order: 7 parent: Modules --- diff --git a/docs/content/docs/modules/core/BaseAddress.mdx b/docs/content/docs/modules/core/BaseAddress.mdx index 4ecc4f0c..a27893f0 100644 --- a/docs/content/docs/modules/core/BaseAddress.mdx +++ b/docs/content/docs/modules/core/BaseAddress.mdx @@ -1,6 +1,6 @@ --- title: core/BaseAddress.ts -nav_order: 9 +nav_order: 8 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bech32.mdx b/docs/content/docs/modules/core/Bech32.mdx index 8ba7cfa5..952ef936 100644 --- a/docs/content/docs/modules/core/Bech32.mdx +++ b/docs/content/docs/modules/core/Bech32.mdx @@ -1,6 +1,6 @@ --- title: core/Bech32.ts -nav_order: 10 +nav_order: 9 parent: Modules --- diff --git a/docs/content/docs/modules/core/BigInt.mdx b/docs/content/docs/modules/core/BigInt.mdx index 901ecf54..6912bb03 100644 --- a/docs/content/docs/modules/core/BigInt.mdx +++ b/docs/content/docs/modules/core/BigInt.mdx @@ -1,6 +1,6 @@ --- title: core/BigInt.ts -nav_order: 11 +nav_order: 10 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bip32PrivateKey.mdx b/docs/content/docs/modules/core/Bip32PrivateKey.mdx index 89501cff..66576a39 100644 --- a/docs/content/docs/modules/core/Bip32PrivateKey.mdx +++ b/docs/content/docs/modules/core/Bip32PrivateKey.mdx @@ -1,6 +1,6 @@ --- title: core/Bip32PrivateKey.ts -nav_order: 12 +nav_order: 11 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bip32PublicKey.mdx b/docs/content/docs/modules/core/Bip32PublicKey.mdx index 2711f41d..10f29eaf 100644 --- a/docs/content/docs/modules/core/Bip32PublicKey.mdx +++ b/docs/content/docs/modules/core/Bip32PublicKey.mdx @@ -1,6 +1,6 @@ --- title: core/Bip32PublicKey.ts -nav_order: 13 +nav_order: 12 parent: Modules --- diff --git a/docs/content/docs/modules/core/Block.mdx b/docs/content/docs/modules/core/Block.mdx index 707e6cd3..9c8c3528 100644 --- a/docs/content/docs/modules/core/Block.mdx +++ b/docs/content/docs/modules/core/Block.mdx @@ -1,6 +1,6 @@ --- title: core/Block.ts -nav_order: 14 +nav_order: 13 parent: Modules --- diff --git a/docs/content/docs/modules/core/BlockBodyHash.mdx b/docs/content/docs/modules/core/BlockBodyHash.mdx index 685aaa9c..56b29f87 100644 --- a/docs/content/docs/modules/core/BlockBodyHash.mdx +++ b/docs/content/docs/modules/core/BlockBodyHash.mdx @@ -1,6 +1,6 @@ --- title: core/BlockBodyHash.ts -nav_order: 15 +nav_order: 14 parent: Modules --- diff --git a/docs/content/docs/modules/core/BlockHeaderHash.mdx b/docs/content/docs/modules/core/BlockHeaderHash.mdx index e5bd6e5b..d5fba4b6 100644 --- a/docs/content/docs/modules/core/BlockHeaderHash.mdx +++ b/docs/content/docs/modules/core/BlockHeaderHash.mdx @@ -1,6 +1,6 @@ --- title: core/BlockHeaderHash.ts -nav_order: 16 +nav_order: 15 parent: Modules --- diff --git a/docs/content/docs/modules/core/BootstrapWitness.mdx b/docs/content/docs/modules/core/BootstrapWitness.mdx index 174bf69c..b10b6609 100644 --- a/docs/content/docs/modules/core/BootstrapWitness.mdx +++ b/docs/content/docs/modules/core/BootstrapWitness.mdx @@ -1,6 +1,6 @@ --- title: core/BootstrapWitness.ts -nav_order: 17 +nav_order: 16 parent: Modules --- diff --git a/docs/content/docs/modules/core/BoundedBytes.mdx b/docs/content/docs/modules/core/BoundedBytes.mdx index 5607eef2..5e28a21d 100644 --- a/docs/content/docs/modules/core/BoundedBytes.mdx +++ b/docs/content/docs/modules/core/BoundedBytes.mdx @@ -1,6 +1,6 @@ --- title: core/BoundedBytes.ts -nav_order: 18 +nav_order: 17 parent: Modules --- diff --git a/docs/content/docs/modules/core/ByronAddress.mdx b/docs/content/docs/modules/core/ByronAddress.mdx index b37f3c4c..5a8c7776 100644 --- a/docs/content/docs/modules/core/ByronAddress.mdx +++ b/docs/content/docs/modules/core/ByronAddress.mdx @@ -1,6 +1,6 @@ --- title: core/ByronAddress.ts -nav_order: 19 +nav_order: 18 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes.mdx b/docs/content/docs/modules/core/Bytes.mdx index 1d5bb795..a5496049 100644 --- a/docs/content/docs/modules/core/Bytes.mdx +++ b/docs/content/docs/modules/core/Bytes.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes.ts -nav_order: 20 +nav_order: 19 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes128.mdx b/docs/content/docs/modules/core/Bytes128.mdx index ba3d0e03..8f670fdd 100644 --- a/docs/content/docs/modules/core/Bytes128.mdx +++ b/docs/content/docs/modules/core/Bytes128.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes128.ts -nav_order: 21 +nav_order: 20 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes16.mdx b/docs/content/docs/modules/core/Bytes16.mdx index 7eb4f64b..362ec0db 100644 --- a/docs/content/docs/modules/core/Bytes16.mdx +++ b/docs/content/docs/modules/core/Bytes16.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes16.ts -nav_order: 22 +nav_order: 21 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes29.mdx b/docs/content/docs/modules/core/Bytes29.mdx index 5f91dee5..ab0c7432 100644 --- a/docs/content/docs/modules/core/Bytes29.mdx +++ b/docs/content/docs/modules/core/Bytes29.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes29.ts -nav_order: 23 +nav_order: 22 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes32.mdx b/docs/content/docs/modules/core/Bytes32.mdx index 6eef668e..ae4cf78a 100644 --- a/docs/content/docs/modules/core/Bytes32.mdx +++ b/docs/content/docs/modules/core/Bytes32.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes32.ts -nav_order: 24 +nav_order: 23 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes4.mdx b/docs/content/docs/modules/core/Bytes4.mdx index b5682b9d..8b636cc6 100644 --- a/docs/content/docs/modules/core/Bytes4.mdx +++ b/docs/content/docs/modules/core/Bytes4.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes4.ts -nav_order: 25 +nav_order: 24 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes448.mdx b/docs/content/docs/modules/core/Bytes448.mdx index 3042353d..dd646304 100644 --- a/docs/content/docs/modules/core/Bytes448.mdx +++ b/docs/content/docs/modules/core/Bytes448.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes448.ts -nav_order: 26 +nav_order: 25 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes57.mdx b/docs/content/docs/modules/core/Bytes57.mdx index 45b667b5..8c74cc84 100644 --- a/docs/content/docs/modules/core/Bytes57.mdx +++ b/docs/content/docs/modules/core/Bytes57.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes57.ts -nav_order: 27 +nav_order: 26 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes64.mdx b/docs/content/docs/modules/core/Bytes64.mdx index d844b3ca..00dd11a5 100644 --- a/docs/content/docs/modules/core/Bytes64.mdx +++ b/docs/content/docs/modules/core/Bytes64.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes64.ts -nav_order: 28 +nav_order: 27 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes80.mdx b/docs/content/docs/modules/core/Bytes80.mdx index dfbaa2f7..24595cfb 100644 --- a/docs/content/docs/modules/core/Bytes80.mdx +++ b/docs/content/docs/modules/core/Bytes80.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes80.ts -nav_order: 29 +nav_order: 28 parent: Modules --- diff --git a/docs/content/docs/modules/core/Bytes96.mdx b/docs/content/docs/modules/core/Bytes96.mdx index a0a15db4..a5c22bb8 100644 --- a/docs/content/docs/modules/core/Bytes96.mdx +++ b/docs/content/docs/modules/core/Bytes96.mdx @@ -1,6 +1,6 @@ --- title: core/Bytes96.ts -nav_order: 30 +nav_order: 29 parent: Modules --- diff --git a/docs/content/docs/modules/core/CBOR.mdx b/docs/content/docs/modules/core/CBOR.mdx index 1ec976c3..407e023a 100644 --- a/docs/content/docs/modules/core/CBOR.mdx +++ b/docs/content/docs/modules/core/CBOR.mdx @@ -1,6 +1,6 @@ --- title: core/CBOR.ts -nav_order: 31 +nav_order: 30 parent: Modules --- diff --git a/docs/content/docs/modules/core/Certificate.mdx b/docs/content/docs/modules/core/Certificate.mdx index 84908cc7..4c7894e0 100644 --- a/docs/content/docs/modules/core/Certificate.mdx +++ b/docs/content/docs/modules/core/Certificate.mdx @@ -1,6 +1,6 @@ --- title: core/Certificate.ts -nav_order: 32 +nav_order: 31 parent: Modules --- diff --git a/docs/content/docs/modules/core/Codec.mdx b/docs/content/docs/modules/core/Codec.mdx index b8072a00..509d33ae 100644 --- a/docs/content/docs/modules/core/Codec.mdx +++ b/docs/content/docs/modules/core/Codec.mdx @@ -1,6 +1,6 @@ --- title: core/Codec.ts -nav_order: 33 +nav_order: 32 parent: Modules --- diff --git a/docs/content/docs/modules/core/Coin.mdx b/docs/content/docs/modules/core/Coin.mdx index e0be744c..83e512a3 100644 --- a/docs/content/docs/modules/core/Coin.mdx +++ b/docs/content/docs/modules/core/Coin.mdx @@ -1,6 +1,6 @@ --- title: core/Coin.ts -nav_order: 34 +nav_order: 33 parent: Modules --- diff --git a/docs/content/docs/modules/core/Combinator.mdx b/docs/content/docs/modules/core/Combinator.mdx index ae6aedc3..77d9d6a0 100644 --- a/docs/content/docs/modules/core/Combinator.mdx +++ b/docs/content/docs/modules/core/Combinator.mdx @@ -1,6 +1,6 @@ --- title: core/Combinator.ts -nav_order: 35 +nav_order: 34 parent: Modules --- diff --git a/docs/content/docs/modules/core/CommitteeColdCredential.mdx b/docs/content/docs/modules/core/CommitteeColdCredential.mdx index d9af4fcd..6cdc6f0d 100644 --- a/docs/content/docs/modules/core/CommitteeColdCredential.mdx +++ b/docs/content/docs/modules/core/CommitteeColdCredential.mdx @@ -1,6 +1,6 @@ --- title: core/CommitteeColdCredential.ts -nav_order: 36 +nav_order: 35 parent: Modules --- diff --git a/docs/content/docs/modules/core/CommitteeHotCredential.mdx b/docs/content/docs/modules/core/CommitteeHotCredential.mdx index b3a067be..867153a7 100644 --- a/docs/content/docs/modules/core/CommitteeHotCredential.mdx +++ b/docs/content/docs/modules/core/CommitteeHotCredential.mdx @@ -1,6 +1,6 @@ --- title: core/CommitteeHotCredential.ts -nav_order: 37 +nav_order: 36 parent: Modules --- diff --git a/docs/content/docs/modules/core/Constitution.mdx b/docs/content/docs/modules/core/Constitution.mdx index 69c92b7c..a634bfb1 100644 --- a/docs/content/docs/modules/core/Constitution.mdx +++ b/docs/content/docs/modules/core/Constitution.mdx @@ -1,6 +1,6 @@ --- title: core/Constitution.ts -nav_order: 38 +nav_order: 37 parent: Modules --- diff --git a/docs/content/docs/modules/core/CostModel.mdx b/docs/content/docs/modules/core/CostModel.mdx index 68985cd2..d0a73fa0 100644 --- a/docs/content/docs/modules/core/CostModel.mdx +++ b/docs/content/docs/modules/core/CostModel.mdx @@ -1,6 +1,6 @@ --- title: core/CostModel.ts -nav_order: 39 +nav_order: 38 parent: Modules --- diff --git a/docs/content/docs/modules/core/Credential.mdx b/docs/content/docs/modules/core/Credential.mdx index 203bb58f..083c11eb 100644 --- a/docs/content/docs/modules/core/Credential.mdx +++ b/docs/content/docs/modules/core/Credential.mdx @@ -1,6 +1,6 @@ --- title: core/Credential.ts -nav_order: 40 +nav_order: 39 parent: Modules --- diff --git a/docs/content/docs/modules/core/DRep.mdx b/docs/content/docs/modules/core/DRep.mdx index 023031be..7223b7ce 100644 --- a/docs/content/docs/modules/core/DRep.mdx +++ b/docs/content/docs/modules/core/DRep.mdx @@ -1,6 +1,6 @@ --- title: core/DRep.ts -nav_order: 45 +nav_order: 44 parent: Modules --- diff --git a/docs/content/docs/modules/core/DRepCredential.mdx b/docs/content/docs/modules/core/DRepCredential.mdx index 21bdc08f..d0b17900 100644 --- a/docs/content/docs/modules/core/DRepCredential.mdx +++ b/docs/content/docs/modules/core/DRepCredential.mdx @@ -1,6 +1,6 @@ --- title: core/DRepCredential.ts -nav_order: 46 +nav_order: 45 parent: Modules --- diff --git a/docs/content/docs/modules/core/Data.mdx b/docs/content/docs/modules/core/Data.mdx index 67a7e5a4..dc479a78 100644 --- a/docs/content/docs/modules/core/Data.mdx +++ b/docs/content/docs/modules/core/Data.mdx @@ -1,6 +1,6 @@ --- title: core/Data.ts -nav_order: 41 +nav_order: 40 parent: Modules --- diff --git a/docs/content/docs/modules/core/DataJson.mdx b/docs/content/docs/modules/core/DataJson.mdx index 517e9607..ba80aede 100644 --- a/docs/content/docs/modules/core/DataJson.mdx +++ b/docs/content/docs/modules/core/DataJson.mdx @@ -1,6 +1,6 @@ --- title: core/DataJson.ts -nav_order: 42 +nav_order: 41 parent: Modules --- diff --git a/docs/content/docs/modules/core/DatumOption.mdx b/docs/content/docs/modules/core/DatumOption.mdx index 93185a27..7537b0f8 100644 --- a/docs/content/docs/modules/core/DatumOption.mdx +++ b/docs/content/docs/modules/core/DatumOption.mdx @@ -1,6 +1,6 @@ --- title: core/DatumOption.ts -nav_order: 43 +nav_order: 42 parent: Modules --- diff --git a/docs/content/docs/modules/core/DnsName.mdx b/docs/content/docs/modules/core/DnsName.mdx index 76a691a8..b07d35cc 100644 --- a/docs/content/docs/modules/core/DnsName.mdx +++ b/docs/content/docs/modules/core/DnsName.mdx @@ -1,6 +1,6 @@ --- title: core/DnsName.ts -nav_order: 44 +nav_order: 43 parent: Modules --- diff --git a/docs/content/docs/modules/core/Ed25519Signature.mdx b/docs/content/docs/modules/core/Ed25519Signature.mdx index 7e48bd96..4c37a0c8 100644 --- a/docs/content/docs/modules/core/Ed25519Signature.mdx +++ b/docs/content/docs/modules/core/Ed25519Signature.mdx @@ -1,6 +1,6 @@ --- title: core/Ed25519Signature.ts -nav_order: 47 +nav_order: 46 parent: Modules --- diff --git a/docs/content/docs/modules/core/EnterpriseAddress.mdx b/docs/content/docs/modules/core/EnterpriseAddress.mdx index 1fc514b3..16021806 100644 --- a/docs/content/docs/modules/core/EnterpriseAddress.mdx +++ b/docs/content/docs/modules/core/EnterpriseAddress.mdx @@ -1,6 +1,6 @@ --- title: core/EnterpriseAddress.ts -nav_order: 48 +nav_order: 47 parent: Modules --- diff --git a/docs/content/docs/modules/core/EpochNo.mdx b/docs/content/docs/modules/core/EpochNo.mdx index 82d88c4b..bda44abe 100644 --- a/docs/content/docs/modules/core/EpochNo.mdx +++ b/docs/content/docs/modules/core/EpochNo.mdx @@ -1,6 +1,6 @@ --- title: core/EpochNo.ts -nav_order: 49 +nav_order: 48 parent: Modules --- diff --git a/docs/content/docs/modules/core/FormatError.mdx b/docs/content/docs/modules/core/FormatError.mdx index aa81de29..2db70936 100644 --- a/docs/content/docs/modules/core/FormatError.mdx +++ b/docs/content/docs/modules/core/FormatError.mdx @@ -1,6 +1,6 @@ --- title: core/FormatError.ts -nav_order: 50 +nav_order: 49 parent: Modules --- diff --git a/docs/content/docs/modules/core/Function.mdx b/docs/content/docs/modules/core/Function.mdx index 638e7639..31adf963 100644 --- a/docs/content/docs/modules/core/Function.mdx +++ b/docs/content/docs/modules/core/Function.mdx @@ -1,6 +1,6 @@ --- title: core/Function.ts -nav_order: 51 +nav_order: 50 parent: Modules --- diff --git a/docs/content/docs/modules/core/GovernanceAction.mdx b/docs/content/docs/modules/core/GovernanceAction.mdx index 19e58d18..8adc595d 100644 --- a/docs/content/docs/modules/core/GovernanceAction.mdx +++ b/docs/content/docs/modules/core/GovernanceAction.mdx @@ -1,6 +1,6 @@ --- title: core/GovernanceAction.ts -nav_order: 52 +nav_order: 51 parent: Modules --- diff --git a/docs/content/docs/modules/core/Hash28.mdx b/docs/content/docs/modules/core/Hash28.mdx index 6d58047d..08ade2f5 100644 --- a/docs/content/docs/modules/core/Hash28.mdx +++ b/docs/content/docs/modules/core/Hash28.mdx @@ -1,6 +1,6 @@ --- title: core/Hash28.ts -nav_order: 53 +nav_order: 52 parent: Modules --- diff --git a/docs/content/docs/modules/core/Header.mdx b/docs/content/docs/modules/core/Header.mdx index 2b4842b7..6de1f4de 100644 --- a/docs/content/docs/modules/core/Header.mdx +++ b/docs/content/docs/modules/core/Header.mdx @@ -1,6 +1,6 @@ --- title: core/Header.ts -nav_order: 54 +nav_order: 53 parent: Modules --- diff --git a/docs/content/docs/modules/core/HeaderBody.mdx b/docs/content/docs/modules/core/HeaderBody.mdx index 742459fa..633b6cfc 100644 --- a/docs/content/docs/modules/core/HeaderBody.mdx +++ b/docs/content/docs/modules/core/HeaderBody.mdx @@ -1,6 +1,6 @@ --- title: core/HeaderBody.ts -nav_order: 55 +nav_order: 54 parent: Modules --- diff --git a/docs/content/docs/modules/core/IPv4.mdx b/docs/content/docs/modules/core/IPv4.mdx index 888234f3..9b69da3c 100644 --- a/docs/content/docs/modules/core/IPv4.mdx +++ b/docs/content/docs/modules/core/IPv4.mdx @@ -1,6 +1,6 @@ --- title: core/IPv4.ts -nav_order: 56 +nav_order: 55 parent: Modules --- diff --git a/docs/content/docs/modules/core/IPv6.mdx b/docs/content/docs/modules/core/IPv6.mdx index 56219ae1..b927ff08 100644 --- a/docs/content/docs/modules/core/IPv6.mdx +++ b/docs/content/docs/modules/core/IPv6.mdx @@ -1,6 +1,6 @@ --- title: core/IPv6.ts -nav_order: 57 +nav_order: 56 parent: Modules --- diff --git a/docs/content/docs/modules/core/KESVkey.mdx b/docs/content/docs/modules/core/KESVkey.mdx index 69b6c0d3..9ed9415c 100644 --- a/docs/content/docs/modules/core/KESVkey.mdx +++ b/docs/content/docs/modules/core/KESVkey.mdx @@ -1,6 +1,6 @@ --- title: core/KESVkey.ts -nav_order: 59 +nav_order: 58 parent: Modules --- diff --git a/docs/content/docs/modules/core/KesSignature.mdx b/docs/content/docs/modules/core/KesSignature.mdx index 6556c9e3..8b404d24 100644 --- a/docs/content/docs/modules/core/KesSignature.mdx +++ b/docs/content/docs/modules/core/KesSignature.mdx @@ -1,6 +1,6 @@ --- title: core/KesSignature.ts -nav_order: 58 +nav_order: 57 parent: Modules --- diff --git a/docs/content/docs/modules/core/KeyHash.mdx b/docs/content/docs/modules/core/KeyHash.mdx index 0b7b925f..67aae639 100644 --- a/docs/content/docs/modules/core/KeyHash.mdx +++ b/docs/content/docs/modules/core/KeyHash.mdx @@ -1,6 +1,6 @@ --- title: core/KeyHash.ts -nav_order: 60 +nav_order: 59 parent: Modules --- @@ -200,7 +200,7 @@ Added in v2.0.0 **Signature** ```ts -toJSON(): string +toJSON() ``` ### toString (method) diff --git a/docs/content/docs/modules/core/Language.mdx b/docs/content/docs/modules/core/Language.mdx index 39503815..ab71ec6b 100644 --- a/docs/content/docs/modules/core/Language.mdx +++ b/docs/content/docs/modules/core/Language.mdx @@ -1,6 +1,6 @@ --- title: core/Language.ts -nav_order: 61 +nav_order: 60 parent: Modules --- diff --git a/docs/content/docs/modules/core/Metadata.mdx b/docs/content/docs/modules/core/Metadata.mdx index 6261fe89..ced04947 100644 --- a/docs/content/docs/modules/core/Metadata.mdx +++ b/docs/content/docs/modules/core/Metadata.mdx @@ -1,6 +1,6 @@ --- title: core/Metadata.ts -nav_order: 62 +nav_order: 61 parent: Modules --- diff --git a/docs/content/docs/modules/core/Mint.mdx b/docs/content/docs/modules/core/Mint.mdx index a020d3f1..018dd196 100644 --- a/docs/content/docs/modules/core/Mint.mdx +++ b/docs/content/docs/modules/core/Mint.mdx @@ -1,6 +1,6 @@ --- title: core/Mint.ts -nav_order: 63 +nav_order: 62 parent: Modules --- @@ -61,9 +61,7 @@ FastCheck arbitrary for generating random Mint instances. **Signature** ```ts -export declare const arbitrary: FastCheck.Arbitrary< - Map> & Brand<"Mint"> -> +export declare const arbitrary: FastCheck.Arbitrary>> ``` Added in v2.0.0 @@ -130,7 +128,7 @@ Encode Mint to CBOR bytes. ```ts export declare const toCBORBytes: ( - input: Map> & Brand<"Mint">, + input: Map>, options?: CBOR.CodecOptions ) => Uint8Array ``` @@ -145,7 +143,7 @@ Encode Mint to CBOR hex string. ```ts export declare const toCBORHex: ( - input: Map> & Brand<"Mint">, + input: Map>, options?: CBOR.CodecOptions ) => string ``` @@ -208,7 +206,7 @@ Parse Mint from CBOR bytes. export declare const fromCBORBytes: ( bytes: Uint8Array, options?: CBOR.CodecOptions -) => Map> & Brand<"Mint"> +) => Map> ``` Added in v2.0.0 @@ -223,7 +221,7 @@ Parse Mint from CBOR hex string. export declare const fromCBORHex: ( hex: string, options?: CBOR.CodecOptions -) => Map> & Brand<"Mint"> +) => Map> ``` Added in v2.0.0 @@ -252,7 +250,7 @@ Check if a value is a valid Mint. export declare const is: ( u: unknown, overrideOptions?: ParseOptions | number -) => u is Map> & Brand<"Mint"> +) => u is Map> ``` Added in v2.0.0 @@ -317,8 +315,8 @@ export declare const FromCBORBytes: ( Schema.transformOrFail< Schema.SchemaClass>, ReadonlyMap>, never>, Schema.SchemaClass< - Map> & Brand<"Mint">, - Map> & Brand<"Mint">, + Map>, + Map>, never >, never @@ -349,8 +347,8 @@ export declare const FromCBORHex: ( Schema.transformOrFail< Schema.SchemaClass>, ReadonlyMap>, never>, Schema.SchemaClass< - Map> & Brand<"Mint">, - Map> & Brand<"Mint">, + Map>, + Map>, never >, never @@ -381,8 +379,8 @@ Where: export declare const FromCDDL: Schema.transformOrFail< Schema.SchemaClass>, ReadonlyMap>, never>, Schema.SchemaClass< - Map> & Brand<"Mint">, - Map> & Brand<"Mint">, + Map>, + Map>, never >, never @@ -406,23 +404,28 @@ The structure is: policy_id => { asset_name => nonZeroInt64 } **Signature** ```ts -export declare const Mint: Schema.brand< - Schema.Map$< - typeof PolicyId.PolicyId, - Schema.transform< - Schema.Array$< - Schema.Tuple2< - typeof AssetName.AssetName, - Schema.Union<[Schema.refine, Schema.refine]> +export declare const Mint: Schema.transform< + Schema.Array$< + Schema.Tuple2< + typeof PolicyId.PolicyId, + Schema.transform< + Schema.Array$< + Schema.Tuple2< + typeof AssetName.AssetName, + Schema.Union<[Schema.refine, Schema.refine]> + > + >, + Schema.MapFromSelf< + Schema.SchemaClass, + Schema.SchemaClass > - >, - Schema.MapFromSelf< - Schema.SchemaClass, - Schema.SchemaClass > > >, - "Mint" + Schema.MapFromSelf< + Schema.SchemaClass, + Schema.SchemaClass, Map, never> + > > ``` diff --git a/docs/content/docs/modules/core/MultiAsset.mdx b/docs/content/docs/modules/core/MultiAsset.mdx index 18e5d254..c3248117 100644 --- a/docs/content/docs/modules/core/MultiAsset.mdx +++ b/docs/content/docs/modules/core/MultiAsset.mdx @@ -1,6 +1,6 @@ --- title: core/MultiAsset.ts -nav_order: 64 +nav_order: 63 parent: Modules --- diff --git a/docs/content/docs/modules/core/MultiHostName.mdx b/docs/content/docs/modules/core/MultiHostName.mdx index 3aee2e92..2b762039 100644 --- a/docs/content/docs/modules/core/MultiHostName.mdx +++ b/docs/content/docs/modules/core/MultiHostName.mdx @@ -1,6 +1,6 @@ --- title: core/MultiHostName.ts -nav_order: 65 +nav_order: 64 parent: Modules --- diff --git a/docs/content/docs/modules/core/NativeScriptJSON.mdx b/docs/content/docs/modules/core/NativeScriptJSON.mdx index bc5bffc9..752c3e31 100644 --- a/docs/content/docs/modules/core/NativeScriptJSON.mdx +++ b/docs/content/docs/modules/core/NativeScriptJSON.mdx @@ -1,6 +1,6 @@ --- title: core/NativeScriptJSON.ts -nav_order: 66 +nav_order: 65 parent: Modules --- diff --git a/docs/content/docs/modules/core/NativeScripts.mdx b/docs/content/docs/modules/core/NativeScripts.mdx index 131c26e4..bf4bc8ef 100644 --- a/docs/content/docs/modules/core/NativeScripts.mdx +++ b/docs/content/docs/modules/core/NativeScripts.mdx @@ -1,6 +1,6 @@ --- title: core/NativeScripts.ts -nav_order: 67 +nav_order: 66 parent: Modules --- diff --git a/docs/content/docs/modules/core/NativeScriptsOLD.mdx b/docs/content/docs/modules/core/NativeScriptsOLD.mdx index c2ebfd0c..3671344e 100644 --- a/docs/content/docs/modules/core/NativeScriptsOLD.mdx +++ b/docs/content/docs/modules/core/NativeScriptsOLD.mdx @@ -1,6 +1,6 @@ --- title: core/NativeScriptsOLD.ts -nav_order: 68 +nav_order: 67 parent: Modules --- diff --git a/docs/content/docs/modules/core/Natural.mdx b/docs/content/docs/modules/core/Natural.mdx index 9e330158..a7ab4e05 100644 --- a/docs/content/docs/modules/core/Natural.mdx +++ b/docs/content/docs/modules/core/Natural.mdx @@ -1,6 +1,6 @@ --- title: core/Natural.ts -nav_order: 69 +nav_order: 68 parent: Modules --- diff --git a/docs/content/docs/modules/core/Network.mdx b/docs/content/docs/modules/core/Network.mdx index 75f21b64..e78017a2 100644 --- a/docs/content/docs/modules/core/Network.mdx +++ b/docs/content/docs/modules/core/Network.mdx @@ -1,6 +1,6 @@ --- title: core/Network.ts -nav_order: 70 +nav_order: 69 parent: Modules --- diff --git a/docs/content/docs/modules/core/NetworkId.mdx b/docs/content/docs/modules/core/NetworkId.mdx index 061160df..f88dec7c 100644 --- a/docs/content/docs/modules/core/NetworkId.mdx +++ b/docs/content/docs/modules/core/NetworkId.mdx @@ -1,6 +1,6 @@ --- title: core/NetworkId.ts -nav_order: 71 +nav_order: 70 parent: Modules --- diff --git a/docs/content/docs/modules/core/NonZeroInt64.mdx b/docs/content/docs/modules/core/NonZeroInt64.mdx index 3a703e57..4587c7b4 100644 --- a/docs/content/docs/modules/core/NonZeroInt64.mdx +++ b/docs/content/docs/modules/core/NonZeroInt64.mdx @@ -1,6 +1,6 @@ --- title: core/NonZeroInt64.ts -nav_order: 73 +nav_order: 72 parent: Modules --- @@ -14,8 +14,6 @@ parent: Modules - [arbitrary](#arbitrary-1) - [constants](#constants) - [NEG_INT64_MIN](#neg_int64_min) -- [constructors](#constructors) - - [make](#make) - [equality](#equality) - [equals](#equals) - [errors](#errors) @@ -73,20 +71,6 @@ export declare const NEG_INT64_MIN: -9223372036854775808n Added in v2.0.0 -# constructors - -## make - -Smart constructor for creating NonZeroInt64 values. - -**Signature** - -```ts -export declare const make: (i: string, overrideOptions?: ParseOptions) => bigint -``` - -Added in v2.0.0 - # equality ## equals diff --git a/docs/content/docs/modules/core/NonnegativeInterval.mdx b/docs/content/docs/modules/core/NonnegativeInterval.mdx index d02e6edd..9030de42 100644 --- a/docs/content/docs/modules/core/NonnegativeInterval.mdx +++ b/docs/content/docs/modules/core/NonnegativeInterval.mdx @@ -1,6 +1,6 @@ --- title: core/NonnegativeInterval.ts -nav_order: 72 +nav_order: 71 parent: Modules --- diff --git a/docs/content/docs/modules/core/Numeric.mdx b/docs/content/docs/modules/core/Numeric.mdx index 28fc021f..180b226a 100644 --- a/docs/content/docs/modules/core/Numeric.mdx +++ b/docs/content/docs/modules/core/Numeric.mdx @@ -1,6 +1,6 @@ --- title: core/Numeric.ts -nav_order: 74 +nav_order: 73 parent: Modules --- diff --git a/docs/content/docs/modules/core/OperationalCert.mdx b/docs/content/docs/modules/core/OperationalCert.mdx index be00474d..d3d8ec6f 100644 --- a/docs/content/docs/modules/core/OperationalCert.mdx +++ b/docs/content/docs/modules/core/OperationalCert.mdx @@ -1,6 +1,6 @@ --- title: core/OperationalCert.ts -nav_order: 75 +nav_order: 74 parent: Modules --- diff --git a/docs/content/docs/modules/core/PaymentAddress.mdx b/docs/content/docs/modules/core/PaymentAddress.mdx index 29add050..ec0dbd48 100644 --- a/docs/content/docs/modules/core/PaymentAddress.mdx +++ b/docs/content/docs/modules/core/PaymentAddress.mdx @@ -1,6 +1,6 @@ --- title: core/PaymentAddress.ts -nav_order: 76 +nav_order: 75 parent: Modules --- diff --git a/docs/content/docs/modules/core/PlutusV1.mdx b/docs/content/docs/modules/core/PlutusV1.mdx index 5e09ef09..debd2625 100644 --- a/docs/content/docs/modules/core/PlutusV1.mdx +++ b/docs/content/docs/modules/core/PlutusV1.mdx @@ -1,6 +1,6 @@ --- title: core/PlutusV1.ts -nav_order: 77 +nav_order: 76 parent: Modules --- diff --git a/docs/content/docs/modules/core/PlutusV2.mdx b/docs/content/docs/modules/core/PlutusV2.mdx index 99fe7fdc..1d5cb882 100644 --- a/docs/content/docs/modules/core/PlutusV2.mdx +++ b/docs/content/docs/modules/core/PlutusV2.mdx @@ -1,6 +1,6 @@ --- title: core/PlutusV2.ts -nav_order: 78 +nav_order: 77 parent: Modules --- diff --git a/docs/content/docs/modules/core/PlutusV3.mdx b/docs/content/docs/modules/core/PlutusV3.mdx index 07420cbe..0e05c86a 100644 --- a/docs/content/docs/modules/core/PlutusV3.mdx +++ b/docs/content/docs/modules/core/PlutusV3.mdx @@ -1,6 +1,6 @@ --- title: core/PlutusV3.ts -nav_order: 79 +nav_order: 78 parent: Modules --- diff --git a/docs/content/docs/modules/core/Pointer.mdx b/docs/content/docs/modules/core/Pointer.mdx index 5a2d92ca..c19a7c93 100644 --- a/docs/content/docs/modules/core/Pointer.mdx +++ b/docs/content/docs/modules/core/Pointer.mdx @@ -1,6 +1,6 @@ --- title: core/Pointer.ts -nav_order: 80 +nav_order: 79 parent: Modules --- diff --git a/docs/content/docs/modules/core/PointerAddress.mdx b/docs/content/docs/modules/core/PointerAddress.mdx index e78c1336..f431402e 100644 --- a/docs/content/docs/modules/core/PointerAddress.mdx +++ b/docs/content/docs/modules/core/PointerAddress.mdx @@ -1,6 +1,6 @@ --- title: core/PointerAddress.ts -nav_order: 81 +nav_order: 80 parent: Modules --- diff --git a/docs/content/docs/modules/core/PolicyId.mdx b/docs/content/docs/modules/core/PolicyId.mdx index 287dd609..39cf20b3 100644 --- a/docs/content/docs/modules/core/PolicyId.mdx +++ b/docs/content/docs/modules/core/PolicyId.mdx @@ -1,6 +1,6 @@ --- title: core/PolicyId.ts -nav_order: 82 +nav_order: 81 parent: Modules --- diff --git a/docs/content/docs/modules/core/PoolKeyHash.mdx b/docs/content/docs/modules/core/PoolKeyHash.mdx index 210d337d..f139c5f5 100644 --- a/docs/content/docs/modules/core/PoolKeyHash.mdx +++ b/docs/content/docs/modules/core/PoolKeyHash.mdx @@ -1,6 +1,6 @@ --- title: core/PoolKeyHash.ts -nav_order: 83 +nav_order: 82 parent: Modules --- diff --git a/docs/content/docs/modules/core/PoolMetadata.mdx b/docs/content/docs/modules/core/PoolMetadata.mdx index b4aa0b49..d7fe3420 100644 --- a/docs/content/docs/modules/core/PoolMetadata.mdx +++ b/docs/content/docs/modules/core/PoolMetadata.mdx @@ -1,6 +1,6 @@ --- title: core/PoolMetadata.ts -nav_order: 84 +nav_order: 83 parent: Modules --- diff --git a/docs/content/docs/modules/core/PoolParams.mdx b/docs/content/docs/modules/core/PoolParams.mdx index 833afa4e..54ed29a6 100644 --- a/docs/content/docs/modules/core/PoolParams.mdx +++ b/docs/content/docs/modules/core/PoolParams.mdx @@ -1,6 +1,6 @@ --- title: core/PoolParams.ts -nav_order: 85 +nav_order: 84 parent: Modules --- diff --git a/docs/content/docs/modules/core/Port.mdx b/docs/content/docs/modules/core/Port.mdx index daf4b808..3d66a446 100644 --- a/docs/content/docs/modules/core/Port.mdx +++ b/docs/content/docs/modules/core/Port.mdx @@ -1,6 +1,6 @@ --- title: core/Port.ts -nav_order: 86 +nav_order: 85 parent: Modules --- diff --git a/docs/content/docs/modules/core/PositiveCoin.mdx b/docs/content/docs/modules/core/PositiveCoin.mdx index 73b7a2e1..4d6fac44 100644 --- a/docs/content/docs/modules/core/PositiveCoin.mdx +++ b/docs/content/docs/modules/core/PositiveCoin.mdx @@ -1,6 +1,6 @@ --- title: core/PositiveCoin.ts -nav_order: 87 +nav_order: 86 parent: Modules --- diff --git a/docs/content/docs/modules/core/PrivateKey.mdx b/docs/content/docs/modules/core/PrivateKey.mdx index 9e5389fe..c0b906f6 100644 --- a/docs/content/docs/modules/core/PrivateKey.mdx +++ b/docs/content/docs/modules/core/PrivateKey.mdx @@ -1,6 +1,6 @@ --- title: core/PrivateKey.ts -nav_order: 88 +nav_order: 87 parent: Modules --- diff --git a/docs/content/docs/modules/core/ProposalProcedure.mdx b/docs/content/docs/modules/core/ProposalProcedure.mdx index c1c2fe4b..fe9f781d 100644 --- a/docs/content/docs/modules/core/ProposalProcedure.mdx +++ b/docs/content/docs/modules/core/ProposalProcedure.mdx @@ -1,6 +1,6 @@ --- title: core/ProposalProcedure.ts -nav_order: 89 +nav_order: 88 parent: Modules --- diff --git a/docs/content/docs/modules/core/ProposalProcedures.mdx b/docs/content/docs/modules/core/ProposalProcedures.mdx index 9278b0d5..8b6829bb 100644 --- a/docs/content/docs/modules/core/ProposalProcedures.mdx +++ b/docs/content/docs/modules/core/ProposalProcedures.mdx @@ -1,6 +1,6 @@ --- title: core/ProposalProcedures.ts -nav_order: 90 +nav_order: 89 parent: Modules --- diff --git a/docs/content/docs/modules/core/ProtocolParamUpdate.mdx b/docs/content/docs/modules/core/ProtocolParamUpdate.mdx index ffcca602..834a1caa 100644 --- a/docs/content/docs/modules/core/ProtocolParamUpdate.mdx +++ b/docs/content/docs/modules/core/ProtocolParamUpdate.mdx @@ -1,6 +1,6 @@ --- title: core/ProtocolParamUpdate.ts -nav_order: 91 +nav_order: 90 parent: Modules --- diff --git a/docs/content/docs/modules/core/ProtocolVersion.mdx b/docs/content/docs/modules/core/ProtocolVersion.mdx index 4fecb5dc..e2d3840f 100644 --- a/docs/content/docs/modules/core/ProtocolVersion.mdx +++ b/docs/content/docs/modules/core/ProtocolVersion.mdx @@ -1,6 +1,6 @@ --- title: core/ProtocolVersion.ts -nav_order: 92 +nav_order: 91 parent: Modules --- diff --git a/docs/content/docs/modules/core/Redeemer.mdx b/docs/content/docs/modules/core/Redeemer.mdx index 89b5512b..e02d9ca4 100644 --- a/docs/content/docs/modules/core/Redeemer.mdx +++ b/docs/content/docs/modules/core/Redeemer.mdx @@ -1,6 +1,6 @@ --- title: core/Redeemer.ts -nav_order: 93 +nav_order: 92 parent: Modules --- diff --git a/docs/content/docs/modules/core/Relay.mdx b/docs/content/docs/modules/core/Relay.mdx index 919baf36..7400a8a8 100644 --- a/docs/content/docs/modules/core/Relay.mdx +++ b/docs/content/docs/modules/core/Relay.mdx @@ -1,6 +1,6 @@ --- title: core/Relay.ts -nav_order: 94 +nav_order: 93 parent: Modules --- diff --git a/docs/content/docs/modules/core/RewardAccount.mdx b/docs/content/docs/modules/core/RewardAccount.mdx index 4a73ba25..99fa05b8 100644 --- a/docs/content/docs/modules/core/RewardAccount.mdx +++ b/docs/content/docs/modules/core/RewardAccount.mdx @@ -1,6 +1,6 @@ --- title: core/RewardAccount.ts -nav_order: 95 +nav_order: 94 parent: Modules --- diff --git a/docs/content/docs/modules/core/RewardAddress.mdx b/docs/content/docs/modules/core/RewardAddress.mdx index bee70c58..28f8abcd 100644 --- a/docs/content/docs/modules/core/RewardAddress.mdx +++ b/docs/content/docs/modules/core/RewardAddress.mdx @@ -1,6 +1,6 @@ --- title: core/RewardAddress.ts -nav_order: 96 +nav_order: 95 parent: Modules --- diff --git a/docs/content/docs/modules/core/Script.mdx b/docs/content/docs/modules/core/Script.mdx index bcc3342b..8dedc21f 100644 --- a/docs/content/docs/modules/core/Script.mdx +++ b/docs/content/docs/modules/core/Script.mdx @@ -1,6 +1,6 @@ --- title: core/Script.ts -nav_order: 97 +nav_order: 96 parent: Modules --- diff --git a/docs/content/docs/modules/core/ScriptDataHash.mdx b/docs/content/docs/modules/core/ScriptDataHash.mdx index 538180bc..f164dd92 100644 --- a/docs/content/docs/modules/core/ScriptDataHash.mdx +++ b/docs/content/docs/modules/core/ScriptDataHash.mdx @@ -1,6 +1,6 @@ --- title: core/ScriptDataHash.ts -nav_order: 98 +nav_order: 97 parent: Modules --- diff --git a/docs/content/docs/modules/core/ScriptHash.mdx b/docs/content/docs/modules/core/ScriptHash.mdx index ba5575a8..4a8d57cc 100644 --- a/docs/content/docs/modules/core/ScriptHash.mdx +++ b/docs/content/docs/modules/core/ScriptHash.mdx @@ -1,6 +1,6 @@ --- title: core/ScriptHash.ts -nav_order: 99 +nav_order: 98 parent: Modules --- diff --git a/docs/content/docs/modules/core/ScriptRef.mdx b/docs/content/docs/modules/core/ScriptRef.mdx index 5c25b419..f58eb0cd 100644 --- a/docs/content/docs/modules/core/ScriptRef.mdx +++ b/docs/content/docs/modules/core/ScriptRef.mdx @@ -1,6 +1,6 @@ --- title: core/ScriptRef.ts -nav_order: 100 +nav_order: 99 parent: Modules --- diff --git a/docs/content/docs/modules/core/SingleHostAddr.mdx b/docs/content/docs/modules/core/SingleHostAddr.mdx index 1ba889a4..bc6caaff 100644 --- a/docs/content/docs/modules/core/SingleHostAddr.mdx +++ b/docs/content/docs/modules/core/SingleHostAddr.mdx @@ -1,6 +1,6 @@ --- title: core/SingleHostAddr.ts -nav_order: 101 +nav_order: 100 parent: Modules --- diff --git a/docs/content/docs/modules/core/SingleHostName.mdx b/docs/content/docs/modules/core/SingleHostName.mdx index 6115f2c7..44cfda29 100644 --- a/docs/content/docs/modules/core/SingleHostName.mdx +++ b/docs/content/docs/modules/core/SingleHostName.mdx @@ -1,6 +1,6 @@ --- title: core/SingleHostName.ts -nav_order: 102 +nav_order: 101 parent: Modules --- diff --git a/docs/content/docs/modules/core/StakeReference.mdx b/docs/content/docs/modules/core/StakeReference.mdx index 76fdc4b5..e527f911 100644 --- a/docs/content/docs/modules/core/StakeReference.mdx +++ b/docs/content/docs/modules/core/StakeReference.mdx @@ -1,6 +1,6 @@ --- title: core/StakeReference.ts -nav_order: 103 +nav_order: 102 parent: Modules --- diff --git a/docs/content/docs/modules/core/TSchema.mdx b/docs/content/docs/modules/core/TSchema.mdx index dd34eeef..4a695bf2 100644 --- a/docs/content/docs/modules/core/TSchema.mdx +++ b/docs/content/docs/modules/core/TSchema.mdx @@ -1,6 +1,6 @@ --- title: core/TSchema.ts -nav_order: 115 +nav_order: 114 parent: Modules --- @@ -191,29 +191,29 @@ export declare const Struct: ( **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Default: nested in Union, index 0 -TSchema.Struct({ name: TSchema.ByteArray, age: TSchema.Integer }) +Core.TSchema.Struct({ name: Core.TSchema.ByteArray, age: Core.TSchema.Integer }) ``` **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Flat union variants with custom indices -TSchema.Struct({ amount: TSchema.Integer }, { index: 121, flat: true }) -TSchema.Struct({ amount: TSchema.Integer }, { index: 122, flat: true }) +Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 121, flat: true }) +Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 122, flat: true }) ``` **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Custom index but stay nested (advanced use case) -TSchema.Struct({ data: TSchema.Integer }, { index: 10, flat: false }) +Core.TSchema.Struct({ data: Core.TSchema.Integer }, { index: 10, flat: false }) ``` Added in v2.0.0 @@ -287,22 +287,22 @@ export declare const Union: >(. **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Standard union with auto indices (nested) -TSchema.Union(TSchema.Struct({ a: TSchema.Integer }), TSchema.Struct({ b: TSchema.Integer })) +Core.TSchema.Union(Core.TSchema.Struct({ a: Core.TSchema.Integer }), Core.TSchema.Struct({ b: Core.TSchema.Integer })) // Encodes to: Constr(0, [Constr(0, [a])]) or Constr(1, [Constr(0, [b])]) ``` **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Union with flat Structs (single-level encoding) -TSchema.Union( - TSchema.Struct({ amount: TSchema.Integer }, { index: 121, flat: true }), - TSchema.Struct({ amount: TSchema.Integer }, { index: 122, flat: true }) +Core.TSchema.Union( + Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 121, flat: true }), + Core.TSchema.Struct({ amount: Core.TSchema.Integer }, { index: 122, flat: true }) ) // Encodes to: Constr(121, [amount]) or Constr(122, [amount]) - single level! ``` @@ -310,13 +310,13 @@ TSchema.Union( **Example** ```typescript -import { TSchema } from "@evolution-sdk/evolution" +import { Core } from "@evolution-sdk/evolution" // Mixed union: some nested, some flat -TSchema.Union( - TSchema.Struct({ a: TSchema.Integer }), // nested, auto index 0 - TSchema.Struct({ b: TSchema.Integer }, { flat: true }), // flat, auto index 1 - TSchema.Struct({ c: TSchema.Integer }, { index: 100, flat: true }) // flat, custom index 100 +Core.TSchema.Union( + Core.TSchema.Struct({ a: Core.TSchema.Integer }), // nested, auto index 0 + Core.TSchema.Struct({ b: Core.TSchema.Integer }, { flat: true }), // flat, auto index 1 + Core.TSchema.Struct({ c: Core.TSchema.Integer }, { index: 100, flat: true }) // flat, custom index 100 ) ``` diff --git a/docs/content/docs/modules/core/Text.mdx b/docs/content/docs/modules/core/Text.mdx index 93062b69..11716f17 100644 --- a/docs/content/docs/modules/core/Text.mdx +++ b/docs/content/docs/modules/core/Text.mdx @@ -1,6 +1,6 @@ --- title: core/Text.ts -nav_order: 104 +nav_order: 103 parent: Modules --- diff --git a/docs/content/docs/modules/core/Text128.mdx b/docs/content/docs/modules/core/Text128.mdx index 9eb8927d..47a44cbf 100644 --- a/docs/content/docs/modules/core/Text128.mdx +++ b/docs/content/docs/modules/core/Text128.mdx @@ -1,6 +1,6 @@ --- title: core/Text128.ts -nav_order: 105 +nav_order: 104 parent: Modules --- diff --git a/docs/content/docs/modules/core/Transaction.mdx b/docs/content/docs/modules/core/Transaction.mdx index 5ad5fa47..4da25c01 100644 --- a/docs/content/docs/modules/core/Transaction.mdx +++ b/docs/content/docs/modules/core/Transaction.mdx @@ -1,6 +1,6 @@ --- title: core/Transaction.ts -nav_order: 106 +nav_order: 105 parent: Modules --- diff --git a/docs/content/docs/modules/core/TransactionBody.mdx b/docs/content/docs/modules/core/TransactionBody.mdx index 774bf469..cfe3354f 100644 --- a/docs/content/docs/modules/core/TransactionBody.mdx +++ b/docs/content/docs/modules/core/TransactionBody.mdx @@ -1,6 +1,6 @@ --- title: core/TransactionBody.ts -nav_order: 107 +nav_order: 106 parent: Modules --- @@ -272,7 +272,7 @@ export declare const isTransactionBody: (u: unknown, overrideOptions?: ParseOpti ```ts export declare const make: ( props: { - readonly mint?: (Map> & Brand<"Mint">) | undefined + readonly mint?: Map> | undefined readonly networkId?: number | undefined readonly withdrawals?: Withdrawals.Withdrawals | undefined readonly fee: bigint diff --git a/docs/content/docs/modules/core/TransactionHash.mdx b/docs/content/docs/modules/core/TransactionHash.mdx index 59519428..b5ad7eeb 100644 --- a/docs/content/docs/modules/core/TransactionHash.mdx +++ b/docs/content/docs/modules/core/TransactionHash.mdx @@ -1,6 +1,6 @@ --- title: core/TransactionHash.ts -nav_order: 108 +nav_order: 107 parent: Modules --- diff --git a/docs/content/docs/modules/core/TransactionIndex.mdx b/docs/content/docs/modules/core/TransactionIndex.mdx index 02cd5a0c..d3821325 100644 --- a/docs/content/docs/modules/core/TransactionIndex.mdx +++ b/docs/content/docs/modules/core/TransactionIndex.mdx @@ -1,6 +1,6 @@ --- title: core/TransactionIndex.ts -nav_order: 109 +nav_order: 108 parent: Modules --- diff --git a/docs/content/docs/modules/core/TransactionInput.mdx b/docs/content/docs/modules/core/TransactionInput.mdx index 57c8bbd6..bcb7b557 100644 --- a/docs/content/docs/modules/core/TransactionInput.mdx +++ b/docs/content/docs/modules/core/TransactionInput.mdx @@ -1,6 +1,6 @@ --- title: core/TransactionInput.ts -nav_order: 110 +nav_order: 109 parent: Modules --- diff --git a/docs/content/docs/modules/core/TransactionMetadatum.mdx b/docs/content/docs/modules/core/TransactionMetadatum.mdx index 19457717..e6ef18a1 100644 --- a/docs/content/docs/modules/core/TransactionMetadatum.mdx +++ b/docs/content/docs/modules/core/TransactionMetadatum.mdx @@ -1,6 +1,6 @@ --- title: core/TransactionMetadatum.ts -nav_order: 111 +nav_order: 110 parent: Modules --- diff --git a/docs/content/docs/modules/core/TransactionMetadatumLabels.mdx b/docs/content/docs/modules/core/TransactionMetadatumLabels.mdx index 6d0f5ec5..8a37445a 100644 --- a/docs/content/docs/modules/core/TransactionMetadatumLabels.mdx +++ b/docs/content/docs/modules/core/TransactionMetadatumLabels.mdx @@ -1,6 +1,6 @@ --- title: core/TransactionMetadatumLabels.ts -nav_order: 112 +nav_order: 111 parent: Modules --- diff --git a/docs/content/docs/modules/core/TransactionOutput.mdx b/docs/content/docs/modules/core/TransactionOutput.mdx index 4855ead4..33b0ebfc 100644 --- a/docs/content/docs/modules/core/TransactionOutput.mdx +++ b/docs/content/docs/modules/core/TransactionOutput.mdx @@ -1,6 +1,6 @@ --- title: core/TransactionOutput.ts -nav_order: 113 +nav_order: 112 parent: Modules --- diff --git a/docs/content/docs/modules/core/TransactionWitnessSet.mdx b/docs/content/docs/modules/core/TransactionWitnessSet.mdx index 818049d1..590dff69 100644 --- a/docs/content/docs/modules/core/TransactionWitnessSet.mdx +++ b/docs/content/docs/modules/core/TransactionWitnessSet.mdx @@ -1,6 +1,6 @@ --- title: core/TransactionWitnessSet.ts -nav_order: 114 +nav_order: 113 parent: Modules --- diff --git a/docs/content/docs/modules/core/UnitInterval.mdx b/docs/content/docs/modules/core/UnitInterval.mdx index ce2d273a..44a320dd 100644 --- a/docs/content/docs/modules/core/UnitInterval.mdx +++ b/docs/content/docs/modules/core/UnitInterval.mdx @@ -1,6 +1,6 @@ --- title: core/UnitInterval.ts -nav_order: 116 +nav_order: 115 parent: Modules --- diff --git a/docs/content/docs/modules/core/Url.mdx b/docs/content/docs/modules/core/Url.mdx index d8e59b67..8bc02a73 100644 --- a/docs/content/docs/modules/core/Url.mdx +++ b/docs/content/docs/modules/core/Url.mdx @@ -1,6 +1,6 @@ --- title: core/Url.ts -nav_order: 117 +nav_order: 116 parent: Modules --- diff --git a/docs/content/docs/modules/core/VKey.mdx b/docs/content/docs/modules/core/VKey.mdx index 123b1f4d..7f34fa0d 100644 --- a/docs/content/docs/modules/core/VKey.mdx +++ b/docs/content/docs/modules/core/VKey.mdx @@ -1,6 +1,6 @@ --- title: core/VKey.ts -nav_order: 119 +nav_order: 118 parent: Modules --- diff --git a/docs/content/docs/modules/core/Value.mdx b/docs/content/docs/modules/core/Value.mdx index c0f1cd21..18a741b7 100644 --- a/docs/content/docs/modules/core/Value.mdx +++ b/docs/content/docs/modules/core/Value.mdx @@ -1,6 +1,6 @@ --- title: core/Value.ts -nav_order: 118 +nav_order: 117 parent: Modules --- diff --git a/docs/content/docs/modules/core/VotingProcedures.mdx b/docs/content/docs/modules/core/VotingProcedures.mdx index fb1c7ba1..3470414a 100644 --- a/docs/content/docs/modules/core/VotingProcedures.mdx +++ b/docs/content/docs/modules/core/VotingProcedures.mdx @@ -1,6 +1,6 @@ --- title: core/VotingProcedures.ts -nav_order: 120 +nav_order: 119 parent: Modules --- diff --git a/docs/content/docs/modules/core/VrfCert.mdx b/docs/content/docs/modules/core/VrfCert.mdx index aee809f2..b6f27685 100644 --- a/docs/content/docs/modules/core/VrfCert.mdx +++ b/docs/content/docs/modules/core/VrfCert.mdx @@ -1,6 +1,6 @@ --- title: core/VrfCert.ts -nav_order: 121 +nav_order: 120 parent: Modules --- diff --git a/docs/content/docs/modules/core/VrfKeyHash.mdx b/docs/content/docs/modules/core/VrfKeyHash.mdx index 51008afc..196c22bc 100644 --- a/docs/content/docs/modules/core/VrfKeyHash.mdx +++ b/docs/content/docs/modules/core/VrfKeyHash.mdx @@ -1,6 +1,6 @@ --- title: core/VrfKeyHash.ts -nav_order: 122 +nav_order: 121 parent: Modules --- diff --git a/docs/content/docs/modules/core/VrfVkey.mdx b/docs/content/docs/modules/core/VrfVkey.mdx index c3d5a2f4..3ab53692 100644 --- a/docs/content/docs/modules/core/VrfVkey.mdx +++ b/docs/content/docs/modules/core/VrfVkey.mdx @@ -1,6 +1,6 @@ --- title: core/VrfVkey.ts -nav_order: 123 +nav_order: 122 parent: Modules --- diff --git a/docs/content/docs/modules/core/Withdrawals.mdx b/docs/content/docs/modules/core/Withdrawals.mdx index 54cc6612..f0912984 100644 --- a/docs/content/docs/modules/core/Withdrawals.mdx +++ b/docs/content/docs/modules/core/Withdrawals.mdx @@ -1,6 +1,6 @@ --- title: core/Withdrawals.ts -nav_order: 124 +nav_order: 123 parent: Modules --- diff --git a/docs/content/docs/modules/sdk/Address.mdx b/docs/content/docs/modules/sdk/Address.mdx index 894b69ee..3d2f966c 100644 --- a/docs/content/docs/modules/sdk/Address.mdx +++ b/docs/content/docs/modules/sdk/Address.mdx @@ -1,23 +1,23 @@ --- title: sdk/Address.ts -nav_order: 125 +nav_order: 124 parent: Modules --- ## Address overview +SDK Address module - user-friendly Bech32 string representation + +Added in v2.0.0 + ---

Table of contents

- [utils](#utils) - [Address (type alias)](#address-type-alias) - - [addressToJson](#addresstojson) - - [fromAddressStructure](#fromaddressstructure) - - [fromAddressStructureToJson](#fromaddressstructuretojson) - - [fromJsonToAddressStructure](#fromjsontoaddressstructure) - - [jsonToAddress](#jsontoaddress) - - [toAddressStructure](#toaddressstructure) + - [fromCoreAddress](#fromcoreaddress) + - [toCoreAddress](#tocoreaddress) --- @@ -31,104 +31,18 @@ parent: Modules export type Address = string ``` -## addressToJson - -**Signature** - -```ts -export declare const addressToJson: ( - i: string, - overrideOptions?: ParseOptions | undefined -) => { - readonly networkId: number - readonly paymentCredential: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - readonly stakingCredential?: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - | undefined -} -``` - -## fromAddressStructure - -**Signature** - -```ts -export declare const fromAddressStructure: ( - a: CoreAddressStructure.AddressStructure, - overrideOptions?: ParseOptions -) => string -``` - -## fromAddressStructureToJson - -**Signature** - -```ts -export declare const fromAddressStructureToJson: ( - a: CoreAddressStructure.AddressStructure, - overrideOptions?: ParseOptions -) => { - readonly networkId: number - readonly paymentCredential: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - readonly stakingCredential?: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - | undefined -} -``` - -## fromJsonToAddressStructure - -**Signature** - -```ts -export declare const fromJsonToAddressStructure: ( - i: { - readonly networkId: number - readonly paymentCredential: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - readonly stakingCredential?: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - | undefined - }, - overrideOptions?: ParseOptions -) => CoreAddressStructure.AddressStructure -``` - -## jsonToAddress +## fromCoreAddress **Signature** ```ts -export declare const jsonToAddress: ( - i: { - readonly networkId: number - readonly paymentCredential: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - readonly stakingCredential?: - | { readonly _tag: "KeyHash"; readonly hash: string } - | { readonly _tag: "ScriptHash"; readonly hash: string } - | undefined - }, - overrideOptions?: ParseOptions | undefined -) => string +export declare const fromCoreAddress: (a: CoreAddress.Address, overrideOptions?: ParseOptions) => string ``` -## toAddressStructure +## toCoreAddress **Signature** ```ts -export declare const toAddressStructure: ( - i: string, - overrideOptions?: ParseOptions -) => CoreAddressStructure.AddressStructure +export declare const toCoreAddress: (i: string, overrideOptions?: ParseOptions) => CoreAddress.Address ``` diff --git a/docs/content/docs/modules/core/AddressDetails.mdx b/docs/content/docs/modules/sdk/AddressDetails.mdx similarity index 56% rename from docs/content/docs/modules/core/AddressDetails.mdx rename to docs/content/docs/modules/sdk/AddressDetails.mdx index 0cf91a69..7944f4c3 100644 --- a/docs/content/docs/modules/core/AddressDetails.mdx +++ b/docs/content/docs/modules/sdk/AddressDetails.mdx @@ -1,6 +1,6 @@ --- -title: core/AddressDetails.ts -nav_order: 1 +title: sdk/AddressDetails.ts +nav_order: 125 parent: Modules --- @@ -10,13 +10,6 @@ parent: Modules

Table of contents

-- [arbitrary](#arbitrary) - - [arbitrary](#arbitrary-1) -- [constructors](#constructors) - - [fromAddress](#fromaddress) - - [make](#make) -- [either](#either) - - [Either (namespace)](#either-namespace) - [encoding](#encoding) - [toBech32](#tobech32) - [toHex](#tohex) @@ -28,60 +21,11 @@ parent: Modules - [schemas](#schemas) - [AddressDetails (class)](#addressdetails-class) - [utils](#utils) - - [AddressDetailsError (class)](#addressdetailserror-class) - [FromBech32](#frombech32-1) - [FromHex](#fromhex-1) --- -# arbitrary - -## arbitrary - -FastCheck arbitrary for AddressDetails instances. - -**Signature** - -```ts -export declare const arbitrary: Arbitrary -``` - -Added in v2.0.0 - -# constructors - -## fromAddress - -Create AddressDetails from an Address. - -**Signature** - -```ts -export declare const fromAddress: (address: AddressEras.AddressEras) => AddressDetails -``` - -Added in v2.0.0 - -## make - -Create AddressDetails from an Address instance. - -**Signature** - -```ts -export declare const make: (this: C, ...args: ConstructorParameters) => InstanceType -``` - -Added in v2.0.0 - -# either - -## Either (namespace) - -Either-based error handling variants for functions that can fail. - -Added in v2.0.0 - # encoding ## toBech32 @@ -91,7 +35,7 @@ Convert AddressDetails to Bech32 string. **Signature** ```ts -export declare const toBech32: (input: AddressDetails) => string +export declare const toBech32: (a: AddressDetails, overrideOptions?: ParseOptions) => string ``` Added in v2.0.0 @@ -103,7 +47,7 @@ Convert AddressDetails to hex string. **Signature** ```ts -export declare const toHex: (input: AddressDetails) => string +export declare const toHex: (a: AddressDetails, overrideOptions?: ParseOptions) => string ``` Added in v2.0.0 @@ -131,7 +75,7 @@ Parse AddressDetails from Bech32 string. **Signature** ```ts -export declare const fromBech32: (input: string) => AddressDetails +export declare const fromBech32: (i: string, overrideOptions?: ParseOptions) => AddressDetails ``` Added in v2.0.0 @@ -143,7 +87,7 @@ Parse AddressDetails from hex string. **Signature** ```ts -export declare const fromHex: (input: string) => AddressDetails +export declare const fromHex: (i: string, overrideOptions?: ParseOptions) => AddressDetails ``` Added in v2.0.0 @@ -165,14 +109,6 @@ Added in v2.0.0 # utils -## AddressDetailsError (class) - -**Signature** - -```ts -export declare class AddressDetailsError -``` - ## FromBech32 **Signature** diff --git a/docs/content/docs/modules/sdk/Assets.mdx b/docs/content/docs/modules/sdk/Assets.mdx index 4c7775c8..45b0a777 100644 --- a/docs/content/docs/modules/sdk/Assets.mdx +++ b/docs/content/docs/modules/sdk/Assets.mdx @@ -10,8 +10,22 @@ parent: Modules

Table of contents

+- [conversion](#conversion) + - [fromMint](#frommint) + - [fromValue](#fromvalue) + - [toMint](#tomint) + - [toValue](#tovalue) +- [helpers](#helpers) + - [addLovelace](#addlovelace) + - [getLovelace](#getlovelace) + - [setLovelace](#setlovelace) + - [subtractLovelace](#subtractlovelace) +- [schemas](#schemas) + - [MintFromAssets](#mintfromassets) + - [ValueFromAssets](#valuefromassets) - [utils](#utils) - - [Assets (interface)](#assets-interface) + - [Assets (type alias)](#assets-type-alias) + - [AssetsSchema](#assetsschema) - [add](#add) - [assetsToValue](#assetstovalue) - [empty](#empty) @@ -31,17 +45,181 @@ parent: Modules --- +# conversion + +## fromMint + +Convert Core Mint to SDK Assets format (without lovelace). + +**Signature** + +```ts +export declare const fromMint: ( + a: Map>, + overrideOptions?: ParseOptions +) => { readonly lovelace?: bigint | undefined } & { readonly [x: string]: bigint } +``` + +Added in v2.0.0 + +## fromValue + +Convert Core Value to SDK Assets format. + +**Signature** + +```ts +export declare const fromValue: ( + a: CoreValue.OnlyCoin | CoreValue.WithAssets, + overrideOptions?: ParseOptions +) => { readonly lovelace?: bigint | undefined } & { readonly [x: string]: bigint } +``` + +Added in v2.0.0 + +## toMint + +Convert SDK Assets to Core Mint (lovelace key will be rejected). + +**Signature** + +```ts +export declare const toMint: ( + i: { readonly lovelace?: bigint | undefined } & { readonly [x: string]: bigint }, + overrideOptions?: ParseOptions +) => Map> +``` + +Added in v2.0.0 + +## toValue + +Convert SDK Assets to Core Value. + +**Signature** + +```ts +export declare const toValue: ( + i: { readonly lovelace?: bigint | undefined } & { readonly [x: string]: bigint }, + overrideOptions?: ParseOptions +) => CoreValue.OnlyCoin | CoreValue.WithAssets +``` + +Added in v2.0.0 + +# helpers + +## addLovelace + +Add a lovelace amount to Assets. + +**Signature** + +```ts +export declare const addLovelace: (assets: Assets, amount: bigint) => Assets +``` + +Added in v2.0.0 + +## getLovelace + +Get the lovelace amount from Assets, defaulting to 0n if undefined. + +**Signature** + +```ts +export declare const getLovelace: (assets: Assets) => bigint +``` + +Added in v2.0.0 + +## setLovelace + +Set the lovelace amount in Assets. + +**Signature** + +```ts +export declare const setLovelace: (assets: Assets, amount: bigint) => Assets +``` + +Added in v2.0.0 + +## subtractLovelace + +Subtract a lovelace amount from Assets. + +**Signature** + +```ts +export declare const subtractLovelace: (assets: Assets, amount: bigint) => Assets +``` + +Added in v2.0.0 + +# schemas + +## MintFromAssets + +Transform between Assets (SDK-friendly) and Mint (Core). + +**Signature** + +```ts +export declare const MintFromAssets: Schema.transformOrFail< + Schema.extend< + Schema.Struct<{ lovelace: Schema.optional }>, + Schema.Record$ + >, + Schema.SchemaClass< + Map>, + Map>, + never + >, + never +> +``` + +Added in v2.0.0 + +## ValueFromAssets + +Transform between Assets (SDK-friendly) and Value (Core). + +**Signature** + +```ts +export declare const ValueFromAssets: Schema.transformOrFail< + Schema.extend< + Schema.Struct<{ lovelace: Schema.optional }>, + Schema.Record$ + >, + Schema.SchemaClass, + never +> +``` + +Added in v2.0.0 + # utils -## Assets (interface) +## Assets (type alias) + +**Signature** + +```ts +export type Assets = typeof AssetsSchema.Type +``` + +## AssetsSchema **Signature** ```ts -export interface Assets { - lovelace: bigint - [key: string]: bigint -} +export declare const AssetsSchema: Schema.extend< + Schema.Struct<{ lovelace: Schema.optional }>, + Schema.Record$ +> ``` ## add diff --git a/docs/content/docs/modules/sdk/Credential.mdx b/docs/content/docs/modules/sdk/Credential.mdx index 3c783970..52fd3e1e 100644 --- a/docs/content/docs/modules/sdk/Credential.mdx +++ b/docs/content/docs/modules/sdk/Credential.mdx @@ -14,8 +14,8 @@ parent: Modules - [Credential (type alias)](#credential-type-alias) - [KeyHash (type alias)](#keyhash-type-alias) - [ScriptHash (type alias)](#scripthash-type-alias) - - [fromCredentialToJson](#fromcredentialtojson) - - [jsonToCredential](#jsontocredential) + - [fromCoreCredential](#fromcorecredential) + - [toCoreCredential](#tocorecredential) --- @@ -26,7 +26,7 @@ parent: Modules **Signature** ```ts -export type Credential = typeof _Credential.CredentialSchema.Encoded +export type Credential = typeof CoreCredential.CredentialSchema.Encoded ``` ## KeyHash (type alias) @@ -34,7 +34,7 @@ export type Credential = typeof _Credential.CredentialSchema.Encoded **Signature** ```ts -export type KeyHash = typeof _KeyHash.KeyHash.Encoded +export type KeyHash = typeof CoreKeyHash.KeyHash.Encoded ``` ## ScriptHash (type alias) @@ -42,27 +42,27 @@ export type KeyHash = typeof _KeyHash.KeyHash.Encoded **Signature** ```ts -export type ScriptHash = typeof _ScriptHash.ScriptHash.Encoded +export type ScriptHash = typeof CoreScriptHash.ScriptHash.Encoded ``` -## fromCredentialToJson +## fromCoreCredential **Signature** ```ts -export declare const fromCredentialToJson: ( - a: _KeyHash.KeyHash | _ScriptHash.ScriptHash, +export declare const fromCoreCredential: ( + a: CoreKeyHash.KeyHash | CoreScriptHash.ScriptHash, overrideOptions?: ParseOptions ) => { readonly _tag: "KeyHash"; readonly hash: string } | { readonly _tag: "ScriptHash"; readonly hash: string } ``` -## jsonToCredential +## toCoreCredential **Signature** ```ts -export declare const jsonToCredential: ( +export declare const toCoreCredential: ( i: { readonly _tag: "KeyHash"; readonly hash: string } | { readonly _tag: "ScriptHash"; readonly hash: string }, overrideOptions?: ParseOptions -) => _KeyHash.KeyHash | _ScriptHash.ScriptHash +) => CoreKeyHash.KeyHash | CoreScriptHash.ScriptHash ``` diff --git a/packages/evolution/docs/modules/sdk/Assets.ts.md b/packages/evolution/docs/modules/sdk/Assets.ts.md index 65a0b3db..3bcba1a7 100644 --- a/packages/evolution/docs/modules/sdk/Assets.ts.md +++ b/packages/evolution/docs/modules/sdk/Assets.ts.md @@ -163,11 +163,6 @@ Added in v2.0.0 Transform between Assets (SDK-friendly) and Mint (Core). -Encoded side: Assets format { [unit: string]: bigint } (non-zero values only) -Type side: Mint (Map>) - -Note: Unlike Value.FromAssets, this excludes "lovelace" since you cannot mint/burn ADA. - **Signature** ```ts @@ -191,9 +186,6 @@ Added in v2.0.0 Transform between Assets (SDK-friendly) and Value (Core). -Encoded side: Assets format { lovelace?: bigint, [unit: string]: bigint } -Type side: Value (OnlyCoin | WithAssets) - **Signature** ```ts diff --git a/packages/evolution/src/sdk/Assets.ts b/packages/evolution/src/sdk/Assets.ts index e308909a..14b8217f 100644 --- a/packages/evolution/src/sdk/Assets.ts +++ b/packages/evolution/src/sdk/Assets.ts @@ -346,9 +346,6 @@ export const assetsToValue = (assets: Assets): CoreValue.Value => { /** * Transform between Assets (SDK-friendly) and Value (Core). * - * Encoded side: Assets format { lovelace?: bigint, [unit: string]: bigint } - * Type side: Value (OnlyCoin | WithAssets) - * * @since 2.0.0 * @category schemas */ @@ -439,11 +436,6 @@ export const ValueFromAssets = Schema.transformOrFail( /** * Transform between Assets (SDK-friendly) and Mint (Core). * - * Encoded side: Assets format { [unit: string]: bigint } (non-zero values only) - * Type side: Mint (Map>) - * - * Note: Unlike Value.FromAssets, this excludes "lovelace" since you cannot mint/burn ADA. - * * @since 2.0.0 * @category schemas */