@meshsdk/wallet 1.6.0-alpha.11

package/src/mesh/index.ts

@@ -0,0 +1,413 @@
+import type {
+  Asset,
+  AssetExtended,
+  DataSignature,
+  UTxO,
+} from "@meshsdk/common";
+import {
+  IFetcher,
+  IInitiator,
+  ISigner,
+  ISubmitter,
+  POLICY_ID_LENGTH,
+  resolveFingerprint,
+  toUTF8,
+} from "@meshsdk/common";
+import {
+  Address,
+  fromTxUnspentOutput,
+  resolvePrivateKey,
+  toTxUnspentOutput,
+  TransactionUnspentOutput,
+} from "@meshsdk/core-cst";
+import { Transaction } from "@meshsdk/transaction";
+
+import { AppWallet } from "../app";
+import { EmbeddedWallet } from "../embedded";
+import { GetAddressType } from "../types";
+
+export type CreateMeshWalletOptions = {
+  networkId: number;
+  fetcher?: IFetcher;
+  submitter?: ISubmitter;
+  key:
+    | {
+        type: "root";
+        bech32: string;
+      }
+    | {
+        type: "cli";
+        payment: string;
+        stake?: string;
+      }
+    | {
+        type: "mnemonic";
+        words: string[];
+      };
+};
+
+/**
+ * Mesh Wallet provides a set of APIs to interact with the blockchain. This wallet is compatible with Mesh transaction builders.
+ *
+ * It is a single address wallet, a wrapper around the AppWallet class.
+ *
+ * ```javascript
+ * import { MeshWallet, BlockfrostProvider } from '@meshsdksdk/core';
+ *
+ * const blockchainProvider = new BlockfrostProvider('<BLOCKFROST_API_KEY>');
+ *
+ * const wallet = new MeshWallet({
+ *   networkId: 0,
+ *   fetcher: blockchainProvider,
+ *   submitter: blockchainProvider,
+ *   key: {
+ *     type: 'mnemonic',
+ *     words: ["solution","solution","solution","solution","solution",","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution","solution"],
+ *   },
+ * });
+ * ```
+ */
+export class MeshWallet implements IInitiator, ISigner, ISubmitter {
+  private readonly _wallet: AppWallet;
+
+  constructor(options: CreateMeshWalletOptions) {
+    switch (options.key.type) {
+      case "root":
+        this._wallet = new AppWallet({
+          networkId: options.networkId,
+          fetcher: options.fetcher,
+          submitter: options.submitter,
+          key: {
+            type: "root",
+            bech32: options.key.bech32,
+          },
+        });
+        break;
+      case "cli":
+        this._wallet = new AppWallet({
+          networkId: options.networkId,
+          fetcher: options.fetcher,
+          submitter: options.submitter,
+          key: {
+            type: "cli",
+            payment: options.key.payment,
+            stake: options.key.stake,
+          },
+        });
+        break;
+      case "mnemonic":
+        this._wallet = new AppWallet({
+          networkId: options.networkId,
+          fetcher: options.fetcher,
+          submitter: options.submitter,
+          key: {
+            type: "mnemonic",
+            words: options.key.words,
+          },
+        });
+        break;
+    }
+  }
+
+  /**
+   * 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
+   */
+  async getBalance(): Promise<Asset[]> {
+    const utxos = await this.getUnspentOutputs();
+
+    const assets = new Map<string, number>();
+    utxos.map((utxo) => {
+      const _utxo = fromTxUnspentOutput(utxo);
+      _utxo.output.amount.map((asset) => {
+        const assetId = asset.unit;
+        const amount = Number(asset.quantity);
+        if (assets.has(assetId)) {
+          const quantity = assets.get(assetId)!;
+          assets.set(assetId, quantity + amount);
+        } else {
+          assets.set(assetId, amount);
+        }
+      });
+    });
+
+    const arrayAssets: Asset[] = Array.from(assets, ([unit, quantity]) => ({
+      unit,
+      quantity: quantity.toString(),
+    }));
+
+    return arrayAssets;
+  }
+
+  /**
+   * 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(): string {
+    return this._wallet.getPaymentAddress();
+  }
+
+  /**
+   * 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.
+   *
+   * @returns a list of UTXOs
+   */
+
+  async getCollateral(
+    addressType: GetAddressType = "payment",
+  ): Promise<UTxO[]> {
+    const utxos = await this._wallet.getCollateralUnspentOutput(0, addressType);
+    return utxos.map((utxo, i) => {
+      return fromTxUnspentOutput(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(): number {
+    return this._wallet.getNetworkId();
+  }
+
+  /**
+   * 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(): string[] {
+    return [this._wallet.getRewardAddress()];
+  }
+
+  /**
+   * Returns a list of unused addresses controlled by the wallet.
+   *
+   * @returns a list of unused addresses
+   */
+  getUnusedAddresses(): string[] {
+    return [this.getChangeAddress()];
+  }
+
+  /**
+   * Returns a list of used addresses controlled by the wallet.
+   *
+   * @returns a list of used addresses
+   */
+  getUsedAddresses(): string[] {
+    return [this.getChangeAddress()];
+  }
+
+  /**
+   * 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
+   */
+  async getUsedCollateral(): Promise<TransactionUnspentOutput[]> {
+    const collateralUtxo = await this.getCollateral();
+
+    const unspentOutput = collateralUtxo.map((utxo) => {
+      return toTxUnspentOutput(utxo);
+    });
+
+    return unspentOutput;
+  }
+
+  /**
+   * Get a list of UTXOs to be used for transaction building.
+   *
+   * This is used in transaction building.
+   *
+   * @returns a list of UTXOs
+   */
+  async getUsedUTxOs(
+    addressType?: GetAddressType,
+  ): Promise<TransactionUnspentOutput[]> {
+    return await this.getUnspentOutputs(addressType);
+  }
+
+  /**
+   * Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet.
+   *
+   * @returns a list of UTXOs
+   */
+  async getUtxos(addressType?: GetAddressType): Promise<UTxO[]> {
+    const utxos = await this.getUsedUTxOs(addressType);
+    return utxos.map((c) => fromTxUnspentOutput(c));
+  }
+
+  /**
+   * 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(payload: string): DataSignature {
+    return this._wallet.signData(this.getChangeAddress(), payload);
+  }
+
+  /**
+   * 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 = false): string {
+    return this._wallet.signTx(unsignedTx, partialSign);
+  }
+
+  /**
+   * Experimental feature - sign multiple transactions at once.
+   *
+   * @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 = false): string[] {
+    const signedTxs: string[] = [];
+
+    for (const unsignedTx of unsignedTxs) {
+      const signedTx = this.signTx(unsignedTx, partialSign);
+      signedTxs.push(signedTx);
+    }
+
+    return signedTxs;
+  }
+
+  /**
+   * 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
+   */
+  async submitTx(tx: string): Promise<string> {
+    return await this._wallet.submitTx(tx);
+  }
+
+  /**
+   * Get a used address of type Address from the wallet.
+   *
+   * This is used in transaction building.
+   *
+   * @returns an Address object
+   */
+  getUsedAddress(addressType?: GetAddressType): Address {
+    return this._wallet.getUsedAddress(0, 0, addressType);
+  }
+
+  /**
+   * Get a list of UTXOs to be used for transaction building.
+   *
+   * This is used in transaction building.
+   *
+   * @returns a list of UTXOs
+   */
+  async getUnspentOutputs(
+    addressType?: GetAddressType,
+  ): Promise<TransactionUnspentOutput[]> {
+    return await this._wallet.getUnspentOutputs(0, addressType);
+  }
+
+  /**
+   * A helper function to get the assets in the wallet.
+   *
+   * @returns a list of assets
+   */
+  async getAssets(): Promise<AssetExtended[]> {
+    const balance = await this.getBalance();
+    return balance
+      .filter((v) => v.unit !== "lovelace")
+      .map((v) => {
+        const policyId = v.unit.slice(0, POLICY_ID_LENGTH);
+        const assetName = v.unit.slice(POLICY_ID_LENGTH);
+        const fingerprint = resolveFingerprint(policyId, assetName);
+
+        return {
+          unit: v.unit,
+          policyId,
+          assetName: toUTF8(assetName),
+          fingerprint,
+          quantity: v.quantity,
+        };
+      });
+  }
+
+  /**
+   * A helper function to get the lovelace balance in the wallet.
+   *
+   * @returns lovelace balance
+   */
+  async getLovelace(): Promise<string> {
+    const balance = await this.getBalance();
+    const nativeAsset = balance.find((v) => v.unit === "lovelace");
+
+    return nativeAsset !== undefined ? nativeAsset.quantity : "0";
+  }
+
+  /**
+   * A helper function to get the assets of a specific policy ID in the wallet.
+   *
+   * @param policyId
+   * @returns a list of assets
+   */
+  async getPolicyIdAssets(policyId: string): Promise<AssetExtended[]> {
+    const assets = await this.getAssets();
+    return assets.filter((v) => v.policyId === policyId);
+  }
+
+  /**
+   * A helper function to get the policy IDs of all the assets in the wallet.
+   *
+   * @returns a list of policy IDs
+   */
+  async getPolicyIds(): Promise<string[]> {
+    const balance = await this.getBalance();
+    return Array.from(
+      new Set(balance.map((v) => v.unit.slice(0, POLICY_ID_LENGTH))),
+    ).filter((p) => p !== "lovelace");
+  }
+
+  /**
+   * A helper function to create a collateral input for a transaction.
+   *
+   * @returns a transaction hash
+   */
+  async createCollateral(): Promise<string> {
+    const tx = new Transaction({ initiator: this });
+    tx.sendLovelace(this.getChangeAddress(), "5000000");
+    const unsignedTx = await tx.build();
+    const signedTx = await this.signTx(unsignedTx);
+    const txHash = await this.submitTx(signedTx);
+    return txHash;
+  }
+
+  /**
+   * Generate mnemonic or private key
+   *
+   * @param privateKey return private key if true
+   * @returns a transaction hash
+   */
+  static brew(privateKey = false, strength = 256): string[] | string {
+    const mnemonic = EmbeddedWallet.generateMnemonic(strength);
+
+    if (privateKey) {
+      return resolvePrivateKey(mnemonic);
+    }
+
+    return mnemonic;
+  }
+}

package/src/types/index.ts

@@ -0,0 +1,39 @@
+import { DataSignature } from "@meshsdk/common";
+
+export type Cardano = {
+  [key: string]: {
+    name: string;
+    icon: string;
+    apiVersion: string;
+    enable: () => Promise<WalletInstance>;
+  };
+};
+
+type TransactionSignatureRequest = {
+  cbor: string;
+  partialSign: boolean;
+};
+
+export type WalletInstance = {
+  experimental: ExperimentalFeatures;
+  getBalance(): Promise<string>;
+  getChangeAddress(): Promise<string>;
+  getNetworkId(): Promise<number>;
+  getRewardAddresses(): Promise<string[]>;
+  getUnusedAddresses(): Promise<string[]>;
+  getUsedAddresses(): Promise<string[]>;
+  getUtxos(): Promise<string[] | undefined>;
+  signData(address: string, payload: string): Promise<DataSignature>;
+  signTx(tx: string, partialSign: boolean): Promise<string>;
+  signTxs?(txs: TransactionSignatureRequest[]): Promise<string[]>; // Overloading interface as currently no standard
+  signTxs?(txs: string[], partialSign: boolean): Promise<string[]>; // Overloading interface as currently no standard
+  submitTx(tx: string): Promise<string>;
+};
+
+type ExperimentalFeatures = {
+  getCollateral(): Promise<string[] | undefined>;
+  signTxs?(txs: TransactionSignatureRequest[]): Promise<string[]>; // Overloading interface as currently no standard
+  signTxs?(txs: string[], partialSign: boolean): Promise<string[]>; // Overloading interface as currently no standard
+};
+
+export type GetAddressType = "enterprise" | "payment";

package/test/app.test.ts

@@ -0,0 +1,98 @@
+import { AppWallet } from "@meshsdk/wallet";
+
+describe("AppWallet", () => {
+  const wallet = new AppWallet({
+    networkId: 0,
+    key: {
+      type: "mnemonic",
+      words: "solution,".repeat(24).split(",").slice(0, 24),
+    },
+  });
+
+  it("brew", () => {
+    const mnemonic = AppWallet.brew();
+    expect(mnemonic.length).toEqual(24);
+  });
+
+  it("private keys", () => {
+    const wallet = new AppWallet({
+      networkId: 0,
+      key: {
+        type: "root",
+        bech32:
+          "xprv1cqa46gk29plgkg98upclnjv5t425fcpl4rgf9mq2txdxuga7jfq5shk7np6l55nj00sl3m4syzna3uwgrwppdm0azgy9d8zahyf32s62klfyhe0ayyxkc7x92nv4s77fa0v25tufk9tnv7x6dgexe9kdz5gpeqgu",
+      },
+    });
+
+    const paymentAddress = wallet.getPaymentAddress();
+    expect(paymentAddress).toEqual(
+      "addr_test1qpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0uafhxhu32dys6pvn6wlw8dav6cmp4pmtv7cc3yel9uu0nq93swx9",
+    );
+    const enterpriseAddress = wallet.getEnterpriseAddress();
+    expect(enterpriseAddress).toEqual(
+      "addr_test1vpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0c7e4cxr",
+    );
+    const rewardAddress = wallet.getRewardAddress();
+    expect(rewardAddress).toEqual(
+      "stake_test1uzw5mnt7g4xjgdqkfa80hrk7kdvds6sa4k0vvgjvlj7w8eskffj2n",
+    );
+  });
+
+  it("cli keys", () => {
+    const wallet = new AppWallet({
+      networkId: 0,
+      key: {
+        type: "cli",
+        payment:
+          "5820f083e5878c6f980c53d30b9cc2baadd780307b08acec9e0792892e013bbe9241",
+        stake:
+          "5820b810d6398db44f380a9ab279f63950c4b95432f44fafb5a6f026afe23bbe9241",
+      },
+    });
+
+    const paymentAddress = wallet.getPaymentAddress();
+    expect(paymentAddress).toEqual(
+      "addr_test1qqdy60gf798xrl20wwvapvsxj3kr8yz8ac6zfmgwg6c5g9p3x07mt562mneg8jxgj03p2uvmhyfyvktjn259mws8e6wq3cdn8p",
+    );
+    const enterpriseAddress = wallet.getEnterpriseAddress();
+    expect(enterpriseAddress).toEqual(
+      "addr_test1vqdy60gf798xrl20wwvapvsxj3kr8yz8ac6zfmgwg6c5g9qh602xh",
+    );
+    const rewardAddress = wallet.getRewardAddress();
+    expect(rewardAddress).toEqual(
+      "stake_test1uqcn8ld46d9deu5reryf8cs4wxdmjyjxt9ef42zahgrua8qctnd74",
+    );
+  });
+
+  it("correct payment address", () => {
+    const paymentAddress = wallet.getPaymentAddress();
+    expect(paymentAddress).toEqual(
+      "addr_test1qpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0uafhxhu32dys6pvn6wlw8dav6cmp4pmtv7cc3yel9uu0nq93swx9",
+    );
+  });
+
+  it("correct enterprise address", () => {
+    const enterpriseAddress = wallet.getEnterpriseAddress();
+    expect(enterpriseAddress).toEqual(
+      "addr_test1vpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0c7e4cxr",
+    );
+  });
+
+  it("correct reward address", () => {
+    const rewardAddress = wallet.getRewardAddress();
+    expect(rewardAddress).toEqual(
+      "stake_test1uzw5mnt7g4xjgdqkfa80hrk7kdvds6sa4k0vvgjvlj7w8eskffj2n",
+    );
+  });
+
+  it("correct used addresses", () => {
+    const paymentAddress = wallet.getUsedAddress();
+    expect(paymentAddress.toBech32()).toEqual(
+      "addr_test1qpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0uafhxhu32dys6pvn6wlw8dav6cmp4pmtv7cc3yel9uu0nq93swx9",
+    );
+    const enterpriseAddress = wallet.getUsedAddress(0, 0, "enterprise");
+    expect(enterpriseAddress.toBech32()).toEqual(
+      "addr_test1vpvx0sacufuypa2k4sngk7q40zc5c4npl337uusdh64kv0c7e4cxr",
+    );
+  });
+});

package/test/browser.test.ts

@@ -0,0 +1,21 @@
+import { CardanoSDKUtil, Serialization } from "@meshsdk/core-cst";
+
+import { WalletStaticMethods } from "../src";
+
+describe("BroswerWallet", () => {
+  it("signTx: addWitnessSet", () => {
+    const unsignedTx =
+      "84a4008282582023925df9067578d15e766d5e7aacf3f1af5b0eb5a90abd9c9281e4881338317e01825820c9b837816abbdcd28ba3905752b24054ca0d8f5b510d15567041e96bb18b2a29000182825839005867c3b8e27840f556ac268b781578b14c5661fc63ee720dbeab663f9d4dcd7e454d2434164f4efb8edeb358d86a1dad9ec6224cfcbce3e61a0016e360825839001e4eb194e3335a0dcc4f5c5d009318167c583bb3b0879d9f718cd9e0d63a93470bd4d8bb986c02ff8a6043796b91cc397ceb29058f5c9ac01a4387095e021a0002a98d0d83825820423351f26b28a089171fb9a6cfb824de99524972c59958533beba877af74503c01825820d06a742f2b8fe2bad4c38e2db9e9dfe924235d2d0b894d207b251f9cfc93e85103825820ec0c2e70b898cf531b03c9db937602e98c45378d9fa8e8a5b5a91ec5c1d7540d05a0f5f6";
+    const witness =
+      "a10081825820cb845bb836d4baf4edffb9f76198072cbc70f0d8bb5402644ffd4db17e65259f58403c82976d080de380506a8fd78afc5e8a0ab4367916c943f368b8541e8aca8cbe4d98e4106a7da065918a676849c00201aed154cda38348220960aba80bb5190a";
+    const cWitness = Serialization.TransactionWitnessSet.fromCbor(
+      CardanoSDKUtil.HexBlob(witness),
+    );
+    const signedTx = WalletStaticMethods.addWitnessSets(unsignedTx, [
+      ...cWitness.vkeys()?.values()!,
+    ]);
+    expect(signedTx).toEqual(
+      "84a4008282582023925df9067578d15e766d5e7aacf3f1af5b0eb5a90abd9c9281e4881338317e01825820c9b837816abbdcd28ba3905752b24054ca0d8f5b510d15567041e96bb18b2a29000182825839005867c3b8e27840f556ac268b781578b14c5661fc63ee720dbeab663f9d4dcd7e454d2434164f4efb8edeb358d86a1dad9ec6224cfcbce3e61a0016e360825839001e4eb194e3335a0dcc4f5c5d009318167c583bb3b0879d9f718cd9e0d63a93470bd4d8bb986c02ff8a6043796b91cc397ceb29058f5c9ac01a4387095e021a0002a98d0d83825820423351f26b28a089171fb9a6cfb824de99524972c59958533beba877af74503c01825820d06a742f2b8fe2bad4c38e2db9e9dfe924235d2d0b894d207b251f9cfc93e85103825820ec0c2e70b898cf531b03c9db937602e98c45378d9fa8e8a5b5a91ec5c1d7540d05a10081825820cb845bb836d4baf4edffb9f76198072cbc70f0d8bb5402644ffd4db17e65259f58403c82976d080de380506a8fd78afc5e8a0ab4367916c943f368b8541e8aca8cbe4d98e4106a7da065918a676849c00201aed154cda38348220960aba80bb5190af5f6",
+    );
+  });
+});