zano_web3 4.6.0 → 4.7.0

package/README.md

@@ -9,6 +9,7 @@
 - **Local Storage Support**: Optionally store wallet credentials in local storage.
 - **Customizable**: Offers hooks for various connection lifecycle events.
 - **Error Handling**: Provides a structured way to handle errors during the connection process.
+- **Alias Management**: Allows retrieving and creating aliases.
 
 ## Installation
 
@@ -88,26 +89,78 @@ zanoWallet.setWalletCredentials({
 });
 ```
 
-## Using the `useZanoWallet` Hook
+### Retrieving Wallet Data
 
-The `useZanoWallet` hook is a custom React hook provided by the `zano_web3` library. It simplifies the process of interacting with the ZanoWallet extension in a React application.
+You can retrieve the wallet data using the `getWallet` method:
 
-This hook is designed to handle server-side rendering (SSR) limitations by ensuring that it only runs on the client-side. This means that any code using the `useZanoWallet` hook will not be executed during server-side rendering, but will work as expected once the application is running in the browser.
+```typescript
+const wallet = await zanoWallet.getWallet();
+console.log('Wallet data:', wallet);
+```
+
+### Getting Address by Alias
 
-To use the `useZanoWallet` hook, you can import it from the `zano_web3` library and call it within a functional component:
+To get an address by alias, use the `getAddressByAlias` method:
 
 ```typescript
-import { useZanoWallet } from 'zano_web3';
+const address = await zanoWallet.getAddressByAlias('exampleAlias');
+console.log('Address:', address);
+```
+
+### Creating an Alias
+
+To create a new alias, use the `createAlias` method:
+
+```typescript
+const newAliasData = await zanoWallet.createAlias('newAlias');
+console.log('Alias created:', newAliasData);
+```
+
+
+## Exported Types
 
-function MyComponent() {
-    
-    const wallet = useZanoWallet({
-        // same params as for new ZanoWallet
-    });
+The following TypeScript interfaces are exported by the `zano_web3` library.
+You can import them directly from library:
+
+```typescript
+import { Wallet, Asset, Transfer, Transaction } from 'zano_web3';
+```
+
+```typescript
+export interface Asset {
+    name: string;
+    ticker: string;
+    assetId: string;
+    decimalPoint: number;
+    balance: string;
+    unlockedBalance: string;
+}
+
+export interface Transfer {
+    amount: string;
+    assetId: string;
+    incoming: boolean;
+}
+
+export interface Transaction {
+    isConfirmed: boolean;
+    txHash: string;
+    blobSize: number;
+    timestamp: number;
+    height: number;
+    paymentId: string;
+    comment: string;
+    fee: string;
+    isInitiator: boolean;
+    transfers: Transfer[];
+}
 
-    return (
-       <div>Your component...</div>
-    );
+export interface Wallet {
+    address: string;
+    alias: string;
+    balance: string;
+    assets: Asset[];
+    transactions: Transaction[];
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zano_web3",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",