zano_web3 2.2.0 → 2.4.0

package/README.md

@@ -1,97 +1,121 @@
-
-# ZanoWallet
-
-`zano_web3` is a TypeScript library for interacting with the ZanoWallet extension in the browser. It allows you to connect to a user's ZanoWallet, handle authentication, and manage wallet credentials.
-
-## Features
-
-- **Easy Integration**: Simplifies the process of connecting to the ZanoWallet extension.
-- **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.
-
-## Installation
-
-To install `zano_web3`, use npm or yarn:
-
-```bash
-npm install zano_web3
-```
-
-or
-
-```bash
-yarn add zano_web3
-```
-
-## Usage
-
-### Importing the Library
-
-```typescript
-import ZanoWallet from 'zano_web3';
-```
-
-### Creating a ZanoWallet Instance
-
-To create a `ZanoWallet` instance, you need to provide configuration options via the `ZanoWalletParams` interface.
-
-```typescript
-const zanoWallet = new ZanoWallet({
-    authPath: '/api/auth', // Custom server path for authentication
-    useLocalStorage: true, // Store wallet credentials in local storage (default: true)
-    aliasRequired: false,  // Whether an alias is required (optional)
-    customLocalStorageKey: 'myWalletKey', // Custom key for local storage (optional)
-    customNonce: 'customNonceValue', // Custom nonce for signing (optional)
-    disableServerRequest: false, // Disable server request after signing (optional)
-
-    onConnectStart: () => {
-        console.log('Connecting to ZanoWallet...');
-    },
-    onConnectEnd: (data) => {
-        console.log('Connected:', data);
-    },
-    onConnectError: (error) => {
-        console.error('Connection error:', error);
-    },
-    beforeConnect: async () => {
-        console.log('Preparing to connect...');
-    },
-    onLocalConnectEnd: (data) => {
-        console.log('Local connection established:', data);
-    }
-});
-```
-
-### Connecting to ZanoWallet
-
-To initiate the connection process, call the `connect` method:
-
-```typescript
-await zanoWallet.connect();
-```
-
-### Handling Wallet Credentials
-
-You can manually manage wallet credentials using `getSavedWalletCredentials` and `setWalletCredentials` methods:
-
-```typescript
-const credentials = zanoWallet.getSavedWalletCredentials();
-if (credentials) {
-    console.log('Stored credentials:', credentials);
-}
-
-zanoWallet.setWalletCredentials({
-    nonce: 'newNonce',
-    signature: 'newSignature',
-    publicKey: 'newPublicKey'
-});
-```
-
-## Requirements
-
-- ZanoWallet browser extension must be installed.
-
-## Contributing
-
-If you find any issues or want to contribute, please create a pull request or submit an issue.
+
+# ZanoWallet
+
+`zano_web3` is a TypeScript library for interacting with the ZanoWallet extension in the browser. It allows you to connect to a user's ZanoWallet, handle authentication, and manage wallet credentials.
+
+## Features
+
+- **Easy Integration**: Simplifies the process of connecting to the ZanoWallet extension.
+- **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.
+
+## Installation
+
+To install `zano_web3`, use npm or yarn:
+
+```bash
+npm install zano_web3
+```
+
+or
+
+```bash
+yarn add zano_web3
+```
+
+## Usage
+
+### Importing the Library
+
+```typescript
+import ZanoWallet from 'zano_web3';
+```
+
+### Creating a ZanoWallet Instance
+
+To create a `ZanoWallet` instance, you need to provide configuration options via the `ZanoWalletParams` interface.
+
+```typescript
+const zanoWallet = new ZanoWallet({
+    authPath: '/api/auth', // Custom server path for authentication
+    useLocalStorage: true, // Store wallet credentials in local storage (default: true)
+    aliasRequired: false,  // Whether an alias is required (optional)
+    customLocalStorageKey: 'myWalletKey', // Custom key for local storage (optional)
+    customNonce: 'customNonceValue', // Custom nonce for signing (optional)
+    disableServerRequest: false, // Disable server request after signing (optional)
+
+    onConnectStart: () => {
+        console.log('Connecting to ZanoWallet...');
+    },
+    onConnectEnd: (data) => {
+        console.log('Connected:', data);
+    },
+    onConnectError: (error) => {
+        console.error('Connection error:', error);
+    },
+    beforeConnect: async () => {
+        console.log('Preparing to connect...');
+    },
+    onLocalConnectEnd: (data) => {
+        console.log('Local connection established:', data);
+    }
+});
+```
+
+### Connecting to ZanoWallet
+
+To initiate the connection process, call the `connect` method:
+
+```typescript
+await zanoWallet.connect();
+```
+
+### Handling Wallet Credentials
+
+You can manually manage wallet credentials using `getSavedWalletCredentials` and `setWalletCredentials` methods:
+
+```typescript
+const credentials = zanoWallet.getSavedWalletCredentials();
+if (credentials) {
+    console.log('Stored credentials:', credentials);
+}
+
+zanoWallet.setWalletCredentials({
+    nonce: 'newNonce',
+    signature: 'newSignature',
+    publicKey: 'newPublicKey'
+});
+```
+
+## Using the `useZanoWallet` Hook
+
+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.
+
+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.
+
+To use the `useZanoWallet` hook, you can import it from the `zano_web3` library and call it within a functional component:
+
+```typescript
+import { useZanoWallet } from 'zano_web3';
+
+function MyComponent() {
+    
+    const wallet = useZanoWallet({
+        // same params as for new ZanoWallet
+    });
+
+    return (
+       <div>Your component...</div>
+    );
+}
+```
+
+
+## Requirements
+
+- ZanoWallet browser extension must be installed.
+
+## Contributing
+
+If you find any issues or want to contribute, please create a pull request or submit an issue.

package/index.ts

@@ -3,4 +3,7 @@ import zanoWallet from "./src/zanoWallet";
 import {useZanoWallet} from "./src/hooks";
 export {useZanoWallet};
 
+import validateWallet from "./src/server";
+export {validateWallet};
+
 export default zanoWallet;

package/package.json

@@ -1,36 +1,38 @@
-{
-  "name": "zano_web3",
-  "version": "2.2.0",
-  "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/jejolare/zano_web3.git"
-  },
-  "keywords": [
-    "zano",
-    "web3",
-    "crypto",
-    "blockchain",
-    "wallet"
-  ],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/react": "^18.3.3",
-    "@types/uuid": "^10.0.0",
-    "typescript": "^5.5.4"
-  },
-  "dependencies": {
-    "react": "^18.3.1",
-    "uuid": "^10.0.0"
-  },
-  "bugs": {
-    "url": "https://github.com/jejolare/zano_web3/issues"
-  },
-  "homepage": "https://github.com/jejolare/zano_web3#readme"
-}
+{
+  "name": "zano_web3",
+  "version": "2.4.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hyle-team/zano_web3.git"
+  },
+  "keywords": [
+    "zano",
+    "web3",
+    "crypto",
+    "blockchain",
+    "wallet"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^20.14.12",
+    "@types/react": "^18.3.3",
+    "@types/uuid": "^10.0.0",
+    "typescript": "^5.5.4"
+  },
+  "dependencies": {
+    "axios": "^1.7.2",
+    "react": "^18.3.1",
+    "uuid": "^10.0.0"
+  },
+  "bugs": {
+    "url": "https://github.com/hyle-team/zano_web3/issues"
+  },
+  "homepage": "https://github.com/hyle-team/zano_web3#readme"
+}

package/src/server.ts

@@ -0,0 +1,94 @@
+import axios from 'axios';
+
+interface BaseAuthData {
+    address: string;
+    signature: string;
+    message: string;
+}
+
+interface AliasAuth extends BaseAuthData {
+    alias: string;
+}
+
+interface PkeyAuth extends BaseAuthData {
+    pkey: string;
+}
+
+type AuthData = AliasAuth | PkeyAuth;
+
+
+interface ValidationParams {
+    buff: string;
+    sig: string;
+    alias?: string;
+    pkey?: string;
+}
+
+
+async function validateWallet(rpcUrl: string, authData: AuthData) {
+
+    async function fetchZanoApi(method: string, params: any) {
+        return await axios.post(
+            'http://195.201.107.230:33340/json_rpc', 
+            {
+                "id": 0,
+                "jsonrpc": "2.0",
+                "method": method,
+                "params": params,
+            }
+        ).then(res => res.data);    
+    }
+
+    const { message, address, signature } = authData;
+
+    const alias = (authData as AliasAuth).alias || undefined;
+    const pkey = (authData as PkeyAuth).pkey || undefined;
+
+    if (!message || (!alias && !pkey) || !signature) {
+        return false;
+    }
+
+    const validationParams: ValidationParams = {
+        "buff": Buffer.from(message).toString("base64"),
+        "sig": signature
+    };
+
+    if (alias) {
+        validationParams['alias'] = alias;
+    } else {
+        validationParams['pkey'] = pkey;
+    }
+
+    const response = await fetchZanoApi(
+        'validate_signature', 
+        validationParams
+    );
+
+    const valid = response?.result?.status === 'OK';
+
+    if (!valid) {
+        return false;
+    }
+
+    if (alias) {
+        const aliasDetailsResponse = await fetchZanoApi(
+            'get_alias_details', 
+            {
+                "alias": alias,
+            }
+        );
+    
+        const aliasDetails = aliasDetailsResponse?.result?.alias_details;
+        const aliasAddress = aliasDetails?.address;
+    
+        const addressValid = !!aliasAddress && aliasAddress === address;
+
+        if (!addressValid) {
+            return false;
+        }
+    }
+
+    return valid;
+}
+
+export default validateWallet;

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-import zanoWallet from "./src/zanoWallet";
-import { useZanoWallet } from "./src/hooks";
-export { useZanoWallet };
-export default zanoWallet;

package/dist/index.js

@@ -1,10 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useZanoWallet = void 0;
-const zanoWallet_1 = __importDefault(require("./src/zanoWallet"));
-const hooks_1 = require("./src/hooks");
-Object.defineProperty(exports, "useZanoWallet", { enumerable: true, get: function () { return hooks_1.useZanoWallet; } });
-exports.default = zanoWallet_1.default;

package/dist/src/hooks.d.ts

@@ -1,3 +0,0 @@
-import ZanoWallet, { ZanoWalletParams } from './zanoWallet';
-declare function useZanoWallet(params: ZanoWalletParams): ZanoWallet | null;
-export { useZanoWallet };

package/dist/src/hooks.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useZanoWallet = useZanoWallet;
-const zanoWallet_1 = __importDefault(require("./zanoWallet"));
-const react_1 = require("react");
-function useZanoWallet(params) {
-    const [zanoWallet, setZanoWallet] = (0, react_1.useState)(null);
-    (0, react_1.useEffect)(() => {
-        if (typeof window === 'undefined') {
-            return;
-        }
-        setZanoWallet(new zanoWallet_1.default(params));
-    }, []);
-    return zanoWallet;
-}

package/dist/src/zanoWallet.d.ts

@@ -1,31 +0,0 @@
-export interface ZanoWalletParams {
-    authPath: string;
-    useLocalStorage?: boolean;
-    aliasRequired?: boolean;
-    customLocalStorageKey?: string;
-    customNonce?: string;
-    customServerPath?: string;
-    disableServerRequest?: boolean;
-    onConnectStart?: (...params: any) => any;
-    onConnectEnd?: (...params: any) => any;
-    onConnectError?: (...params: any) => any;
-    beforeConnect?: (...params: any) => any;
-    onLocalConnectEnd?: (...params: any) => any;
-}
-interface WalletCredentials {
-    nonce: string;
-    signature: string;
-    publicKey: string;
-}
-declare class ZanoWallet {
-    private DEFAULT_LOCAL_STORAGE_KEY;
-    private localStorageKey;
-    private params;
-    private zanoWallet;
-    constructor(params: ZanoWalletParams);
-    private handleError;
-    getSavedWalletCredentials(): WalletCredentials | undefined;
-    setWalletCredentials(credentials: WalletCredentials | undefined): void;
-    connect(): Promise<void>;
-}
-export default ZanoWallet;

package/dist/src/zanoWallet.js

@@ -1,133 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const uuid_1 = require("uuid");
-class ZanoWallet {
-    constructor(params) {
-        this.DEFAULT_LOCAL_STORAGE_KEY = "wallet";
-        if (typeof window === 'undefined') {
-            throw new Error('ZanoWallet can only be used in the browser');
-        }
-        if (!window.zano) {
-            throw new Error('ZanoWallet requires the ZanoWallet extension to be installed');
-        }
-        this.params = params;
-        this.zanoWallet = window.zano;
-        this.localStorageKey = params.customLocalStorageKey || this.DEFAULT_LOCAL_STORAGE_KEY;
-    }
-    handleError({ message }) {
-        if (this.params.onConnectError) {
-            this.params.onConnectError(message);
-        }
-        else {
-            console.error(message);
-        }
-    }
-    getSavedWalletCredentials() {
-        const savedWallet = localStorage.getItem(this.localStorageKey);
-        if (!savedWallet)
-            return undefined;
-        try {
-            return JSON.parse(savedWallet);
-        }
-        catch (_a) {
-            return undefined;
-        }
-    }
-    setWalletCredentials(credentials) {
-        if (credentials) {
-            localStorage.setItem(this.localStorageKey, JSON.stringify(credentials));
-        }
-        else {
-            localStorage.removeItem(this.localStorageKey);
-        }
-    }
-    connect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            if (this.params.beforeConnect) {
-                yield this.params.beforeConnect();
-            }
-            if (this.params.onConnectStart) {
-                this.params.onConnectStart();
-            }
-            const walletData = (yield window.zano.request('GET_WALLET_DATA')).data;
-            if (!(walletData === null || walletData === void 0 ? void 0 : walletData.address)) {
-                return this.handleError({ message: 'Companion is offline' });
-            }
-            if (!(walletData === null || walletData === void 0 ? void 0 : walletData.alias) && this.params.aliasRequired) {
-                return this.handleError({ message: 'Alias not found' });
-            }
-            let nonce = "";
-            let signature = "";
-            let publicKey = "";
-            const existingWallet = this.params.useLocalStorage ? this.getSavedWalletCredentials() : undefined;
-            if (existingWallet) {
-                nonce = existingWallet.nonce;
-                signature = existingWallet.signature;
-                publicKey = existingWallet.publicKey;
-            }
-            else {
-                const generatedNonce = this.params.customNonce || (0, uuid_1.v4)();
-                const signResult = yield this.zanoWallet.request('REQUEST_MESSAGE_SIGN', {
-                    message: generatedNonce
-                }, null);
-                if (!((_a = signResult === null || signResult === void 0 ? void 0 : signResult.data) === null || _a === void 0 ? void 0 : _a.result)) {
-                    return this.handleError({ message: 'Failed to sign message' });
-                }
-                nonce = generatedNonce;
-                signature = signResult.data.result.sig;
-                publicKey = signResult.data.result.pkey;
-            }
-            const serverData = {
-                alias: walletData.alias,
-                address: walletData.address,
-                signature,
-                publicKey,
-                message: nonce,
-                isSavedData: !!existingWallet
-            };
-            if (this.params.onLocalConnectEnd) {
-                this.params.onLocalConnectEnd(serverData);
-            }
-            if (!this.params.disableServerRequest) {
-                const result = yield fetch(this.params.customServerPath || "/api/auth", {
-                    method: "POST",
-                    headers: {
-                        "Content-Type": "application/json",
-                    },
-                    body: JSON.stringify({
-                        data: serverData
-                    })
-                })
-                    .then(res => res.json())
-                    .catch((e) => ({
-                    success: false,
-                    error: e.message
-                }));
-                if (!(result === null || result === void 0 ? void 0 : result.success) || !(result === null || result === void 0 ? void 0 : result.data)) {
-                    return this.handleError({ message: result.error });
-                }
-                if (!existingWallet && this.params.useLocalStorage) {
-                    this.setWalletCredentials({
-                        publicKey,
-                        signature,
-                        nonce
-                    });
-                }
-                if (this.params.onConnectEnd) {
-                    this.params.onConnectEnd(Object.assign(Object.assign({}, serverData), { token: result.data.token }));
-                }
-            }
-        });
-    }
-}
-exports.default = ZanoWallet;