@massalabs/wallet-provider 1.4.2-dev.20230929102824 → 1.4.2-dev.20230929135423

package/README.md

@@ -1,69 +1,22 @@
+# Wallet-Provider
 
-# Wallet-provider
+> **PREREQUISITES:**
+> 
+>    - NodeJS 18+
+>    - npm / yarn (refer to package.json for specifics)
 
-  
-
-`Wallet-provider` is a TypeScript library that one could utilize to establish a connection between a frontend application and any browser wallet extensions that implement the [massa standard](https://github.com/massalabs/massa-standards/blob/main/wallet/dapps-communication.md). With this library one can access all massa-blockchain wallets and their standardized functionalities for ready use.
-
-  
-
-## Usage
-
-`Wallet-provider` could be used as a library for frameworks or as a stand-alone bundled js file which can be easily loaded into the browser.
-
-  
-
-### Library (Node.js/React/Vue.js) usage
-
-  
-
-> npm install @massalabs/wallet-provider
-
-  
-
-### Browser usage
-
-  
-
-Add the following script to your html file:
-
-  
-
-```ts
-
-<script
-
-type="text/javascript"
-
-src="https://cdn.jsdelivr.net/npm/@massalabs/wallet-provider@x.x.x/bundle.js"
-
-></script>
-
-```
-
-  
-
-whereby the x.x.x is one of the available released versions under [Wallet-provider's releases page](https://github.com/massalabs/wallet-provider/releases).
-
-  
-
-In your code, once the script is fully loaded, just use `window.wallet` to access all `wallet-provider`'s' exported functionalities.
+`Wallet-provider` is a TypeScript library designed to seamlessly connect frontend applications with MassaStation and browser wallet extensions adhering to the [massa standard](https://github.com/massalabs/massa-standards/blob/main/wallet/dapps-communication.md). This library provides a gateway to all massa-blockchain wallets, offering standardized functionalities for effortless integration.
 
+## **Installation**
 
-```ts
-
-<script>
-
-const  providers = window.massa.providers();
-
-console.log("Massa Providers ", providers);
+`Wallet-provider` can be integrated as a library within frameworks or bundled for direct browser use.
 
-</script>
+### **For Frameworks (Node.js/React/Vue.js)**
 
+```sh
+npm install @massalabs/wallet-provider
 ```
 
-  
-
 ## Documentation
 
 Wallet-provider provides complete documentation of all available functions and objects.
@@ -76,31 +29,16 @@ npm run doc
 
 The documentation will be generated in the `docs/documentation/html` directory.
 
-   
-
-## Web3 Wallet Provider Requirement and Initialization
-
-
-### Requirements
-
-- NodeJS 16+
-
-- npm / yarn (see package.json)
-
-
-### Initialization
-
-1. Run `npm install` to install all dependencies
-
-2. Run `npx playwright install --with-deps` to install playwright and its dependencies
+## Usage
 
-3. Run `npm run build` to build distribution content
+- Go to [Web3 client initialization](https://docs.massa.net/docs/build/massa-web3#with-wallet-provider) to learn how to use wallet provider in a dapp.
 
-4. Run `npm run test` to run integration and unit tests
+- Discover dApp examples with associated frontends at the [massa-sc-examples](https://github.com/massalabs/massa-sc-examples) repository.
 
-<br>
+## Example
 
-The library exports a function called `providers` which can be executed to return a vector of all massa-wallet providers currently initialized in the space. As shown below in the example code, each provider has its own callable methods for listing, importing and deleting accounts. Each account can return its name, address and has methods to retrieve its balance and sign a data array.
+Wallet-provider is meant to be used with massa-web3 but can also be used as a standalone library.
+Here is a simple example of how to use Wallet-provider:
 
 ```ts
 
@@ -135,7 +73,7 @@ await  myProvider.importAccount(publicKey, privateKey);
 
 console.log("Retrieving the accounts ...");
 
-const  myAccounts = await  myProvider.accounts();
+const  myAccounts = await myProvider.accounts();
 
 console.log("Provider accounts ...", myAccounts);
   
@@ -151,7 +89,7 @@ console.log("Account address ", myAccount.address());
 
 console.log("Retrieving the account balance ...");
 
-const  accountBalance = await  myAccount.balance();
+const  accountBalance = await myAccount.balance();
 
 console.log("Account Balance = ", accountBalance.balance);
  
@@ -160,7 +98,7 @@ console.log("Account Balance = ", accountBalance.balance);
 
 console.log("Signing a message ...");
 
-const  signature = await  myAccount.sign([0, 1, 2]);
+const  signature = await myAccount.sign([0, 1, 2]);
 
 console.log("Signature = ", signature);
   
@@ -173,8 +111,11 @@ await  myProvider.importAccount(myAccount.address());
 
 ```
 
-
 ## Contributing
-We welcome contributions from the community!
 
-If you would like to contribute to Wallet Provider, please read the  [CONTRIBUTING file](https://github.com/massalabs/wallet-provider/blob/main/CONTRIBUTING.md).
+Community contributions are highly valued! If you're keen on contributing to `Wallet-provider`, please check out our [CONTRIBUTING guidelines](CONTRIBUTING.md).
+
+## License
+
+`Wallet-provider` is distributed under the [MIT License](LICENSE).
+

package/dist/cmd/account/AccountBalance.d.ts

@@ -1,19 +1,17 @@
 /**
- * Represents the request for an AccountBalance command.
- *
- * address - The account address.
+ * Request for an AccountBalance command.
  */
 export interface IAccountBalanceRequest {
+    /** Account address */
     address: string;
 }
 /**
- * Represents the response from an AccountBalance command.
- *
- * finalBalance - The account's final confirmed balance.
- * candidateBalance - The account's pending balance.
+ * Response from an AccountBalance command.
  */
 export interface IAccountBalanceResponse {
+    /** Final confirmed balance of the account */
     finalBalance: string;
+    /** Pending balance of the account */
     candidateBalance: string;
 }
 //# sourceMappingURL=AccountBalance.d.ts.map

package/dist/cmd/account/AccountBalance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccountBalance.d.ts","sourceRoot":"","sources":["../../../src/account/AccountBalance.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;CAC1B"}
+{"version":3,"file":"AccountBalance.d.ts","sourceRoot":"","sources":["../../../src/account/AccountBalance.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,qCAAqC;IACrC,gBAAgB,EAAE,MAAM,CAAC;CAC1B"}

package/dist/cmd/account/AccountBalance.js.map

@@ -1 +1 @@
-{"version":3,"file":"AccountBalance.js","sourceRoot":"","sources":["../../../src/account/AccountBalance.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Represents the request for an AccountBalance command.\n *\n * address - The account address.\n */\nexport interface IAccountBalanceRequest {\n  address: string;\n}\n\n/**\n * Represents the response from an AccountBalance command.\n *\n * finalBalance - The account's final confirmed balance.\n * candidateBalance - The account's pending balance.\n */\nexport interface IAccountBalanceResponse {\n  finalBalance: string;\n  candidateBalance: string;\n}\n"]}
+{"version":3,"file":"AccountBalance.js","sourceRoot":"","sources":["../../../src/account/AccountBalance.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Request for an AccountBalance command.\n */\nexport interface IAccountBalanceRequest {\n  /** Account address */\n  address: string;\n}\n\n/**\n * Response from an AccountBalance command.\n */\nexport interface IAccountBalanceResponse {\n  /** Final confirmed balance of the account */\n  finalBalance: string;\n  /** Pending balance of the account */\n  candidateBalance: string;\n}\n"]}

package/dist/cmd/account/AccountSign.d.ts

@@ -1,28 +1,28 @@
 /**
- * Represents the payload for a signing operation request sent to the content script.
- * address - Account's unique address.
- * data - Data to be signed, as a Uint8Array.
+ * Payload for a signing operation request sent to the content script.
  */
 export interface IAccountSignRequest {
+    /** Account's unique address */
     address: string;
+    /** Data to be signed, represented as a Uint8Array */
     data: Uint8Array;
 }
 /**
- * Represents response from the content script after a signing operation.
- * publicKey - Public key of the account.
- * signature - Signed message data.
+ * Response from the content script after a signing operation.
  */
 export interface IAccountSignResponse {
+    /** Public key of the account */
     publicKey: string;
+    /** Signed message data */
     signature: string;
 }
 /**
- * Represents the output produced by the sign() method.
- * publicKey - Public key of the account.
- * base58Encoded - Base58 encoded representation of the signed data.
+ * Output produced by the sign() method.
  */
 export interface IAccountSignOutput {
+    /** Public key of the account */
     publicKey: string;
+    /** Base58 encoded representation of the signed data */
     base58Encoded: string;
 }
 //# sourceMappingURL=AccountSign.d.ts.map

package/dist/cmd/account/AccountSign.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccountSign.d.ts","sourceRoot":"","sources":["../../../src/account/AccountSign.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB"}
+{"version":3,"file":"AccountSign.d.ts","sourceRoot":"","sources":["../../../src/account/AccountSign.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,aAAa,EAAE,MAAM,CAAC;CACvB"}

package/dist/cmd/account/AccountSign.js.map

@@ -1 +1 @@
-{"version":3,"file":"AccountSign.js","sourceRoot":"","sources":["../../../src/account/AccountSign.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Represents the payload for a signing operation request sent to the content script.\n * address - Account's unique address.\n * data - Data to be signed, as a Uint8Array.\n */\nexport interface IAccountSignRequest {\n  address: string;\n  data: Uint8Array;\n}\n\n/**\n * Represents response from the content script after a signing operation.\n * publicKey - Public key of the account.\n * signature - Signed message data.\n */\nexport interface IAccountSignResponse {\n  publicKey: string;\n  signature: string;\n}\n\n/**\n * Represents the output produced by the sign() method.\n * publicKey - Public key of the account.\n * base58Encoded - Base58 encoded representation of the signed data.\n */\nexport interface IAccountSignOutput {\n  publicKey: string;\n  base58Encoded: string;\n}\n"]}
+{"version":3,"file":"AccountSign.js","sourceRoot":"","sources":["../../../src/account/AccountSign.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Payload for a signing operation request sent to the content script.\n */\nexport interface IAccountSignRequest {\n  /** Account's unique address */\n  address: string;\n  /** Data to be signed, represented as a Uint8Array */\n  data: Uint8Array;\n}\n\n/**\n * Response from the content script after a signing operation.\n */\nexport interface IAccountSignResponse {\n  /** Public key of the account */\n  publicKey: string;\n  /** Signed message data */\n  signature: string;\n}\n\n/**\n * Output produced by the sign() method.\n */\nexport interface IAccountSignOutput {\n  /** Public key of the account */\n  publicKey: string;\n  /** Base58 encoded representation of the signed data */\n  base58Encoded: string;\n}\n"]}

package/dist/cmd/account/IAccount.d.ts

@@ -2,20 +2,50 @@
 import { ITransactionDetails } from '..';
 import { IAccountBalanceResponse } from './AccountBalance';
 import { IAccountSignOutput } from './AccountSign';
-import { Args } from '@massalabs/web3-utils';
+import { Args, IContractReadOperationResponse } from '@massalabs/web3-utils';
 /**
- * This interface represents an Account object.
- *
+ * Defines the expected structure for an account.
  */
 export interface IAccount {
+    /** Retrieves the account's address. */
     address(): string;
+    /** Retrieves the account's name. */
     name(): string;
+    /** Retrieves the provider's name associated with the account. */
     providerName(): string;
+    /** Initiates a balance retrieval request for the account. */
     balance(): Promise<IAccountBalanceResponse>;
+    /**
+     * Signs data.
+     * @param data - Data to be signed (Buffer, Uint8Array, or string).
+     */
     sign(data: Buffer | Uint8Array | string): Promise<IAccountSignOutput>;
+    /**
+     * Purchases rolls.
+     * @param amount - Amount of rolls.
+     * @param fee - Fee.
+     */
     buyRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;
-    sellRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;
+    /**
+     * Sends a transaction.
+     *
+     * @param amount - Amount to send.
+     * @param recipientAddress - Address of the recipient.
+     * @param fee - Transaction fee.
+     * @returns A promise resolving to an `ITransactionDetails` object.
+     */
     sendTransaction(amount: bigint, recipientAddress: string, fee: bigint): Promise<ITransactionDetails>;
-    callSC(contractAddress: string, functionName: string, parameter: Uint8Array | Args, amount: bigint, fee: bigint, maxGas: bigint, nonPersistentExecution?: boolean): any;
+    /**
+     * Calls a smart contract.
+     *
+     * @param contractAddress - Address of the smart contract.
+     * @param functionName - Name of the function to call.
+     * @param parameter - Parameters to pass to the function.
+     * @param amount - Amount of funds to send with the call.
+     * @param fee - Fee for the transaction.
+     * @param maxGas - Maximum gas to use for the transaction.
+     * @param nonPersistentExecution - Optional flag for non-persistent execution.
+     */
+    callSC(contractAddress: string, functionName: string, parameter: Uint8Array | Args, amount: bigint, fee: bigint, maxGas: bigint, nonPersistentExecution?: boolean): Promise<ITransactionDetails | IContractReadOperationResponse>;
 }
 //# sourceMappingURL=IAccount.d.ts.map

package/dist/cmd/account/IAccount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccount.d.ts","sourceRoot":"","sources":["../../../src/account/IAccount.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,IAAI,MAAM,CAAC;IAClB,IAAI,IAAI,MAAM,CAAC;IACf,YAAY,IAAI,MAAM,CAAC;IACvB,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC5C,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACpE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACrE,eAAe,CACb,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM,EACxB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,UAAU,GAAG,IAAI,EAC5B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,sBAAsB,CAAC,EAAE,OAAO,OAChC;CACH"}
+{"version":3,"file":"IAccount.d.ts","sourceRoot":"","sources":["../../../src/account/IAccount.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,uCAAuC;IACvC,OAAO,IAAI,MAAM,CAAC;IAElB,oCAAoC;IACpC,IAAI,IAAI,MAAM,CAAC;IAEf,iEAAiE;IACjE,YAAY,IAAI,MAAM,CAAC;IAEvB,6DAA6D;IAC7D,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE5C;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEtE;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEpE;;;;;;;OAOG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM,EACxB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,UAAU,GAAG,IAAI,EAC5B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,sBAAsB,CAAC,EAAE,OAAO,GAC/B,OAAO,CAAC,mBAAmB,GAAG,8BAA8B,CAAC,CAAC;CAClE"}

package/dist/cmd/account/IAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccount.js","sourceRoot":"","sources":["../../../src/account/IAccount.ts"],"names":[],"mappings":"","sourcesContent":["import { ITransactionDetails } from '..';\nimport { IAccountBalanceResponse } from './AccountBalance';\nimport { IAccountSignOutput } from './AccountSign';\nimport { Args } from '@massalabs/web3-utils';\n\n/**\n * This interface represents an Account object.\n *\n */\nexport interface IAccount {\n  address(): string;\n  name(): string;\n  providerName(): string;\n  balance(): Promise<IAccountBalanceResponse>;\n  sign(data: Buffer | Uint8Array | string): Promise<IAccountSignOutput>;\n  buyRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;\n  sellRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;\n  sendTransaction(\n    amount: bigint,\n    recipientAddress: string,\n    fee: bigint,\n  ): Promise<ITransactionDetails>;\n  callSC(\n    contractAddress: string,\n    functionName: string,\n    parameter: Uint8Array | Args,\n    amount: bigint,\n    fee: bigint,\n    maxGas: bigint,\n    nonPersistentExecution?: boolean,\n  );\n}\n"]}
+{"version":3,"file":"IAccount.js","sourceRoot":"","sources":["../../../src/account/IAccount.ts"],"names":[],"mappings":"","sourcesContent":["import { ITransactionDetails } from '..';\nimport { IAccountBalanceResponse } from './AccountBalance';\nimport { IAccountSignOutput } from './AccountSign';\nimport { Args, IContractReadOperationResponse } from '@massalabs/web3-utils';\n\n/**\n * Defines the expected structure for an account.\n */\nexport interface IAccount {\n  /** Retrieves the account's address. */\n  address(): string;\n\n  /** Retrieves the account's name. */\n  name(): string;\n\n  /** Retrieves the provider's name associated with the account. */\n  providerName(): string;\n\n  /** Initiates a balance retrieval request for the account. */\n  balance(): Promise<IAccountBalanceResponse>;\n\n  /**\n   * Signs data.\n   * @param data - Data to be signed (Buffer, Uint8Array, or string).\n   */\n  sign(data: Buffer | Uint8Array | string): Promise<IAccountSignOutput>;\n\n  /**\n   * Purchases rolls.\n   * @param amount - Amount of rolls.\n   * @param fee - Fee.\n   */\n  buyRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;\n\n  /**\n   * Sends a transaction.\n   *\n   * @param amount - Amount to send.\n   * @param recipientAddress - Address of the recipient.\n   * @param fee - Transaction fee.\n   * @returns A promise resolving to an `ITransactionDetails` object.\n   */\n  sendTransaction(\n    amount: bigint,\n    recipientAddress: string,\n    fee: bigint,\n  ): Promise<ITransactionDetails>;\n\n  /**\n   * Calls a smart contract.\n   *\n   * @param contractAddress - Address of the smart contract.\n   * @param functionName - Name of the function to call.\n   * @param parameter - Parameters to pass to the function.\n   * @param amount - Amount of funds to send with the call.\n   * @param fee - Fee for the transaction.\n   * @param maxGas - Maximum gas to use for the transaction.\n   * @param nonPersistentExecution - Optional flag for non-persistent execution.\n   */\n  callSC(\n    contractAddress: string,\n    functionName: string,\n    parameter: Uint8Array | Args,\n    amount: bigint,\n    fee: bigint,\n    maxGas: bigint,\n    nonPersistentExecution?: boolean,\n  ): Promise<ITransactionDetails | IContractReadOperationResponse>;\n}\n"]}

package/dist/cmd/account/IAccountCallSCRequest.d.ts

@@ -1,25 +1,24 @@
 import { Args } from '@massalabs/web3-utils';
 /**
- * This interface represents the request object to send to the content script to
- * interact with a deployed smart contract.
+ * Interface for requests to interact with deployed smart contracts via content script.
  *
  * @remarks
- * - If your smart contract function does not require any parameters, you can pass an empty array.
- *
- * @see nickname - The nickname of the account to use.
- * @see name - The name of the function to be called.
- * @see at - The address of the smart contract.
- * @see args - The parameters as an Args object to be passed to the function.
- * @see coins - The amount of MASSA coins to be sent to the block creator.
- * @see dryRun - The parameters for the dry run.
+ * Pass an empty array if the smart contract function doesn't require parameters.
  */
 export interface IAccountCallSCRequest {
+    /** Account nickname to use */
     nickname: string;
+    /** Function name to call */
     name: string;
+    /** Deployed smart contract address */
     at: string;
+    /** Parameters to pass to the function, as an `Args` object */
     args: Args;
+    /** Amount of MASSA coins sent to the block creator */
     coins: bigint;
+    /** Transaction fee */
     fee: bigint;
+    /** Flag for non-persistent execution */
     nonPersistentExecution: boolean;
 }
 //# sourceMappingURL=IAccountCallSCRequest.d.ts.map

package/dist/cmd/account/IAccountCallSCRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountCallSCRequest.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountCallSCRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,sBAAsB,EAAE,OAAO,CAAC;CACjC"}
+{"version":3,"file":"IAccountCallSCRequest.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountCallSCRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,8DAA8D;IAC9D,IAAI,EAAE,IAAI,CAAC;IACX,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,sBAAsB,EAAE,OAAO,CAAC;CACjC"}

package/dist/cmd/account/IAccountCallSCRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountCallSCRequest.js","sourceRoot":"","sources":["../../../src/account/IAccountCallSCRequest.ts"],"names":[],"mappings":"","sourcesContent":["import { Args } from '@massalabs/web3-utils';\n\n/**\n * This interface represents the request object to send to the content script to\n * interact with a deployed smart contract.\n *\n * @remarks\n * - If your smart contract function does not require any parameters, you can pass an empty array.\n *\n * @see nickname - The nickname of the account to use.\n * @see name - The name of the function to be called.\n * @see at - The address of the smart contract.\n * @see args - The parameters as an Args object to be passed to the function.\n * @see coins - The amount of MASSA coins to be sent to the block creator.\n * @see dryRun - The parameters for the dry run.\n */\nexport interface IAccountCallSCRequest {\n  nickname: string;\n  name: string;\n  at: string;\n  args: Args;\n  coins: bigint;\n  fee: bigint;\n  nonPersistentExecution: boolean;\n}\n"]}
+{"version":3,"file":"IAccountCallSCRequest.js","sourceRoot":"","sources":["../../../src/account/IAccountCallSCRequest.ts"],"names":[],"mappings":"","sourcesContent":["import { Args } from '@massalabs/web3-utils';\n\n/**\n * Interface for requests to interact with deployed smart contracts via content script.\n *\n * @remarks\n * Pass an empty array if the smart contract function doesn't require parameters.\n */\nexport interface IAccountCallSCRequest {\n  /** Account nickname to use */\n  nickname: string;\n  /** Function name to call */\n  name: string;\n  /** Deployed smart contract address */\n  at: string;\n  /** Parameters to pass to the function, as an `Args` object */\n  args: Args;\n  /** Amount of MASSA coins sent to the block creator */\n  coins: bigint;\n  /** Transaction fee */\n  fee: bigint;\n  /** Flag for non-persistent execution */\n  nonPersistentExecution: boolean;\n}\n"]}

package/dist/cmd/account/IAccountDetails.d.ts

@@ -1,8 +1,10 @@
 /**
- * This interface represents the account details such as name and address.
+ * Interface for account details.
  */
 export interface IAccountDetails {
+    /** Optional account name */
     name?: string;
+    /** Account address */
     address: string;
 }
 //# sourceMappingURL=IAccountDetails.d.ts.map

package/dist/cmd/account/IAccountDetails.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountDetails.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountDetails.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"IAccountDetails.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountDetails.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/cmd/account/IAccountDetails.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountDetails.js","sourceRoot":"","sources":["../../../src/account/IAccountDetails.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This interface represents the account details such as name and address.\n */\nexport interface IAccountDetails {\n  name?: string;\n  address: string;\n}\n"]}
+{"version":3,"file":"IAccountDetails.js","sourceRoot":"","sources":["../../../src/account/IAccountDetails.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Interface for account details.\n */\nexport interface IAccountDetails {\n  /** Optional account name */\n  name?: string;\n  /** Account address */\n  address: string;\n}\n"]}

package/dist/cmd/account/IAccountRolls.d.ts

@@ -1,8 +1,10 @@
 /**
- * This interface represents the request object for roll operations (buy & sell) sent to the content script.
+ * Interface for roll operation requests (buy & sell) sent to the content script.
  */
 export interface IAccountRollsRequest {
+    /** Amount of rolls involved in the operation */
     amount: string;
+    /** Fee associated with the operation */
     fee: string;
 }
 //# sourceMappingURL=IAccountRolls.d.ts.map

package/dist/cmd/account/IAccountRolls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountRolls.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountRolls.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb"}
+{"version":3,"file":"IAccountRolls.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountRolls.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/cmd/account/IAccountRolls.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountRolls.js","sourceRoot":"","sources":["../../../src/account/IAccountRolls.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This interface represents the request object for roll operations (buy & sell) sent to the content script.\n */\nexport interface IAccountRollsRequest {\n  amount: string;\n  fee: string;\n}\n"]}
+{"version":3,"file":"IAccountRolls.js","sourceRoot":"","sources":["../../../src/account/IAccountRolls.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Interface for roll operation requests (buy & sell) sent to the content script.\n */\nexport interface IAccountRollsRequest {\n  /** Amount of rolls involved in the operation */\n  amount: string;\n  /** Fee associated with the operation */\n  fee: string;\n}\n"]}

package/dist/cmd/account/IAccountSendTransaction.d.ts

@@ -1,9 +1,12 @@
 /**
- * This interface represents the request object for roll operations (buy & sell) sent to the content script.
+ * Interface for transaction send requests sent to the content script.
  */
 export interface IAccountSendTransactionRequest {
+    /** Address of the recipient */
     recipientAddress: string;
+    /** Amount to be sent */
     amount: string;
+    /** Transaction fee */
     fee: string;
 }
 //# sourceMappingURL=IAccountSendTransaction.d.ts.map

package/dist/cmd/account/IAccountSendTransaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountSendTransaction.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountSendTransaction.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb"}
+{"version":3,"file":"IAccountSendTransaction.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountSendTransaction.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,+BAA+B;IAC/B,gBAAgB,EAAE,MAAM,CAAC;IACzB,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/cmd/account/IAccountSendTransaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountSendTransaction.js","sourceRoot":"","sources":["../../../src/account/IAccountSendTransaction.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This interface represents the request object for roll operations (buy & sell) sent to the content script.\n */\nexport interface IAccountSendTransactionRequest {\n  recipientAddress: string;\n  amount: string;\n  fee: string;\n}\n"]}
+{"version":3,"file":"IAccountSendTransaction.js","sourceRoot":"","sources":["../../../src/account/IAccountSendTransaction.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Interface for transaction send requests sent to the content script.\n */\nexport interface IAccountSendTransactionRequest {\n  /** Address of the recipient */\n  recipientAddress: string;\n  /** Amount to be sent */\n  amount: string;\n  /** Transaction fee */\n  fee: string;\n}\n"]}

package/dist/esm/account/AccountBalance.d.ts

@@ -1,19 +1,17 @@
 /**
- * Represents the request for an AccountBalance command.
- *
- * address - The account address.
+ * Request for an AccountBalance command.
  */
 export interface IAccountBalanceRequest {
+    /** Account address */
     address: string;
 }
 /**
- * Represents the response from an AccountBalance command.
- *
- * finalBalance - The account's final confirmed balance.
- * candidateBalance - The account's pending balance.
+ * Response from an AccountBalance command.
  */
 export interface IAccountBalanceResponse {
+    /** Final confirmed balance of the account */
     finalBalance: string;
+    /** Pending balance of the account */
     candidateBalance: string;
 }
 //# sourceMappingURL=AccountBalance.d.ts.map

package/dist/esm/account/AccountBalance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccountBalance.d.ts","sourceRoot":"","sources":["../../../src/account/AccountBalance.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;CAC1B"}
+{"version":3,"file":"AccountBalance.d.ts","sourceRoot":"","sources":["../../../src/account/AccountBalance.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,qCAAqC;IACrC,gBAAgB,EAAE,MAAM,CAAC;CAC1B"}

package/dist/esm/account/AccountBalance.js.map

@@ -1 +1 @@
-{"version":3,"file":"AccountBalance.js","sourceRoot":"","sources":["../../../src/account/AccountBalance.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Represents the request for an AccountBalance command.\n *\n * address - The account address.\n */\nexport interface IAccountBalanceRequest {\n  address: string;\n}\n\n/**\n * Represents the response from an AccountBalance command.\n *\n * finalBalance - The account's final confirmed balance.\n * candidateBalance - The account's pending balance.\n */\nexport interface IAccountBalanceResponse {\n  finalBalance: string;\n  candidateBalance: string;\n}\n"]}
+{"version":3,"file":"AccountBalance.js","sourceRoot":"","sources":["../../../src/account/AccountBalance.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Request for an AccountBalance command.\n */\nexport interface IAccountBalanceRequest {\n  /** Account address */\n  address: string;\n}\n\n/**\n * Response from an AccountBalance command.\n */\nexport interface IAccountBalanceResponse {\n  /** Final confirmed balance of the account */\n  finalBalance: string;\n  /** Pending balance of the account */\n  candidateBalance: string;\n}\n"]}

package/dist/esm/account/AccountSign.d.ts

@@ -1,28 +1,28 @@
 /**
- * Represents the payload for a signing operation request sent to the content script.
- * address - Account's unique address.
- * data - Data to be signed, as a Uint8Array.
+ * Payload for a signing operation request sent to the content script.
  */
 export interface IAccountSignRequest {
+    /** Account's unique address */
     address: string;
+    /** Data to be signed, represented as a Uint8Array */
     data: Uint8Array;
 }
 /**
- * Represents response from the content script after a signing operation.
- * publicKey - Public key of the account.
- * signature - Signed message data.
+ * Response from the content script after a signing operation.
  */
 export interface IAccountSignResponse {
+    /** Public key of the account */
     publicKey: string;
+    /** Signed message data */
     signature: string;
 }
 /**
- * Represents the output produced by the sign() method.
- * publicKey - Public key of the account.
- * base58Encoded - Base58 encoded representation of the signed data.
+ * Output produced by the sign() method.
  */
 export interface IAccountSignOutput {
+    /** Public key of the account */
     publicKey: string;
+    /** Base58 encoded representation of the signed data */
     base58Encoded: string;
 }
 //# sourceMappingURL=AccountSign.d.ts.map

package/dist/esm/account/AccountSign.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccountSign.d.ts","sourceRoot":"","sources":["../../../src/account/AccountSign.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB"}
+{"version":3,"file":"AccountSign.d.ts","sourceRoot":"","sources":["../../../src/account/AccountSign.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,aAAa,EAAE,MAAM,CAAC;CACvB"}

package/dist/esm/account/AccountSign.js.map

@@ -1 +1 @@
-{"version":3,"file":"AccountSign.js","sourceRoot":"","sources":["../../../src/account/AccountSign.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Represents the payload for a signing operation request sent to the content script.\n * address - Account's unique address.\n * data - Data to be signed, as a Uint8Array.\n */\nexport interface IAccountSignRequest {\n  address: string;\n  data: Uint8Array;\n}\n\n/**\n * Represents response from the content script after a signing operation.\n * publicKey - Public key of the account.\n * signature - Signed message data.\n */\nexport interface IAccountSignResponse {\n  publicKey: string;\n  signature: string;\n}\n\n/**\n * Represents the output produced by the sign() method.\n * publicKey - Public key of the account.\n * base58Encoded - Base58 encoded representation of the signed data.\n */\nexport interface IAccountSignOutput {\n  publicKey: string;\n  base58Encoded: string;\n}\n"]}
+{"version":3,"file":"AccountSign.js","sourceRoot":"","sources":["../../../src/account/AccountSign.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Payload for a signing operation request sent to the content script.\n */\nexport interface IAccountSignRequest {\n  /** Account's unique address */\n  address: string;\n  /** Data to be signed, represented as a Uint8Array */\n  data: Uint8Array;\n}\n\n/**\n * Response from the content script after a signing operation.\n */\nexport interface IAccountSignResponse {\n  /** Public key of the account */\n  publicKey: string;\n  /** Signed message data */\n  signature: string;\n}\n\n/**\n * Output produced by the sign() method.\n */\nexport interface IAccountSignOutput {\n  /** Public key of the account */\n  publicKey: string;\n  /** Base58 encoded representation of the signed data */\n  base58Encoded: string;\n}\n"]}

package/dist/esm/account/IAccount.d.ts

@@ -2,20 +2,50 @@
 import { ITransactionDetails } from '..';
 import { IAccountBalanceResponse } from './AccountBalance';
 import { IAccountSignOutput } from './AccountSign';
-import { Args } from '@massalabs/web3-utils';
+import { Args, IContractReadOperationResponse } from '@massalabs/web3-utils';
 /**
- * This interface represents an Account object.
- *
+ * Defines the expected structure for an account.
  */
 export interface IAccount {
+    /** Retrieves the account's address. */
     address(): string;
+    /** Retrieves the account's name. */
     name(): string;
+    /** Retrieves the provider's name associated with the account. */
     providerName(): string;
+    /** Initiates a balance retrieval request for the account. */
     balance(): Promise<IAccountBalanceResponse>;
+    /**
+     * Signs data.
+     * @param data - Data to be signed (Buffer, Uint8Array, or string).
+     */
     sign(data: Buffer | Uint8Array | string): Promise<IAccountSignOutput>;
+    /**
+     * Purchases rolls.
+     * @param amount - Amount of rolls.
+     * @param fee - Fee.
+     */
     buyRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;
-    sellRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;
+    /**
+     * Sends a transaction.
+     *
+     * @param amount - Amount to send.
+     * @param recipientAddress - Address of the recipient.
+     * @param fee - Transaction fee.
+     * @returns A promise resolving to an `ITransactionDetails` object.
+     */
     sendTransaction(amount: bigint, recipientAddress: string, fee: bigint): Promise<ITransactionDetails>;
-    callSC(contractAddress: string, functionName: string, parameter: Uint8Array | Args, amount: bigint, fee: bigint, maxGas: bigint, nonPersistentExecution?: boolean): any;
+    /**
+     * Calls a smart contract.
+     *
+     * @param contractAddress - Address of the smart contract.
+     * @param functionName - Name of the function to call.
+     * @param parameter - Parameters to pass to the function.
+     * @param amount - Amount of funds to send with the call.
+     * @param fee - Fee for the transaction.
+     * @param maxGas - Maximum gas to use for the transaction.
+     * @param nonPersistentExecution - Optional flag for non-persistent execution.
+     */
+    callSC(contractAddress: string, functionName: string, parameter: Uint8Array | Args, amount: bigint, fee: bigint, maxGas: bigint, nonPersistentExecution?: boolean): Promise<ITransactionDetails | IContractReadOperationResponse>;
 }
 //# sourceMappingURL=IAccount.d.ts.map

package/dist/esm/account/IAccount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccount.d.ts","sourceRoot":"","sources":["../../../src/account/IAccount.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,OAAO,IAAI,MAAM,CAAC;IAClB,IAAI,IAAI,MAAM,CAAC;IACf,YAAY,IAAI,MAAM,CAAC;IACvB,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC5C,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACpE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACrE,eAAe,CACb,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM,EACxB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,UAAU,GAAG,IAAI,EAC5B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,sBAAsB,CAAC,EAAE,OAAO,OAChC;CACH"}
+{"version":3,"file":"IAccount.d.ts","sourceRoot":"","sources":["../../../src/account/IAccount.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,uCAAuC;IACvC,OAAO,IAAI,MAAM,CAAC;IAElB,oCAAoC;IACpC,IAAI,IAAI,MAAM,CAAC;IAEf,iEAAiE;IACjE,YAAY,IAAI,MAAM,CAAC;IAEvB,6DAA6D;IAC7D,OAAO,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAE5C;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEtE;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEpE;;;;;;;OAOG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,gBAAgB,EAAE,MAAM,EACxB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,UAAU,GAAG,IAAI,EAC5B,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,sBAAsB,CAAC,EAAE,OAAO,GAC/B,OAAO,CAAC,mBAAmB,GAAG,8BAA8B,CAAC,CAAC;CAClE"}

package/dist/esm/account/IAccount.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccount.js","sourceRoot":"","sources":["../../../src/account/IAccount.ts"],"names":[],"mappings":"","sourcesContent":["import { ITransactionDetails } from '..';\nimport { IAccountBalanceResponse } from './AccountBalance';\nimport { IAccountSignOutput } from './AccountSign';\nimport { Args } from '@massalabs/web3-utils';\n\n/**\n * This interface represents an Account object.\n *\n */\nexport interface IAccount {\n  address(): string;\n  name(): string;\n  providerName(): string;\n  balance(): Promise<IAccountBalanceResponse>;\n  sign(data: Buffer | Uint8Array | string): Promise<IAccountSignOutput>;\n  buyRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;\n  sellRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;\n  sendTransaction(\n    amount: bigint,\n    recipientAddress: string,\n    fee: bigint,\n  ): Promise<ITransactionDetails>;\n  callSC(\n    contractAddress: string,\n    functionName: string,\n    parameter: Uint8Array | Args,\n    amount: bigint,\n    fee: bigint,\n    maxGas: bigint,\n    nonPersistentExecution?: boolean,\n  );\n}\n"]}
+{"version":3,"file":"IAccount.js","sourceRoot":"","sources":["../../../src/account/IAccount.ts"],"names":[],"mappings":"","sourcesContent":["import { ITransactionDetails } from '..';\nimport { IAccountBalanceResponse } from './AccountBalance';\nimport { IAccountSignOutput } from './AccountSign';\nimport { Args, IContractReadOperationResponse } from '@massalabs/web3-utils';\n\n/**\n * Defines the expected structure for an account.\n */\nexport interface IAccount {\n  /** Retrieves the account's address. */\n  address(): string;\n\n  /** Retrieves the account's name. */\n  name(): string;\n\n  /** Retrieves the provider's name associated with the account. */\n  providerName(): string;\n\n  /** Initiates a balance retrieval request for the account. */\n  balance(): Promise<IAccountBalanceResponse>;\n\n  /**\n   * Signs data.\n   * @param data - Data to be signed (Buffer, Uint8Array, or string).\n   */\n  sign(data: Buffer | Uint8Array | string): Promise<IAccountSignOutput>;\n\n  /**\n   * Purchases rolls.\n   * @param amount - Amount of rolls.\n   * @param fee - Fee.\n   */\n  buyRolls(amount: bigint, fee: bigint): Promise<ITransactionDetails>;\n\n  /**\n   * Sends a transaction.\n   *\n   * @param amount - Amount to send.\n   * @param recipientAddress - Address of the recipient.\n   * @param fee - Transaction fee.\n   * @returns A promise resolving to an `ITransactionDetails` object.\n   */\n  sendTransaction(\n    amount: bigint,\n    recipientAddress: string,\n    fee: bigint,\n  ): Promise<ITransactionDetails>;\n\n  /**\n   * Calls a smart contract.\n   *\n   * @param contractAddress - Address of the smart contract.\n   * @param functionName - Name of the function to call.\n   * @param parameter - Parameters to pass to the function.\n   * @param amount - Amount of funds to send with the call.\n   * @param fee - Fee for the transaction.\n   * @param maxGas - Maximum gas to use for the transaction.\n   * @param nonPersistentExecution - Optional flag for non-persistent execution.\n   */\n  callSC(\n    contractAddress: string,\n    functionName: string,\n    parameter: Uint8Array | Args,\n    amount: bigint,\n    fee: bigint,\n    maxGas: bigint,\n    nonPersistentExecution?: boolean,\n  ): Promise<ITransactionDetails | IContractReadOperationResponse>;\n}\n"]}

package/dist/esm/account/IAccountCallSCRequest.d.ts

@@ -1,25 +1,24 @@
 import { Args } from '@massalabs/web3-utils';
 /**
- * This interface represents the request object to send to the content script to
- * interact with a deployed smart contract.
+ * Interface for requests to interact with deployed smart contracts via content script.
  *
  * @remarks
- * - If your smart contract function does not require any parameters, you can pass an empty array.
- *
- * @see nickname - The nickname of the account to use.
- * @see name - The name of the function to be called.
- * @see at - The address of the smart contract.
- * @see args - The parameters as an Args object to be passed to the function.
- * @see coins - The amount of MASSA coins to be sent to the block creator.
- * @see dryRun - The parameters for the dry run.
+ * Pass an empty array if the smart contract function doesn't require parameters.
  */
 export interface IAccountCallSCRequest {
+    /** Account nickname to use */
     nickname: string;
+    /** Function name to call */
     name: string;
+    /** Deployed smart contract address */
     at: string;
+    /** Parameters to pass to the function, as an `Args` object */
     args: Args;
+    /** Amount of MASSA coins sent to the block creator */
     coins: bigint;
+    /** Transaction fee */
     fee: bigint;
+    /** Flag for non-persistent execution */
     nonPersistentExecution: boolean;
 }
 //# sourceMappingURL=IAccountCallSCRequest.d.ts.map

package/dist/esm/account/IAccountCallSCRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountCallSCRequest.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountCallSCRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,sBAAsB,EAAE,OAAO,CAAC;CACjC"}
+{"version":3,"file":"IAccountCallSCRequest.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountCallSCRequest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,8DAA8D;IAC9D,IAAI,EAAE,IAAI,CAAC;IACX,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,wCAAwC;IACxC,sBAAsB,EAAE,OAAO,CAAC;CACjC"}

package/dist/esm/account/IAccountCallSCRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountCallSCRequest.js","sourceRoot":"","sources":["../../../src/account/IAccountCallSCRequest.ts"],"names":[],"mappings":"","sourcesContent":["import { Args } from '@massalabs/web3-utils';\n\n/**\n * This interface represents the request object to send to the content script to\n * interact with a deployed smart contract.\n *\n * @remarks\n * - If your smart contract function does not require any parameters, you can pass an empty array.\n *\n * @see nickname - The nickname of the account to use.\n * @see name - The name of the function to be called.\n * @see at - The address of the smart contract.\n * @see args - The parameters as an Args object to be passed to the function.\n * @see coins - The amount of MASSA coins to be sent to the block creator.\n * @see dryRun - The parameters for the dry run.\n */\nexport interface IAccountCallSCRequest {\n  nickname: string;\n  name: string;\n  at: string;\n  args: Args;\n  coins: bigint;\n  fee: bigint;\n  nonPersistentExecution: boolean;\n}\n"]}
+{"version":3,"file":"IAccountCallSCRequest.js","sourceRoot":"","sources":["../../../src/account/IAccountCallSCRequest.ts"],"names":[],"mappings":"","sourcesContent":["import { Args } from '@massalabs/web3-utils';\n\n/**\n * Interface for requests to interact with deployed smart contracts via content script.\n *\n * @remarks\n * Pass an empty array if the smart contract function doesn't require parameters.\n */\nexport interface IAccountCallSCRequest {\n  /** Account nickname to use */\n  nickname: string;\n  /** Function name to call */\n  name: string;\n  /** Deployed smart contract address */\n  at: string;\n  /** Parameters to pass to the function, as an `Args` object */\n  args: Args;\n  /** Amount of MASSA coins sent to the block creator */\n  coins: bigint;\n  /** Transaction fee */\n  fee: bigint;\n  /** Flag for non-persistent execution */\n  nonPersistentExecution: boolean;\n}\n"]}

package/dist/esm/account/IAccountDetails.d.ts

@@ -1,8 +1,10 @@
 /**
- * This interface represents the account details such as name and address.
+ * Interface for account details.
  */
 export interface IAccountDetails {
+    /** Optional account name */
     name?: string;
+    /** Account address */
     address: string;
 }
 //# sourceMappingURL=IAccountDetails.d.ts.map

package/dist/esm/account/IAccountDetails.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountDetails.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountDetails.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"IAccountDetails.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountDetails.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/esm/account/IAccountDetails.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountDetails.js","sourceRoot":"","sources":["../../../src/account/IAccountDetails.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This interface represents the account details such as name and address.\n */\nexport interface IAccountDetails {\n  name?: string;\n  address: string;\n}\n"]}
+{"version":3,"file":"IAccountDetails.js","sourceRoot":"","sources":["../../../src/account/IAccountDetails.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Interface for account details.\n */\nexport interface IAccountDetails {\n  /** Optional account name */\n  name?: string;\n  /** Account address */\n  address: string;\n}\n"]}

package/dist/esm/account/IAccountRolls.d.ts

@@ -1,8 +1,10 @@
 /**
- * This interface represents the request object for roll operations (buy & sell) sent to the content script.
+ * Interface for roll operation requests (buy & sell) sent to the content script.
  */
 export interface IAccountRollsRequest {
+    /** Amount of rolls involved in the operation */
     amount: string;
+    /** Fee associated with the operation */
     fee: string;
 }
 //# sourceMappingURL=IAccountRolls.d.ts.map

package/dist/esm/account/IAccountRolls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountRolls.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountRolls.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb"}
+{"version":3,"file":"IAccountRolls.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountRolls.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/esm/account/IAccountRolls.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountRolls.js","sourceRoot":"","sources":["../../../src/account/IAccountRolls.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This interface represents the request object for roll operations (buy & sell) sent to the content script.\n */\nexport interface IAccountRollsRequest {\n  amount: string;\n  fee: string;\n}\n"]}
+{"version":3,"file":"IAccountRolls.js","sourceRoot":"","sources":["../../../src/account/IAccountRolls.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Interface for roll operation requests (buy & sell) sent to the content script.\n */\nexport interface IAccountRollsRequest {\n  /** Amount of rolls involved in the operation */\n  amount: string;\n  /** Fee associated with the operation */\n  fee: string;\n}\n"]}

package/dist/esm/account/IAccountSendTransaction.d.ts

@@ -1,9 +1,12 @@
 /**
- * This interface represents the request object for roll operations (buy & sell) sent to the content script.
+ * Interface for transaction send requests sent to the content script.
  */
 export interface IAccountSendTransactionRequest {
+    /** Address of the recipient */
     recipientAddress: string;
+    /** Amount to be sent */
     amount: string;
+    /** Transaction fee */
     fee: string;
 }
 //# sourceMappingURL=IAccountSendTransaction.d.ts.map

package/dist/esm/account/IAccountSendTransaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountSendTransaction.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountSendTransaction.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb"}
+{"version":3,"file":"IAccountSendTransaction.d.ts","sourceRoot":"","sources":["../../../src/account/IAccountSendTransaction.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,+BAA+B;IAC/B,gBAAgB,EAAE,MAAM,CAAC;IACzB,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB;IACtB,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/esm/account/IAccountSendTransaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAccountSendTransaction.js","sourceRoot":"","sources":["../../../src/account/IAccountSendTransaction.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This interface represents the request object for roll operations (buy & sell) sent to the content script.\n */\nexport interface IAccountSendTransactionRequest {\n  recipientAddress: string;\n  amount: string;\n  fee: string;\n}\n"]}
+{"version":3,"file":"IAccountSendTransaction.js","sourceRoot":"","sources":["../../../src/account/IAccountSendTransaction.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Interface for transaction send requests sent to the content script.\n */\nexport interface IAccountSendTransactionRequest {\n  /** Address of the recipient */\n  recipientAddress: string;\n  /** Amount to be sent */\n  amount: string;\n  /** Transaction fee */\n  fee: string;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@massalabs/wallet-provider",
-    "version": "1.4.2-dev.20230929102824",
+    "version": "1.4.2-dev.20230929135423",
     "description": "massa's wallet provider",
     "main": "dist/esm/index.js",
     "module": "dist/esm/index.js",