@meshsdk/wallet 1.6.2 → 1.6.3

package/dist/index.d.cts

@@ -1,12 +1,19 @@
 import { DataSignature, IFetcher, ISubmitter, ISigner, IInitiator, Wallet, Asset, UTxO, AssetExtended } from '@meshsdk/common';
-import { TransactionUnspentOutput, Address, PrivateKey, VkeyWitness } from '@meshsdk/core-cst';
+import { TransactionUnspentOutput, Address, StricaPrivateKey, VkeyWitness } from '@meshsdk/core-cst';
 
 type Cardano = {
     [key: string]: {
         name: string;
         icon: string;
         apiVersion: string;
-        enable: () => Promise<WalletInstance>;
+        enable: (extensions?: {
+            extensions: {
+                cip: number;
+            }[];
+        }) => Promise<WalletInstance>;
+        supportedExtensions?: {
+            cip: number;
+        }[];
     };
 };
 type TransactionSignatureRequest = {
@@ -17,6 +24,9 @@ type WalletInstance = {
     experimental: ExperimentalFeatures;
     getBalance(): Promise<string>;
     getChangeAddress(): Promise<string>;
+    getExtensions(): Promise<{
+        cip: number;
+    }[]>;
     getNetworkId(): Promise<number>;
     getRewardAddresses(): Promise<string[]>;
     getUnusedAddresses(): Promise<string[]>;
@@ -27,6 +37,11 @@ type WalletInstance = {
     signTxs?(txs: TransactionSignatureRequest[]): Promise<string[]>;
     signTxs?(txs: string[], partialSign: boolean): Promise<string[]>;
     submitTx(tx: string): Promise<string>;
+    cip95?: WalletInstanceCip95;
+};
+type WalletInstanceCip95 = {
+    getPubDRepKey(): Promise<string>;
+    getRegisteredPubStakeKeys(): Promise<string[]>;
 };
 type ExperimentalFeatures = {
     getCollateral(): Promise<string[] | undefined>;
@@ -97,7 +112,11 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      *
      * @returns a list of wallet names
      */
-    static getInstalledWallets(): Wallet[];
+    static getAvailableWallets({ metamask, }?: {
+        metamask?: {
+            network: string;
+        };
+    }): Promise<Wallet[]>;
     /**
      * 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.
@@ -106,22 +125,17 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      *
      * @returns a list of wallet names
      */
-    static getAvailableWallets({ nufiNetwork, }?: {
-        nufiNetwork?: string;
-    }): Promise<Wallet[]>;
+    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.
      *
      * 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
+     * @param walletName - the name of the wallet to enable (e.g. "eternl", "begin", "nufiSnap")
+     * @param extensions - optional, a list of CIPs that the wallet should support
      * @returns WalletInstance
      */
-    static enable(walletName: string): Promise<BrowserWallet>;
-    /**
-     * Retrieves the total available balance of the wallet, encoded in CBOR.
-     * @returns {Promise<Value>} - The balance of the wallet.
-     */
+    static enable(walletName: string, extensions?: number[]): 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.
@@ -145,6 +159,12 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      * @returns a list of UTXOs
      */
     getCollateral(): Promise<UTxO[]>;
+    /**
+     * Return a list of supported CIPs of the wallet.
+     *
+     * @returns a list of CIPs
+     */
+    getExtensions(): Promise<number[]>;
     /**
      * 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.
      *
@@ -184,20 +204,18 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      */
     getUtxos(): Promise<UTxO[]>;
     /**
-     * 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.
+     * 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
-     * @param payload
+     * @param payload - the data to be signed
+     * @param address - optional, if not provided, the first staking address will be used
      * @returns a signature
      */
-    signData(address: string, payload: string): Promise<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.
      *
-     * @param unsignedTx
-     * @param partialSign
+     * @param unsignedTx - a transaction in CBOR
+     * @param partialSign - if the transaction is signed partially
      * @returns a signed transaction in CBOR
      */
     signTx(unsignedTx: string, partialSign?: boolean): Promise<string>;
@@ -267,8 +285,20 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      * @returns a list of policy IDs
      */
     getPolicyIds(): Promise<string[]>;
+    getPubDRepKey(): Promise<{
+        pubDRepKey: string;
+        dRepIDHash: string;
+        dRepIDBech32: string;
+    } | undefined>;
+    getRegisteredPubStakeKeys(): Promise<{
+        pubStakeKeys: string[];
+        pubStakeKeyHashes: string[];
+    } | undefined>;
     private static resolveInstance;
     static addBrowserWitnesses(unsignedTx: string, witnesses: string): string;
+    static getSupportedExtensions(wallet: string): {
+        cip: number;
+    }[];
 }
 
 type Account = {
@@ -278,8 +308,8 @@ type Account = {
     baseAddressBech32: string;
     enterpriseAddressBech32: string;
     rewardAddressBech32: string;
-    paymentKey: PrivateKey;
-    stakeKey: PrivateKey;
+    paymentKey: StricaPrivateKey;
+    stakeKey: StricaPrivateKey;
     paymentKeyHex: string;
     stakeKeyHex: string;
 };
@@ -302,7 +332,7 @@ declare class WalletStaticMethods {
     static privateKeyToEntropy(bech32: string): string;
     static mnemonicToEntropy(words: string[]): string;
     static signingKeyToEntropy(paymentKey: string, stakeKey: string): [string, string];
-    static getAddresses(paymentKey: PrivateKey, stakingKey: PrivateKey, networkId?: number): {
+    static getAddresses(paymentKey: StricaPrivateKey, stakingKey: StricaPrivateKey, networkId?: number): {
         baseAddress: Address;
         enterpriseAddress: Address;
         rewardAddress: Address;
@@ -387,6 +417,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * 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 addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getCollateral(addressType?: GetAddressType): Promise<UTxO[]>;
@@ -395,6 +426,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * This is used in transaction building.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getCollateralUnspentOutput(addressType?: GetAddressType): Promise<TransactionUnspentOutput[]>;
@@ -435,30 +467,30 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * This is used in transaction building.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getUsedUTxOs(addressType?: GetAddressType): Promise<TransactionUnspentOutput[]>;
     /**
      * Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getUtxos(addressType?: GetAddressType): Promise<UTxO[]>;
     /**
-     * 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.
+     * 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
-     * @param payload
+     * @param payload - the payload to sign
+     * @param address - the address to use for signing (optional)
      * @returns a signature
      */
-    signData(payload: string): DataSignature;
+    signData(payload: string, address?: string): 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.
      *
-     * @param unsignedTx
-     * @param partialSign
+     * @param unsignedTx - a transaction in CBOR
+     * @param partialSign - if the transaction is partially signed (default: false)
      * @returns a signed transaction in CBOR
      */
     signTx(unsignedTx: string, partialSign?: boolean): string;
@@ -475,7 +507,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * 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
+     * @param tx - a signed transaction in CBOR
      * @returns a transaction hash
      */
     submitTx(tx: string): Promise<string>;
@@ -484,6 +516,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * This is used in transaction building.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns an Address object
      */
     getUsedAddress(addressType?: GetAddressType): Address;
@@ -492,6 +525,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * This is used in transaction building.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getUnspentOutputs(addressType?: GetAddressType): Promise<TransactionUnspentOutput[]>;

package/dist/index.d.ts

@@ -1,12 +1,19 @@
 import { DataSignature, IFetcher, ISubmitter, ISigner, IInitiator, Wallet, Asset, UTxO, AssetExtended } from '@meshsdk/common';
-import { TransactionUnspentOutput, Address, PrivateKey, VkeyWitness } from '@meshsdk/core-cst';
+import { TransactionUnspentOutput, Address, StricaPrivateKey, VkeyWitness } from '@meshsdk/core-cst';
 
 type Cardano = {
     [key: string]: {
         name: string;
         icon: string;
         apiVersion: string;
-        enable: () => Promise<WalletInstance>;
+        enable: (extensions?: {
+            extensions: {
+                cip: number;
+            }[];
+        }) => Promise<WalletInstance>;
+        supportedExtensions?: {
+            cip: number;
+        }[];
     };
 };
 type TransactionSignatureRequest = {
@@ -17,6 +24,9 @@ type WalletInstance = {
     experimental: ExperimentalFeatures;
     getBalance(): Promise<string>;
     getChangeAddress(): Promise<string>;
+    getExtensions(): Promise<{
+        cip: number;
+    }[]>;
     getNetworkId(): Promise<number>;
     getRewardAddresses(): Promise<string[]>;
     getUnusedAddresses(): Promise<string[]>;
@@ -27,6 +37,11 @@ type WalletInstance = {
     signTxs?(txs: TransactionSignatureRequest[]): Promise<string[]>;
     signTxs?(txs: string[], partialSign: boolean): Promise<string[]>;
     submitTx(tx: string): Promise<string>;
+    cip95?: WalletInstanceCip95;
+};
+type WalletInstanceCip95 = {
+    getPubDRepKey(): Promise<string>;
+    getRegisteredPubStakeKeys(): Promise<string[]>;
 };
 type ExperimentalFeatures = {
     getCollateral(): Promise<string[] | undefined>;
@@ -97,7 +112,11 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      *
      * @returns a list of wallet names
      */
-    static getInstalledWallets(): Wallet[];
+    static getAvailableWallets({ metamask, }?: {
+        metamask?: {
+            network: string;
+        };
+    }): Promise<Wallet[]>;
     /**
      * 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.
@@ -106,22 +125,17 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      *
      * @returns a list of wallet names
      */
-    static getAvailableWallets({ nufiNetwork, }?: {
-        nufiNetwork?: string;
-    }): Promise<Wallet[]>;
+    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.
      *
      * 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
+     * @param walletName - the name of the wallet to enable (e.g. "eternl", "begin", "nufiSnap")
+     * @param extensions - optional, a list of CIPs that the wallet should support
      * @returns WalletInstance
      */
-    static enable(walletName: string): Promise<BrowserWallet>;
-    /**
-     * Retrieves the total available balance of the wallet, encoded in CBOR.
-     * @returns {Promise<Value>} - The balance of the wallet.
-     */
+    static enable(walletName: string, extensions?: number[]): 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.
@@ -145,6 +159,12 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      * @returns a list of UTXOs
      */
     getCollateral(): Promise<UTxO[]>;
+    /**
+     * Return a list of supported CIPs of the wallet.
+     *
+     * @returns a list of CIPs
+     */
+    getExtensions(): Promise<number[]>;
     /**
      * 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.
      *
@@ -184,20 +204,18 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      */
     getUtxos(): Promise<UTxO[]>;
     /**
-     * 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.
+     * 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
-     * @param payload
+     * @param payload - the data to be signed
+     * @param address - optional, if not provided, the first staking address will be used
      * @returns a signature
      */
-    signData(address: string, payload: string): Promise<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.
      *
-     * @param unsignedTx
-     * @param partialSign
+     * @param unsignedTx - a transaction in CBOR
+     * @param partialSign - if the transaction is signed partially
      * @returns a signed transaction in CBOR
      */
     signTx(unsignedTx: string, partialSign?: boolean): Promise<string>;
@@ -267,8 +285,20 @@ declare class BrowserWallet implements IInitiator, ISigner, ISubmitter {
      * @returns a list of policy IDs
      */
     getPolicyIds(): Promise<string[]>;
+    getPubDRepKey(): Promise<{
+        pubDRepKey: string;
+        dRepIDHash: string;
+        dRepIDBech32: string;
+    } | undefined>;
+    getRegisteredPubStakeKeys(): Promise<{
+        pubStakeKeys: string[];
+        pubStakeKeyHashes: string[];
+    } | undefined>;
     private static resolveInstance;
     static addBrowserWitnesses(unsignedTx: string, witnesses: string): string;
+    static getSupportedExtensions(wallet: string): {
+        cip: number;
+    }[];
 }
 
 type Account = {
@@ -278,8 +308,8 @@ type Account = {
     baseAddressBech32: string;
     enterpriseAddressBech32: string;
     rewardAddressBech32: string;
-    paymentKey: PrivateKey;
-    stakeKey: PrivateKey;
+    paymentKey: StricaPrivateKey;
+    stakeKey: StricaPrivateKey;
     paymentKeyHex: string;
     stakeKeyHex: string;
 };
@@ -302,7 +332,7 @@ declare class WalletStaticMethods {
     static privateKeyToEntropy(bech32: string): string;
     static mnemonicToEntropy(words: string[]): string;
     static signingKeyToEntropy(paymentKey: string, stakeKey: string): [string, string];
-    static getAddresses(paymentKey: PrivateKey, stakingKey: PrivateKey, networkId?: number): {
+    static getAddresses(paymentKey: StricaPrivateKey, stakingKey: StricaPrivateKey, networkId?: number): {
         baseAddress: Address;
         enterpriseAddress: Address;
         rewardAddress: Address;
@@ -387,6 +417,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * 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 addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getCollateral(addressType?: GetAddressType): Promise<UTxO[]>;
@@ -395,6 +426,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * This is used in transaction building.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getCollateralUnspentOutput(addressType?: GetAddressType): Promise<TransactionUnspentOutput[]>;
@@ -435,30 +467,30 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * This is used in transaction building.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getUsedUTxOs(addressType?: GetAddressType): Promise<TransactionUnspentOutput[]>;
     /**
      * Return a list of all UTXOs (unspent transaction outputs) controlled by the wallet.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getUtxos(addressType?: GetAddressType): Promise<UTxO[]>;
     /**
-     * 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.
+     * 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
-     * @param payload
+     * @param payload - the payload to sign
+     * @param address - the address to use for signing (optional)
      * @returns a signature
      */
-    signData(payload: string): DataSignature;
+    signData(payload: string, address?: string): 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.
      *
-     * @param unsignedTx
-     * @param partialSign
+     * @param unsignedTx - a transaction in CBOR
+     * @param partialSign - if the transaction is partially signed (default: false)
      * @returns a signed transaction in CBOR
      */
     signTx(unsignedTx: string, partialSign?: boolean): string;
@@ -475,7 +507,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * 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
+     * @param tx - a signed transaction in CBOR
      * @returns a transaction hash
      */
     submitTx(tx: string): Promise<string>;
@@ -484,6 +516,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * This is used in transaction building.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns an Address object
      */
     getUsedAddress(addressType?: GetAddressType): Address;
@@ -492,6 +525,7 @@ declare class MeshWallet implements IInitiator, ISigner, ISubmitter {
      *
      * This is used in transaction building.
      *
+     * @param addressType - the type of address to fetch UTXOs from (default: payment)
      * @returns a list of UTXOs
      */
     getUnspentOutputs(addressType?: GetAddressType): Promise<TransactionUnspentOutput[]>;