meshjs 0.0.1 → 1.2.0-beta.4

package/README.md

@@ -0,0 +1,32 @@
+![Mesh Logo](https://mesh.martify.io/logo-mesh/mesh.png)
+
+Mesh is an open-source library 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.
+
+Explore the features on [Mesh Playground](https://mesh.martify.io/).
+
+## Guides and documentations
+
+- [Start a Web3 app on Next.js](https://mesh.martify.io/guides/nextjs)
+- [Minting on Node.js](https://mesh.martify.io/guides/mintingonnodejs)
+- [App Wallet - Wallet for building transactions in your applications](https://mesh.martify.io/apis/appwallet)
+- [Browser Wallet - CIP30 wallets intergration](https://mesh.martify.io/apis/browserwallet)
+- [Transaction - Building, minting, burning, smart contracts and more](https://mesh.martify.io/apis/transaction)
+- [Resolvers - Helpful functions that you need while building dApps](https://mesh.martify.io/apis/resolvers)
+
+## Why use Mesh
+- Always up to date - Vasil ready, developed closely as the network updates so your app will always works
+- Simple to use - Check out our [guides](https://mesh.martify.io/guides), you will get started in less than 10 mins
+- Everything you need to build Web3 apps - [React components](https://mesh.martify.io/react) like wallet connection buttons, and useful React hooks - Mesh provides everything you need to build web3 apps
+- Adopts best practices - implemented various CIPs and package is well build (no hacking and tweaking needed to get it to work)
+- Thoroughly tested - Mesh is used by developers and learners, built by developers with solid software engineering background
+- Integrates with Cardano projects - Koios, Blockfrost, ADA Handle (and more), you pick what you want to use for your app
+- Well documented - We focus on documentation so you can use it, our [Playground](https://mesh.martify.io/) is built so you can see how it works
+
+[Find out more](https://mesh.martify.io/about)
+
+## How can you contribute?
+
+- [You can support Mesh!](https://mesh.martify.io/about/support-us)
+- Build something - try Mesh by implementing your Web 3.0 project (recommended [starter guide](https://mesh.martify.io/guides/nextjs))
+- Inform others - Tell others about Mesh, and star the [Github repo](https://github.com/MartifyLabs/mesh) :star:
+- Write ups - documentations and guides

package/dist/common/constants.d.ts

@@ -0,0 +1,27 @@
+import { csl } from '@mesh/core';
+import type { Costmdls } from '@mesh/core';
+import type { Budget, Era, Network, Protocol } from './types';
+export declare const DEFAULT_REDEEMER_BUDGET: Budget;
+export declare const DEFAULT_PROTOCOL_PARAMETERS: Protocol;
+export declare const HARDENED_KEY_START = 2147483648;
+export declare const LANGUAGE_VERSIONS: {
+    V1: csl.Language;
+    V2: csl.Language;
+};
+export declare const POLICY_ID_LENGTH = 56;
+export declare const REDEEMER_TAGS: {
+    CERT: csl.RedeemerTag;
+    MINT: csl.RedeemerTag;
+    REWARD: csl.RedeemerTag;
+    SPEND: csl.RedeemerTag;
+};
+export declare const SUPPORTED_CLOCKS: Record<Network, [
+    epoch: string,
+    slot: string,
+    systemStart: string,
+    epochLength: string
+]>;
+export declare const SUPPORTED_COST_MODELS: Record<Era, Costmdls>;
+export declare const SUPPORTED_LANGUAGE_VIEWS: Record<Era, Partial<Record<keyof typeof LANGUAGE_VERSIONS, string>>>;
+export declare const SUPPORTED_HANDLES: Record<number, string>;
+export declare const SUPPORTED_WALLETS: string[];

package/dist/common/contracts/fetcher.d.ts

@@ -0,0 +1,8 @@
+import type { AccountInfo, AssetMetadata, Protocol, UTxO } from '@mesh/common/types';
+export interface IFetcher {
+    fetchAccountInfo(address: string): Promise<AccountInfo>;
+    fetchAddressUTxOs(address: string, asset?: string): Promise<UTxO[]>;
+    fetchAssetMetadata(asset: string): Promise<AssetMetadata>;
+    fetchHandleAddress(handle: string): Promise<string>;
+    fetchProtocolParameters(epoch: number): Promise<Protocol>;
+}

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

@@ -0,0 +1,5 @@
+export * from './fetcher';
+export * from './initiator';
+export * from './signer';
+export * from './submitter';
+export * from './uploader';

package/dist/common/contracts/initiator.d.ts

@@ -0,0 +1,8 @@
+import type { Address, TransactionUnspentOutput } from '@mesh/core';
+export interface IInitiator {
+    getUsedAddress(): SometimesPromise<Address>;
+    getUsedCollateral(limit?: number): SometimesPromise<TransactionUnspentOutput[]>;
+    getUsedUTxOs(): SometimesPromise<TransactionUnspentOutput[]>;
+}
+declare type SometimesPromise<T> = Promise<T> | T;
+export {};

package/dist/common/contracts/signer.d.ts

@@ -0,0 +1,7 @@
+import { DataSignature } from '@mesh/common/types';
+export interface ISigner {
+    signData(address: string, payload: string): SometimesPromise<DataSignature>;
+    signTx(unsignedTx: string, partialSign: boolean): SometimesPromise<string>;
+}
+declare type SometimesPromise<T> = Promise<T> | T;
+export {};

package/dist/common/contracts/submitter.d.ts

@@ -0,0 +1,3 @@
+export interface ISubmitter {
+    submitTx(tx: string): Promise<string>;
+}

package/dist/common/contracts/uploader.d.ts

@@ -0,0 +1,3 @@
+export interface IUploader {
+    uploadContent(content: FormData, recursive: boolean): Promise<string>;
+}

package/dist/common/decorators.d.ts

@@ -0,0 +1,19 @@
+/// <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/helpers/index.d.ts

@@ -0,0 +1 @@
+export * from './mergeSignatures';

package/dist/common/helpers/mergeSignatures.d.ts

@@ -0,0 +1,3 @@
+import { csl } from '@mesh/core';
+import type { TransactionWitnessSet, Vkeywitnesses } from '@mesh/core';
+export declare const mergeSignatures: (txWitnessSet: TransactionWitnessSet, newSignatures: Vkeywitnesses) => csl.Vkeywitnesses;

package/dist/common/types/Account.d.ts

@@ -0,0 +1,5 @@
+export declare type Account = {
+    baseAddress: string;
+    enterpriseAddress: string;
+    rewardAddress: string;
+};

package/dist/common/types/AccountInfo.d.ts

@@ -0,0 +1,7 @@
+export declare type AccountInfo = {
+    active: boolean;
+    poolId?: string;
+    balance: string;
+    rewards: string;
+    withdrawals: string;
+};

package/dist/common/types/Action.d.ts

@@ -0,0 +1,12 @@
+import { REDEEMER_TAGS } from '@mesh/common/constants';
+import { Data } from './Data';
+export declare type Action = {
+    data: Data;
+    index: number;
+    budget: Budget;
+    tag: keyof typeof REDEEMER_TAGS;
+};
+export declare type Budget = {
+    mem: number;
+    steps: number;
+};

package/dist/common/types/Asset.d.ts

@@ -0,0 +1,6 @@
+export declare type Asset = {
+    unit: Unit;
+    quantity: Quantity;
+};
+export declare type Unit = string;
+export declare type Quantity = string;

package/dist/common/types/AssetExtended.d.ts

@@ -0,0 +1,8 @@
+import { Quantity, Unit } from './Asset';
+export declare type AssetExtended = {
+    unit: Unit;
+    policyId: string;
+    assetName: string;
+    fingerprint: string;
+    quantity: Quantity;
+};

package/dist/common/types/AssetMetadata.d.ts

@@ -0,0 +1,24 @@
+import type { MetadataStandard, Files } from '@mesh/core';
+export declare type AssetMetadata = FungibleAssetMetadata | NonFungibleAssetMetadata;
+export declare type FungibleAssetMetadata = MetadataStandard & {
+    ticker: string;
+    decimals: number;
+    version: `${number}.${number}`;
+};
+export declare type NonFungibleAssetMetadata = AudioAssetMetadata | ImageAssetMetadata | SmartAssetMetadata | VideoAssetMetadata;
+declare type AudioAssetMetadata = MetadataStandard & Files;
+export declare type ImageAssetMetadata = MetadataStandard & Files & {
+    artists?: [
+        {
+            name: string;
+            twitter?: `https://twitter.com/${string}`;
+        }
+    ];
+    attributes?: {
+        [key: string]: string;
+    };
+    traits?: string[];
+};
+declare type SmartAssetMetadata = MetadataStandard & Files;
+declare type VideoAssetMetadata = MetadataStandard & Files;
+export {};

package/dist/common/types/Data.d.ts

@@ -0,0 +1,4 @@
+export declare type Data = string | number | Array<Data> | Map<Data, Data> | {
+    alternative: number;
+    fields: Array<Data>;
+};

package/dist/common/types/DataSignature.d.ts

@@ -0,0 +1,4 @@
+export declare type DataSignature = {
+    signature: string;
+    key: string;
+};

package/dist/common/types/Era.d.ts

@@ -0,0 +1 @@
+export declare type Era = 'ALONZO' | 'BABBAGE';

package/dist/common/types/Mint.d.ts

@@ -0,0 +1,10 @@
+import { Quantity } from './Asset';
+import { AssetMetadata } from './AssetMetadata';
+import { Recipient } from './Recipient';
+export declare type Mint = {
+    assetName: string;
+    assetQuantity: Quantity;
+    metadata: AssetMetadata;
+    recipient: Recipient;
+    label: '20' | '721';
+};

package/dist/common/types/NativeScript.d.ts

@@ -0,0 +1,14 @@
+export declare type NativeScript = {
+    type: 'after' | 'before';
+    slot: string;
+} | {
+    type: 'all' | 'any';
+    scripts: NativeScript[];
+} | {
+    type: 'atLeast';
+    required: number;
+    scripts: NativeScript[];
+} | {
+    type: 'sig';
+    keyHash: string;
+};

package/dist/common/types/Network.d.ts

@@ -0,0 +1 @@
+export declare type Network = 'testnet' | 'preview' | 'preprod' | 'mainnet';

package/dist/common/types/PlutusScript.d.ts

@@ -0,0 +1,6 @@
+import { LANGUAGE_VERSIONS } from '../constants';
+export declare type PlutusScript = {
+    version: LanguageVersion;
+    code: string;
+};
+export declare type LanguageVersion = keyof typeof LANGUAGE_VERSIONS;

package/dist/common/types/PoolParams.d.ts

@@ -0,0 +1,16 @@
+import { Relay } from './Relay';
+export declare type PoolParams = {
+    operator: string;
+    vrfKeyHash: string;
+    pledge: string;
+    cost: string;
+    margin: number;
+    rewardAddress: string;
+    relays: Relay[];
+    owners: string[];
+    metadata?: PoolMetadata;
+};
+export declare type PoolMetadata = {
+    URL: string;
+    hash: string;
+};

package/dist/common/types/Protocol.d.ts

@@ -0,0 +1,22 @@
+export declare type Protocol = {
+    epoch: number;
+    minFeeA: number;
+    minFeeB: number;
+    maxBlockSize: number;
+    maxTxSize: number;
+    maxBlockHeaderSize: number;
+    keyDeposit: string;
+    poolDeposit: string;
+    decentralisation: number;
+    minPoolCost: string;
+    priceMem: number;
+    priceStep: number;
+    maxTxExMem: string;
+    maxTxExSteps: string;
+    maxBlockExMem: string;
+    maxBlockExSteps: string;
+    maxValSize: string;
+    collateralPercent: number;
+    maxCollateralInputs: number;
+    coinsPerUTxOSize: string;
+};

package/dist/common/types/Recipient.d.ts

@@ -0,0 +1,11 @@
+import { Data } from './Data';
+import { NativeScript } from './NativeScript';
+import { PlutusScript } from './PlutusScript';
+export declare type Recipient = string | {
+    address: string;
+    datum?: {
+        value: Data;
+        inline?: boolean;
+    };
+    script?: PlutusScript | NativeScript;
+};

package/dist/common/types/Relay.d.ts

@@ -0,0 +1,13 @@
+export declare type Relay = {
+    type: 'SingleHostAddr';
+    IPV4?: string;
+    IPV6?: string;
+    port?: number;
+} | {
+    type: 'SingleHostName';
+    domainName: string;
+    port?: number;
+} | {
+    type: 'MultiHostName';
+    domainName: string;
+};

package/dist/common/types/UTxO.d.ts

@@ -0,0 +1,14 @@
+import { Asset } from './Asset';
+export declare type UTxO = {
+    input: {
+        outputIndex: number;
+        txHash: string;
+    };
+    output: {
+        address: string;
+        amount: Asset[];
+        dataHash?: string;
+        plutusData?: string;
+        scriptRef?: string;
+    };
+};

package/dist/common/types/Wallet.d.ts

@@ -0,0 +1,5 @@
+export declare type Wallet = {
+    name: string;
+    icon: string;
+    version: string;
+};

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

@@ -0,0 +1,19 @@
+export * from './Account';
+export * from './AccountInfo';
+export * from './Action';
+export * from './Asset';
+export * from './AssetExtended';
+export * from './AssetMetadata';
+export * from './Data';
+export * from './DataSignature';
+export * from './Era';
+export * from './Mint';
+export * from './NativeScript';
+export * from './Network';
+export * from './PlutusScript';
+export * from './PoolParams';
+export * from './Protocol';
+export * from './Recipient';
+export * from './Relay';
+export * from './UTxO';
+export * from './Wallet';

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

@@ -0,0 +1,17 @@
+import { csl } from '@mesh/core';
+import type { BaseAddress, Bip32PrivateKey, DataCost, DatumSource, Ed25519KeyHash, EnterpriseAddress, PlutusScriptSource, RewardAddress, TransactionBuilder, TransactionOutputBuilder, TxInputsBuilder } from '@mesh/core';
+import type { Data, PlutusScript, Recipient, UTxO } from '@mesh/common/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 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/common/types").Protocol) => TransactionBuilder;
+export declare const buildTxInputsBuilder: (utxos: unknown[]) => TxInputsBuilder;
+export declare const buildTxOutputBuilder: (recipient: Recipient) => TransactionOutputBuilder;

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

@@ -0,0 +1,26 @@
+import { csl } from '@mesh/core';
+import type { ScriptRef, TransactionUnspentOutput, Value } from '@mesh/core';
+import type { Action, Asset, Data, NativeScript, PlutusScript, PoolParams, Relay, UTxO } from '@mesh/common/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 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

@@ -0,0 +1,17 @@
+import { csl } from '@mesh/core';
+import type { LanguageVersion } from '@mesh/common/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 deserializeNativeScript: (nativeScript: string) => csl.NativeScript;
+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

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

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

@@ -0,0 +1 @@
+export declare const parseHttpError: (error: unknown) => string;

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

@@ -0,0 +1,17 @@
+import type { Data, Era, LanguageVersion, NativeScript, Network, PlutusScript } from '@mesh/common/types';
+export declare const resolveDataHash: (data: Data) => string;
+export declare const resolveEpochNo: (network: Network, milliseconds?: number) => number;
+export declare const resolveFingerprint: (policyId: string, assetName: string) => string;
+export declare const resolveLanguageView: (era: Era, version: LanguageVersion) => string | undefined;
+export declare const resolveNativeScriptHash: (script: NativeScript) => string;
+export declare const resolvePaymentKeyHash: (bech32: string) => string;
+export declare const resolvePlutusScriptAddress: (script: PlutusScript, networkId?: number) => string;
+export declare const resolvePlutusScriptHash: (bech32: string) => string;
+export declare const resolvePoolId: (hash: string) => string;
+export declare const resolvePrivateKey: (words: string[]) => string;
+export declare const resolveScriptRef: (script: PlutusScript | NativeScript) => string;
+export declare const resolveSlotNo: (network: Network, milliseconds?: number) => string;
+export declare const resolveRewardAddress: (bech32: string) => string;
+export declare const resolveStakeKeyHash: (bech32: string) => string;
+export declare const resolveTxFees: (txSize: number, minFeeA?: number, minFeeB?: number) => string;
+export declare const resolveTxHash: (txHex: string) => string;

package/dist/core/CIP14.d.ts

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

package/dist/core/CIP1852.d.ts

@@ -0,0 +1,4 @@
+export declare const deriveAccountKeys: (rootKey: string, accountIndex: number) => {
+    paymentKey: import("@emurgo/cardano-serialization-lib-nodejs").PrivateKey;
+    stakeKey: import("@emurgo/cardano-serialization-lib-nodejs").PrivateKey;
+};

package/dist/core/CIP1853.d.ts

@@ -0,0 +1 @@
+export declare const deriveStakePoolColdKey: (rootKey: string, coldIndex: number) => import("@emurgo/cardano-serialization-lib-nodejs").PrivateKey;

package/dist/core/CIP1855.d.ts

@@ -0,0 +1 @@
+export declare const deriveForgingPolicyKey: (rootKey: string, policyIndex: number) => import("@emurgo/cardano-serialization-lib-nodejs").PrivateKey;

package/dist/core/CIP2.d.ts

@@ -0,0 +1,3 @@
+import type { Quantity, Unit, UTxO } from '@mesh/common/types';
+export declare const largestFirst: (lovelace: Quantity, initialUTxOSet: UTxO[], includeTxFees?: boolean, { maxTxSize, minFeeA, minFeeB }?: import("@mesh/common/types").Protocol) => UTxO[];
+export declare const largestFirstMultiAsset: (requestedOutputSet: Map<Unit, Quantity>, initialUTxOSet: UTxO[], includeTxFees?: boolean, parameters?: import("@mesh/common/types").Protocol) => UTxO[];

package/dist/core/CIP25.d.ts

@@ -0,0 +1,19 @@
+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/CIP8.d.ts

@@ -0,0 +1,13 @@
+import type { Address, PrivateKey } from './CSL';
+export declare const signMessage: (message: Message, signer: Signer) => {
+    coseKey: string;
+    coseSign1: string;
+};
+export declare type Message = {
+    payload: string;
+    externalAAD?: string;
+};
+export declare type Signer = {
+    address: Address;
+    key: PrivateKey;
+};