@meshsdk/core 1.6.0-alpha.2 → 1.6.0-alpha.20

package/README.md

@@ -1,32 +1,5 @@
-![Mesh Logo](https://meshjs.dev/logo-mesh/mesh.png)
+# mesh-core
 
-Mesh is an open-source library designed to make building dApps accessible. Whether you're a beginner developer, startup, web3 market leader, or a large enterprise, Mesh makes web3 development easy with reliable, scalable, and well-engineered APIs & developer tools.
+Exports all the functionalities including wallets, transactions, and providers
 
-Explore the features on [Mesh Playground](https://meshjs.dev/).
-
-## Guides and documentations
-
-- [Starter Templates](https://meshjs.dev/starter-templates)
-- [Guides](https://meshjs.dev/guides)
-- [Install Mesh into existing project](https://meshjs.dev/migration-manual-installation)
-- [App Wallet (Building transactions on applications)](https://meshjs.dev/apis/appwallet)
-- [Browser Wallet (CIP30 wallets intergration)](https://meshjs.dev/apis/browserwallet)
-- [Transaction - Building, minting, burning, smart contracts, stake pool and more](https://meshjs.dev/apis/transaction)
-- [React Components](https://meshjs.dev/react)
-- [Service Providers](https://meshjs.dev/providers)
-- [Resolvers](https://meshjs.dev/apis/resolvers)
-
-## Why use Mesh
-- Start a new project with one of out [Starter Templates](https://meshjs.dev/starter-templates) with CLI command
-- Always up to date - Vasil-ready, developed promptly as the network updates so your app always works
-- Simple to use - Check out our [guides](https://meshjs.dev/guides) - you'll get started in less than 10 mins!
-- Adopts best practices - implements various CIPs and package is well build (no hacking and tweaking needed to get it to work)
-- Thoroughly tested - Mesh is used by both developers and learners, and is being built by developers with solid software engineering backgrounds
-- Integrates with Cardano projects - Koios, Blockfrost, ADA Handle (and more), you can pick and choose freely what you want to use for your app
-- Well documented - we focus on documentation so you can use it with ease, and our [Playground](https://meshjs.dev/) is built so you can see how it works
-
-## How can you contribute?
-
-- [Support us](https://meshjs.dev/about/support-us)
-- Build something - try Mesh by implementing your Web 3.0 project (recommended [starter guide](https://meshjs.dev/guides/nextjs))
-- Inform others - Tell others about Mesh, and star the [Github repo](https://github.com/MeshJS/mesh) :star:
+[meshjs.dev](https://meshjs.dev/)

package/package.json

@@ -1,81 +1,38 @@
 {
   "name": "@meshsdk/core",
-  "description": "Rapidly build Web3 apps on the Cardano Blockchain.",
-  "homepage": "https://meshjs.dev",
-  "author": "MeshJS",
-  "version": "1.6.0-alpha.2",
-  "license": "Apache-2.0",
-  "type": "module",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MeshJS/mesh.git"
-  },
-  "bugs": {
-    "url": "https://github.com/MeshJS/mesh/issues"
-  },
-  "keywords": [
-    "blockchain",
-    "cardano",
-    "plutus"
-  ],
-  "main": "dist/core.cjs",
-  "module": "dist/core.js",
-  "typings": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "engines": {
-    "node": ">=16"
-  },
-  "scripts": {
-    "lint": "eslint --ext .ts .",
-    "test": "vitest --run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
-    "build": "vite build && yarn docs",
-    "prepare": "yarn lint && yarn test && yarn build",
-    "dev": "vite build --watch",
-    "docs": "typedoc src/index.ts --json ../docs/src/data/api.json",
-    "docs2": "typedoc src/index.ts --out ../docs/tmp"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "yarn lint"
-    }
-  },
-  "browser": {
-    "@emurgo/cardano-message-signing-nodejs": "@emurgo/cardano-message-signing-browser",
-    "@sidan-lab/sidan-csl-rs-nodejs": "@sidan-lab/sidan-csl-rs-browser"
-  },
+  "version": "1.6.0-alpha.20",
+  "description": "",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/core.js",
-      "require": "./dist/core.cjs",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
     }
   },
+  "scripts": {
+    "build:mesh": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
+    "lint": "eslint",
+    "clean": "rm -rf .turbo && rm -rf dist && rm -rf node_modules",
+    "format": "prettier --check . --ignore-path ../../.gitignore"
+  },
   "devDependencies": {
-    "@rollup/plugin-typescript": "8.4.0",
-    "@typescript-eslint/eslint-plugin": "5.36.1",
-    "@typescript-eslint/parser": "5.36.1",
-    "husky": "8.0.1",
-    "rollup": "2.79.0",
-    "tslib": "2.4.0",
-    "typedoc": "^0.25.8",
-    "vite": "3.1.4",
-    "vite-plugin-eslint": "1.8.1",
-    "vite-plugin-wasm": "2.1.0",
-    "vitest": "0.22.1"
+    "@meshsdk/eslint-config": "*",
+    "@meshsdk/typescript-config": "*",
+    "eslint": "^8.57.0",
+    "tsup": "^8.0.2",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@emurgo/cardano-message-signing-browser": "1.0.1",
-    "@emurgo/cardano-message-signing-nodejs": "1.0.1",
-    "@emurgo/cip14-js": "3.0.1",
-    "@meshsdk/mesh-csl": "^0.0.5",
-    "axios": "1.6.3",
-    "bip39": "3.0.4",
-    "json-bigint": "^1.0.0",
-    "nanoid": "3.3.4",
-    "zod": "3.22.4"
-  }
+    "@meshsdk/common": "*",
+    "@meshsdk/core-csl": "*",
+    "@meshsdk/core-cst": "*",
+    "@meshsdk/provider": "*",
+    "@meshsdk/react": "*",
+    "@meshsdk/transaction": "*",
+    "@meshsdk/wallet": "*"
+  },
+  "prettier": "@meshsdk/prettier-config"
 }

package/src/core.ts

@@ -0,0 +1,3 @@
+import * as core from "@meshsdk/core-csl";
+
+export { core };

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from "./utils";
+export * from "@meshsdk/common";
+export * as cst from "@meshsdk/core-cst";
+export * from "@meshsdk/provider";
+export * from "@meshsdk/transaction";
+export * from "@meshsdk/wallet";

package/src/utils/deserializer.ts

@@ -0,0 +1,23 @@
+import { DeserializedAddress } from "@meshsdk/common";
+
+import { core } from "../core";
+
+/**
+ * Deserialize bech32 address into payment and staking parts, with visibility of whether they are script or key hash
+ * @param bech32 The bech32 address
+ * @returns The deserialized address object:
+ *
+ * ```ts
+ * const { pubKeyHash, scriptHash, stakeCredentialHash, stakeScriptCredentialHash } = deserializeAddress(bech32Address);
+ * ```
+ */
+export const deserializeAddress = (bech32: string): DeserializedAddress =>
+  core.deserializeBech32Address(bech32);
+
+/**
+ * Deserialize a datum from a CBOR string to JSON object
+ * @param datumCbor The CBOR string
+ * @returns The deserialized JSON object
+ */
+export const deserializeDatum = <T = any>(datumCbor: string): T =>
+  core.parseDatumCbor(datumCbor);

package/src/utils/index.ts

@@ -0,0 +1,3 @@
+export * from "./resolver";
+export * from "./deserializer";
+export * from "./serializer";

package/src/utils/resolver.ts

@@ -0,0 +1,126 @@
+import {
+  Data,
+  LanguageVersion,
+  NativeScript,
+  PlutusScript,
+} from "@meshsdk/common";
+import {
+  deserializeNativeScript,
+  deserializePlutusScript,
+} from "@meshsdk/core-csl";
+
+import { core } from "../core";
+
+/**
+ * Resolve the private key from mnemonic words
+ *
+ * Update pending to support resolving a tree of private key
+ *
+ * @param words The mnemonic words
+ * @returns The private key
+ */
+export const resolvePrivateKey = (words: string[]) =>
+  core.resolvePrivateKey(words);
+
+/**
+ * Resolve the transaction hash from transaction hex
+ * @param txHex The transaction hex
+ * @returns The transaction hash
+ */
+export const resolveTxHash = (txHex: string) => core.calculateTxHash(txHex);
+
+/**
+ * Hash Cardano data
+ * @param data Cardano data in Mesh Data type
+ * @returns Cardano data hash
+ */
+export const resolveDataHash = (data: Data) => core.resolveDataHash(data);
+
+/**
+ * Hash Cardano native script
+ * @param script Cardano native script in Mesh NativeScript type
+ * @returns Cardano native script hash
+ */
+export const resolveNativeScriptHash = (script: NativeScript) =>
+  core.resolveNativeScriptHash(script);
+
+/**
+ * Converting script cbor hex to script hash
+ * @param scriptCode The script cbor hex
+ * @param version The language version of the plutus script, without providing indicates it is a native script
+ * @returns The script hash
+ */
+export const resolveScriptHash = (
+  scriptCode: string,
+  version?: LanguageVersion,
+): string => {
+  if (!version) {
+    return deserializeNativeScript(scriptCode).hash().to_hex();
+  }
+  return deserializePlutusScript(scriptCode, version).hash().to_hex();
+};
+
+/**
+ * Resolve the pool id from hash
+ * @param hash The pool hash
+ * @returns The pool id
+ */
+export const resolvePoolId = (hash: string) => core.resolvePoolId(hash);
+
+/**
+ * Resolve the Ed25519 key hash from bech32 address
+ * @param bech32 The bech32 address
+ * @returns The Ed25519 key hash
+ */
+export const resolveRewardAddress = (bech32: string) =>
+  core.resolveRewardAddress(bech32);
+
+// ------------------- Deprecated zone ---------------------
+
+/**
+ * Deprecated - use `serializePlutusScript` instead
+ */
+export const resolvePlutusScriptAddress = (
+  script: PlutusScript,
+  networkId?: number,
+) => core.resolvePlutusScriptAddress(script, networkId);
+
+/**
+ * Deprecated - use `serializeNativeScript` instead
+ */
+export const resolveNativeScriptAddress = (
+  script: NativeScript,
+  networkId?: number,
+) => core.resolveNativeScriptAddress(script, networkId);
+
+/**
+ * Deprecated - use `serializeNativeScript` instead
+ */
+export const resolveNativeScriptHex = (script: NativeScript) =>
+  core.toNativeScript(script).to_hex();
+
+/**
+ * Deprecated - use `deserializeAddress` instead
+ */
+export const resolvePaymentKeyHash = (bech32: string) =>
+  core.deserializeBech32Address(bech32).pubKeyHash;
+
+/**
+ * Deprecated - use `deserializeAddress` instead
+ */
+export const resolvePlutusScriptHash = (bech32: string) =>
+  core.deserializeBech32Address(bech32).scriptHash;
+
+/**
+ * Deprecated - use `deserializeAddress` instead
+ */
+export const resolveStakeKeyHash = (bech32: string) =>
+  core.deserializeBech32Address(bech32).stakeCredentialHash;
+
+/**
+ * Deprecated - this is more used with the low level process inside Mesh
+ *
+ * If you need this, please import @meshsdk/core-csl or @meshsdk/core-cst instead
+ */
+export const resolveScriptRef = (script: NativeScript | PlutusScript) =>
+  core.resolveScriptRef(script);

package/src/utils/serializer.ts

@@ -0,0 +1,70 @@
+import {
+  DeserializedAddress,
+  NativeScript,
+  PlutusScript,
+  PubKeyAddress,
+  ScriptAddress,
+} from "@meshsdk/common";
+
+import { core } from "../core";
+
+/**
+ * Serialize Native script into bech32 address
+ * @param script The native script object
+ * @param networkId 0 (testnet) or 1 (mainnet). Default to be 0 (testnet).
+ * @returns Bech32 address
+ */
+export const serializeNativeScript = (
+  script: NativeScript,
+  stakeCredentialHash?: string,
+  networkId = 0,
+  isScriptStakeCredential = false,
+) => {
+  const serializer = new core.CSLSerializer();
+  const { scriptCbor, scriptHash } =
+    serializer.deserializer.script.deserializeNativeScript(script);
+  const deserializedAddress: Partial<DeserializedAddress> = {
+    scriptHash: scriptHash,
+  };
+  if (isScriptStakeCredential) {
+    deserializedAddress.stakeScriptCredentialHash = stakeCredentialHash;
+  } else {
+    deserializedAddress.stakeCredentialHash = stakeCredentialHash;
+  }
+  const address = serializer.serializeAddress(deserializedAddress, networkId);
+  return { address, scriptCbor };
+};
+
+/**
+ * Serialize Native script into bech32 address
+ * @param script The native script object
+ * @param networkId 0 (testnet) or 1 (mainnet). Default to be 0 (testnet).
+ * @returns Bech32 address
+ */
+export const serializePlutusScript = (
+  script: PlutusScript,
+  stakeCredentialHash?: string,
+  networkId = 0,
+  isScriptStakeCredential = false,
+) => {
+  const scriptHash = core
+    .deserializePlutusScript(script.code, script.version)
+    .hash()
+    .to_hex();
+  const address = core.scriptHashToBech32(
+    scriptHash,
+    stakeCredentialHash,
+    networkId,
+    isScriptStakeCredential,
+  );
+  return { address };
+};
+
+/**
+ * Serialize address in Cardano data JSON format into bech32 address
+ * @param address The Cardano address in data JSON format
+ * @returns Bech32 address
+ */
+export const serializeAddressObj = (address: PubKeyAddress | ScriptAddress) => {
+  return core.serializeAddressObj(address);
+};

package/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "@meshsdk/typescript-config/base.json",
+  "include": ["src/**/*"],
+  "exclude": ["dist", "node_modules"]
+}

package/dist/common/decorators.d.ts

@@ -1,19 +0,0 @@
-/// <reference types="chai" />
-/// <reference types="chai-subset" />
-export declare const Trackable: <T extends new (...args: any[]) => Object>(constructor: T) => {
-    new (...args: any[]): {
-        __visits: never[];
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
-        should: Chai.Assertion;
-    };
-} & T;
-export declare const Checkpoint: () => (_target: Object, propertyKey: string | symbol, descriptor: PropertyDescriptor) => void;
-export interface TrackableObject {
-    __visits: unknown[];
-}

package/dist/common/utils/builder.d.ts

@@ -1,18 +0,0 @@
-import { csl } from '@mesh/core';
-import type { BaseAddress, Bip32PrivateKey, DataCost, DatumSource, Ed25519KeyHash, EnterpriseAddress, MintWitness, PlutusScriptSource, RewardAddress, TransactionBuilder, TransactionOutputBuilder, TxInputsBuilder } from '@mesh/core';
-import type { Action, Data, PlutusScript, Recipient, UTxO } from '@mesh/types';
-export declare const buildBaseAddress: (networkId: number, paymentKeyHash: Ed25519KeyHash, stakeKeyHash: Ed25519KeyHash) => BaseAddress;
-export declare const buildBip32PrivateKey: (entropy: string, password?: string) => Bip32PrivateKey;
-export declare const buildDataCost: (coinsPerByte: string) => DataCost;
-export declare const buildDatumSource: (datum: Data | UTxO) => DatumSource;
-export declare const buildEnterpriseAddress: (networkId: number, paymentKeyHash: Ed25519KeyHash) => EnterpriseAddress;
-export declare const buildGeneralTxMetadata: (metadata: Record<string, unknown>) => csl.GeneralTransactionMetadata;
-export declare const buildMintWitness: (script: string | PlutusScript | UTxO, redeemer?: Partial<Action>) => MintWitness;
-export declare const buildRewardAddress: (networkId: number, stakeKeyHash: Ed25519KeyHash) => RewardAddress;
-export declare const buildPlutusScriptSource: (script: PlutusScript | UTxO) => PlutusScriptSource;
-export declare const buildScriptPubkey: (keyHash: Ed25519KeyHash) => csl.NativeScript;
-export declare const buildTimelockExpiry: (slot: string) => csl.NativeScript;
-export declare const buildTimelockStart: (slot: string) => csl.NativeScript;
-export declare const buildTxBuilder: (parameters?: import("@mesh/types").Protocol) => TransactionBuilder;
-export declare const buildTxInputsBuilder: (utxos: unknown[]) => TxInputsBuilder;
-export declare const buildTxOutputBuilder: (recipient: Recipient) => TransactionOutputBuilder;

package/dist/common/utils/converter.d.ts

@@ -1,27 +0,0 @@
-import { csl } from '@mesh/core';
-import type { PlutusData, ScriptRef, TransactionUnspentOutput, Value } from '@mesh/core';
-import type { Action, Asset, Data, NativeScript, PlutusScript, PoolParams, Relay, UTxO } from '@mesh/types';
-export declare const toAddress: (bech32: string) => csl.Address;
-export declare const toBaseAddress: (bech32: string) => csl.BaseAddress | undefined;
-export declare const toEnterpriseAddress: (bech32: string) => csl.EnterpriseAddress | undefined;
-export declare const toRewardAddress: (bech32: string) => csl.RewardAddress | undefined;
-export declare const fromBytes: (bytes: Uint8Array) => string;
-export declare const toBytes: (hex: string) => Uint8Array;
-export declare const fromLovelace: (lovelace: number) => number;
-export declare const toLovelace: (ada: number) => number;
-export declare const fromNativeScript: (script: csl.NativeScript) => NativeScript;
-export declare const toNativeScript: (script: NativeScript) => csl.NativeScript;
-export declare const fromPlutusData: (plutusData: PlutusData) => Data;
-export declare const toPlutusData: (data: Data) => csl.PlutusData;
-export declare const toPoolParams: (params: PoolParams) => never;
-export declare const toRedeemer: (action: Action) => csl.Redeemer;
-export declare const toRelay: (relay: Relay) => csl.Relay;
-export declare const fromScriptRef: (scriptRef: ScriptRef) => NativeScript | PlutusScript;
-export declare const toScriptRef: (script: PlutusScript | NativeScript) => csl.ScriptRef;
-export declare const fromTxUnspentOutput: (txUnspentOutput: TransactionUnspentOutput) => UTxO;
-export declare const toTxUnspentOutput: (utxo: UTxO) => csl.TransactionUnspentOutput;
-export declare const toUnitInterval: (float: string) => csl.UnitInterval;
-export declare const fromUTF8: (utf8: string) => string;
-export declare const toUTF8: (hex: string) => string;
-export declare const fromValue: (value: Value) => Asset[];
-export declare const toValue: (assets: Asset[]) => csl.Value;

package/dist/common/utils/deserializer.d.ts

@@ -1,19 +0,0 @@
-import { csl } from '@mesh/core';
-import type { LanguageVersion } from '@mesh/types';
-export declare const deserializeAddress: (address: string) => csl.Address;
-export declare const deserializeBip32PrivateKey: (bip32PrivateKey: string) => csl.Bip32PrivateKey;
-export declare const deserializeDataHash: (dataHash: string) => csl.DataHash;
-export declare const deserializeEd25519KeyHash: (ed25519KeyHash: string) => csl.Ed25519KeyHash;
-export declare const deserializeEd25519Signature: (ed25519Signature: string) => csl.Ed25519Signature;
-export declare const deserializeNativeScript: (nativeScript: string) => csl.NativeScript;
-export declare const deserializePublicKey: (publicKey: string) => csl.PublicKey;
-export declare const deserializePlutusData: (plutusData: string) => csl.PlutusData;
-export declare const deserializePlutusScript: (plutusScript: string, version: LanguageVersion) => csl.PlutusScript;
-export declare const deserializeScriptRef: (scriptRef: string) => csl.ScriptRef;
-export declare const deserializeScriptHash: (scriptHash: string) => csl.ScriptHash;
-export declare const deserializeTx: (tx: string) => csl.Transaction;
-export declare const deserializeTxBody: (txBody: string) => csl.TransactionBody;
-export declare const deserializeTxHash: (txHash: string) => csl.TransactionHash;
-export declare const deserializeTxUnspentOutput: (txUnspentOutput: string) => csl.TransactionUnspentOutput;
-export declare const deserializeTxWitnessSet: (txWitnessSet: string) => csl.TransactionWitnessSet;
-export declare const deserializeValue: (value: string) => csl.Value;

package/dist/common/utils/index.d.ts

@@ -1,5 +0,0 @@
-export * from './builder';
-export * from './converter';
-export * from './deserializer';
-export * from './parser';
-export * from './resolver';

package/dist/core/CIP14.d.ts

@@ -1,2 +0,0 @@
-import CIP14 from '@emurgo/cip14-js';
-export declare const AssetFingerprint: typeof CIP14;

package/dist/core/CIP1852.d.ts

@@ -1,4 +0,0 @@
-export declare const deriveAccountKeys: (rootKey: string, accountIndex: number) => {
-    paymentKey: import("@sidan-lab/sidan-csl-rs-nodejs").PrivateKey;
-    stakeKey: import("@sidan-lab/sidan-csl-rs-nodejs").PrivateKey;
-};

package/dist/core/CIP1853.d.ts

@@ -1 +0,0 @@
-export declare const deriveStakePoolColdKey: (rootKey: string, coldIndex: number) => import("@sidan-lab/sidan-csl-rs-nodejs").PrivateKey;

package/dist/core/CIP1855.d.ts

@@ -1 +0,0 @@
-export declare const deriveForgingPolicyKey: (rootKey: string, policyIndex: number) => import("@sidan-lab/sidan-csl-rs-nodejs").PrivateKey;

package/dist/core/CIP25.d.ts

@@ -1,19 +0,0 @@
-export declare type MetadataStandard = {
-    name: string;
-    image: `${string}://${string}`;
-    mediaType?: `image/${string}`;
-    description?: string | string[];
-    instagram?: `https://instagram.com/${string}`;
-    twitter?: `https://twitter.com/${string}`;
-    discord?: `https://discord.gg/${string}`;
-    website?: `https://${string}`;
-};
-export declare type Files = {
-    files?: [
-        {
-            name: string;
-            src: `${string}://${string}`;
-            mediaType: `${string}/${string}`;
-        }
-    ];
-};

package/dist/core/CIP27.d.ts

@@ -1,4 +0,0 @@
-export declare type RoyaltiesStandard = {
-    rate: string;
-    address: string;
-};

package/dist/core/CPS0009.d.ts

@@ -1,2 +0,0 @@
-import type { Quantity, UTxO, Unit } from '@mesh/types';
-export declare const selectUtxos: (inputs: UTxO[], requiredAssets: Map<Unit, Quantity>, threshold: Quantity) => UTxO[];