@meshsdk/common 1.6.2 → 1.6.3

package/dist/index.d.ts

@@ -173,7 +173,6 @@ type Relay = {
     type: "MultiHostName";
     domainName: string;
 };
-declare const relayToObj: (relay: Relay) => object;
 
 type PoolParams = {
     vrfKeyHash: string;
@@ -186,12 +185,10 @@ type PoolParams = {
     rewardAddress: string;
     metadata?: PoolMetadata;
 };
-declare const poolParamsToObj: (poolParams: PoolParams) => object;
 type PoolMetadata = {
     URL: string;
     hash: string;
 };
-declare const poolMetadataToObj: (poolMetadata: PoolMetadata) => object;
 
 type Protocol = {
     epoch: number;
@@ -215,6 +212,7 @@ type Protocol = {
     maxCollateralInputs: number;
     coinsPerUtxoSize: number;
 };
+declare const castProtocol: (data: Partial<Record<keyof Protocol, any>>) => Protocol;
 
 type Token = keyof typeof SUPPORTED_TOKENS;
 
@@ -328,127 +326,81 @@ type SimpleScriptSourceInfo = {
     simpleScriptHash: string;
 };
 
-type MintItem = {
-    type: "Plutus" | "Native";
-    policyId: string;
-    assetName: string;
-    amount: string;
+type Certificate = {
+    type: "BasicCertificate";
+    certType: CertificateType;
+} | {
+    type: "ScriptCertificate";
+    certType: CertificateType;
     redeemer?: Redeemer;
-    scriptSource?: ScriptSource | SimpleScriptSourceInfo;
-};
-
-type Output = {
-    address: string;
-    amount: Asset[];
-    datum?: {
-        type: "Hash" | "Inline";
-        data: BuilderData;
-    };
-    referenceScript?: PlutusScript;
-};
-
-type RefTxIn = {
-    txHash: string;
-    txIndex: number;
-};
-type TxInParameter = {
-    txHash: string;
-    txIndex: number;
-    amount?: Asset[];
-    address?: string;
-};
-type TxIn = PubKeyTxIn | SimpleScriptTxIn | ScriptTxIn;
-type PubKeyTxIn = {
-    type: "PubKey";
-    txIn: TxInParameter;
-};
-type SimpleScriptTxIn = {
-    type: "SimpleScript";
-    txIn: TxInParameter;
-    simpleScriptTxIn: SimpleScriptTxInParameter;
-};
-type SimpleScriptTxInParameter = {
-    scriptSource?: {
-        type: "Provided";
-        script: string;
-    } | {
-        type: "Inline";
-        txInInfo: SimpleScriptSourceInfo;
-    };
-};
-type ScriptTxInParameter = {
     scriptSource?: ScriptSource;
-    datumSource?: DatumSource;
-    redeemer?: Redeemer;
-};
-type ScriptTxIn = {
-    type: "Script";
-    txIn: TxInParameter;
-    scriptTxIn: ScriptTxInParameter;
+} | {
+    type: "SimpleScriptCertificate";
+    certType: CertificateType;
+    simpleScriptSource?: SimpleScriptSourceInfo;
 };
-
-type Certificate = {
+type CertificateType = {
     type: "RegisterPool";
     poolParams: PoolParams;
 } | {
     type: "RegisterStake";
-    stakeKeyHash: string;
+    stakeKeyAddress: string;
 } | {
     type: "DelegateStake";
-    stakeKeyHash: string;
+    stakeKeyAddress: string;
     poolId: string;
 } | {
     type: "DeregisterStake";
-    stakeKeyHash: string;
+    stakeKeyAddress: string;
 } | {
     type: "RetirePool";
     poolId: string;
     epoch: number;
 } | {
     type: "VoteDelegation";
-    stakeKeyHash: string;
+    stakeKeyAddress: string;
     drep: DRep;
 } | {
     type: "StakeAndVoteDelegation";
-    stakeKeyHash: string;
+    stakeKeyAddress: string;
     poolKeyHash: string;
     drep: DRep;
 } | {
     type: "StakeRegistrationAndDelegation";
-    stakeKeyHash: string;
+    stakeKeyAddress: string;
     poolKeyHash: string;
     coin: number;
 } | {
     type: "VoteRegistrationAndDelegation";
-    stakeKeyHash: string;
+    stakeKeyAddress: string;
     drep: DRep;
     coin: number;
 } | {
     type: "StakeVoteRegistrationAndDelegation";
-    stakeKeyHash: string;
+    stakeKeyAddress: string;
     poolKeyHash: string;
     drep: DRep;
     coin: number;
 } | {
     type: "CommitteeHotAuth";
-    committeeColdKeyHash: string;
-    committeeHotKeyHash: string;
+    committeeColdKeyAddress: string;
+    committeeHotKeyAddress: string;
 } | {
     type: "CommitteeColdResign";
-    committeeColdKeyHash: string;
+    committeeColdKeyAddress: string;
     anchor?: Anchor;
 } | {
     type: "DRepRegistration";
-    votingKeyHash: string;
+    votingKeyAddress: string;
     coin: number;
     anchor?: Anchor;
 } | {
     type: "DRepDeregistration";
-    votingKeyHash: string;
+    votingKeyAddress: string;
     coin: number;
 } | {
     type: "DRepUpdate";
-    votingKeyHash: string;
+    votingKeyAddress: string;
     anchor: Anchor;
 };
 type DRep = {
@@ -464,20 +416,85 @@ type Anchor = {
     anchorUrl: string;
     anchorDataHash: string;
 };
-type Withdrawal = {
-    pubKeyWithdrawal: {
-        address: string;
-        coin: string;
+
+type MintItem = {
+    type: "Plutus" | "Native";
+    policyId: string;
+    assetName: string;
+    amount: string;
+    redeemer?: Redeemer;
+    scriptSource?: ScriptSource | SimpleScriptSourceInfo;
+};
+
+type Output = {
+    address: string;
+    amount: Asset[];
+    datum?: {
+        type: "Hash" | "Inline";
+        data: BuilderData;
     };
-} | {
-    plutusScriptWithdrawal: {
-        address: string;
-        coin: string;
-        scriptSource?: ScriptSource;
-        redeemer?: Redeemer;
+    referenceScript?: PlutusScript;
+};
+
+type RefTxIn = {
+    txHash: string;
+    txIndex: number;
+};
+type TxInParameter = {
+    txHash: string;
+    txIndex: number;
+    amount?: Asset[];
+    address?: string;
+};
+type TxIn = PubKeyTxIn | SimpleScriptTxIn | ScriptTxIn;
+type PubKeyTxIn = {
+    type: "PubKey";
+    txIn: TxInParameter;
+};
+type SimpleScriptTxIn = {
+    type: "SimpleScript";
+    txIn: TxInParameter;
+    simpleScriptTxIn: SimpleScriptTxInParameter;
+};
+type SimpleScriptTxInParameter = {
+    scriptSource?: {
+        type: "Provided";
+        script: string;
+    } | {
+        type: "Inline";
+        txInInfo: SimpleScriptSourceInfo;
     };
 };
-declare const certificateToObj: (certificate: Certificate) => object;
+type ScriptTxInParameter = {
+    scriptSource?: ScriptSource;
+    datumSource?: DatumSource;
+    redeemer?: Redeemer;
+};
+type ScriptTxIn = {
+    type: "Script";
+    txIn: TxInParameter;
+    scriptTxIn: ScriptTxInParameter;
+};
+
+type Withdrawal = PubKeyWithdrawal | ScriptWithdrawal | SimpleScriptWithdrawal;
+type PubKeyWithdrawal = {
+    type: "PubKeyWithdrawal";
+    address: string;
+    coin: string;
+};
+type ScriptWithdrawal = {
+    type: "ScriptWithdrawal";
+    address: string;
+    coin: string;
+    scriptSource?: ScriptSource;
+    redeemer?: Redeemer;
+};
+type SimpleScriptWithdrawal = {
+    type: "SimpleScriptWithdrawal";
+    address: string;
+    coin: string;
+    scriptSource?: SimpleScriptSourceInfo;
+};
 
 type MeshTxBuilderBody = {
     inputs: TxIn[];
@@ -641,6 +658,7 @@ interface IMeshTxSerializer {
     serializeData(data: BuilderData): string;
     serializeAddress(address: DeserializedAddress, networkId?: 0 | 1): string;
     serializePoolId(hash: string): string;
+    serializeRewardAddress(stakeKeyHash: string, isScriptHash?: boolean, network_id?: 0 | 1): string;
 }
 interface IResolver {
     keys: {
@@ -803,7 +821,7 @@ declare const mMaybeStakingHash: (stakeCredential: string, isScriptCredential?:
  * @param isScriptCredential The flag to indicate if the credential is a script credential
  * @returns The Mesh Data public key address object
  */
-declare const mPubKeyAddress: (bytes: string, stakeCredential?: string) => Data;
+declare const mPubKeyAddress: (bytes: string, stakeCredential?: string, isScriptCredential?: boolean) => Data;
 /**
  * The utility function to create a Mesh Data script address
  * @param bytes The validator hash in hex
@@ -811,7 +829,7 @@ declare const mPubKeyAddress: (bytes: string, stakeCredential?: string) => Data;
  * @param isScriptCredential The flag to indicate if the credential is a script credential
  * @returns The Mesh Data script address object
  */
-declare const mScriptAddress: (bytes: string, stakeCredential?: string) => Data;
+declare const mScriptAddress: (bytes: string, stakeCredential?: string, isScriptCredential?: boolean) => Data;
 
 /**
  * The Mesh Data boolean
@@ -1231,8 +1249,26 @@ type SlotConfig = {
 };
 declare const SLOT_CONFIG_NETWORK: Record<Network, SlotConfig>;
 declare const slotToBeginUnixTime: (slot: number, slotConfig: SlotConfig) => number;
+/**
+ * Eqivalent to `slotToBeginUnixTime` but option to provide optional config
+ * @param unixTime Timestamp in milliseconds
+ * @param slotConfig Slot configuration for calculation
+ * @returns Slot number
+ */
 declare const unixTimeToEnclosingSlot: (unixTime: number, slotConfig: SlotConfig) => number;
+/**
+ * Resolve slot number based on timestamp in milliseconds.
+ * @param network Network: mainnet | preprod | preview.
+ * @param milliseconds Timestamp in milliseconds
+ * @returns Slot number
+ */
 declare const resolveSlotNo: (network: Network, milliseconds?: number) => string;
+/**
+ * Resolve epoch number based on timestamp in  milliseconds.
+ * @param network Network: mainnet | preprod | preview.
+ * @param milliseconds Timestamp in milliseconds
+ * @returns Epoch number
+ */
 declare const resolveEpochNo: (network: Network, milliseconds?: number) => number;
 
 /**
@@ -1372,6 +1408,9 @@ declare class MeshValue {
     toJSON: () => Value;
 }
 
+declare const AssetFingerprint: typeof CIP14;
+declare const resolveFingerprint: (policyId: string, assetName: string) => any;
+
 declare class BigNum {
     value: bigint;
     constructor(value?: bigint | number | string);
@@ -1386,7 +1425,4 @@ declare class BigNum {
     toString(): string;
 }
 
-declare const AssetFingerprint: typeof CIP14;
-declare const resolveFingerprint: (policyId: string, assetName: string) => any;
-
-export { type AccountInfo, type Action, type Anchor, type Asset, type AssetClass, type AssetExtended, AssetFingerprint, type AssetMetadata, type AssetName, type AssocMap, type AssocMapItem, BigNum, type BlockInfo, type Bool, type Budget, type BuilderData, type BuiltinByteString, type ByteString, CIP68_100, CIP68_222, type Certificate, type ConStr, type ConStr0, type ConStr1, type ConStr2, type CurrencySymbol, DEFAULT_PROTOCOL_PARAMETERS, DEFAULT_REDEEMER_BUDGET, DEFAULT_V1_COST_MODEL_LIST, DEFAULT_V2_COST_MODEL_LIST, type DRep, type Data, type DataSignature, type DatumSource, type DeserializedAddress, type DeserializedScript, type Dict, type DictItem, type Era, type Files, type FungibleAssetMetadata, HARDENED_KEY_START, type IDeserializer, type IEvaluator, type IFetcher, type IInitiator, type IListener, type IMeshTxSerializer, type IResolver, type ISigner, type ISubmitter, type ImageAssetMetadata, type Integer, LANGUAGE_VERSIONS, type LanguageVersion, type List, type MAssetClass, type MBool, type MConStr, type MConStr0, type MConStr1, type MConStr2, type MMaybeStakingHash, type MOutputReference, type MPubKeyAddress, type MScriptAddress, type MTuple, type MTxOutRef, type MValue, type MaybeStakingHash, type MeshTxBuilderBody, MeshValue, type Message, type Metadata, type Mint, type MintItem, type NativeScript, type Network, type NonFungibleAssetMetadata, type Output, type OutputReference, POLICY_ID_LENGTH, type POSIXTime, type PlutusData, type PlutusScript, type PolicyId, type PoolMetadata, type PoolParams, type Protocol, type PubKeyAddress, type PubKeyHash, type PubKeyTxIn, type Quantity, type Recipient, type Redeemer, type RedeemerTagType, type RefTxIn, type Relay, type RequiredWith, type RoyaltiesStandard, SLOT_CONFIG_NETWORK, SUPPORTED_CLOCKS, SUPPORTED_HANDLES, SUPPORTED_LANGUAGE_VIEWS, SUPPORTED_OGMIOS_LINKS, SUPPORTED_TOKENS, SUPPORTED_WALLETS, type ScriptAddress, type ScriptHash, type ScriptSource, type ScriptTxIn, type ScriptTxInParameter, type SimpleScriptSourceInfo, type SimpleScriptTxIn, type SimpleScriptTxInParameter, type SlotConfig, type Token, type TokenName, type TransactionInfo, type Tuple, type TxIn, type TxInParameter, type TxOutRef, type UTxO, type Unit, UtxoSelection, type UtxoSelectionStrategy, type ValidityRange, type Value, type Wallet, type Withdrawal, assetClass, assetName, assocMap, bool, builtinByteString, byteString, bytesToHex, certificateToObj, conStr, conStr0, conStr1, conStr2, currencySymbol, dict, emptyTxBuilderBody, experimentalSelectUtxos, fromUTF8, fungibleAssetKeys, hashByteString, hexToBytes, hexToString, integer, isNetwork, keepRelevant, largestFirst, largestFirstMultiAsset, list, mAssetClass, mBool, mConStr, mConStr0, mConStr1, mConStr2, mMaybeStakingHash, mOutputReference, mPlutusBSArrayToString, mPubKeyAddress, mScriptAddress, mStringToPlutusBSArray, mTuple, mTxOutRef, mValue, maybeStakingHash, mergeAssets, metadataStandardKeys, metadataToCip68, outputReference, parseAssetUnit, plutusBSArrayToString, policyId, poolMetadataToObj, poolParamsToObj, posixTime, pubKeyAddress, pubKeyHash, relayToObj, resolveEpochNo, resolveFingerprint, resolveLanguageView, resolveSlotNo, resolveTxFees, royaltiesStandardKeys, scriptAddress, scriptHash, slotToBeginUnixTime, stringToBSArray, stringToHex, toBytes, toUTF8, tokenName, tuple, txOutRef, unixTimeToEnclosingSlot, validityRangeToObj, value };
+export { type AccountInfo, type Action, type Anchor, type Asset, type AssetClass, type AssetExtended, AssetFingerprint, type AssetMetadata, type AssetName, type AssocMap, type AssocMapItem, BigNum, type BlockInfo, type Bool, type Budget, type BuilderData, type BuiltinByteString, type ByteString, CIP68_100, CIP68_222, type Certificate, type CertificateType, type ConStr, type ConStr0, type ConStr1, type ConStr2, type CurrencySymbol, DEFAULT_PROTOCOL_PARAMETERS, DEFAULT_REDEEMER_BUDGET, DEFAULT_V1_COST_MODEL_LIST, DEFAULT_V2_COST_MODEL_LIST, type DRep, type Data, type DataSignature, type DatumSource, type DeserializedAddress, type DeserializedScript, type Dict, type DictItem, type Era, type Files, type FungibleAssetMetadata, HARDENED_KEY_START, type IDeserializer, type IEvaluator, type IFetcher, type IInitiator, type IListener, type IMeshTxSerializer, type IResolver, type ISigner, type ISubmitter, type ImageAssetMetadata, type Integer, LANGUAGE_VERSIONS, type LanguageVersion, type List, type MAssetClass, type MBool, type MConStr, type MConStr0, type MConStr1, type MConStr2, type MMaybeStakingHash, type MOutputReference, type MPubKeyAddress, type MScriptAddress, type MTuple, type MTxOutRef, type MValue, type MaybeStakingHash, type MeshTxBuilderBody, MeshValue, type Message, type Metadata, type Mint, type MintItem, type NativeScript, type Network, type NonFungibleAssetMetadata, type Output, type OutputReference, POLICY_ID_LENGTH, type POSIXTime, type PlutusData, type PlutusScript, type PolicyId, type PoolMetadata, type PoolParams, type Protocol, type PubKeyAddress, type PubKeyHash, type PubKeyTxIn, type PubKeyWithdrawal, type Quantity, type Recipient, type Redeemer, type RedeemerTagType, type RefTxIn, type Relay, type RequiredWith, type RoyaltiesStandard, SLOT_CONFIG_NETWORK, SUPPORTED_CLOCKS, SUPPORTED_HANDLES, SUPPORTED_LANGUAGE_VIEWS, SUPPORTED_OGMIOS_LINKS, SUPPORTED_TOKENS, SUPPORTED_WALLETS, type ScriptAddress, type ScriptHash, type ScriptSource, type ScriptTxIn, type ScriptTxInParameter, type ScriptWithdrawal, type SimpleScriptSourceInfo, type SimpleScriptTxIn, type SimpleScriptTxInParameter, type SimpleScriptWithdrawal, type SlotConfig, type Token, type TokenName, type TransactionInfo, type Tuple, type TxIn, type TxInParameter, type TxOutRef, type UTxO, type Unit, UtxoSelection, type UtxoSelectionStrategy, type ValidityRange, type Value, type Wallet, type Withdrawal, assetClass, assetName, assocMap, bool, builtinByteString, byteString, bytesToHex, castProtocol, conStr, conStr0, conStr1, conStr2, currencySymbol, dict, emptyTxBuilderBody, experimentalSelectUtxos, fromUTF8, fungibleAssetKeys, hashByteString, hexToBytes, hexToString, integer, isNetwork, keepRelevant, largestFirst, largestFirstMultiAsset, list, mAssetClass, mBool, mConStr, mConStr0, mConStr1, mConStr2, mMaybeStakingHash, mOutputReference, mPlutusBSArrayToString, mPubKeyAddress, mScriptAddress, mStringToPlutusBSArray, mTuple, mTxOutRef, mValue, maybeStakingHash, mergeAssets, metadataStandardKeys, metadataToCip68, outputReference, parseAssetUnit, plutusBSArrayToString, policyId, posixTime, pubKeyAddress, pubKeyHash, resolveEpochNo, resolveFingerprint, resolveLanguageView, resolveSlotNo, resolveTxFees, royaltiesStandardKeys, scriptAddress, scriptHash, slotToBeginUnixTime, stringToBSArray, stringToHex, toBytes, toUTF8, tokenName, tuple, txOutRef, unixTimeToEnclosingSlot, validityRangeToObj, value };