@meshsdk/core 1.5.11-beta.5 → 1.5.11-beta.7

package/dist/providers/blockfrost.provider.d.ts

@@ -1,8 +1,25 @@
 import { IFetcher, IListener, ISubmitter } from '@mesh/common/contracts';
 import type { AccountInfo, Asset, AssetMetadata, BlockInfo, Protocol, TransactionInfo, UTxO } from '@mesh/common/types';
+/**
+ * [Blockfrost](https://blockfrost.io/) provides restful APIs which allows your app to access information stored on the blockchain.
+ *
+ * Get started:
+ * ```ts
+ * const blockfrostProvider = new BlockfrostProvider('<BLOCKFROST_API_KEY>');
+ * ```
+ */
 export declare class BlockfrostProvider implements IFetcher, IListener, ISubmitter {
     private readonly _axiosInstance;
+    /**
+     * If you are using a privately hosted Blockfrost instance, you can set the URL in the parameter.
+     * @param baseUrl The base URL of the instance.
+     */
     constructor(baseUrl: string);
+    /**
+     * If you are using [Blockfrost](https://blockfrost.io/) hosted instance, you can set the project ID in the parameter.
+     * @param projectId The project ID of the instance.
+     * @param version The version of the API. Default is 0.
+     */
     constructor(projectId: string, version?: number);
     fetchAccountInfo(address: string): Promise<AccountInfo>;
     private resolveScriptRef;

package/dist/transaction/meshTxBuilder/meshTxBuilderCore.d.ts

@@ -1,6 +1,6 @@
-import { Action, Asset, Data, LanguageVersion, Protocol, UTxO } from '@mesh/common/types';
+import { Action, Asset, Data, LanguageVersion, Protocol, UTxO, PoolParams } from '@mesh/common/types';
 import { csl } from '@mesh/core';
-import { MintItem, TxIn, PubKeyTxIn, MeshTxBuilderBody, RefTxIn, BuilderData } from './type';
+import { MintItem, TxIn, PubKeyTxIn, MeshTxBuilderBody, RefTxIn, BuilderData, Certificate } from './type';
 export declare class MeshTxBuilderCore {
     txHex: string;
     txBuilder: csl.TransactionBuilder;
@@ -155,7 +155,7 @@ export declare class MeshTxBuilderCore {
      * @param name The hex of token name of the asset to be minted
      * @returns The MeshTxBuilder instance
      */
-    mint: (quantity: number, policy: string, name: string) => this;
+    mint: (quantity: string, policy: string, name: string) => this;
     /**
      * Set the minting script of current mint
      * @param scriptCBOR The CBOR hex of the minting policy script
@@ -207,6 +207,39 @@ export declare class MeshTxBuilderCore {
      * @returns The MeshTxBuilder instance
      */
     txInCollateral: (txHash: string, txIndex: number, amount?: Asset[], address?: string) => this;
+    /**
+     * Creates a pool registration certificate, and adds it to the transaction
+     * @param poolParams Parameters for pool registration
+     * @returns The MeshTxBuilder instance
+     */
+    registerPoolCertificate: (poolParams: PoolParams) => this;
+    /**
+     * Creates a stake registration certificate, and adds it to the transaction
+     * @param stakeKeyHash The keyHash of the stake key
+     * @returns The MeshTxBuilder instance
+     */
+    registerStakeCertificate: (stakeKeyHash: string) => this;
+    /**
+     * Creates a stake delegation certificate, and adds it to the transaction
+     * This will delegate stake from the corresponding stake address to the pool
+     * @param stakeKeyHash The keyHash of the stake key
+     * @param poolId poolId can be in either bech32 or hex form
+     * @returns The MeshTxBuilder instance
+     */
+    delegateStakeCertificate: (stakeKeyHash: string, poolId: string) => this;
+    /**
+     * Creates a stake deregister certificate, and adds it to the transaction
+     * @param stakeKeyHash The keyHash of the stake key
+     * @returns The MeshTxBuilder instance
+     */
+    deregisterStakeCertificate: (stakeKeyHash: string) => this;
+    /**
+     * Creates a pool retire certificate, and adds it to the transaction
+     * @param poolId poolId can be in either bech32 or hex form
+     * @param epoch The intended epoch to retire the pool
+     * @returns The MeshTxBuilder instance
+     */
+    retirePoolCertificate: (poolId: string, epoch: number) => this;
     /**
      * Configure the address to accept change UTxO
      * @param addr The address to accept change UTxO
@@ -270,7 +303,11 @@ export declare class MeshTxBuilderCore {
     protected addAllMints: (mints: MintItem[]) => void;
     private addPlutusMint;
     private addNativeMint;
+    private decimalToFraction;
+    private toPoolParams;
+    private addCertificate;
     protected queueAllLastItem: () => void;
+    protected addAllCertificates: (allCertificates: Certificate[]) => void;
     protected addCostModels: () => void;
     private addChange;
     private addValidityRange;

package/dist/transaction/meshTxBuilder/type.d.ts

@@ -1,4 +1,4 @@
-import { Asset, Budget, Data, LanguageVersion, PlutusScript, UTxO } from '@mesh/common/types';
+import { Asset, Budget, Data, LanguageVersion, PlutusScript, UTxO, PoolParams } from '@mesh/common/types';
 export declare type MeshTxBuilderBody = {
     inputs: TxIn[];
     outputs: Output[];
@@ -11,6 +11,7 @@ export declare type MeshTxBuilderBody = {
     changeAddress: string;
     metadata: Metadata[];
     validityRange: ValidityRange;
+    certificates: Certificate[];
     signingKey: string[];
 };
 export declare type TxIn = PubKeyTxIn | ScriptTxIn;
@@ -70,7 +71,7 @@ export declare type MintItem = {
     type: 'Plutus' | 'Native';
     policyId: string;
     assetName: string;
-    amount: number;
+    amount: string;
     redeemer?: Redeemer;
     scriptSource?: {
         type: 'Provided';
@@ -104,6 +105,24 @@ export declare type Metadata = {
     tag: string;
     metadata: object;
 };
+export declare type Certificate = {
+    type: 'RegisterPool';
+    poolParams: PoolParams;
+} | {
+    type: 'RegisterStake';
+    stakeKeyHash: string;
+} | {
+    type: 'DelegateStake';
+    stakeKeyHash: string;
+    poolId: string;
+} | {
+    type: 'DeregisterStake';
+    stakeKeyHash: string;
+} | {
+    type: 'RetirePool';
+    poolId: string;
+    epoch: number;
+};
 export declare type RequiredWith<T, K extends keyof T> = Required<T> & {
     [P in K]: Required<T[P]>;
 };

package/dist/transaction/transaction.service.d.ts

@@ -15,6 +15,8 @@ export declare class Transaction {
     private readonly _txInputsBuilder;
     private readonly _txWithdrawals;
     constructor(options?: Partial<CreateTxOptions>);
+    static attachMetadata(cborTx: string, cborTxMetadata: string, era?: Era): string;
+    static deattachMetadata(cborTx: string): string;
     static maskMetadata(cborTx: string, era?: Era): string;
     static readMetadata(cborTx: string): string;
     static writeMetadata(cborTx: string, cborTxMetadata: string, era?: Era): string;
@@ -27,7 +29,7 @@ export declare class Transaction {
     redeemValue(options: {
         value: UTxO;
         script: PlutusScript | UTxO;
-        datum: Data | UTxO;
+        datum?: Data | UTxO;
         redeemer?: Action;
     }): Transaction;
     registerStake(rewardAddress: string): Transaction;

package/dist/wallet/browser.service.d.ts

@@ -13,13 +13,13 @@ export declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
     getRewardAddresses(): Promise<string[]>;
     getUnusedAddresses(): Promise<string[]>;
     getUsedAddresses(): Promise<string[]>;
-    getUtxos(): Promise<UTxO[]>;
+    getUtxos(amount?: Asset[] | undefined): Promise<UTxO[]>;
     signData(address: string, payload: string): Promise<DataSignature>;
     signTx(unsignedTx: string, partialSign?: boolean): Promise<string>;
     submitTx(tx: string): Promise<string>;
     getUsedAddress(): Promise<Address>;
     getUsedCollateral(limit?: number): Promise<TransactionUnspentOutput[]>;
-    getUsedUTxOs(): Promise<TransactionUnspentOutput[]>;
+    getUsedUTxOs(amount?: Asset[] | undefined): Promise<TransactionUnspentOutput[]>;
     getAssets(): Promise<AssetExtended[]>;
     getLovelace(): Promise<string>;
     getPolicyIdAssets(policyId: string): Promise<AssetExtended[]>;
@@ -47,7 +47,7 @@ declare type WalletInstance = {
     getRewardAddresses(): Promise<string[]>;
     getUnusedAddresses(): Promise<string[]>;
     getUsedAddresses(): Promise<string[]>;
-    getUtxos(): Promise<string[] | undefined>;
+    getUtxos(amount: string | undefined): Promise<string[] | undefined>;
     signData(address: string, payload: string): Promise<DataSignature>;
     signTx(tx: string, partialSign: boolean): Promise<string>;
     submitTx(tx: string): Promise<string>;

package/dist/wallet/index.d.ts

@@ -1,4 +1,3 @@
 export * from './app.service';
 export * from './browser.service';
 export * from './embedded.service';
-export * from './mina.service';

package/package.json

@@ -3,7 +3,7 @@
   "description": "Rapidly build Web3 apps on the Cardano Blockchain.",
   "homepage": "https://meshjs.dev",
   "author": "MeshJS",
-  "version": "1.5.11-beta.5",
+  "version": "1.5.11-beta.7",
   "license": "Apache-2.0",
   "type": "module",
   "repository": {
@@ -32,9 +32,11 @@
     "test": "vitest --run",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
-    "build": "vite build",
+    "build": "vite build && yarn docs",
     "prepare": "yarn lint && yarn test && yarn build",
-    "dev": "vite build --watch"
+    "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": {
@@ -59,6 +61,7 @@
     "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",