@meshsdk/core 1.5.24 → 1.5.28

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

@@ -1,146 +0,0 @@
-import { Asset, Budget, Data, LanguageVersion, PlutusScript, UTxO, PoolParams } from '@mesh/common/types';
-export declare type MeshTxBuilderBody = {
-    inputs: TxIn[];
-    outputs: Output[];
-    extraInputs: UTxO[];
-    selectionThreshold: number;
-    collaterals: PubKeyTxIn[];
-    requiredSignatures: string[];
-    referenceInputs: RefTxIn[];
-    mints: MintItem[];
-    changeAddress: string;
-    metadata: Metadata[];
-    validityRange: ValidityRange;
-    certificates: Certificate[];
-    signingKey: string[];
-};
-export declare type TxIn = PubKeyTxIn | SimpleScriptTxIn | ScriptTxIn;
-export declare type PubKeyTxIn = {
-    type: 'PubKey';
-    txIn: TxInParameter;
-};
-export declare type TxInParameter = {
-    txHash: string;
-    txIndex: number;
-    amount?: Asset[];
-    address?: string;
-};
-export declare type SimpleScriptTxIn = {
-    type: 'SimpleScript';
-    txIn: TxInParameter;
-    simpleScriptTxIn: SimpleScriptTxInParameter;
-};
-export declare type SimpleScriptTxInParameter = {
-    scriptSource?: {
-        type: 'Provided';
-        script: string;
-    } | {
-        type: 'Inline';
-        txInInfo: SimpleScriptSourceInfo;
-    };
-};
-export declare type SimpleScriptSourceInfo = {
-    txHash: string;
-    txIndex: number;
-};
-export declare type ScriptTxIn = {
-    type: 'Script';
-    txIn: TxInParameter;
-    scriptTxIn: ScriptTxInParameter;
-};
-export declare type ScriptTxInParameter = {
-    scriptSource?: {
-        type: 'Provided';
-        script: PlutusScript;
-    } | {
-        type: 'Inline';
-        txInInfo: ScriptSourceInfo;
-    };
-    datumSource?: {
-        type: 'Provided';
-        data: BuilderData;
-    } | {
-        type: 'Inline';
-        txHash: string;
-        txIndex: number;
-    };
-    redeemer?: Redeemer;
-};
-export declare type ScriptSourceInfo = {
-    txHash: string;
-    txIndex: number;
-    spendingScriptHash?: string;
-    version: LanguageVersion;
-};
-export declare type RefTxIn = {
-    txHash: string;
-    txIndex: number;
-};
-export declare type Output = {
-    address: string;
-    amount: Asset[];
-    datum?: {
-        type: 'Hash' | 'Inline';
-        data: BuilderData;
-    };
-    referenceScript?: PlutusScript;
-};
-export declare type MintItem = {
-    type: 'Plutus' | 'Native';
-    policyId: string;
-    assetName: string;
-    amount: string;
-    redeemer?: Redeemer;
-    scriptSource?: {
-        type: 'Provided';
-        script: PlutusScript;
-    } | {
-        type: 'Reference Script';
-        txHash: string;
-        txIndex: number;
-        version: LanguageVersion;
-    };
-};
-export declare type ValidityRange = {
-    invalidBefore?: number;
-    invalidHereafter?: number;
-};
-export declare type BuilderData = {
-    type: 'Mesh';
-    content: Data;
-} | {
-    type: 'JSON';
-    content: string;
-} | {
-    type: 'CBOR';
-    content: string;
-};
-export declare type Redeemer = {
-    data: BuilderData;
-    exUnits: Budget;
-};
-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

@@ -1,157 +0,0 @@
-import { IInitiator } from '@mesh/common/contracts';
-import type { Action, Asset, Data, Era, Mint, Protocol, NativeScript, PlutusScript, PoolParams, Recipient, Token, UTxO } from '@mesh/common/types';
-export declare class Transaction {
-    private _changeAddress?;
-    private _txOutputs;
-    private _recipients;
-    private _totalBurns;
-    private _totalMints;
-    private readonly _era?;
-    private readonly _initiator?;
-    private readonly _mintBuilder;
-    private readonly _protocolParameters;
-    private readonly _txBuilder;
-    private readonly _txCertificates;
-    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;
-    get size(): number;
-    build(): Promise<string>;
-    burnAsset(forgeScript: string | PlutusScript | UTxO, asset: Asset, redeemer?: Partial<Action>): Transaction;
-    delegateStake(rewardAddress: string, poolId: string): Transaction;
-    deregisterStake(rewardAddress: string): Transaction;
-    mintAsset(forgeScript: string | PlutusScript | UTxO, mint: Mint, redeemer?: Partial<Action>): Transaction;
-    redeemValue(options: {
-        value: UTxO;
-        script: PlutusScript | UTxO;
-        datum?: Data | UTxO;
-        redeemer?: Action;
-    }): Transaction;
-    registerStake(rewardAddress: string): Transaction;
-    registerPool(params: PoolParams): Transaction;
-    retirePool(poolId: string, epochNo: number): Transaction;
-    /**
-     * Adds an output to the transaction.
-     *
-     * @param recipient The recipient of the output.
-     * @param assets The assets to send.
-     * @returns The transaction builder.
-     * @see {@link https://meshjs.dev/apis/transaction#sendAssets}
-     */
-    sendAssets(recipient: Recipient, assets: Asset[]): Transaction;
-    /**
-     * Adds a transaction output to the transaction.
-     *
-     * @param {Recipient} recipient The recipient of the transaction.
-     * @param {string} lovelace The amount of lovelace to send.
-     * @returns {Transaction} The Transaction object.
-     * @see {@link https://meshjs.dev/apis/transaction#sendAda}
-     */
-    sendLovelace(recipient: Recipient, lovelace: string): Transaction;
-    /**
-     * Adds stable coins transaction output to the transaction.
-     * @param {Recipient} recipient The recipient of the transaction.
-     * @param {Token} ticker The ticker of the token to send.
-     * @param {string} amount The amount of the token to send.
-     * @returns {Transaction} The Transaction object.
-     * @see {@link https://meshjs.dev/apis/transaction#sendToken}
-     */
-    sendToken(recipient: Recipient, ticker: Token, amount: string): Transaction;
-    /**
-     * Adds an output to the transaction.
-     *
-     * @param {Recipient} recipient The recipient of the output.
-     * @param {UTxO} value The UTxO value of the output.
-     * @returns {Transaction} The Transaction object.
-     */
-    sendValue(recipient: Recipient, value: UTxO): Transaction;
-    /**
-     * Sets the change address for the transaction.
-     *
-     * @param {string} changeAddress The change address.
-     * @returns {Transaction} The Transaction object.
-     */
-    setChangeAddress(changeAddress: string): Transaction;
-    /**
-     * Sets the collateral for the transaction.
-     *
-     * @param {UTxO[]} collateral - Set the UTxO for collateral.
-     * @returns {Transaction} The Transaction object.
-     */
-    setCollateral(collateral: UTxO[]): Transaction;
-    /**
-     * Add a JSON metadata entry to the transaction.
-     *
-     * @param {number} key The key to use for the metadata entry.
-     * @param {unknown} value The value to use for the metadata entry.
-     * @returns {Transaction} The Transaction object.
-     * @see {@link https://meshjs.dev/apis/transaction#setMetadata}
-     */
-    setMetadata(key: number, value: unknown): Transaction;
-    /**
-     * Sets the required signers for the transaction.
-     *
-     * @param {string[]} addresses The addresses of the required signers.
-     * @returns {Transaction} The Transaction object.
-     */
-    setRequiredSigners(addresses: string[]): Transaction;
-    /**
-     * Sets the native script for the transaction.
-     * @param {NativeScript} script The native script to spend from.
-     * @param {UTxO} utxo The UTxO attached to the script.
-     * @returns {Transaction} The Transaction object.
-     */
-    setNativeScriptInput(script: NativeScript, utxo: UTxO): Transaction;
-    /**
-     * Sets the start slot for the transaction.
-     *
-     * @param {string} slot The start slot for the transaction.
-     * @returns {Transaction} The Transaction object.
-     * @see {@link https://meshjs.dev/apis/transaction#setTimeLimit}
-     */
-    setTimeToStart(slot: string): Transaction;
-    /**
-     * Set the time to live for the transaction.
-     *
-     * @param {string} slot The slot number to expire the transaction at.
-     * @returns {Transaction} The Transaction object.
-     * @see {@link https://meshjs.dev/apis/transaction#setTimeLimit}
-     */
-    setTimeToExpire(slot: string): Transaction;
-    /**
-     * Sets the inputs for the transaction.
-     *
-     * @param {UTxO[]} inputs The inputs to set.
-     * @returns {Transaction} The transaction.
-     */
-    setTxInputs(inputs: UTxO[]): Transaction;
-    /**
-     * Sets the reference inputs for the transaction.
-     *
-     * @param {UTxO[]} inputs The reference inputs to set.
-     * @returns {Transaction} The transaction.
-     */
-    setTxRefInputs(inputs: UTxO[]): Transaction;
-    withdrawRewards(rewardAddress: string, lovelace: string): Transaction;
-    private addBurnInputsIfNeeded;
-    private addChangeAddress;
-    private addCollateralIfNeeded;
-    private addRequiredSignersIfNeeded;
-    private addTxInputsAsNeeded;
-    private forgeAssetsIfNeeded;
-    private filterAvailableUTxOs;
-    private addMintOutputs;
-    private notVisited;
-    private setTxOutput;
-}
-declare type CreateTxOptions = {
-    initiator: IInitiator;
-    parameters: Protocol;
-    era: Era;
-};
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,45 +0,0 @@
-import { csl } from '@mesh/core';
-import { IFetcher, IInitiator, ISigner, ISubmitter } from '@mesh/common/contracts';
-import type { Address, TransactionUnspentOutput } from '@mesh/core';
-import type { DataSignature } from '@mesh/common/types';
-export declare type AppWalletKeyType = {
-    type: 'root';
-    bech32: string;
-} | {
-    type: 'cli';
-    payment: string;
-    stake?: string;
-} | {
-    type: 'mnemonic';
-    words: string[];
-};
-export declare type CreateAppWalletOptions = {
-    networkId: number;
-    fetcher?: IFetcher;
-    submitter?: ISubmitter;
-    key: AppWalletKeyType;
-};
-export declare class AppWallet implements IInitiator, ISigner, ISubmitter {
-    private readonly _fetcher?;
-    private readonly _submitter?;
-    private readonly _wallet;
-    constructor(options: CreateAppWalletOptions);
-    getBaseAddress(accountIndex?: number, keyIndex?: number): string;
-    getPaymentAddress(accountIndex?: number, keyIndex?: number): string;
-    getRewardAddress(accountIndex?: number, keyIndex?: number): string;
-    getUsedAddress(accountIndex?: number, keyIndex?: number): Address;
-    getUsedCollateral(_limit?: number): Promise<TransactionUnspentOutput[]>;
-    getUsedUTxOs(accountIndex?: number): Promise<TransactionUnspentOutput[]>;
-    signData(address: string, payload: string, accountIndex?: number, keyIndex?: number): DataSignature;
-    signTx(unsignedTx: string, partialSign?: boolean, accountIndex?: number, keyIndex?: number): Promise<string>;
-    signTxSync(unsignedTx: string, partialSign?: boolean, accountIndex?: number, keyIndex?: number): string;
-    signTxs(unsignedTxs: string[], partialSign: boolean): Promise<string[]>;
-    submitTx(tx: string): Promise<string>;
-    static brew(strength?: number): string[];
-    /**
-     * development: browser wallets apis
-     */
-    getUtxos(): Promise<TransactionUnspentOutput[]>;
-    getCollateral(): Promise<csl.TransactionUnspentOutput>;
-    getUsedAddresses(): Promise<string[]>;
-}

package/dist/wallet/app.service.spec.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,218 +0,0 @@
-import { IInitiator, ISigner, ISubmitter } from '@mesh/common/contracts';
-import type { Address, TransactionUnspentOutput } from '@mesh/core';
-import type { Asset, AssetExtended, DataSignature, UTxO, Wallet } from '@mesh/common/types';
-/**
- * These wallets APIs are in accordance to CIP-30, which defines the API for dApps to communicate with the user's wallet. Additional utility functions provided for developers that are useful for building dApps.
- *
- * ```javascript
- * // import BrowserWallet
- * import { BrowserWallet } from '@meshsdk/core';
- *
- * // connect to a wallet
- * const wallet = await BrowserWallet.enable('eternl');
- *
- * // get assets in wallet
- * const assets = await wallet.getAssets();
- * ```
- */
-export declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
-    readonly _walletInstance: WalletInstance;
-    readonly _walletName: string;
-    walletInstance: WalletInstance;
-    private constructor();
-    /**
-     * Returns a list of wallets installed on user's device. Each wallet is an object with the following properties:
-     * - A name is provided to display wallet's name on the user interface.
-     * - A version is provided to display wallet's version on the user interface.
-     * - An icon is provided to display wallet's icon on the user interface.
-     *
-     * @returns a list of wallet names
-     */
-    static getInstalledWallets(): Wallet[];
-    /**
-     * This is the entrypoint to start communication with the user's wallet. The wallet should request the user's permission to connect the web page to the user's wallet, and if permission has been granted, the wallet will be returned and exposing the full API for the dApp to use.
-     *
-     * Query BrowserWallet.getInstalledWallets() to get a list of available wallets, then provide the wallet name for which wallet the user would like to connect with.
-     *
-     * @param walletName
-     * @returns WalletInstance
-     */
-    static enable(walletName: string): Promise<BrowserWallet>;
-    /**
-     * Returns a list of assets in the wallet. This API will return every assets in the wallet. Each asset is an object with the following properties:
-     * - A unit is provided to display asset's name on the user interface.
-     * - A quantity is provided to display asset's quantity on the user interface.
-     *
-     * @returns a list of assets and their quantities
-     */
-    getBalance(): Promise<Asset[]>;
-    /**
-     * Returns an address owned by the wallet that should be used as a change address to return leftover assets during transaction creation back to the connected wallet.
-     *
-     * @returns an address
-     */
-    getChangeAddress(): Promise<string>;
-    /**
-     * This function shall return a list of one or more UTXOs (unspent transaction outputs) controlled by the wallet that are required to reach AT LEAST the combined ADA value target specified in amount AND the best suitable to be used as collateral inputs for transactions with plutus script inputs (pure ADA-only UTXOs).
-     *
-     * If this cannot be attained, an error message with an explanation of the blocking problem shall be returned. NOTE: wallets are free to return UTXOs that add up to a greater total ADA value than requested in the amount parameter, but wallets must never return any result where UTXOs would sum up to a smaller total ADA value, instead in a case like that an error message must be returned.
-     *
-     * @param limit
-     * @returns a list of UTXOs
-     */
-    getCollateral(limit?: number): Promise<UTxO[]>;
-    /**
-     * Returns the network ID of the currently connected account. 0 is testnet and 1 is mainnet but other networks can possibly be returned by wallets. Those other network ID values are not governed by CIP-30. This result will stay the same unless the connected account has changed.
-     *
-     * @returns network ID
-     */
-    getNetworkId(): Promise<number>;
-    /**
-     * Returns a list of reward addresses owned by the wallet. A reward address is a stake address that is used to receive rewards from staking, generally starts from `stake` prefix.
-     *
-     * @returns a list of reward addresses
-     */
-    getRewardAddresses(): Promise<string[]>;
-    /**
-     * Returns a list of unused addresses controlled by the wallet.
-     *
-     * @returns a list of unused addresses
-     */
-    getUnusedAddresses(): Promise<string[]>;
-    /**
-     * Returns a list of used addresses controlled by the wallet.
-     *
-     * @returns a list of used addresses
-     */
-    getUsedAddresses(): Promise<string[]>;
-    /**
-     * Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet.
-     *
-     * @param amount
-     * @returns a list of UTXOs
-     */
-    getUtxos(amount?: Asset[] | undefined): Promise<UTxO[]>;
-    /**
-     * This endpoint utilizes the [CIP-8 - Message Signing](https://github.com/cardano-foundation/CIPs/tree/master/CIP-0030) to sign arbitrary data, to verify the data was signed by the owner of the private key.
-     *
-     * Here, we get the first wallet's address with wallet.getUsedAddresses(), alternativelly you can use reward addresses (getRewardAddresses()) too. It's really up to you as the developer which address you want to use in your application.
-     *
-     * @param address
-     * @param payload
-     * @returns a signature
-     */
-    signData(address: string, payload: string): Promise<DataSignature>;
-    /**
-     * Requests user to sign the provided transaction (tx). The wallet should ask the user for permission, and if given, try to sign the supplied body and return a signed transaction. partialSign should be true if the transaction provided requires multiple signatures.
-     *
-     * @param unsignedTx
-     * @param partialSign
-     * @returns a signed transaction in CBOR
-     */
-    signTx(unsignedTx: string, partialSign?: boolean): Promise<string>;
-    /**
-     * Experimental feature - sign multiple transactions at once (Supported wallet(s): Typhon)
-     *
-     * @param unsignedTxs - array of unsigned transactions in CborHex string
-     * @param partialSign - if the transactions are signed partially
-     * @returns array of signed transactions CborHex string
-     */
-    signTxs(unsignedTxs: string[], partialSign?: boolean): Promise<string[]>;
-    /**
-     * Submits the signed transaction to the blockchain network.
-     *
-     * As wallets should already have this ability to submit transaction, we allow dApps to request that a transaction be sent through it. If the wallet accepts the transaction and tries to send it, it shall return the transaction ID for the dApp to track. The wallet can return error messages or failure if there was an error in sending it.
-     *
-     * @param tx
-     * @returns a transaction hash
-     */
-    submitTx(tx: string): Promise<string>;
-    /**
-     * Get a used address of type Address from the wallet.
-     *
-     * This is used in transaction building.
-     *
-     * @returns an Address object
-     */
-    getUsedAddress(): Promise<Address>;
-    /**
-     * Get a list of UTXOs to be used as collateral inputs for transactions with plutus script inputs.
-     *
-     * This is used in transaction building.
-     *
-     * @returns a list of UTXOs
-     */
-    getUsedCollateral(limit?: number): Promise<TransactionUnspentOutput[]>;
-    /**
-     * Get a list of UTXOs to be used for transaction building.
-     *
-     * This is used in transaction building.
-     *
-     * @returns a list of UTXOs
-     */
-    getUsedUTxOs(amount?: Asset[] | undefined): Promise<TransactionUnspentOutput[]>;
-    /**
-     * A helper function to get the assets in the wallet.
-     *
-     * @returns a list of assets
-     */
-    getAssets(): Promise<AssetExtended[]>;
-    /**
-     * A helper function to get the lovelace balance in the wallet.
-     *
-     * @returns lovelace balance
-     */
-    getLovelace(): Promise<string>;
-    /**
-     * A helper function to get the assets of a specific policy ID in the wallet.
-     *
-     * @param policyId
-     * @returns a list of assets
-     */
-    getPolicyIdAssets(policyId: string): Promise<AssetExtended[]>;
-    /**
-     * A helper function to get the policy IDs of all the assets in the wallet.
-     *
-     * @returns a list of policy IDs
-     */
-    getPolicyIds(): Promise<string[]>;
-    private static resolveInstance;
-}
-declare global {
-    interface Window {
-        cardano: Cardano;
-    }
-}
-declare type Cardano = {
-    [key: string]: {
-        name: string;
-        icon: string;
-        apiVersion: string;
-        enable: () => Promise<WalletInstance>;
-    };
-};
-declare type TransactionSignatureRequest = {
-    cbor: string;
-    partialSign: boolean;
-};
-declare type WalletInstance = {
-    experimental: ExperimentalFeatures;
-    getBalance(): Promise<string>;
-    getChangeAddress(): Promise<string>;
-    getNetworkId(): Promise<number>;
-    getRewardAddresses(): Promise<string[]>;
-    getUnusedAddresses(): Promise<string[]>;
-    getUsedAddresses(): Promise<string[]>;
-    getUtxos(amount: string | undefined): Promise<string[] | undefined>;
-    signData(address: string, payload: string): Promise<DataSignature>;
-    signTx(tx: string, partialSign: boolean): Promise<string>;
-    signTxs?(txs: TransactionSignatureRequest[]): Promise<string[]>;
-    signTxs?(txs: string[], partialSign: boolean): Promise<string[]>;
-    submitTx(tx: string): Promise<string>;
-};
-declare type ExperimentalFeatures = {
-    getCollateral(): Promise<string[] | undefined>;
-    signTxs?(txs: TransactionSignatureRequest[]): Promise<string[]>;
-    signTxs?(txs: string[], partialSign: boolean): Promise<string[]>;
-};
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,21 +0,0 @@
-import type { Vkeywitnesses } from '@mesh/core';
-import type { Account, DataSignature, UTxO } from '@mesh/common/types';
-export declare class EmbeddedWallet {
-    private readonly _networkId;
-    private readonly _encryptedSecret;
-    constructor(_networkId: number, _encryptedSecret: string | [string, string]);
-    getAccount(accountIndex: number, password: string, keyIndex?: number): Account;
-    signData(accountIndex: number, password: string, address: string, payload: string, keyIndex?: number): DataSignature;
-    signTx(accountIndex: number, password: string, utxos: UTxO[], unsignedTx: string, partialSign: boolean, keyIndex?: number): Vkeywitnesses;
-    addPaymentKey(accountIndex: number, password: string, unsignedTx: string, signatures: Vkeywitnesses, keyIndex?: number): Vkeywitnesses;
-    static encryptMnemonic(words: string[], password: string): string;
-    static encryptPrivateKey(bech32: string, password: string): string;
-    static encryptSigningKeys(cborPaymentKey: string, cborStakeKey: string, password: string): [string, string];
-    static generateMnemonic(strength?: number): string[];
-    private accountContext;
-    private static decrypt;
-    private static encrypt;
-    private static resolveAddress;
-    private static resolveKeys;
-    private static resolveSigners;
-}

package/dist/wallet/embedded.service.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/wallet/index.d.ts

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