@onekeyfe/onekey-scdo-provider 2.1.0

package/LICENSE.md

@@ -0,0 +1,51 @@
+# ONEKEY STANDARD SOURCE LICENSE (O-SSL)
+
+This license governs use of the accompanying software. If you use the software,
+you accept this license. If you do not accept the license, do not use the
+software.
+
+## 1. Definitions
+
+The terms "reproduce," "reproduction" and "distribution" have the same meaning
+here as under Hong Kong copyright law.
+
+"You" means the licensee of the software.
+
+"Your company" means the company you worked for when you downloaded the
+software.
+
+"Reference use" means use of the software within your company as a reference,
+in read only form, for the sole purposes of debugging your products,
+maintaining your products, or enhancing the interoperability of your products
+with the software, and specifically excludes the right to distribute the
+software outside of your company.
+
+"Licensed patents" means any Licensor patent claims which read directly on the
+software as distributed by the Licensor under this license.
+
+## 2. Grant of Rights
+
+(A) Copyright Grant - Subject to the terms of this license, the Licensor grants
+you a non-transferable, non-exclusive, worldwide, royalty-free copyright
+license to reproduce the software for reference use.
+
+(B) Patent Grant - Subject to the terms of this license, the Licensor grants
+you a non-transferable, non-exclusive, worldwide, royalty-free patent license
+under licensed patents for reference use.
+
+## 3. Limitations
+
+(A) No Trademark License - This license does not grant you any rights to use
+the Licensor's name, logo, or trademarks.
+
+(B) If you begin patent litigation against the Licensor over patents that you
+think may apply to the software (including a cross-claim or counterclaim in
+a lawsuit), your license to the software ends automatically.
+
+(C) The software is licensed "as-is." You bear the risk of using it. The
+Licensor gives no express warranties, guarantees or conditions. You may have
+additional consumer rights under your local laws which this license cannot
+change. To the extent permitted under your local laws, the Licensor excludes
+the implied warranties of merchantability, fitness for a particular purpose and
+non-infringement.This license agreement is governed by the laws of Hong Kong, 
+and any disputes related to this license agreement shall be resolved in accordance with Hong Kong law.

package/README.md

@@ -0,0 +1 @@
+# cross-inpage-provider

package/dist/OnekeyScdoProvider.d.ts

@@ -0,0 +1,109 @@
+import type { IInpageProviderConfig } from '@onekeyfe/cross-inpage-provider-core';
+import { ProviderScdoBase } from './ProviderScdoBase';
+import type { IJsonRpcRequest } from '@onekeyfe/cross-inpage-provider-types';
+export declare enum PROVIDER_EVENTS {
+    accountsChanged = "accountsChanged",
+    disconnect = "disconnect",
+    message_low_level = "message_low_level"
+}
+type ScdoProviderEventsMap = {
+    [PROVIDER_EVENTS.accountsChanged]: (accounts: string[]) => void;
+    [PROVIDER_EVENTS.disconnect]: () => void;
+    [PROVIDER_EVENTS.message_low_level]: (payload: IJsonRpcRequest) => void;
+};
+export declare enum ScdoRequestMethods {
+    scdo_requestAccounts = "scdo_requestAccounts",
+    scdo_disconnect = "scdo_disconnect",
+    scdo_getAccounts = "scdo_getAccounts",
+    scdo_getBalance = "scdo_getBalance",
+    scdo_signTransaction = "scdo_signTransaction",
+    scdo_estimateGas = "scdo_estimateGas",
+    scdo_sendTransaction = "scdo_sendTransaction"
+}
+export interface Tx {
+    from: string;
+    to: string;
+    amount?: number;
+    accountNonce?: number;
+    gasPrice?: number;
+    gasLimit?: number;
+    timestamp?: number;
+    payload?: string;
+    hash?: string;
+    signature?: {
+        Sig: string;
+    };
+}
+export interface RawTransaction {
+    Type: number;
+    From: string;
+    To: string;
+    Amount: number;
+    AccountNonce: number;
+    GasPrice: number;
+    GasLimit: number;
+    Timestamp: number;
+    Payload: string;
+}
+export interface SignedTx {
+    Data: RawTransaction;
+    Hash: string;
+    Signature: {
+        Sig: string;
+    };
+}
+type ScdoRequest = {
+    [ScdoRequestMethods.scdo_requestAccounts]: () => string[];
+    [ScdoRequestMethods.scdo_disconnect]: () => void;
+    [ScdoRequestMethods.scdo_getAccounts]: () => string[];
+    [ScdoRequestMethods.scdo_getBalance]: (address: string, blockHash?: string, blockHeight?: number) => string;
+    [ScdoRequestMethods.scdo_signTransaction]: (tx: Tx) => SignedTx;
+    [ScdoRequestMethods.scdo_estimateGas]: (tx: Tx) => string;
+    [ScdoRequestMethods.scdo_sendTransaction]: (tx: Tx) => SignedTx;
+};
+type ScdoRequestParams = Parameters<ScdoRequest[ScdoRequestMethods]>;
+type ScdoRequestResponse = ReturnType<ScdoRequest[ScdoRequestMethods]>;
+interface ScdoRequestProps {
+    method: ScdoRequestMethods;
+    params: ScdoRequestParams;
+}
+export type IProviderScdo = {
+    on: <E extends keyof ScdoProviderEventsMap>(event: E, cb: ScdoProviderEventsMap[E]) => void;
+    removeListener: <E extends keyof ScdoProviderEventsMap>(event: E, cb: ScdoProviderEventsMap[E]) => void;
+    request: (props: ScdoRequestProps) => Promise<ScdoRequestResponse>;
+};
+export type OneKeyScdoProviderProps = IInpageProviderConfig & {
+    timeout?: number;
+};
+export declare class ProviderScdo extends ProviderScdoBase implements IProviderScdo {
+    private _account?;
+    accounts: string[];
+    constructor(props: OneKeyScdoProviderProps);
+    private _registerEvents;
+    private _callBridge;
+    private _handleDisconnected;
+    isAccountsChanged(account: string | undefined): boolean;
+    private _handleAccountChange;
+    on<E extends keyof ScdoProviderEventsMap>(event: E, listener: ScdoProviderEventsMap[E]): this;
+    emit<E extends keyof ScdoProviderEventsMap>(event: E, ...args: Parameters<ScdoProviderEventsMap[E]>): boolean;
+    removeListener<E extends keyof ScdoProviderEventsMap>(eventName: E, listener: ScdoProviderEventsMap[E]): this;
+    private _transformTx;
+    request(props: ScdoRequestProps): Promise<string | void | string[] | {
+        Data: {
+            Type: number;
+            From: string;
+            To: string;
+            Amount: number;
+            AccountNonce: number;
+            GasPrice: number;
+            GasLimit: number;
+            Timestamp: number;
+            Payload: string;
+        };
+        Hash: string;
+        Signature: {
+            Sig: string;
+        };
+    }>;
+}
+export {};

package/dist/OnekeyScdoProvider.js

@@ -0,0 +1,131 @@
+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());
+    });
+};
+import { getOrCreateExtInjectedJsBridge } from '@onekeyfe/extension-bridge-injected';
+import { ProviderScdoBase } from './ProviderScdoBase';
+export var PROVIDER_EVENTS;
+(function (PROVIDER_EVENTS) {
+    PROVIDER_EVENTS["accountsChanged"] = "accountsChanged";
+    PROVIDER_EVENTS["disconnect"] = "disconnect";
+    PROVIDER_EVENTS["message_low_level"] = "message_low_level";
+})(PROVIDER_EVENTS || (PROVIDER_EVENTS = {}));
+export var ScdoRequestMethods;
+(function (ScdoRequestMethods) {
+    ScdoRequestMethods["scdo_requestAccounts"] = "scdo_requestAccounts";
+    ScdoRequestMethods["scdo_disconnect"] = "scdo_disconnect";
+    ScdoRequestMethods["scdo_getAccounts"] = "scdo_getAccounts";
+    ScdoRequestMethods["scdo_getBalance"] = "scdo_getBalance";
+    ScdoRequestMethods["scdo_signTransaction"] = "scdo_signTransaction";
+    ScdoRequestMethods["scdo_estimateGas"] = "scdo_estimateGas";
+    ScdoRequestMethods["scdo_sendTransaction"] = "scdo_sendTransaction";
+})(ScdoRequestMethods || (ScdoRequestMethods = {}));
+function isWalletEventMethodMatch({ method, name }) {
+    return method === `wallet_events_${name}`;
+}
+export class ProviderScdo extends ProviderScdoBase {
+    constructor(props) {
+        super(Object.assign(Object.assign({}, props), { bridge: props.bridge || getOrCreateExtInjectedJsBridge({ timeout: props.timeout }) }));
+        this.accounts = [];
+        this._registerEvents();
+    }
+    _registerEvents() {
+        window.addEventListener('onekey_bridge_disconnect', () => {
+            this._handleDisconnected();
+        });
+        this.on(PROVIDER_EVENTS.message_low_level, (payload) => {
+            if (!payload)
+                return;
+            const { method, params } = payload;
+            if (isWalletEventMethodMatch({ method, name: PROVIDER_EVENTS.accountsChanged })) {
+                this._handleAccountChange(params);
+            }
+        });
+    }
+    _callBridge(params) {
+        return this.bridgeRequest(params);
+    }
+    _handleDisconnected(options = { emit: true }) {
+        this._account = undefined;
+        if (options.emit && this.isConnectionStatusChanged('disconnected')) {
+            this.connectionStatus = 'disconnected';
+            this.emit(PROVIDER_EVENTS.disconnect);
+        }
+    }
+    isAccountsChanged(account) {
+        if (!account)
+            return false;
+        if (!this._account)
+            return true;
+        return account !== this._account;
+    }
+    // trigger by bridge account change event
+    _handleAccountChange(payload) {
+        const account = payload;
+        if (this.isAccountsChanged(account) && account) {
+            this.emit(PROVIDER_EVENTS.accountsChanged, [account]);
+        }
+        if (!account) {
+            this._handleDisconnected();
+            return;
+        }
+    }
+    on(event, listener) {
+        return super.on(event, listener);
+    }
+    emit(event, ...args) {
+        return super.emit(event, ...args);
+    }
+    removeListener(eventName, listener) {
+        return super.removeListener(eventName, listener);
+    }
+    _transformTx(tx) {
+        var _a, _b, _c, _d, _e, _f;
+        return {
+            Type: 0,
+            From: tx.from,
+            To: tx.to,
+            Amount: (_a = tx.amount) !== null && _a !== void 0 ? _a : 0,
+            AccountNonce: (_b = tx.accountNonce) !== null && _b !== void 0 ? _b : 0,
+            GasPrice: (_c = tx.gasPrice) !== null && _c !== void 0 ? _c : 1,
+            GasLimit: (_d = tx.gasLimit) !== null && _d !== void 0 ? _d : 0,
+            Timestamp: (_e = tx.timestamp) !== null && _e !== void 0 ? _e : 0,
+            Payload: (_f = tx.payload) !== null && _f !== void 0 ? _f : '',
+        };
+    }
+    request(props) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const reqParams = props.params;
+            let params;
+            if (props.method === ScdoRequestMethods.scdo_estimateGas) {
+                const tx = reqParams[0];
+                params = [{
+                        Data: this._transformTx(tx),
+                        Hash: (_a = tx.hash) !== null && _a !== void 0 ? _a : '',
+                        Signature: (_b = tx.signature) !== null && _b !== void 0 ? _b : { Sig: '' },
+                    }];
+            }
+            else if (props.method === ScdoRequestMethods.scdo_signTransaction || props.method === ScdoRequestMethods.scdo_sendTransaction) {
+                params = [this._transformTx(props.params[0])];
+            }
+            else {
+                params = reqParams;
+            }
+            const res = yield this._callBridge({
+                method: props.method,
+                params,
+            });
+            if (props.method === ScdoRequestMethods.scdo_getAccounts) {
+                this.accounts.length = 0;
+                this.accounts.push(...res);
+            }
+            return res;
+        });
+    }
+}

package/dist/ProviderScdoBase.d.ts

@@ -0,0 +1,8 @@
+import { IInjectedProviderNames } from '@onekeyfe/cross-inpage-provider-types';
+import { ProviderBase, IInpageProviderConfig } from '@onekeyfe/cross-inpage-provider-core';
+declare class ProviderScdoBase extends ProviderBase {
+    constructor(props: IInpageProviderConfig);
+    protected providerName: IInjectedProviderNames;
+    request(data: unknown): Promise<unknown>;
+}
+export { ProviderScdoBase };

package/dist/ProviderScdoBase.js

@@ -0,0 +1,12 @@
+import { IInjectedProviderNames } from '@onekeyfe/cross-inpage-provider-types';
+import { ProviderBase } from '@onekeyfe/cross-inpage-provider-core';
+class ProviderScdoBase extends ProviderBase {
+    constructor(props) {
+        super(props);
+        this.providerName = IInjectedProviderNames.scdo;
+    }
+    request(data) {
+        return this.bridgeRequest(data);
+    }
+}
+export { ProviderScdoBase };

package/dist/cjs/OnekeyScdoProvider.js

@@ -0,0 +1,135 @@
+"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 });
+exports.ProviderScdo = exports.ScdoRequestMethods = exports.PROVIDER_EVENTS = void 0;
+const extension_bridge_injected_1 = require("@onekeyfe/extension-bridge-injected");
+const ProviderScdoBase_1 = require("./ProviderScdoBase");
+var PROVIDER_EVENTS;
+(function (PROVIDER_EVENTS) {
+    PROVIDER_EVENTS["accountsChanged"] = "accountsChanged";
+    PROVIDER_EVENTS["disconnect"] = "disconnect";
+    PROVIDER_EVENTS["message_low_level"] = "message_low_level";
+})(PROVIDER_EVENTS = exports.PROVIDER_EVENTS || (exports.PROVIDER_EVENTS = {}));
+var ScdoRequestMethods;
+(function (ScdoRequestMethods) {
+    ScdoRequestMethods["scdo_requestAccounts"] = "scdo_requestAccounts";
+    ScdoRequestMethods["scdo_disconnect"] = "scdo_disconnect";
+    ScdoRequestMethods["scdo_getAccounts"] = "scdo_getAccounts";
+    ScdoRequestMethods["scdo_getBalance"] = "scdo_getBalance";
+    ScdoRequestMethods["scdo_signTransaction"] = "scdo_signTransaction";
+    ScdoRequestMethods["scdo_estimateGas"] = "scdo_estimateGas";
+    ScdoRequestMethods["scdo_sendTransaction"] = "scdo_sendTransaction";
+})(ScdoRequestMethods = exports.ScdoRequestMethods || (exports.ScdoRequestMethods = {}));
+function isWalletEventMethodMatch({ method, name }) {
+    return method === `wallet_events_${name}`;
+}
+class ProviderScdo extends ProviderScdoBase_1.ProviderScdoBase {
+    constructor(props) {
+        super(Object.assign(Object.assign({}, props), { bridge: props.bridge || (0, extension_bridge_injected_1.getOrCreateExtInjectedJsBridge)({ timeout: props.timeout }) }));
+        this.accounts = [];
+        this._registerEvents();
+    }
+    _registerEvents() {
+        window.addEventListener('onekey_bridge_disconnect', () => {
+            this._handleDisconnected();
+        });
+        this.on(PROVIDER_EVENTS.message_low_level, (payload) => {
+            if (!payload)
+                return;
+            const { method, params } = payload;
+            if (isWalletEventMethodMatch({ method, name: PROVIDER_EVENTS.accountsChanged })) {
+                this._handleAccountChange(params);
+            }
+        });
+    }
+    _callBridge(params) {
+        return this.bridgeRequest(params);
+    }
+    _handleDisconnected(options = { emit: true }) {
+        this._account = undefined;
+        if (options.emit && this.isConnectionStatusChanged('disconnected')) {
+            this.connectionStatus = 'disconnected';
+            this.emit(PROVIDER_EVENTS.disconnect);
+        }
+    }
+    isAccountsChanged(account) {
+        if (!account)
+            return false;
+        if (!this._account)
+            return true;
+        return account !== this._account;
+    }
+    // trigger by bridge account change event
+    _handleAccountChange(payload) {
+        const account = payload;
+        if (this.isAccountsChanged(account) && account) {
+            this.emit(PROVIDER_EVENTS.accountsChanged, [account]);
+        }
+        if (!account) {
+            this._handleDisconnected();
+            return;
+        }
+    }
+    on(event, listener) {
+        return super.on(event, listener);
+    }
+    emit(event, ...args) {
+        return super.emit(event, ...args);
+    }
+    removeListener(eventName, listener) {
+        return super.removeListener(eventName, listener);
+    }
+    _transformTx(tx) {
+        var _a, _b, _c, _d, _e, _f;
+        return {
+            Type: 0,
+            From: tx.from,
+            To: tx.to,
+            Amount: (_a = tx.amount) !== null && _a !== void 0 ? _a : 0,
+            AccountNonce: (_b = tx.accountNonce) !== null && _b !== void 0 ? _b : 0,
+            GasPrice: (_c = tx.gasPrice) !== null && _c !== void 0 ? _c : 1,
+            GasLimit: (_d = tx.gasLimit) !== null && _d !== void 0 ? _d : 0,
+            Timestamp: (_e = tx.timestamp) !== null && _e !== void 0 ? _e : 0,
+            Payload: (_f = tx.payload) !== null && _f !== void 0 ? _f : '',
+        };
+    }
+    request(props) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const reqParams = props.params;
+            let params;
+            if (props.method === ScdoRequestMethods.scdo_estimateGas) {
+                const tx = reqParams[0];
+                params = [{
+                        Data: this._transformTx(tx),
+                        Hash: (_a = tx.hash) !== null && _a !== void 0 ? _a : '',
+                        Signature: (_b = tx.signature) !== null && _b !== void 0 ? _b : { Sig: '' },
+                    }];
+            }
+            else if (props.method === ScdoRequestMethods.scdo_signTransaction || props.method === ScdoRequestMethods.scdo_sendTransaction) {
+                params = [this._transformTx(props.params[0])];
+            }
+            else {
+                params = reqParams;
+            }
+            const res = yield this._callBridge({
+                method: props.method,
+                params,
+            });
+            if (props.method === ScdoRequestMethods.scdo_getAccounts) {
+                this.accounts.length = 0;
+                this.accounts.push(...res);
+            }
+            return res;
+        });
+    }
+}
+exports.ProviderScdo = ProviderScdo;

package/dist/cjs/ProviderScdoBase.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProviderScdoBase = void 0;
+const cross_inpage_provider_types_1 = require("@onekeyfe/cross-inpage-provider-types");
+const cross_inpage_provider_core_1 = require("@onekeyfe/cross-inpage-provider-core");
+class ProviderScdoBase extends cross_inpage_provider_core_1.ProviderBase {
+    constructor(props) {
+        super(props);
+        this.providerName = cross_inpage_provider_types_1.IInjectedProviderNames.scdo;
+    }
+    request(data) {
+        return this.bridgeRequest(data);
+    }
+}
+exports.ProviderScdoBase = ProviderScdoBase;

package/dist/cjs/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./OnekeyScdoProvider"), exports);

package/dist/cjs/type-utils.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './OnekeyScdoProvider';

package/dist/index.js

@@ -0,0 +1 @@
+export * from './OnekeyScdoProvider';

package/dist/type-utils.d.ts

@@ -0,0 +1,4 @@
+export type WireStringified<T> = T extends Array<infer P> ? Array<WireStringified<P>> : T extends object ? {
+    [K in keyof T]: WireStringified<T[K]>;
+} : T;
+export type ResolvePromise<T> = T extends Promise<infer P> ? P : T;

package/dist/type-utils.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@onekeyfe/onekey-scdo-provider",
+  "version": "2.1.0",
+  "keywords": [
+    "cross-inpage-provider"
+  ],
+  "author": "dev-fe@onekey.so",
+  "repository": "https://github.com/OneKeyHQ/cross-inpage-provider",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "files": [
+    "dist/*"
+  ],
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "require": "./dist/cjs/index.js"
+  },
+  "types": "./dist/index.d.ts",
+  "module": "./dist/index.js",
+  "main": "./dist/cjs/index.js",
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "tsc && tsc --project tsconfig.cjs.json",
+    "start": "tsc --watch"
+  },
+  "dependencies": {
+    "@onekeyfe/cross-inpage-provider-core": "2.1.0",
+    "@onekeyfe/cross-inpage-provider-errors": "2.1.0",
+    "@onekeyfe/cross-inpage-provider-types": "2.1.0",
+    "@onekeyfe/extension-bridge-injected": "2.1.0"
+  },
+  "gitHead": "6c27b10b87edbd6d6c839566276c7f6f9cb4940c"
+}