@meshsdk/wallet 1.5.30 → 1.6.0-alpha.20

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshsdk/wallet",
-  "version": "1.5.30",
+  "version": "1.6.0-alpha.20",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -11,11 +11,8 @@
       "require": "./dist/index.js"
     }
   },
-  "files": [
-    "dist/**"
-  ],
   "scripts": {
-    "build:mesh": "tsup src/index.ts --format esm,cjs --dts --minify",
+    "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",
@@ -35,8 +32,5 @@
     "@meshsdk/core-cst": "*",
     "@meshsdk/transaction": "*"
   },
-  "prettier": "@meshsdk/prettier-config",
-  "publishConfig": {
-    "access": "public"
-  }
+  "prettier": "@meshsdk/prettier-config"
 }

package/src/app/index.ts

@@ -0,0 +1,239 @@
+import { DataSignature, IFetcher, ISigner, ISubmitter } from "@meshsdk/common";
+import {
+  Address,
+  deserializeTx,
+  toAddress,
+  toTxUnspentOutput,
+  TransactionUnspentOutput,
+} from "@meshsdk/core-cst";
+
+import { EmbeddedWallet } from "../embedded";
+import { GetAddressType } from "../types";
+
+export type AppWalletKeyType =
+  | {
+      type: "root";
+      bech32: string;
+    }
+  | {
+      type: "cli";
+      payment: string;
+      stake?: string;
+    }
+  | {
+      type: "mnemonic";
+      words: string[];
+    };
+
+export type CreateAppWalletOptions = {
+  networkId: number;
+  fetcher?: IFetcher;
+  submitter?: ISubmitter;
+  key: AppWalletKeyType;
+};
+
+export class AppWallet implements ISigner, ISubmitter {
+  private readonly _fetcher?: IFetcher;
+  private readonly _submitter?: ISubmitter;
+  private readonly _wallet: EmbeddedWallet;
+
+  constructor(options: CreateAppWalletOptions) {
+    this._fetcher = options.fetcher;
+    this._submitter = options.submitter;
+
+    switch (options.key.type) {
+      case "mnemonic":
+        this._wallet = new EmbeddedWallet({
+          networkId: options.networkId,
+          key: {
+            type: "mnemonic",
+            words: options.key.words,
+          },
+        });
+        break;
+      case "root":
+        this._wallet = new EmbeddedWallet({
+          networkId: options.networkId,
+          key: {
+            type: "root",
+            bech32: options.key.bech32,
+          },
+        });
+        break;
+      case "cli":
+        this._wallet = new EmbeddedWallet({
+          networkId: options.networkId,
+          key: {
+            type: "cli",
+            payment: options.key.payment,
+            stake: options.key.stake,
+          },
+        });
+    }
+  }
+
+  /**
+   * 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 getCollateralUnspentOutput(
+    accountIndex = 0,
+    addressType: GetAddressType = "payment",
+  ): Promise<TransactionUnspentOutput[]> {
+    const utxos = await this.getUnspentOutputs(accountIndex, addressType);
+
+    // find utxos that are pure ADA-only
+    const pureAdaUtxos = utxos.filter((utxo) => {
+      return utxo.output().amount().multiasset() === undefined;
+    });
+
+    // sort utxos by their lovelace amount
+    pureAdaUtxos.sort((a, b) => {
+      return (
+        Number(a.output().amount().coin()) - Number(b.output().amount().coin())
+      );
+    });
+
+    // return the smallest utxo but not less than 5000000 lovelace
+    for (const utxo of pureAdaUtxos) {
+      if (Number(utxo.output().amount().coin()) >= 5000000) {
+        return [utxo];
+      }
+    }
+
+    return [];
+  }
+
+  getEnterpriseAddress(accountIndex = 0, keyIndex = 0): string {
+    const account = this._wallet.getAccount(accountIndex, keyIndex);
+    return account.enterpriseAddressBech32;
+  }
+
+  getPaymentAddress(accountIndex = 0, keyIndex = 0): string {
+    const account = this._wallet.getAccount(accountIndex, keyIndex);
+    return account.baseAddressBech32;
+  }
+
+  getRewardAddress(accountIndex = 0, keyIndex = 0): string {
+    const account = this._wallet.getAccount(accountIndex, keyIndex);
+    return account.rewardAddressBech32;
+  }
+
+  getNetworkId(): number {
+    return this._wallet.getNetworkId();
+  }
+
+  getUsedAddress(
+    accountIndex = 0,
+    keyIndex = 0,
+    addressType: GetAddressType = "payment",
+  ): Address {
+    if (addressType === "enterprise") {
+      return toAddress(this.getEnterpriseAddress(accountIndex, keyIndex));
+    } else {
+      return toAddress(this.getPaymentAddress(accountIndex, keyIndex));
+    }
+  }
+
+  async getUnspentOutputs(
+    accountIndex = 0,
+    addressType: GetAddressType = "payment",
+  ): Promise<TransactionUnspentOutput[]> {
+    if (!this._fetcher) {
+      throw new Error(
+        "[AppWallet] Fetcher is required to fetch UTxOs. Please provide a fetcher.",
+      );
+    }
+    const account = this._wallet.getAccount(accountIndex);
+
+    const utxos = await this._fetcher.fetchAddressUTxOs(
+      addressType == "enterprise"
+        ? account.enterpriseAddressBech32
+        : account.baseAddressBech32,
+    );
+
+    return utxos.map((utxo) => toTxUnspentOutput(utxo));
+  }
+
+  signData(
+    address: string,
+    payload: string,
+    accountIndex = 0,
+    keyIndex = 0,
+  ): DataSignature {
+    try {
+      return this._wallet.signData(address, payload, accountIndex, keyIndex);
+    } catch (error) {
+      throw new Error(
+        `[AppWallet] An error occurred during signData: ${error}.`,
+      );
+    }
+  }
+
+  signTx(
+    unsignedTx: string,
+    partialSign = false,
+    accountIndex = 0,
+    keyIndex = 0,
+  ): string {
+    try {
+      const tx = deserializeTx(unsignedTx);
+      if (
+        !partialSign &&
+        tx.witnessSet().vkeys() !== undefined &&
+        tx.witnessSet().vkeys()!.size() !== 0
+      )
+        throw new Error(
+          "Signatures already exist in the transaction in a non partial sign call",
+        );
+
+      const newSignatures = this._wallet.signTx(
+        unsignedTx,
+        accountIndex,
+        keyIndex,
+      );
+
+      let signedTx = EmbeddedWallet.addWitnessSets(unsignedTx, [newSignatures]);
+      return signedTx;
+    } catch (error) {
+      throw new Error(`[AppWallet] An error occurred during signTx: ${error}.`);
+    }
+  }
+
+  signTxSync(
+    unsignedTx: string,
+    partialSign = false,
+    accountIndex = 0,
+    keyIndex = 0,
+  ): string {
+    try {
+      // todo
+      return "signedTx";
+    } catch (error) {
+      throw new Error(`[AppWallet] An error occurred during signTx: ${error}.`);
+    }
+  }
+
+  async signTxs(
+    unsignedTxs: string[],
+    partialSign: boolean,
+  ): Promise<string[]> {
+    throw new Error(`[AppWallet] signTxs() is not implemented.`);
+  }
+
+  submitTx(tx: string): Promise<string> {
+    if (!this._submitter) {
+      throw new Error(
+        "[AppWallet] Submitter is required to submit transactions. Please provide a submitter.",
+      );
+    }
+    return this._submitter.submitTx(tx);
+  }
+
+  static brew(strength = 256): string[] {
+    return EmbeddedWallet.generateMnemonic(strength);
+  }
+}

package/src/browser/index.ts

@@ -0,0 +1,440 @@
+import {
+  Asset,
+  AssetExtended,
+  DataSignature,
+  DEFAULT_PROTOCOL_PARAMETERS,
+  fromUTF8,
+  IInitiator,
+  ISigner,
+  ISubmitter,
+  POLICY_ID_LENGTH,
+  resolveFingerprint,
+  UTxO,
+  Wallet,
+} from "@meshsdk/common";
+import {
+  Address,
+  addressToBech32,
+  CardanoSDKUtil,
+  deserializeAddress,
+  deserializeTx,
+  deserializeTxUnspentOutput,
+  deserializeValue,
+  fromTxUnspentOutput,
+  fromValue,
+  Serialization,
+  toAddress,
+  Transaction,
+  TransactionUnspentOutput,
+  VkeyWitness,
+} from "@meshsdk/core-cst";
+
+import { Cardano, WalletInstance } from "../types";
+
+declare global {
+  interface Window {
+    cardano: Cardano;
+  }
+}
+
+export class BrowserWallet implements IInitiator, ISigner, ISubmitter {
+  walletInstance: WalletInstance;
+
+  private constructor(
+    readonly _walletInstance: WalletInstance,
+    readonly _walletName: string,
+  ) {
+    this.walletInstance = { ..._walletInstance };
+  }
+
+  /**
+   * 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[] {
+    if (window === undefined) return [];
+    if (window.cardano === undefined) return [];
+
+    let wallets: Wallet[] = [];
+    for (const key in window.cardano) {
+      try {
+        const _wallet = window.cardano[key];
+        if (_wallet === undefined) continue;
+        if (_wallet.name === undefined) continue;
+        if (_wallet.icon === undefined) continue;
+        if (_wallet.apiVersion === undefined) continue;
+        wallets.push({
+          id: key,
+          name: _wallet.name,
+          icon: _wallet.icon,
+          version: _wallet.apiVersion,
+        });
+      } catch (e) {}
+    }
+
+    return wallets;
+  }
+
+  /**
+   * 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 async enable(walletName: string): Promise<BrowserWallet> {
+    try {
+      const walletInstance = await BrowserWallet.resolveInstance(walletName);
+
+      if (walletInstance !== undefined)
+        return new BrowserWallet(walletInstance, walletName);
+
+      throw new Error(`Couldn't create an instance of wallet: ${walletName}`);
+    } catch (error) {
+      throw new Error(
+        `[BrowserWallet] An error occurred during enable: ${JSON.stringify(
+          error,
+        )}.`,
+      );
+    }
+  }
+
+  /**
+   * Retrieves the total available balance of the wallet, encoded in CBOR.
+   * @returns {Promise<Value>} - The balance of the wallet.
+   */
+  // async _getBalance(): Promise<Value> {
+  //   const balance = await this._walletInstance.getBalance();
+  //   return Value.fromCbor(HexBlob(balance));
+  // }
+
+  /**
+   * 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 balance = await this._walletInstance.getBalance();
+    return fromValue(deserializeValue(balance));
+  }
+
+  /**
+   * 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
+   */
+  async getChangeAddress(): Promise<string> {
+    const changeAddress = await this._walletInstance.getChangeAddress();
+    return addressToBech32(deserializeAddress(changeAddress));
+  }
+
+  /**
+   * 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
+   */
+  async getCollateral(): Promise<UTxO[]> {
+    const deserializedCollateral = await this.getCollateralUnspentOutput();
+    return deserializedCollateral.map((dc) => fromTxUnspentOutput(dc));
+  }
+
+  /**
+   * 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> {
+    return this._walletInstance.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
+   */
+  async getRewardAddresses(): Promise<string[]> {
+    const rewardAddresses = await this._walletInstance.getRewardAddresses();
+    return rewardAddresses.map((ra) => addressToBech32(deserializeAddress(ra)));
+  }
+
+  /**
+   * Returns a list of unused addresses controlled by the wallet.
+   *
+   * @returns a list of unused addresses
+   */
+  async getUnusedAddresses(): Promise<string[]> {
+    const unusedAddresses = await this._walletInstance.getUnusedAddresses();
+    return unusedAddresses.map((una) =>
+      addressToBech32(deserializeAddress(una)),
+    );
+  }
+
+  /**
+   * Returns a list of used addresses controlled by the wallet.
+   *
+   * @returns a list of used addresses
+   */
+  async getUsedAddresses(): Promise<string[]> {
+    const usedAddresses = await this._walletInstance.getUsedAddresses();
+    return usedAddresses.map((usa) => addressToBech32(deserializeAddress(usa)));
+  }
+
+  /**
+   * 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(
+    limit = DEFAULT_PROTOCOL_PARAMETERS.maxCollateralInputs,
+  ): Promise<TransactionUnspentOutput[]> {
+    const collateral =
+      (await this._walletInstance.experimental.getCollateral()) ?? [];
+    return collateral.map((c) => deserializeTxUnspentOutput(c)).slice(0, limit);
+  }
+
+  /**
+   * Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet.
+   *
+   * @returns a list of UTXOs
+   */
+  async getUtxos(): Promise<UTxO[]> {
+    const deserializedUTxOs = await this.getUsedUTxOs();
+    return deserializedUTxOs.map((du) => fromTxUnspentOutput(du));
+  }
+
+  /**
+   * 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> {
+    const signerAddress = toAddress(address).toBytes().toString();
+    return this._walletInstance.signData(signerAddress, fromUTF8(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
+   */
+  async signTx(unsignedTx: string, partialSign = false): Promise<string> {
+    const witness = await this._walletInstance.signTx(unsignedTx, partialSign);
+    console.log("witness", witness);
+
+    return BrowserWallet.addBrowserWitnesses(unsignedTx, witness);
+  }
+
+  /**
+   * 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
+   */
+  async signTxs(unsignedTxs: string[], partialSign = false): Promise<string[]> {
+    let witnessSets: string[] | undefined = undefined;
+    // Hardcoded behavior customized for different wallet for now as there is no standard confirmed
+    switch (this._walletName) {
+      case "Typhon Wallet":
+        if (this._walletInstance.signTxs) {
+          witnessSets = await this._walletInstance.signTxs(
+            unsignedTxs,
+            partialSign,
+          );
+        }
+        break;
+      default:
+        if (this._walletInstance.signTxs) {
+          witnessSets = await this._walletInstance.signTxs(
+            unsignedTxs.map((cbor) => ({
+              cbor,
+              partialSign,
+            })),
+          );
+        } else if (this._walletInstance.experimental.signTxs) {
+          witnessSets = await this._walletInstance.experimental.signTxs(
+            unsignedTxs.map((cbor) => ({
+              cbor,
+              partialSign,
+            })),
+          );
+        }
+        break;
+    }
+
+    if (!witnessSets) throw new Error("Wallet does not support signTxs");
+
+    const signedTxs: string[] = [];
+    for (let i = 0; i < witnessSets.length; i++) {
+      const unsignedTx = unsignedTxs[i]!;
+      const cWitness = witnessSets[i]!;
+      const signedTx = BrowserWallet.addBrowserWitnesses(unsignedTx, cWitness);
+      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
+   */
+  submitTx(tx: string): Promise<string> {
+    return this._walletInstance.submitTx(tx);
+  }
+
+  /**
+   * Get a used address of type Address from the wallet.
+   *
+   * This is used in transaction building.
+   *
+   * @returns an Address object
+   */
+  async getUsedAddress(): Promise<Address> {
+    const usedAddresses = await this._walletInstance.getUsedAddresses();
+    if (usedAddresses.length === 0) throw new Error("No used addresses found");
+    return deserializeAddress(usedAddresses[0]!);
+  }
+
+  /**
+   * 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 getCollateralUnspentOutput(): Promise<TransactionUnspentOutput[]> {
+    const collateral =
+      (await this._walletInstance.experimental.getCollateral()) ?? [];
+    return collateral.map((c) => deserializeTxUnspentOutput(c));
+  }
+
+  /**
+   * Get a list of UTXOs to be used for transaction building.
+   *
+   * This is used in transaction building.
+   *
+   * @returns a list of UTXOs
+   */
+  async getUsedUTxOs(): Promise<TransactionUnspentOutput[]> {
+    const utxos = (await this._walletInstance.getUtxos()) ?? [];
+    return utxos.map((u) => deserializeTxUnspentOutput(u));
+  }
+
+  /**
+   * 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,
+          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");
+  }
+
+  private static resolveInstance(walletName: string) {
+    if (window.cardano === undefined) return undefined;
+    if (window.cardano[walletName] === undefined) return undefined;
+
+    const wallet = window.cardano[walletName];
+    return wallet?.enable();
+  }
+
+  static addBrowserWitnesses(unsignedTx: string, witnesses: string) {
+    const cWitness = Serialization.TransactionWitnessSet.fromCbor(
+      CardanoSDKUtil.HexBlob(witnesses),
+    )
+      .vkeys()
+      ?.values();
+
+    if (cWitness === undefined) {
+      return unsignedTx;
+    }
+
+    let tx = deserializeTx(unsignedTx);
+    // let tx = Transaction.fromCbor(CardanoSDK.TxCBOR(txHex));
+    let witnessSet = tx.witnessSet();
+    let witnessSetVkeys = witnessSet.vkeys();
+    let witnessSetVkeysValues: Serialization.VkeyWitness[] = witnessSetVkeys
+      ? [...witnessSetVkeys.values(), ...cWitness]
+      : [...cWitness];
+    witnessSet.setVkeys(
+      Serialization.CborSet.fromCore(
+        witnessSetVkeysValues.map((vkw) => vkw.toCore()),
+        VkeyWitness.fromCore,
+      ),
+    );
+
+    return new Transaction(tx.body(), witnessSet, tx.auxiliaryData()).toCbor();
+  }
+}