@anastasia-labs/cardano-multiplatform-lib-nodejs 6.0.1-1 → 6.0.1

package/cardano_multiplatform_lib.d.ts

@@ -17,18 +17,6 @@ export function emip3_encrypt_with_password(password: string, salt: string, nonc
 */
 export function emip3_decrypt_with_password(password: string, data: string): string;
 /**
-* encodes arbitrary bytes into chunks of 64 bytes (the limit for bytes) as a list to be valid Metadata
-* @param {Uint8Array} bytes
-* @returns {TransactionMetadatum}
-*/
-export function encode_arbitrary_bytes_as_metadatum(bytes: Uint8Array): TransactionMetadatum;
-/**
-* decodes from chunks of bytes in a list to a byte vector if that is the metadata format, otherwise returns None
-* @param {TransactionMetadatum} metadata
-* @returns {Uint8Array | undefined}
-*/
-export function decode_arbitrary_bytes_from_metadatum(metadata: TransactionMetadatum): Uint8Array | undefined;
-/**
 * @param {AuxiliaryData} auxiliary_data
 * @returns {AuxiliaryDataHash}
 */
@@ -104,33 +92,6 @@ export function get_implicit_input(txbody: TransactionBody, pool_deposit: bigint
 */
 export function get_deposit(txbody: TransactionBody, pool_deposit: bigint, key_deposit: bigint): bigint;
 /**
-*
-* * Min fee for JUST the script, NOT including ref inputs
-* 
-* @param {Transaction} tx
-* @param {ExUnitPrices} ex_unit_prices
-* @returns {bigint}
-*/
-export function min_script_fee(tx: Transaction, ex_unit_prices: ExUnitPrices): bigint;
-/**
-* @param {Transaction} tx
-* @param {LinearFee} linear_fee
-* @returns {bigint}
-*/
-export function min_no_script_fee(tx: Transaction, linear_fee: LinearFee): bigint;
-/**
-*
-* * Calculates the cost of all ref scripts
-* * * `total_ref_script_size` - Total size (original, not hashes) of all ref scripts. Duplicate scripts are counted as many times as they occur
-* 
-* @param {Transaction} tx
-* @param {LinearFee} linear_fee
-* @param {ExUnitPrices} ex_unit_prices
-* @param {bigint} total_ref_script_size
-* @returns {bigint}
-*/
-export function min_fee(tx: Transaction, linear_fee: LinearFee, ex_unit_prices: ExUnitPrices, total_ref_script_size: bigint): bigint;
-/**
 * Converts JSON to Metadata according to MetadataJsonSchema
 * @param {string} json
 * @param {MetadataJsonSchema} schema
@@ -145,11 +106,47 @@ export function encode_json_str_to_metadatum(json: string, schema: MetadataJsonS
 */
 export function decode_metadatum_to_json_str(metadatum: TransactionMetadatum, schema: MetadataJsonSchema): string;
 /**
+* @param {string} json
+* @param {CardanoNodePlutusDatumSchema} schema
+* @returns {PlutusData}
+*/
+export function encode_json_str_to_plutus_datum(json: string, schema: CardanoNodePlutusDatumSchema): PlutusData;
+/**
+* @param {PlutusData} datum
+* @param {CardanoNodePlutusDatumSchema} schema
+* @returns {string}
+*/
+export function decode_plutus_datum_to_json_str(datum: PlutusData, schema: CardanoNodePlutusDatumSchema): string;
+/**
+* @param {TransactionOutput} output
+* @param {bigint} coins_per_utxo_byte
+* @returns {bigint}
+*/
+export function min_ada_required(output: TransactionOutput, coins_per_utxo_byte: bigint): bigint;
+/**
 * @param {Redeemers} redeemers
 * @returns {ExUnits}
 */
 export function compute_total_ex_units(redeemers: Redeemers): ExUnits;
 /**
+* encodes arbitrary bytes into chunks of 64 bytes (the limit for bytes) as a list to be valid Metadata
+* @param {Uint8Array} bytes
+* @returns {TransactionMetadatum}
+*/
+export function encode_arbitrary_bytes_as_metadatum(bytes: Uint8Array): TransactionMetadatum;
+/**
+* decodes from chunks of bytes in a list to a byte vector if that is the metadata format, otherwise returns None
+* @param {TransactionMetadatum} metadata
+* @returns {Uint8Array | undefined}
+*/
+export function decode_arbitrary_bytes_from_metadatum(metadata: TransactionMetadatum): Uint8Array | undefined;
+/**
+* @param {TransactionHash} tx_body_hash
+* @param {PrivateKey} sk
+* @returns {Vkeywitness}
+*/
+export function make_vkey_witness(tx_body_hash: TransactionHash, sk: PrivateKey): Vkeywitness;
+/**
 * @param {TransactionHash} tx_body_hash
 * @param {ByronAddress} addr
 * @param {LegacyDaedalusPrivateKey} key
@@ -164,97 +161,85 @@ export function make_daedalus_bootstrap_witness(tx_body_hash: TransactionHash, a
 */
 export function make_icarus_bootstrap_witness(tx_body_hash: TransactionHash, addr: ByronAddress, key: Bip32PrivateKey): BootstrapWitness;
 /**
-* @param {TransactionHash} tx_body_hash
-* @param {PrivateKey} sk
-* @returns {Vkeywitness}
-*/
-export function make_vkey_witness(tx_body_hash: TransactionHash, sk: PrivateKey): Vkeywitness;
-/**
-* @param {TransactionOutput} output
-* @param {bigint} coins_per_utxo_byte
+*
+* * Min fee for JUST the script, NOT including ref inputs
+* 
+* @param {Transaction} tx
+* @param {ExUnitPrices} ex_unit_prices
 * @returns {bigint}
 */
-export function min_ada_required(output: TransactionOutput, coins_per_utxo_byte: bigint): bigint;
+export function min_script_fee(tx: Transaction, ex_unit_prices: ExUnitPrices): bigint;
 /**
-* @param {string} json
-* @param {CardanoNodePlutusDatumSchema} schema
-* @returns {PlutusData}
+* @param {Transaction} tx
+* @param {LinearFee} linear_fee
+* @returns {bigint}
 */
-export function encode_json_str_to_plutus_datum(json: string, schema: CardanoNodePlutusDatumSchema): PlutusData;
+export function min_no_script_fee(tx: Transaction, linear_fee: LinearFee): bigint;
 /**
-* @param {PlutusData} datum
-* @param {CardanoNodePlutusDatumSchema} schema
-* @returns {string}
+*
+* * Calculates the cost of all ref scripts
+* * * `total_ref_script_size` - Total size (original, not hashes) of all ref scripts. Duplicate scripts are counted as many times as they occur
+* 
+* @param {Transaction} tx
+* @param {LinearFee} linear_fee
+* @param {ExUnitPrices} ex_unit_prices
+* @param {bigint} total_ref_script_size
+* @returns {bigint}
 */
-export function decode_plutus_datum_to_json_str(datum: PlutusData, schema: CardanoNodePlutusDatumSchema): string;
+export function min_fee(tx: Transaction, linear_fee: LinearFee, ex_unit_prices: ExUnitPrices, total_ref_script_size: bigint): bigint;
 /**
 */
-export enum RedeemersKind {
-  ArrLegacyRedeemer = 0,
-  MapRedeemerKeyToRedeemerVal = 1,
+export enum MetadataJsonSchema {
+  NoConversions = 0,
+  BasicConversions = 1,
+  DetailedSchema = 2,
 }
 /**
 */
-export enum Language {
-  PlutusV1 = 0,
-  PlutusV2 = 1,
-  PlutusV3 = 2,
+export enum AddressKind {
+  Base = 0,
+  Ptr = 1,
+  Enterprise = 2,
+  Reward = 3,
+  Byron = 4,
 }
 /**
 */
-export enum AuxiliaryDataKind {
-  Shelley = 0,
-  ShelleyMA = 1,
-  Conway = 2,
+export enum CredentialKind {
+  PubKey = 0,
+  Script = 1,
 }
 /**
+* Which version of the CIP25 spec to use. See CIP25 for details.
+* This will change how things are encoded but for the most part contains
+* the same information.
 */
-export enum MetadataJsonSchema {
-  NoConversions = 0,
-  BasicConversions = 1,
-  DetailedSchema = 2,
-}
+export enum CIP25Version {
 /**
+* Initial version of CIP25 with only string (utf8) asset names allowed.
 */
-export enum ScriptKind {
-  Native = 0,
-  PlutusV1 = 1,
-  PlutusV2 = 2,
-  PlutusV3 = 3,
-}
+  V1 = 0,
 /**
-* Careful: this enum doesn't include the network ID part of the header
-* ex: base address isn't 0b0000_0000 but instead 0b0000
-* Use `header_matches_kind` if you don't want to implement the bitwise operators yourself
+* Second version of CIP25. Supports any type of asset names.
 */
-export enum AddressHeaderKind {
-  BasePaymentKeyStakeKey = 0,
-  BasePaymentScriptStakeKey = 1,
-  BasePaymentKeyStakeScript = 2,
-  BasePaymentScriptStakeScript = 3,
-  PointerKey = 4,
-  PointerScript = 5,
-  EnterpriseKey = 6,
-  EnterpriseScript = 7,
-  Byron = 8,
-  RewardKey = 14,
-  RewardScript = 15,
+  V2 = 1,
 }
 /**
 */
-export enum RedeemerTag {
-  Spend = 0,
-  Mint = 1,
-  Cert = 2,
-  Reward = 3,
-  Voting = 4,
-  Proposing = 5,
+export enum VoterKind {
+  ConstitutionalCommitteeHotKeyHash = 0,
+  ConstitutionalCommitteeHotScriptHash = 1,
+  DRepKeyHash = 2,
+  DRepScriptHash = 3,
+  StakingPoolKeyHash = 4,
 }
 /**
 */
-export enum StakeDistributionKind {
-  SingleKey = 0,
-  BootstrapEra = 1,
+export enum ScriptKind {
+  Native = 0,
+  PlutusV1 = 1,
+  PlutusV2 = 2,
+  PlutusV3 = 3,
 }
 /**
 */
@@ -265,41 +250,16 @@ export enum Vote {
 }
 /**
 */
-export enum CoinSelectionStrategyCIP2 {
-/**
-* Performs CIP2's Largest First ada-only selection. Will error if outputs contain non-ADA assets.
-*/
-  LargestFirst = 0,
-/**
-* Performs CIP2's Random Improve ada-only selection. Will error if outputs contain non-ADA assets.
-*/
-  RandomImprove = 1,
-/**
-* Same as LargestFirst, but before adding ADA, will insert by largest-first for each asset type.
-*/
-  LargestFirstMultiAsset = 2,
-/**
-* Same as RandomImprove, but before adding ADA, will insert by random-improve for each asset type.
-*/
-  RandomImproveMultiAsset = 3,
-}
-/**
-*/
-export enum AddressKind {
-  Base = 0,
-  Ptr = 1,
-  Enterprise = 2,
-  Reward = 3,
-  Byron = 4,
+export enum NonceKind {
+  Identity = 0,
+  Hash = 1,
 }
 /**
 */
-export enum TransactionMetadatumKind {
-  Map = 0,
-  List = 1,
-  Int = 2,
-  Bytes = 3,
-  Text = 4,
+export enum RelayKind {
+  SingleHostAddr = 0,
+  SingleHostName = 1,
+  MultiHostName = 2,
 }
 /**
 * JSON <-> PlutusData conversion schemas.
@@ -355,43 +315,41 @@ export enum CardanoNodePlutusDatumSchema {
 }
 /**
 */
-export enum NativeScriptKind {
-  ScriptPubkey = 0,
-  ScriptAll = 1,
-  ScriptAny = 2,
-  ScriptNOfK = 3,
-  ScriptInvalidBefore = 4,
-  ScriptInvalidHereafter = 5,
+export enum RedeemerTag {
+  Spend = 0,
+  Mint = 1,
+  Cert = 2,
+  Reward = 3,
+  Voting = 4,
+  Proposing = 5,
 }
 /**
 */
-export enum ChunkableStringKind {
-  Single = 0,
-  Chunked = 1,
-}
+export enum CoinSelectionStrategyCIP2 {
+/**
+* Performs CIP2's Largest First ada-only selection. Will error if outputs contain non-ADA assets.
+*/
+  LargestFirst = 0,
 /**
+* Performs CIP2's Random Improve ada-only selection. Will error if outputs contain non-ADA assets.
 */
-export enum DRepKind {
-  Key = 0,
-  Script = 1,
-  AlwaysAbstain = 2,
-  AlwaysNoConfidence = 3,
-}
+  RandomImprove = 1,
 /**
+* Same as LargestFirst, but before adding ADA, will insert by largest-first for each asset type.
 */
-export enum PlutusDataKind {
-  ConstrPlutusData = 0,
-  Map = 1,
-  List = 2,
-  Integer = 3,
-  Bytes = 4,
+  LargestFirstMultiAsset = 2,
+/**
+* Same as RandomImprove, but before adding ADA, will insert by random-improve for each asset type.
+*/
+  RandomImproveMultiAsset = 3,
 }
 /**
 */
-export enum ByronAddrType {
-  PublicKey = 0,
+export enum DRepKind {
+  Key = 0,
   Script = 1,
-  Redeem = 2,
+  AlwaysAbstain = 2,
+  AlwaysNoConfidence = 3,
 }
 /**
 */
@@ -416,12 +374,12 @@ export enum CertificateKind {
 }
 /**
 */
-export enum VoterKind {
-  ConstitutionalCommitteeHotKeyHash = 0,
-  ConstitutionalCommitteeHotScriptHash = 1,
-  DRepKeyHash = 2,
-  DRepScriptHash = 3,
-  StakingPoolKeyHash = 4,
+export enum PlutusDataKind {
+  ConstrPlutusData = 0,
+  Map = 1,
+  List = 2,
+  Integer = 3,
+  Bytes = 4,
 }
 /**
 */
@@ -431,21 +389,48 @@ export enum DelegationDistributionKind {
 }
 /**
 */
-export enum RelayKind {
-  SingleHostAddr = 0,
-  SingleHostName = 1,
-  MultiHostName = 2,
+export enum GovActionKind {
+  ParameterChangeAction = 0,
+  HardForkInitiationAction = 1,
+  TreasuryWithdrawalsAction = 2,
+  NoConfidence = 3,
+  UpdateCommittee = 4,
+  NewConstitution = 5,
+  InfoAction = 6,
 }
 /**
 */
-export enum CredentialKind {
-  PubKey = 0,
-  Script = 1,
+export enum Language {
+  PlutusV1 = 0,
+  PlutusV2 = 1,
+  PlutusV3 = 2,
 }
 /**
 */
-export enum ChangeSelectionAlgo {
-  Default = 0,
+export enum StakeDistributionKind {
+  SingleKey = 0,
+  BootstrapEra = 1,
+}
+/**
+*/
+export enum ChunkableStringKind {
+  Single = 0,
+  Chunked = 1,
+}
+/**
+*/
+export enum TransactionMetadatumKind {
+  Map = 0,
+  List = 1,
+  Int = 2,
+  Bytes = 3,
+  Text = 4,
+}
+/**
+*/
+export enum DatumOptionKind {
+  Hash = 0,
+  Datum = 1,
 }
 /**
 */
@@ -456,47 +441,62 @@ export enum SpendingDataKind {
 }
 /**
 */
-export enum TransactionOutputKind {
-  AlonzoFormatTxOut = 0,
-  ConwayFormatTxOut = 1,
+export enum RedeemersKind {
+  ArrLegacyRedeemer = 0,
+  MapRedeemerKeyToRedeemerVal = 1,
 }
 /**
+* Careful: this enum doesn't include the network ID part of the header
+* ex: base address isn't 0b0000_0000 but instead 0b0000
+* Use `header_matches_kind` if you don't want to implement the bitwise operators yourself
 */
-export enum NonceKind {
-  Identity = 0,
-  Hash = 1,
+export enum AddressHeaderKind {
+  BasePaymentKeyStakeKey = 0,
+  BasePaymentScriptStakeKey = 1,
+  BasePaymentKeyStakeScript = 2,
+  BasePaymentScriptStakeScript = 3,
+  PointerKey = 4,
+  PointerScript = 5,
+  EnterpriseKey = 6,
+  EnterpriseScript = 7,
+  Byron = 8,
+  RewardKey = 14,
+  RewardScript = 15,
 }
 /**
-* Which version of the CIP25 spec to use. See CIP25 for details.
-* This will change how things are encoded but for the most part contains
-* the same information.
 */
-export enum CIP25Version {
+export enum TransactionOutputKind {
+  AlonzoFormatTxOut = 0,
+  ConwayFormatTxOut = 1,
+}
 /**
-* Initial version of CIP25 with only string (utf8) asset names allowed.
 */
-  V1 = 0,
+export enum ByronAddrType {
+  PublicKey = 0,
+  Script = 1,
+  Redeem = 2,
+}
 /**
-* Second version of CIP25. Supports any type of asset names.
 */
-  V2 = 1,
+export enum NativeScriptKind {
+  ScriptPubkey = 0,
+  ScriptAll = 1,
+  ScriptAny = 2,
+  ScriptNOfK = 3,
+  ScriptInvalidBefore = 4,
+  ScriptInvalidHereafter = 5,
 }
 /**
 */
-export enum GovActionKind {
-  ParameterChangeAction = 0,
-  HardForkInitiationAction = 1,
-  TreasuryWithdrawalsAction = 2,
-  NoConfidence = 3,
-  UpdateCommittee = 4,
-  NewConstitution = 5,
-  InfoAction = 6,
+export enum AuxiliaryDataKind {
+  Shelley = 0,
+  ShelleyMA = 1,
+  Conway = 2,
 }
 /**
 */
-export enum DatumOptionKind {
-  Hash = 0,
-  Datum = 1,
+export enum ChangeSelectionAlgo {
+  Default = 0,
 }
 /**
 */
@@ -1072,6 +1072,51 @@ export class AssetName {
   free(): void;
 /**
 *
+*     * Create an AssetName from utf8 string. 64 byte (not char!) maximum.
+*     
+* @param {string} utf8_str
+* @returns {AssetName}
+*/
+  static from_str(utf8_str: string): AssetName;
+/**
+*
+*     * AssetName as a utf8 string if it's possible. Will error if the asset is not utf8
+*     
+* @returns {string}
+*/
+  to_str(): string;
+/**
+*
+*             * Direct raw bytes without any CBOR structure
+*             
+* @returns {Uint8Array}
+*/
+  to_raw_bytes(): Uint8Array;
+/**
+*
+*             * Parse from the direct raw bytes, without any CBOR structure
+*             
+* @param {Uint8Array} bytes
+* @returns {AssetName}
+*/
+  static from_raw_bytes(bytes: Uint8Array): AssetName;
+/**
+*
+*             * Direct raw bytes without any CBOR structure, as a hex-encoded string
+*             
+* @returns {string}
+*/
+  to_hex(): string;
+/**
+*
+*             * Parse from a hex string of the direct raw bytes, without any CBOR structure
+*             
+* @param {string} input
+* @returns {AssetName}
+*/
+  static from_hex(input: string): AssetName;
+/**
+*
 *             * Serialize this type to CBOR bytes
 *             * This type type supports encoding preservation so this will preserve round-trip CBOR formats.
 *             * If created from scratch the CBOR will be canonical.
@@ -1132,51 +1177,6 @@ export class AssetName {
 * @returns {AssetName}
 */
   static from_json(json: string): AssetName;
-/**
-*
-*     * Create an AssetName from utf8 string. 64 byte (not char!) maximum.
-*     
-* @param {string} utf8_str
-* @returns {AssetName}
-*/
-  static from_str(utf8_str: string): AssetName;
-/**
-*
-*     * AssetName as a utf8 string if it's possible. Will error if the asset is not utf8
-*     
-* @returns {string}
-*/
-  to_str(): string;
-/**
-*
-*             * Direct raw bytes without any CBOR structure
-*             
-* @returns {Uint8Array}
-*/
-  to_raw_bytes(): Uint8Array;
-/**
-*
-*             * Parse from the direct raw bytes, without any CBOR structure
-*             
-* @param {Uint8Array} bytes
-* @returns {AssetName}
-*/
-  static from_raw_bytes(bytes: Uint8Array): AssetName;
-/**
-*
-*             * Direct raw bytes without any CBOR structure, as a hex-encoded string
-*             
-* @returns {string}
-*/
-  to_hex(): string;
-/**
-*
-*             * Parse from a hex string of the direct raw bytes, without any CBOR structure
-*             
-* @param {string} input
-* @returns {AssetName}
-*/
-  static from_hex(input: string): AssetName;
 }
 /**
 */
@@ -7597,6 +7597,25 @@ export class PlutusData {
   free(): void;
 /**
 *
+*     *  Convert to a Datum that will serialize equivalent to cardano-node's format
+*     *
+*     *  Please VERY STRONGLY consider using PlutusData::from_cbor_bytes() instead wherever possible.
+*     * You should try to never rely on a tool encoding CBOR a certain way as there are many possible,
+*     * and just because it matches with a specific datum, doesn't mean that a different datum won't differ.
+*     * This is critical as that means the datum hash won't match.
+*     * After creation a datum (or other hashable CBOR object) should only be treated as raw CBOR bytes,
+*     * or through a type that respects its specific CBOR format e.g. CML's PlutusData::from_cbor_bytes()
+*     *
+*     *  This function is just here in case there's no possible way at all to create from CBOR bytes and
+*     * thus cold only be constructed manually and then had this function called on it.
+*     *
+*     *  This is also the format that CSL and Lucid use
+*     
+* @returns {PlutusData}
+*/
+  to_cardano_node_format(): PlutusData;
+/**
+*
 *             * Serialize this type to CBOR bytes
 *             * This type type supports encoding preservation so this will preserve round-trip CBOR formats.
 *             * If created from scratch the CBOR will be canonical.