@meshsdk/wallet 1.8.8 → 1.8.10

package/dist/index.cjs

@@ -711,9 +711,22 @@ var EmbeddedWallet = class extends WalletStaticMethods {
     }
     return _account;
   }
+  /**
+   * Get wallet network ID.
+   *
+   * @returns network ID
+   */
   getNetworkId() {
     return this._networkId;
   }
+  /**
+   * This endpoint utilizes the [CIP-8 - Message Signing](https://cips.cardano.org/cips/cip8/) to sign arbitrary data, to verify the data was signed by the owner of the private key.
+   *
+   * @param address - bech32 address to sign the data with
+   * @param payload - the data to be signed
+   * @param accountIndex account index (default: 0)
+   * @returns a signature
+   */
   signData(address, payload, accountIndex = 0, keyIndex = 0) {
     try {
       const { baseAddress, enterpriseAddress, rewardAddress, paymentKey } = this.getAccount(accountIndex, keyIndex);
@@ -734,6 +747,14 @@ var EmbeddedWallet = class extends WalletStaticMethods {
       );
     }
   }
+  /**
+   * This endpoints sign the provided transaction (unsignedTx) with the private key of the owner.
+   *
+   * @param unsignedTx - a transaction in CBOR
+   * @param accountIndex account index (default: 0)
+   * @param keyIndex key index (default: 0)
+   * @returns VkeyWitness
+   */
   signTx(unsignedTx, accountIndex = 0, keyIndex = 0) {
     try {
       const txHash = (0, import_core_cst.deserializeTxHash)((0, import_core_cst.resolveTxHash)(unsignedTx));
@@ -847,7 +868,7 @@ var AppWallet = class {
     );
     return utxos.map((utxo) => (0, import_core_cst2.toTxUnspentOutput)(utxo));
   }
-  signData(address, payload, accountIndex = 0, keyIndex = 0) {
+  async signData(address, payload, accountIndex = 0, keyIndex = 0) {
     try {
       return this._wallet.signData(address, payload, accountIndex, keyIndex);
     } catch (error) {
@@ -856,7 +877,7 @@ var AppWallet = class {
       );
     }
   }
-  signTx(unsignedTx, partialSign = false, accountIndex = 0, keyIndex = 0) {
+  async signTx(unsignedTx, partialSign = false, accountIndex = 0, keyIndex = 0) {
     try {
       const tx = (0, import_core_cst2.deserializeTx)(unsignedTx);
       if (!partialSign && tx.witnessSet().vkeys() !== void 0 && tx.witnessSet().vkeys().size() !== 0)
@@ -1428,7 +1449,7 @@ async function login({
   serverUrl,
   username
 }) {
-  const initAuthRes = await fetch(`${serverUrl}/init-auth`, {
+  const initAuthRes = await fetch(`${serverUrl}/auth-init`, {
     credentials: "include",
     method: "POST",
     headers: {
@@ -1446,9 +1467,9 @@ async function login({
       errorCode: initAuth.errorCode
     };
   }
-  const optionsJSON = initAuth.optionsJSON;
+  const optionsJSON = initAuth.data.optionsJSON;
   const authJSON = await (0, import_browser.startAuthentication)({ optionsJSON });
-  const verifyAuthRes = await fetch(`${serverUrl}/verify-auth`, {
+  const verifyAuthRes = await fetch(`${serverUrl}/auth-verify`, {
     credentials: "include",
     method: "POST",
     headers: {
@@ -1460,7 +1481,7 @@ async function login({
   if (!verifyAuthRes.ok) {
     return { success: false, error: verifyAuth.error };
   }
-  if (verifyAuth.verified) {
+  if (verifyAuth.data.verified) {
     return { success: true, authJSON };
   } else {
     return { success: false, error: "Failed to log in" };
@@ -1473,7 +1494,7 @@ async function register({
   serverUrl,
   username
 }) {
-  const initRegisterRes = await fetch(`${serverUrl}/init-register`, {
+  const initRegisterRes = await fetch(`${serverUrl}/register-init`, {
     credentials: "include",
     method: "POST",
     headers: {
@@ -1491,9 +1512,9 @@ async function register({
       errorCode: initRegister.errorCode
     };
   }
-  const optionsJSON = initRegister.optionsJSON;
+  const optionsJSON = initRegister.data.optionsJSON;
   const registrationJSON = await (0, import_browser2.startRegistration)({ optionsJSON });
-  const verifyResponse = await fetch(`${serverUrl}/verify-register`, {
+  const verifyResponse = await fetch(`${serverUrl}/register-verify`, {
     credentials: "include",
     method: "POST",
     headers: {
@@ -1510,7 +1531,7 @@ async function register({
       errorCode: verifyData.errorCode
     };
   }
-  if (verifyData.verified) {
+  if (verifyData.data.verified) {
     console.log(`Successfully registered ${username}`);
     return { success: true };
   } else {
@@ -1526,7 +1547,7 @@ async function connect({
   serverUrl
 }) {
   const responseRegister = await register({ serverUrl, username });
-  if (responseRegister.success || responseRegister.errorCode == ERRORCODES.USEREXISTS) {
+  if (responseRegister.success || responseRegister.error.errorCode == ERRORCODES.USEREXISTS) {
     const loginRes = await handleLogin({ serverUrl, username });
     if (loginRes.success && loginRes.authJSON) {
       const wallet = await buildWalletFromPasskey(
@@ -1779,7 +1800,7 @@ var MeshWallet = class {
    * @param address - the address to use for signing (optional)
    * @returns a signature
    */
-  signData(payload, address) {
+  async signData(payload, address) {
     if (!this._wallet) {
       throw new Error(
         "[MeshWallet] Read only wallet does not support signing data."
@@ -1802,7 +1823,7 @@ var MeshWallet = class {
    * @param partialSign - if the transaction is partially signed (default: false)
    * @returns a signed transaction in CBOR
    */
-  signTx(unsignedTx, partialSign = false) {
+  async signTx(unsignedTx, partialSign = false) {
     if (!this._wallet) {
       throw new Error(
         "[MeshWallet] Read only wallet does not support signing data."
@@ -1828,7 +1849,7 @@ var MeshWallet = class {
    * @param partialSign - if the transactions are signed partially
    * @returns array of signed transactions CborHex string
    */
-  signTxs(unsignedTxs, partialSign = false) {
+  async signTxs(unsignedTxs, partialSign = false) {
     if (!this._wallet) {
       throw new Error(
         "[MeshWallet] Read only wallet does not support signing data."
@@ -1836,7 +1857,7 @@ var MeshWallet = class {
     }
     const signedTxs = [];
     for (const unsignedTx of unsignedTxs) {
-      const signedTx = this.signTx(unsignedTx, partialSign);
+      const signedTx = await this.signTx(unsignedTx, partialSign);
       signedTxs.push(signedTx);
     }
     return signedTxs;

package/dist/index.d.cts

@@ -91,8 +91,8 @@ declare class AppWallet implements ISigner, ISubmitter {
     getNetworkId(): number;
     getUsedAddress(accountIndex?: number, keyIndex?: number, addressType?: GetAddressType): Address;
     getUnspentOutputs(accountIndex?: number, addressType?: GetAddressType): Promise<TransactionUnspentOutput[]>;
-    signData(address: string, payload: string, accountIndex?: number, keyIndex?: number): DataSignature;
-    signTx(unsignedTx: string, partialSign?: boolean, accountIndex?: number, keyIndex?: number): string;
+    signData(address: string, payload: string, accountIndex?: number, keyIndex?: number): Promise<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>;
@@ -433,8 +433,29 @@ declare class EmbeddedWallet extends WalletStaticMethods {
     private readonly _networkId;
     constructor(options: CreateEmbeddedWalletOptions);
     getAccount(accountIndex?: number, keyIndex?: number): Account;
+    /**
+     * Get wallet network ID.
+     *
+     * @returns network ID
+     */
     getNetworkId(): number;
+    /**
+     * This endpoint utilizes the [CIP-8 - Message Signing](https://cips.cardano.org/cips/cip8/) to sign arbitrary data, to verify the data was signed by the owner of the private key.
+     *
+     * @param address - bech32 address to sign the data with
+     * @param payload - the data to be signed
+     * @param accountIndex account index (default: 0)
+     * @returns a signature
+     */
     signData(address: string, payload: string, accountIndex?: number, keyIndex?: number): DataSignature;
+    /**
+     * This endpoints sign the provided transaction (unsignedTx) with the private key of the owner.
+     *
+     * @param unsignedTx - a transaction in CBOR
+     * @param accountIndex account index (default: 0)
+     * @param keyIndex key index (default: 0)
+     * @returns VkeyWitness
+     */
     signTx(unsignedTx: string, accountIndex?: number, keyIndex?: number): VkeyWitness;
 }
 
@@ -617,7 +638,7 @@ declare class MeshWallet implements IWallet {
      * @param address - the address to use for signing (optional)
      * @returns a signature
      */
-    signData(payload: string, address?: string): DataSignature;
+    signData(payload: string, address?: 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.
      *
@@ -625,7 +646,7 @@ declare class MeshWallet implements IWallet {
      * @param partialSign - if the transaction is partially signed (default: false)
      * @returns a signed transaction in CBOR
      */
-    signTx(unsignedTx: string, partialSign?: boolean): string;
+    signTx(unsignedTx: string, partialSign?: boolean): Promise<string>;
     /**
      * Experimental feature - sign multiple transactions at once.
      *
@@ -633,7 +654,7 @@ declare class MeshWallet implements IWallet {
      * @param partialSign - if the transactions are signed partially
      * @returns array of signed transactions CborHex string
      */
-    signTxs(unsignedTxs: string[], partialSign?: boolean): string[];
+    signTxs(unsignedTxs: string[], partialSign?: boolean): Promise<string[]>;
     /**
      * Submits the signed transaction to the blockchain network.
      *

package/dist/index.d.ts

@@ -91,8 +91,8 @@ declare class AppWallet implements ISigner, ISubmitter {
     getNetworkId(): number;
     getUsedAddress(accountIndex?: number, keyIndex?: number, addressType?: GetAddressType): Address;
     getUnspentOutputs(accountIndex?: number, addressType?: GetAddressType): Promise<TransactionUnspentOutput[]>;
-    signData(address: string, payload: string, accountIndex?: number, keyIndex?: number): DataSignature;
-    signTx(unsignedTx: string, partialSign?: boolean, accountIndex?: number, keyIndex?: number): string;
+    signData(address: string, payload: string, accountIndex?: number, keyIndex?: number): Promise<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>;
@@ -433,8 +433,29 @@ declare class EmbeddedWallet extends WalletStaticMethods {
     private readonly _networkId;
     constructor(options: CreateEmbeddedWalletOptions);
     getAccount(accountIndex?: number, keyIndex?: number): Account;
+    /**
+     * Get wallet network ID.
+     *
+     * @returns network ID
+     */
     getNetworkId(): number;
+    /**
+     * This endpoint utilizes the [CIP-8 - Message Signing](https://cips.cardano.org/cips/cip8/) to sign arbitrary data, to verify the data was signed by the owner of the private key.
+     *
+     * @param address - bech32 address to sign the data with
+     * @param payload - the data to be signed
+     * @param accountIndex account index (default: 0)
+     * @returns a signature
+     */
     signData(address: string, payload: string, accountIndex?: number, keyIndex?: number): DataSignature;
+    /**
+     * This endpoints sign the provided transaction (unsignedTx) with the private key of the owner.
+     *
+     * @param unsignedTx - a transaction in CBOR
+     * @param accountIndex account index (default: 0)
+     * @param keyIndex key index (default: 0)
+     * @returns VkeyWitness
+     */
     signTx(unsignedTx: string, accountIndex?: number, keyIndex?: number): VkeyWitness;
 }
 
@@ -617,7 +638,7 @@ declare class MeshWallet implements IWallet {
      * @param address - the address to use for signing (optional)
      * @returns a signature
      */
-    signData(payload: string, address?: string): DataSignature;
+    signData(payload: string, address?: 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.
      *
@@ -625,7 +646,7 @@ declare class MeshWallet implements IWallet {
      * @param partialSign - if the transaction is partially signed (default: false)
      * @returns a signed transaction in CBOR
      */
-    signTx(unsignedTx: string, partialSign?: boolean): string;
+    signTx(unsignedTx: string, partialSign?: boolean): Promise<string>;
     /**
      * Experimental feature - sign multiple transactions at once.
      *
@@ -633,7 +654,7 @@ declare class MeshWallet implements IWallet {
      * @param partialSign - if the transactions are signed partially
      * @returns array of signed transactions CborHex string
      */
-    signTxs(unsignedTxs: string[], partialSign?: boolean): string[];
+    signTxs(unsignedTxs: string[], partialSign?: boolean): Promise<string[]>;
     /**
      * Submits the signed transaction to the blockchain network.
      *

package/dist/index.js

@@ -720,9 +720,22 @@ var EmbeddedWallet = class extends WalletStaticMethods {
     }
     return _account;
   }
+  /**
+   * Get wallet network ID.
+   *
+   * @returns network ID
+   */
   getNetworkId() {
     return this._networkId;
   }
+  /**
+   * This endpoint utilizes the [CIP-8 - Message Signing](https://cips.cardano.org/cips/cip8/) to sign arbitrary data, to verify the data was signed by the owner of the private key.
+   *
+   * @param address - bech32 address to sign the data with
+   * @param payload - the data to be signed
+   * @param accountIndex account index (default: 0)
+   * @returns a signature
+   */
   signData(address, payload, accountIndex = 0, keyIndex = 0) {
     try {
       const { baseAddress, enterpriseAddress, rewardAddress, paymentKey } = this.getAccount(accountIndex, keyIndex);
@@ -743,6 +756,14 @@ var EmbeddedWallet = class extends WalletStaticMethods {
       );
     }
   }
+  /**
+   * This endpoints sign the provided transaction (unsignedTx) with the private key of the owner.
+   *
+   * @param unsignedTx - a transaction in CBOR
+   * @param accountIndex account index (default: 0)
+   * @param keyIndex key index (default: 0)
+   * @returns VkeyWitness
+   */
   signTx(unsignedTx, accountIndex = 0, keyIndex = 0) {
     try {
       const txHash = deserializeTxHash(resolveTxHash(unsignedTx));
@@ -856,7 +877,7 @@ var AppWallet = class {
     );
     return utxos.map((utxo) => toTxUnspentOutput(utxo));
   }
-  signData(address, payload, accountIndex = 0, keyIndex = 0) {
+  async signData(address, payload, accountIndex = 0, keyIndex = 0) {
     try {
       return this._wallet.signData(address, payload, accountIndex, keyIndex);
     } catch (error) {
@@ -865,7 +886,7 @@ var AppWallet = class {
       );
     }
   }
-  signTx(unsignedTx, partialSign = false, accountIndex = 0, keyIndex = 0) {
+  async signTx(unsignedTx, partialSign = false, accountIndex = 0, keyIndex = 0) {
     try {
       const tx = deserializeTx2(unsignedTx);
       if (!partialSign && tx.witnessSet().vkeys() !== void 0 && tx.witnessSet().vkeys().size() !== 0)
@@ -1457,7 +1478,7 @@ async function login({
   serverUrl,
   username
 }) {
-  const initAuthRes = await fetch(`${serverUrl}/init-auth`, {
+  const initAuthRes = await fetch(`${serverUrl}/auth-init`, {
     credentials: "include",
     method: "POST",
     headers: {
@@ -1475,9 +1496,9 @@ async function login({
       errorCode: initAuth.errorCode
     };
   }
-  const optionsJSON = initAuth.optionsJSON;
+  const optionsJSON = initAuth.data.optionsJSON;
   const authJSON = await startAuthentication({ optionsJSON });
-  const verifyAuthRes = await fetch(`${serverUrl}/verify-auth`, {
+  const verifyAuthRes = await fetch(`${serverUrl}/auth-verify`, {
     credentials: "include",
     method: "POST",
     headers: {
@@ -1489,7 +1510,7 @@ async function login({
   if (!verifyAuthRes.ok) {
     return { success: false, error: verifyAuth.error };
   }
-  if (verifyAuth.verified) {
+  if (verifyAuth.data.verified) {
     return { success: true, authJSON };
   } else {
     return { success: false, error: "Failed to log in" };
@@ -1502,7 +1523,7 @@ async function register({
   serverUrl,
   username
 }) {
-  const initRegisterRes = await fetch(`${serverUrl}/init-register`, {
+  const initRegisterRes = await fetch(`${serverUrl}/register-init`, {
     credentials: "include",
     method: "POST",
     headers: {
@@ -1520,9 +1541,9 @@ async function register({
       errorCode: initRegister.errorCode
     };
   }
-  const optionsJSON = initRegister.optionsJSON;
+  const optionsJSON = initRegister.data.optionsJSON;
   const registrationJSON = await startRegistration({ optionsJSON });
-  const verifyResponse = await fetch(`${serverUrl}/verify-register`, {
+  const verifyResponse = await fetch(`${serverUrl}/register-verify`, {
     credentials: "include",
     method: "POST",
     headers: {
@@ -1539,7 +1560,7 @@ async function register({
       errorCode: verifyData.errorCode
     };
   }
-  if (verifyData.verified) {
+  if (verifyData.data.verified) {
     console.log(`Successfully registered ${username}`);
     return { success: true };
   } else {
@@ -1555,7 +1576,7 @@ async function connect({
   serverUrl
 }) {
   const responseRegister = await register({ serverUrl, username });
-  if (responseRegister.success || responseRegister.errorCode == ERRORCODES.USEREXISTS) {
+  if (responseRegister.success || responseRegister.error.errorCode == ERRORCODES.USEREXISTS) {
     const loginRes = await handleLogin({ serverUrl, username });
     if (loginRes.success && loginRes.authJSON) {
       const wallet = await buildWalletFromPasskey(
@@ -1823,7 +1844,7 @@ var MeshWallet = class {
    * @param address - the address to use for signing (optional)
    * @returns a signature
    */
-  signData(payload, address) {
+  async signData(payload, address) {
     if (!this._wallet) {
       throw new Error(
         "[MeshWallet] Read only wallet does not support signing data."
@@ -1846,7 +1867,7 @@ var MeshWallet = class {
    * @param partialSign - if the transaction is partially signed (default: false)
    * @returns a signed transaction in CBOR
    */
-  signTx(unsignedTx, partialSign = false) {
+  async signTx(unsignedTx, partialSign = false) {
     if (!this._wallet) {
       throw new Error(
         "[MeshWallet] Read only wallet does not support signing data."
@@ -1872,7 +1893,7 @@ var MeshWallet = class {
    * @param partialSign - if the transactions are signed partially
    * @returns array of signed transactions CborHex string
    */
-  signTxs(unsignedTxs, partialSign = false) {
+  async signTxs(unsignedTxs, partialSign = false) {
     if (!this._wallet) {
       throw new Error(
         "[MeshWallet] Read only wallet does not support signing data."
@@ -1880,7 +1901,7 @@ var MeshWallet = class {
     }
     const signedTxs = [];
     for (const unsignedTx of unsignedTxs) {
-      const signedTx = this.signTx(unsignedTx, partialSign);
+      const signedTx = await this.signTx(unsignedTx, partialSign);
       signedTxs.push(signedTx);
     }
     return signedTxs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshsdk/wallet",
-  "version": "1.8.8",
+  "version": "1.8.10",
   "description": "Wallets - https://meshjs.dev/apis/wallets",
   "main": "./dist/index.cjs",
   "browser": "./dist/index.js",
@@ -35,10 +35,10 @@
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@meshsdk/common": "1.8.8",
-    "@meshsdk/core-csl": "1.8.8",
-    "@meshsdk/core-cst": "1.8.8",
-    "@meshsdk/transaction": "1.8.8",
+    "@meshsdk/common": "1.8.10",
+    "@meshsdk/core-csl": "1.8.10",
+    "@meshsdk/core-cst": "1.8.10",
+    "@meshsdk/transaction": "1.8.10",
     "@simplewebauthn/browser": "^13.0.0"
   },
   "prettier": "@meshsdk/configs/prettier",