zano_web3 5.0.0 → 5.2.0

package/README.md

@@ -25,12 +25,14 @@ or
 yarn add zano_web3
 ```
 
+# WEB API (extension): 
+
 ## Usage
 
 ### Importing the Library
 
 ```typescript
-import ZanoWallet from 'zano_web3';
+import ZanoWallet from 'zano_web3/web';
 ```
 
 ### Creating a ZanoWallet Instance
@@ -164,99 +166,189 @@ export interface Wallet {
 }
 ```
 
+## Requirements
 
-## Server-Side Validator
+- ZanoWallet browser extension must be installed.
 
-The server-side validator function, `validateWallet`, is used to validate wallet authentication data using the Zano RPC API. It supports authentication using either an alias or a public key.
 
-### Usage
+# Server api (Wallet RPC, Daemon):
 
-The function `validateWallet` accepts a `rpcUrl` for the Zano node and an `AuthData` object containing the authentication details.
+#### Methods
 
-```typescript
-import validateWallet from './validateWallet';
-
-const authData = {
-    address: 'wallet_address',
-    signature: 'signed_message',
-    message: 'original_message',
-    alias: 'user_alias' // or pkey: 'public_key'
-};
-
-const rpcUrl = 'https://zano-node.example.com';
-
-validateWallet(rpcUrl, authData)
-    .then(valid => {
-        if (valid) {
-            console.log('Wallet is valid');
-        } else {
-            console.log('Invalid wallet data');
-        }
+- `updateWalletRpcUrl(rpcUrl: string)`: Updates the wallet RPC URL.
+- `updateDaemonRpcUrl(rpcUrl: string)`: Updates the daemon RPC URL.
+- `getAssetsList()`: Retrieves the list of assets.
+- `getAssetDetails(assetId: string)`: Retrieves details of a specific asset.
+- `getAssetInfo(assetId: string)`: Retrieves info of a specific asset.
+- `sendTransfer(assetId: string, address: string, amount: string)`: Sends a transfer to an address.
+- `getBalances()`: Retrieves the balances.
+- `validateWallet(rpcUrl: string, authData: AuthData)`: Validates the wallet.
+
+
+#### 1. **Updating Wallet RPC URL**
+
+```javascript
+import { ServerWallet } from "zano_web3/server";
+
+(async () => {
+    const zanoServerAPI = new ServerWallet({
+        walletUrl: "http://127.0.0.1:11211/json_rpc",
+        daemonUrl: "http://127.0.0.1:11211/json_rpc"
     });
+
+    // Update the wallet RPC URL
+    await zanoServerAPI.updateWalletRpcUrl("http://new_wallet_url:11211/json_rpc");
+
+    console.log("Wallet RPC URL updated.");
+})();
 ```
 
-### AuthData Types
+#### 2. **Updating Daemon RPC URL**
 
-The `AuthData` type is a union of `AliasAuth` and `PkeyAuth` interfaces:
+```javascript
+import { ServerWallet } from "zano_web3/server";
 
-```typescript
-interface BaseAuthData {
-    address: string;
-    signature: string;
-    message: string;
-}
+(async () => {
+    const zanoServerAPI = new ServerWallet({
+        walletUrl: "http://127.0.0.1:11211/json_rpc",
+        daemonUrl: "http://127.0.0.1:11211/json_rpc"
+    });
 
-interface AliasAuth extends BaseAuthData {
-    alias: string;
-}
+    // Update the daemon RPC URL
+    await zanoServerAPI.updateDaemonRpcUrl("http://new_daemon_url:11211/json_rpc");
 
-interface PkeyAuth extends BaseAuthData {
-    pkey: string;
-}
+    console.log("Daemon RPC URL updated.");
+})();
+```
+
+#### 3. **Getting the List of Assets**
+
+```javascript
+import { ServerWallet } from "zano_web3/server";
+
+(async () => {
+    const zanoServerAPI = new ServerWallet({
+        walletUrl: "http://127.0.0.1:11211/json_rpc",
+        daemonUrl: "http://127.0.0.1:11211/json_rpc"
+    });
+
+    // Get the list of assets
+    const assets = await zanoServerAPI.getAssetsList();
+
+    console.log("Assets List:", assets);
+})();
+```
 
-type AuthData = AliasAuth | PkeyAuth;
+#### 4. **Getting Asset Details**
+
+```javascript
+import { ServerWallet } from "zano_web3/server";
+
+(async () => {
+    const zanoServerAPI = new ServerWallet({
+        walletUrl: "http://127.0.0.1:11211/json_rpc",
+        daemonUrl: "http://127.0.0.1:11211/json_rpc"
+    });
+
+    // Get details of a specific asset by ID
+    const assetId = "example-asset-id";
+    const assetDetails = await zanoServerAPI.getAssetDetails(assetId);
+
+    console.log(`Details for Asset ID ${assetId}:`, assetDetails);
+})();
 ```
 
-### Internal Validation Logic
+#### 5. **Getting Asset Info**
 
-The `validateWallet` function internally uses the Zano RPC method `validate_signature` to verify the authenticity of the provided signature against the message. If an alias is provided, it also checks that the alias resolves to the correct wallet address.
+```javascript
+import { ServerWallet } from "zano_web3/server";
 
-### Functions
+(async () => {
+    const zanoServerAPI = new ServerWallet({
+        walletUrl: "http://127.0.0.1:11211/json_rpc",
+        daemonUrl: "http://127.0.0.1:11211/json_rpc"
+    });
 
-#### `validateWallet(rpcUrl: string, authData: AuthData)`
+    // Get info for a specific asset by ID
+    const assetId = "example-asset-id";
+    const assetInfo = await zanoServerAPI.getAssetInfo(assetId);
 
-- `rpcUrl`: The URL of the Zano RPC node.
-- `authData`: The authentication data, which includes the address, signature, message, and optionally alias or public key.
+    console.log(`Info for Asset ID ${assetId}:`, assetInfo);
+})();
+```
 
-Returns `true` if the wallet data is valid, otherwise returns `false`.
+#### 6. **Sending a Transfer**
 
-#### Example
+```javascript
+import { ServerWallet } from "zano_web3/server";
 
-```typescript
-const authData = {
-    address: 'wallet_address',
-    signature: 'signed_message',
-    message: 'original_message',
-    alias: 'user_alias' // or pkey: 'public_key'
-};
-
-const rpcUrl = 'https://zano-node.example.com';
-
-validateWallet(rpcUrl, authData)
-    .then(valid => {
-        if (valid) {
-            console.log('Wallet is valid');
-        } else {
-            console.log('Invalid wallet data');
-        }
+(async () => {
+    const zanoServerAPI = new ServerWallet({
+        walletUrl: "http://127.0.0.1:11211/json_rpc",
+        daemonUrl: "http://127.0.0.1:11211/json_rpc"
     });
+
+    // Send a transfer
+    const assetId = "example-asset-id";
+    const address = "recipient-address";
+    const amount = "10.5"; // in asset units
+
+    try {
+        const transferResult = await zanoServerAPI.sendTransfer(assetId, address, amount);
+        console.log("Transfer successful:", transferResult);
+    } catch (error) {
+        console.error("Transfer failed:", error.message);
+    }
+})();
 ```
 
+#### 7. **Getting Balances**
 
-## Requirements
+```javascript
+import { ServerWallet } from "zano_web3/server";
 
-- ZanoWallet browser extension must be installed.
+(async () => {
+    const zanoServerAPI = new ServerWallet({
+        walletUrl: "http://127.0.0.1:11211/json_rpc",
+        daemonUrl: "http://127.0.0.1:11211/json_rpc"
+    });
+
+    // Get the balances
+    const balances = await zanoServerAPI.getBalances();
+
+    console.log("Balances:", balances);
+})();
+```
+
+#### 8. **Validating a Wallet**
+
+```javascript
+import { ServerWallet } from "zano_web3/server";
+import { AuthData } from "./types";
 
-## Contributing
+(async () => {
+    const zanoServerAPI = new ServerWallet({
+        walletUrl: "http://127.0.0.1:11211/json_rpc",
+        daemonUrl: "http://127.0.0.1:11211/json_rpc"
+    });
+
+    // Validate wallet using AuthData
+    const authData: AuthData = {
+        message: "message to sign",
+        address: "wallet-address",
+        signature: "signature",
+        alias: "wallet-alias"
+    };
+
+    try {
+        const isValid = await zanoServerAPI.validateWallet("http://127.0.0.1:11211/json_rpc", authData);
+        console.log("Wallet validation:", isValid ? "Valid" : "Invalid");
+    } catch (error) {
+        console.error("Validation failed:", error.message);
+    }
+})();
+```
+
+## Requirements
 
-If you find any issues or want to contribute, please create a pull request or submit an issue.
+- Correct RPC URLs for the wallet and daemon.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zano_web3",
-  "version": "5.0.0",
+  "version": "5.2.0",
   "description": "",
   "type": "module",
   "scripts": {
@@ -23,6 +23,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@types/big.js": "^6.2.2",
     "@types/node": "^20.14.12",
     "@types/react": "^18.3.3",
     "@types/uuid": "^10.0.0",
@@ -35,8 +36,5 @@
   "bugs": {
     "url": "https://github.com/hyle-team/zano_web3/issues"
   },
-  "homepage": "https://github.com/hyle-team/zano_web3#readme",
-  "devDependencies": {
-    "@types/big.js": "^6.2.2"
-  }
+  "homepage": "https://github.com/hyle-team/zano_web3#readme"
 }