Merge pull request #2 from iamyoki/master

refactor: apply logger to console, fix #1

Author: Littleor

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

README.md

@@ -55,6 +55,8 @@ const provider = new Provider({
 });
 ```
 
+> logger可以传入null来禁用日志打印，或传入自定义的日志工具，默认为`window.console`
+
 ### UMD
 
 从 `anyweb-js-sdk` 的 `dist` 目录中进行引用 `umd` 版本.

dist/anyweb-js-sdk.umd.min.js

@@ -1,7 +1,7 @@
 {
     "name": "@idealight-labs/anyweb-js-sdk",
     "description": "AnyWeb JavaScript Software Development Kit",
-    "version": "1.2.0",
+    "version": "1.2.1",
     "license": "LGPL-3.0",
     "author": "common@idealight.ltd",
     "repository": {

dist/anyweb-js-sdk.umd.min.js.map

@@ -8,21 +8,13 @@ import { ConsoleLike } from '../utils/types';
  */
 export interface IRequestArguments {
     readonly method: string;
-    readonly params?: any;
+    readonly params?: unknown;
     readonly chainId?: number;
 }
 export interface IBaseProviderOptions {
     logger?: ConsoleLike;
     appId: string;
 }
-/**
- * Provider RPC Error
- */
-export interface IProviderRpcError extends Error {
-    message: string;
-    code: number;
-    data?: unknown;
-}
 /**
  * Base Provider
  */

dist/package.json

@@ -13,7 +13,7 @@ import { ConsoleLike } from './utils/types';
  * const provider = new Provider()
  */
 export declare class Provider implements IProvider {
-    logger: ConsoleLike;
+    logger?: ConsoleLike;
     readonly appId: string;
     private chainId;
     private static instance;

dist/src/interface/provider.d.ts

@@ -29,16 +29,13 @@ const address_1 = require("./utils/address");
  * const provider = new Provider()
  */
 class Provider {
-    constructor({ logger, appId }) {
+    constructor({ logger = console, appId }) {
         this.chainId = 1;
         this.events = {};
         if (Provider.instance) {
             return Provider.instance;
         }
         Provider.instance = this;
-        if (!logger) {
-            logger = console;
-        }
         this.logger = logger;
         this.appId = appId;
         // bind functions (to prevent consumers from making unbound calls)
@@ -52,6 +49,7 @@ class Provider {
             window.anyweb = this;
         }
         const messageHandler = (event) => {
+            var _a;
             if (event.data &&
                 (0, common_1.isObject)(event.data) &&
                 'type' in event.data &&
@@ -60,25 +58,25 @@ class Provider {
                 if (IframeData.type == 'event' &&
                     IframeData.data == 'ready' &&
                     IframeData.success) {
-                    console.debug('[AnyWeb] SDK初始化完成');
+                    (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug('[AnyWeb] SDK初始化完成');
                     Provider.ready = true;
                     this.events.onReady && this.events.onReady();
                     window.removeEventListener('message', messageHandler);
                 }
             }
         };
         window.addEventListener('message', messageHandler);
-        (0, common_1.createIframe)('pages/index/home')
+        (0, common_1.createIframe)('pages/index/home', this.logger)
             .then()
-            .catch((e) => console.error('[AnyWeb] createIframe error', e));
+            .catch((e) => { var _a; return (_a = this.logger) === null || _a === void 0 ? void 0 : _a.error('[AnyWeb] createIframe error', e); });
     }
     static getInstance(params) {
         if (!Provider.instance) {
             if (params) {
                 Provider.instance = new Provider(params);
             }
             else {
-                throw new Error('[AnyWeb] Provider is not initialized');
+                throw new common_1.ProviderRpcError(common_1.ProviderErrorCode.SDKNotReady, 'Provider is not initialized');
             }
         }
         return Provider.instance;
@@ -88,21 +86,23 @@ class Provider {
      * @param arg
      */
     send(...arg) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            console.info('[AnyWeb] `send` is deprecated, use `request` instead');
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info('[AnyWeb] `send` is deprecated, use `request` instead');
             if (arg.length > 1) {
                 return yield this.request({ method: arg[0], params: arg[1] });
             }
-            throw new Error('Invalid arguments');
+            throw new common_1.ProviderRpcError(common_1.ProviderErrorCode.ParamsError, 'Invalid arguments');
         });
     }
     /**
      * Deprecated: use `request` instead
      * @param arg
      */
     call(...arg) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            console.info('[AnyWeb] `call` is deprecated, use `request` instead', arg);
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info('[AnyWeb] `call` is deprecated, use `request` instead', arg);
             if (arg.length > 1) {
                 return yield this.request({ method: arg[0], params: arg[1] });
             }
@@ -119,17 +119,18 @@ class Provider {
      * const result = await provider.request({ method: 'cfx_sendTransaction', params})
      */
     request(args) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             if (!args || typeof args !== 'object' || Array.isArray(args)) {
-                throw new Error('Invalid request arguments');
+                throw new common_1.ProviderRpcError(common_1.ProviderErrorCode.ParamsError, 'Invalid request arguments');
             }
             const { method, params } = args;
             if (!method || method.trim().length === 0) {
-                throw new Error('Method is required');
+                throw new common_1.ProviderRpcError(common_1.ProviderErrorCode.ParamsError, 'Invalid request arguments: Method is required');
             }
-            console.debug(`[AnyWeb] request ${method} with`, params);
+            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug(`[AnyWeb] request ${method} with`, params);
             const result = yield this.rawRequest(method, params);
-            console.debug(`[AnyWeb] request(${method}):`, result);
+            (_b = this.logger) === null || _b === void 0 ? void 0 : _b.debug(`[AnyWeb] request(${method}):`, result);
             return result;
         });
     }
@@ -149,16 +150,18 @@ class Provider {
      * @param params
      * @protected
      */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     rawRequest(method, params) {
+        var _a, _b, _c, _d, _e, _f;
         return __awaiter(this, void 0, void 0, function* () {
             if (!Provider.ready) {
-                throw new Error("[AnyWeb] Provider is not ready, please use on('ready', callback) to listen to ready event");
+                throw new common_1.ProviderRpcError(common_1.ProviderErrorCode.SDKNotReady, "Provider is not ready, please use on('ready', callback) to listen to ready event");
             }
             switch (method) {
                 case 'cfx_requestAccounts':
                     return this.rawRequest('cfx_accounts');
                 case 'cfx_accounts':
-                    console.debug('[AnyWeb]', { params });
+                    (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug('[AnyWeb]', { params });
                     const scopes = params[0].scopes;
                     let result;
                     try {
@@ -170,10 +173,10 @@ class Provider {
                             scopes: scopes,
                             silence: true,
                         }, this));
-                        console.debug('[AnyWeb]', 'silent auth result', result);
+                        (_b = this.logger) === null || _b === void 0 ? void 0 : _b.debug('[AnyWeb]', 'silent auth result', result);
                     }
                     catch (e) {
-                        console.debug('[AnyWeb]', 'need to auth', e);
+                        (_c = this.logger) === null || _c === void 0 ? void 0 : _c.debug('[AnyWeb]', 'need to auth', e);
                         result = (yield (0, common_1.callIframe)('pages/dapp/auth', {
                             appId: this.appId,
                             params: params ? JSON.stringify(params[0]) : '',
@@ -208,7 +211,7 @@ class Provider {
                         const to = payload.to;
                         if (to) {
                             authType =
-                                (0, address_1.getAddressType)(to) === address_1.AddressType.CONTRACT
+                                (0, address_1.getAddressType)(to, this.logger) === address_1.AddressType.CONTRACT
                                     ? 'callContract'
                                     : 'createTransaction';
                         }
@@ -229,8 +232,7 @@ class Provider {
                         }, this);
                     }
                     catch (e) {
-                        console.error('[AnyWeb] Error to sendTransaction', e);
-                        return e;
+                        throw new common_1.ProviderRpcError(common_1.ProviderErrorCode.SendTransactionError, 'Error to sendTransaction: ' + e);
                     }
                 case 'anyweb_importAccount':
                     try {
@@ -242,8 +244,7 @@ class Provider {
                         }, this);
                     }
                     catch (e) {
-                        console.error('[AnyWeb] Error to import Address', e);
-                        return e;
+                        throw new common_1.ProviderRpcError(common_1.ProviderErrorCode.ImportAddressError, 'Error to import Address: ' + e);
                     }
                 case 'anyweb_version':
                     return package_json_1.default.version;
@@ -272,10 +273,10 @@ class Provider {
                             authType: 'check_identify',
                             silence: true,
                         }, this);
-                        console.debug('[AnyWeb]', 'Check identify result', identifyResult);
+                        (_d = this.logger) === null || _d === void 0 ? void 0 : _d.debug('[AnyWeb]', 'Check identify result', identifyResult);
                     }
                     catch (e) {
-                        console.debug('[AnyWeb]', 'need to identify', e);
+                        (_e = this.logger) === null || _e === void 0 ? void 0 : _e.debug('[AnyWeb]', 'need to identify', e);
                         identifyResult = yield (0, common_1.callIframe)('pages/user/identify', {
                             appId: this.appId,
                             chainId: this.chainId,
@@ -304,11 +305,11 @@ class Provider {
                         }, this);
                     }
                     catch (e) {
-                        console.debug('[AnyWeb]', 'need to login', e);
+                        (_f = this.logger) === null || _f === void 0 ? void 0 : _f.debug('[AnyWeb]', 'need to login', e);
                         return false;
                     }
                 default:
-                    return 'Unsupported method';
+                    throw new common_1.ProviderRpcError(common_1.ProviderErrorCode.UnsupportedMethod, 'Unsupported Method: ' + method);
             }
         });
     }
@@ -320,7 +321,8 @@ class Provider {
      * provider.on('connected', listener)
      */
     on(type, listener) {
-        console.debug('[AnyWeb] on', {
+        var _a;
+        (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug('[AnyWeb] on', {
             type,
             listener,
         });

dist/src/provider.d.ts

@@ -1,3 +1,4 @@
+import { ConsoleLike } from './types';
 export declare enum AddressType {
     USER = "user",
     CONTRACT = "contract",
@@ -8,4 +9,4 @@ export declare enum AddressType {
  * Get the type of an address.
  * @param address
  */
-export declare const getAddressType: (address: string) => AddressType;
+export declare const getAddressType: (address: string, logger?: ConsoleLike) => AddressType;

dist/src/provider.js

@@ -13,9 +13,9 @@ var AddressType;
  * Get the type of an address.
  * @param address
  */
-const getAddressType = (address) => {
+const getAddressType = (address, logger = console) => {
     const decodeResult = (0, conflux_address_js_1.decode)(address);
-    console.debug('[AnyWeb] decodeResult', decodeResult);
+    logger.debug('[AnyWeb] decodeResult', decodeResult);
     if (Object.keys(decodeResult).includes('type')) {
         return decodeResult.type;
     }