zano_web3 2.1.0 → 2.3.0

package/README.md

@@ -88,6 +88,30 @@ zanoWallet.setWalletCredentials({
 });
 ```
 
+## 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.

package/dist/index.d.ts

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

package/dist/index.js

@@ -3,5 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-var zanoWallet_1 = __importDefault(require("./src/zanoWallet"));
+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

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

package/dist/src/hooks.js

@@ -0,0 +1,18 @@
+"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,4 +1,4 @@
-interface ZanoWalletParams {
+export interface ZanoWalletParams {
     authPath: string;
     useLocalStorage?: boolean;
     aliasRequired?: boolean;

package/dist/src/zanoWallet.js

@@ -1,15 +1,4 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 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) {
@@ -19,37 +8,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var uuid_1 = require("uuid");
-var ZanoWallet = /** @class */ (function () {
-    function ZanoWallet(params) {
+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');
@@ -61,17 +23,16 @@ var ZanoWallet = /** @class */ (function () {
         this.zanoWallet = window.zano;
         this.localStorageKey = params.customLocalStorageKey || this.DEFAULT_LOCAL_STORAGE_KEY;
     }
-    ZanoWallet.prototype.handleError = function (_a) {
-        var message = _a.message;
+    handleError({ message }) {
         if (this.params.onConnectError) {
             this.params.onConnectError(message);
         }
         else {
             console.error(message);
         }
-    };
-    ZanoWallet.prototype.getSavedWalletCredentials = function () {
-        var savedWallet = localStorage.getItem(this.localStorageKey);
+    }
+    getSavedWalletCredentials() {
+        const savedWallet = localStorage.getItem(this.localStorageKey);
         if (!savedWallet)
             return undefined;
         try {
@@ -80,111 +41,93 @@ var ZanoWallet = /** @class */ (function () {
         catch (_a) {
             return undefined;
         }
-    };
-    ZanoWallet.prototype.setWalletCredentials = function (credentials) {
+    }
+    setWalletCredentials(credentials) {
         if (credentials) {
             localStorage.setItem(this.localStorageKey, JSON.stringify(credentials));
         }
         else {
             localStorage.removeItem(this.localStorageKey);
         }
-    };
-    ZanoWallet.prototype.connect = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var walletData, nonce, signature, publicKey, existingWallet, generatedNonce, signResult, serverData, result;
+    }
+    connect() {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        if (!this.params.beforeConnect) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.params.beforeConnect()];
-                    case 1:
-                        _b.sent();
-                        _b.label = 2;
-                    case 2:
-                        if (this.params.onConnectStart) {
-                            this.params.onConnectStart();
-                        }
-                        return [4 /*yield*/, window.zano.request('GET_WALLET_DATA')];
-                    case 3:
-                        walletData = (_b.sent()).data;
-                        if (!(walletData === null || walletData === void 0 ? void 0 : walletData.address)) {
-                            return [2 /*return*/, this.handleError({ message: 'Companion is offline' })];
-                        }
-                        if (!(walletData === null || walletData === void 0 ? void 0 : walletData.alias) && this.params.aliasRequired) {
-                            return [2 /*return*/, this.handleError({ message: 'Alias not found' })];
-                        }
-                        nonce = "";
-                        signature = "";
-                        publicKey = "";
-                        existingWallet = this.params.useLocalStorage ? this.getSavedWalletCredentials() : undefined;
-                        if (!existingWallet) return [3 /*break*/, 4];
-                        nonce = existingWallet.nonce;
-                        signature = existingWallet.signature;
-                        publicKey = existingWallet.publicKey;
-                        return [3 /*break*/, 6];
-                    case 4:
-                        generatedNonce = this.params.customNonce || (0, uuid_1.v4)();
-                        return [4 /*yield*/, this.zanoWallet.request('REQUEST_MESSAGE_SIGN', {
-                                message: generatedNonce
-                            }, null)];
-                    case 5:
-                        signResult = _b.sent();
-                        if (!((_a = signResult === null || signResult === void 0 ? void 0 : signResult.data) === null || _a === void 0 ? void 0 : _a.result)) {
-                            return [2 /*return*/, this.handleError({ message: 'Failed to sign message' })];
-                        }
-                        nonce = generatedNonce;
-                        signature = signResult.data.result.sig;
-                        publicKey = signResult.data.result.pkey;
-                        _b.label = 6;
-                    case 6:
-                        serverData = {
-                            alias: walletData.alias,
-                            address: walletData.address,
-                            signature: signature,
-                            publicKey: publicKey,
-                            message: nonce,
-                            isSavedData: !!existingWallet
-                        };
-                        if (this.params.onLocalConnectEnd) {
-                            this.params.onLocalConnectEnd(serverData);
-                        }
-                        if (!!this.params.disableServerRequest) return [3 /*break*/, 8];
-                        return [4 /*yield*/, fetch(this.params.customServerPath || "/api/auth", {
-                                method: "POST",
-                                headers: {
-                                    "Content-Type": "application/json",
-                                },
-                                body: JSON.stringify({
-                                    data: serverData
-                                })
-                            })
-                                .then(function (res) { return res.json(); })
-                                .catch(function (e) { return ({
-                                success: false,
-                                error: e.message
-                            }); })];
-                    case 7:
-                        result = _b.sent();
-                        if (!(result === null || result === void 0 ? void 0 : result.success) || !(result === null || result === void 0 ? void 0 : result.data)) {
-                            return [2 /*return*/, this.handleError({ message: result.error })];
-                        }
-                        if (!existingWallet && this.params.useLocalStorage) {
-                            this.setWalletCredentials({
-                                publicKey: publicKey,
-                                signature: signature,
-                                nonce: nonce
-                            });
-                        }
-                        if (this.params.onConnectEnd) {
-                            this.params.onConnectEnd(__assign(__assign({}, serverData), { token: result.data.token }));
-                        }
-                        _b.label = 8;
-                    case 8: return [2 /*return*/];
+            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 }));
                 }
-            });
+            }
         });
-    };
-    return ZanoWallet;
-}());
+    }
+}
 exports.default = ZanoWallet;

package/package.json

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

package/tsconfig.json

@@ -1,11 +1,12 @@
 {
   "compilerOptions": {
-    "target": "ES5",                          
-    "module": "CommonJS",                     
-    "declaration": true,                     
-    "outDir": "./dist",                      
-    "strict": true,                          
-    "esModuleInterop": true                  
+    "target": "ES6", 
+    "module": "CommonJS",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "lib": ["ES6", "DOM"]
   },
   "include": ["src/**/*", "index.ts"]
-}
+}