@meshsdk/wallet 1.8.13 → 1.9.0-beta-38

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { DataSignature, IFetcher, ISubmitter, ISigner, IWallet, Wallet, Asset, UTxO, AssetExtended } from '@meshsdk/common';
-import { Ed25519PublicKeyHex, TransactionUnspentOutput, Address, StricaPrivateKey, DRepID, Ed25519KeyHashHex, VkeyWitness } from '@meshsdk/core-cst';
+import { DataSignature, IFetcher, ISubmitter, ISigner, IWallet, Wallet, Extension, Asset, UTxO, AssetExtended } from '@meshsdk/common';
+import { Ed25519PublicKeyHex, TransactionUnspentOutput, Address, Ed25519PrivateKey, DRepID, Ed25519KeyHashHex, VkeyWitness } from '@meshsdk/core-cst';
 import * as _simplewebauthn_browser from '@simplewebauthn/browser';
 
 type Cardano = {
@@ -77,6 +77,11 @@ declare class AppWallet implements ISigner, ISubmitter {
     private readonly _submitter?;
     private readonly _wallet;
     constructor(options: CreateAppWalletOptions);
+    /**
+     * Initializes the wallet. This is a required call as fetching addresses from the wallet is an async operation.
+     * @returns void
+     */
+    init(): Promise<void>;
     /**
      * Get a list of UTXOs to be used as collateral inputs for transactions with plutus script inputs.
      *
@@ -107,7 +112,7 @@ declare global {
 /**
  * Browser Wallet provides a set of APIs to interact with the blockchain. This wallet is compatible with Mesh transaction builders.
  *
- * 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.
+ * These wallets APIs are in accordance to CIP-30, which defines the API for apps to communicate with the user's wallet. Additional utility functions provided for developers that are useful for building applications.
  * ```javascript
  * import { BrowserWallet } from '@meshsdk/core';
  *
@@ -140,7 +145,7 @@ declare class BrowserWallet implements IWallet {
      */
     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.
+     * 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 app 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.
      *
@@ -148,7 +153,7 @@ declare class BrowserWallet implements IWallet {
      * @param extensions - optional, a list of CIPs that the wallet should support
      * @returns WalletInstance
      */
-    static enable(walletName: string, extensions?: number[]): Promise<BrowserWallet>;
+    static enable(walletName: string, extensions?: Extension[]): 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.
@@ -235,7 +240,7 @@ declare class BrowserWallet implements IWallet {
     /**
      * 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.
+     * As wallets should already have this ability to submit transaction, we allow apps 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 app to track. The wallet can return error messages or failure if there was an error in sending it.
      *
      * @param tx
      * @returns a transaction hash
@@ -294,7 +299,7 @@ declare class BrowserWallet implements IWallet {
      * The connected wallet account provides the account's public DRep Key, derivation as described in CIP-0105.
      * These are used by the client to identify the user's on-chain CIP-1694 interactions, i.e. if a user has registered to be a DRep.
      *
-     * @returns wallet account's public DRep Key
+     * @returns DRep object
      */
     getDRep(): Promise<{
         publicKey: string;
@@ -307,11 +312,7 @@ declare class BrowserWallet implements IWallet {
      *
      * @returns wallet account's public DRep Key
      */
-    getPubDRepKey(): Promise<{
-        pubDRepKey: string;
-        dRepIDHash: string;
-        dRepIDBech32: string;
-    } | undefined>;
+    getPubDRepKey(): Promise<string | undefined>;
     getRegisteredPubStakeKeys(): Promise<{
         pubStakeKeys: string[];
         pubStakeKeyHashes: string[];
@@ -384,13 +385,14 @@ type Account = {
     baseAddressBech32: string;
     enterpriseAddressBech32: string;
     rewardAddressBech32: string;
-    paymentKey: StricaPrivateKey;
-    stakeKey: StricaPrivateKey;
+    paymentKey: Ed25519PrivateKey;
+    stakeKey: Ed25519PrivateKey;
     paymentKeyHex: string;
     stakeKeyHex: string;
     pubDRepKey?: string;
     dRepIDBech32?: DRepID;
     dRepIDHash?: Ed25519KeyHashHex;
+    dRepIDCip105?: string;
 };
 type EmbeddedWalletKeyType = {
     type: "root";
@@ -411,27 +413,30 @@ type CreateEmbeddedWalletOptions = {
     key: EmbeddedWalletKeyType;
 };
 declare class WalletStaticMethods {
-    static privateKeyToEntropy(_bech32: string): string;
-    static mnemonicToEntropy(words: string[]): string;
-    static signingKeyToEntropy(paymentKey: string, stakeKey: string): [string, string];
-    static bip32BytesToEntropy(bip32Bytes: Uint8Array): string;
-    static getAddresses(paymentKey: StricaPrivateKey, stakingKey: StricaPrivateKey, networkId?: number): {
+    static privateKeyBech32ToPrivateKeyHex(_bech32: string): string;
+    static mnemonicToPrivateKeyHex(words: string[]): string;
+    static signingKeyToHexes(paymentKey: string, stakeKey: string): [string, string];
+    static bip32BytesToPrivateKeyHex(bip32Bytes: Uint8Array): string;
+    static getAddresses(paymentKey: Ed25519PrivateKey, stakingKey: Ed25519PrivateKey, networkId?: number): {
         baseAddress: Address;
         enterpriseAddress: Address;
         rewardAddress: Address;
     };
-    static getDRepKey(dRepKey: StricaPrivateKey, networkId?: number): {
+    static getDRepKey(dRepKey: Ed25519PrivateKey, networkId?: number): {
         pubDRepKey: string;
         dRepIDBech32: DRepID;
         dRepIDHash: Ed25519KeyHashHex;
+        dRepIDCip105: string;
     };
     static generateMnemonic(strength?: number): string[];
     static addWitnessSets(txHex: string, witnesses: VkeyWitness[]): string;
 }
 declare class EmbeddedWallet extends WalletStaticMethods {
-    private readonly _entropy?;
+    private readonly _walletSecret?;
     private readonly _networkId;
+    cryptoIsReady: boolean;
     constructor(options: CreateEmbeddedWalletOptions);
+    init(): Promise<void>;
     getAccount(accountIndex?: number, keyIndex?: number): Account;
     /**
      * Get wallet network ID.
@@ -495,20 +500,23 @@ type CreateMeshWalletOptions = {
  * ```javascript
  * import { MeshWallet, BlockfrostProvider } from '@meshsdk/core';
  *
- * const blockchainProvider = new BlockfrostProvider('<BLOCKFROST_API_KEY>');
+ * const provider = new BlockfrostProvider('<BLOCKFROST_API_KEY>');
  *
  * const wallet = new MeshWallet({
  *   networkId: 0,
- *   fetcher: blockchainProvider,
- *   submitter: blockchainProvider,
+ *   fetcher: provider,
+ *   submitter: provider,
  *   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"],
  *   },
  * });
  * ```
+ *
+ * Please call `await wallet.init()` after creating the wallet to fetch the addresses from the wallet.
  */
 declare class MeshWallet implements IWallet {
+    private readonly _keyType;
     private readonly _wallet;
     private readonly _accountIndex;
     private readonly _keyIndex;
@@ -525,8 +533,14 @@ declare class MeshWallet implements IWallet {
         pubDRepKey?: string;
         dRepIDBech32?: DRepID;
         dRepIDHash?: Ed25519KeyHashHex;
+        dRepIDCip105?: string;
     };
     constructor(options: CreateMeshWalletOptions);
+    /**
+     * Initializes the wallet. This is a required call as fetching addresses from the wallet is an async operation.
+     * @returns void
+     */
+    init(): Promise<void>;
     /**
      * Returns all derived addresses from the wallet.
      * @returns a list of addresses
@@ -541,6 +555,7 @@ declare class MeshWallet implements IWallet {
         pubDRepKey?: string;
         dRepIDBech32?: DRepID;
         dRepIDHash?: Ed25519KeyHashHex;
+        dRepIDCip105?: string;
     };
     /**
      * 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:
@@ -555,7 +570,7 @@ declare class MeshWallet implements IWallet {
      *
      * @returns an address
      */
-    getChangeAddress(): string;
+    getChangeAddress(addressType?: GetAddressType): 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).
      *
@@ -584,7 +599,7 @@ declare class MeshWallet implements IWallet {
      * The connected wallet account provides the account's public DRep Key, derivation as described in CIP-0105.
      * These are used by the client to identify the user's on-chain CIP-1694 interactions, i.e. if a user has registered to be a DRep.
      *
-     * @returns wallet account's public DRep Key
+     * @returns DRep object
      */
     getDRep(): Promise<{
         publicKey: string;
@@ -658,7 +673,7 @@ declare class MeshWallet implements IWallet {
     /**
      * 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.
+     * As wallets should already have this ability to submit transaction, we allow apps 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 app to track. The wallet can return error messages or failure if there was an error in sending it.
      *
      * @param tx - a signed transaction in CBOR
      * @returns a transaction hash
@@ -725,6 +740,7 @@ declare class MeshWallet implements IWallet {
         pubDRepKey: string | undefined;
         dRepIDBech32: string | undefined;
         dRepIDHash: string | undefined;
+        dRepIDCip105: string | undefined;
     };
     /**
      * Generate mnemonic or private key

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { DataSignature, IFetcher, ISubmitter, ISigner, IWallet, Wallet, Asset, UTxO, AssetExtended } from '@meshsdk/common';
-import { Ed25519PublicKeyHex, TransactionUnspentOutput, Address, StricaPrivateKey, DRepID, Ed25519KeyHashHex, VkeyWitness } from '@meshsdk/core-cst';
+import { DataSignature, IFetcher, ISubmitter, ISigner, IWallet, Wallet, Extension, Asset, UTxO, AssetExtended } from '@meshsdk/common';
+import { Ed25519PublicKeyHex, TransactionUnspentOutput, Address, Ed25519PrivateKey, DRepID, Ed25519KeyHashHex, VkeyWitness } from '@meshsdk/core-cst';
 import * as _simplewebauthn_browser from '@simplewebauthn/browser';
 
 type Cardano = {
@@ -77,6 +77,11 @@ declare class AppWallet implements ISigner, ISubmitter {
     private readonly _submitter?;
     private readonly _wallet;
     constructor(options: CreateAppWalletOptions);
+    /**
+     * Initializes the wallet. This is a required call as fetching addresses from the wallet is an async operation.
+     * @returns void
+     */
+    init(): Promise<void>;
     /**
      * Get a list of UTXOs to be used as collateral inputs for transactions with plutus script inputs.
      *
@@ -107,7 +112,7 @@ declare global {
 /**
  * Browser Wallet provides a set of APIs to interact with the blockchain. This wallet is compatible with Mesh transaction builders.
  *
- * 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.
+ * These wallets APIs are in accordance to CIP-30, which defines the API for apps to communicate with the user's wallet. Additional utility functions provided for developers that are useful for building applications.
  * ```javascript
  * import { BrowserWallet } from '@meshsdk/core';
  *
@@ -140,7 +145,7 @@ declare class BrowserWallet implements IWallet {
      */
     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.
+     * 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 app 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.
      *
@@ -148,7 +153,7 @@ declare class BrowserWallet implements IWallet {
      * @param extensions - optional, a list of CIPs that the wallet should support
      * @returns WalletInstance
      */
-    static enable(walletName: string, extensions?: number[]): Promise<BrowserWallet>;
+    static enable(walletName: string, extensions?: Extension[]): 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.
@@ -235,7 +240,7 @@ declare class BrowserWallet implements IWallet {
     /**
      * 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.
+     * As wallets should already have this ability to submit transaction, we allow apps 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 app to track. The wallet can return error messages or failure if there was an error in sending it.
      *
      * @param tx
      * @returns a transaction hash
@@ -294,7 +299,7 @@ declare class BrowserWallet implements IWallet {
      * The connected wallet account provides the account's public DRep Key, derivation as described in CIP-0105.
      * These are used by the client to identify the user's on-chain CIP-1694 interactions, i.e. if a user has registered to be a DRep.
      *
-     * @returns wallet account's public DRep Key
+     * @returns DRep object
      */
     getDRep(): Promise<{
         publicKey: string;
@@ -307,11 +312,7 @@ declare class BrowserWallet implements IWallet {
      *
      * @returns wallet account's public DRep Key
      */
-    getPubDRepKey(): Promise<{
-        pubDRepKey: string;
-        dRepIDHash: string;
-        dRepIDBech32: string;
-    } | undefined>;
+    getPubDRepKey(): Promise<string | undefined>;
     getRegisteredPubStakeKeys(): Promise<{
         pubStakeKeys: string[];
         pubStakeKeyHashes: string[];
@@ -384,13 +385,14 @@ type Account = {
     baseAddressBech32: string;
     enterpriseAddressBech32: string;
     rewardAddressBech32: string;
-    paymentKey: StricaPrivateKey;
-    stakeKey: StricaPrivateKey;
+    paymentKey: Ed25519PrivateKey;
+    stakeKey: Ed25519PrivateKey;
     paymentKeyHex: string;
     stakeKeyHex: string;
     pubDRepKey?: string;
     dRepIDBech32?: DRepID;
     dRepIDHash?: Ed25519KeyHashHex;
+    dRepIDCip105?: string;
 };
 type EmbeddedWalletKeyType = {
     type: "root";
@@ -411,27 +413,30 @@ type CreateEmbeddedWalletOptions = {
     key: EmbeddedWalletKeyType;
 };
 declare class WalletStaticMethods {
-    static privateKeyToEntropy(_bech32: string): string;
-    static mnemonicToEntropy(words: string[]): string;
-    static signingKeyToEntropy(paymentKey: string, stakeKey: string): [string, string];
-    static bip32BytesToEntropy(bip32Bytes: Uint8Array): string;
-    static getAddresses(paymentKey: StricaPrivateKey, stakingKey: StricaPrivateKey, networkId?: number): {
+    static privateKeyBech32ToPrivateKeyHex(_bech32: string): string;
+    static mnemonicToPrivateKeyHex(words: string[]): string;
+    static signingKeyToHexes(paymentKey: string, stakeKey: string): [string, string];
+    static bip32BytesToPrivateKeyHex(bip32Bytes: Uint8Array): string;
+    static getAddresses(paymentKey: Ed25519PrivateKey, stakingKey: Ed25519PrivateKey, networkId?: number): {
         baseAddress: Address;
         enterpriseAddress: Address;
         rewardAddress: Address;
     };
-    static getDRepKey(dRepKey: StricaPrivateKey, networkId?: number): {
+    static getDRepKey(dRepKey: Ed25519PrivateKey, networkId?: number): {
         pubDRepKey: string;
         dRepIDBech32: DRepID;
         dRepIDHash: Ed25519KeyHashHex;
+        dRepIDCip105: string;
     };
     static generateMnemonic(strength?: number): string[];
     static addWitnessSets(txHex: string, witnesses: VkeyWitness[]): string;
 }
 declare class EmbeddedWallet extends WalletStaticMethods {
-    private readonly _entropy?;
+    private readonly _walletSecret?;
     private readonly _networkId;
+    cryptoIsReady: boolean;
     constructor(options: CreateEmbeddedWalletOptions);
+    init(): Promise<void>;
     getAccount(accountIndex?: number, keyIndex?: number): Account;
     /**
      * Get wallet network ID.
@@ -495,20 +500,23 @@ type CreateMeshWalletOptions = {
  * ```javascript
  * import { MeshWallet, BlockfrostProvider } from '@meshsdk/core';
  *
- * const blockchainProvider = new BlockfrostProvider('<BLOCKFROST_API_KEY>');
+ * const provider = new BlockfrostProvider('<BLOCKFROST_API_KEY>');
  *
  * const wallet = new MeshWallet({
  *   networkId: 0,
- *   fetcher: blockchainProvider,
- *   submitter: blockchainProvider,
+ *   fetcher: provider,
+ *   submitter: provider,
  *   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"],
  *   },
  * });
  * ```
+ *
+ * Please call `await wallet.init()` after creating the wallet to fetch the addresses from the wallet.
  */
 declare class MeshWallet implements IWallet {
+    private readonly _keyType;
     private readonly _wallet;
     private readonly _accountIndex;
     private readonly _keyIndex;
@@ -525,8 +533,14 @@ declare class MeshWallet implements IWallet {
         pubDRepKey?: string;
         dRepIDBech32?: DRepID;
         dRepIDHash?: Ed25519KeyHashHex;
+        dRepIDCip105?: string;
     };
     constructor(options: CreateMeshWalletOptions);
+    /**
+     * Initializes the wallet. This is a required call as fetching addresses from the wallet is an async operation.
+     * @returns void
+     */
+    init(): Promise<void>;
     /**
      * Returns all derived addresses from the wallet.
      * @returns a list of addresses
@@ -541,6 +555,7 @@ declare class MeshWallet implements IWallet {
         pubDRepKey?: string;
         dRepIDBech32?: DRepID;
         dRepIDHash?: Ed25519KeyHashHex;
+        dRepIDCip105?: string;
     };
     /**
      * 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:
@@ -555,7 +570,7 @@ declare class MeshWallet implements IWallet {
      *
      * @returns an address
      */
-    getChangeAddress(): string;
+    getChangeAddress(addressType?: GetAddressType): 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).
      *
@@ -584,7 +599,7 @@ declare class MeshWallet implements IWallet {
      * The connected wallet account provides the account's public DRep Key, derivation as described in CIP-0105.
      * These are used by the client to identify the user's on-chain CIP-1694 interactions, i.e. if a user has registered to be a DRep.
      *
-     * @returns wallet account's public DRep Key
+     * @returns DRep object
      */
     getDRep(): Promise<{
         publicKey: string;
@@ -658,7 +673,7 @@ declare class MeshWallet implements IWallet {
     /**
      * 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.
+     * As wallets should already have this ability to submit transaction, we allow apps 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 app to track. The wallet can return error messages or failure if there was an error in sending it.
      *
      * @param tx - a signed transaction in CBOR
      * @returns a transaction hash
@@ -725,6 +740,7 @@ declare class MeshWallet implements IWallet {
         pubDRepKey: string | undefined;
         dRepIDBech32: string | undefined;
         dRepIDHash: string | undefined;
+        dRepIDCip105: string | undefined;
     };
     /**
      * Generate mnemonic or private key