@onekeyfe/hd-transport-http 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+# @onekeyfe/hd-transport-http
+
+使用 http 协议与固件通信

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_URL = "http://localhost:21320";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,2BAA2B,CAAC"}

package/dist/http.d.ts

@@ -0,0 +1,7 @@
+export declare type HttpRequestOptions = {
+    body?: Array<any> | Record<string, unknown> | string;
+    url: string;
+    method: 'POST' | 'GET';
+};
+export declare function request(options: HttpRequestOptions): Promise<any>;
+//# sourceMappingURL=http.d.ts.map

package/dist/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B,IAAI,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;CACxB,CAAC;AAwBF,wBAAsB,OAAO,CAAC,OAAO,EAAE,kBAAkB,gBAsBxD"}

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import * as _onekeyfe_hd_transport from '@onekeyfe/hd-transport';
+import _onekeyfe_hd_transport__default, { OneKeyDeviceInfoWithSession, AcquireInput } from '@onekeyfe/hd-transport';
+
+declare type IncompleteRequestOptions = {
+    body?: Array<any> | Record<string, unknown> | string;
+    url: string;
+};
+declare class HttpTransport {
+    _messages: ReturnType<typeof _onekeyfe_hd_transport__default.parseConfigure> | undefined;
+    configured: boolean;
+    stopped: boolean;
+    url: string;
+    constructor(url?: string);
+    _post(options: IncompleteRequestOptions): Promise<any>;
+    init(): Promise<string>;
+    _silentInit(): Promise<string>;
+    configure(signedData: any): void;
+    listen(old?: Array<OneKeyDeviceInfoWithSession>): Promise<OneKeyDeviceInfoWithSession[]>;
+    enumerate(): Promise<OneKeyDeviceInfoWithSession[]>;
+    _acquireMixed(input: AcquireInput): Promise<any>;
+    acquire(input: AcquireInput): Promise<string>;
+    release(session: string, onclose: boolean): Promise<void>;
+    call(session: string, name: string, data: Record<string, unknown>): Promise<_onekeyfe_hd_transport.MessageFromOneKey>;
+    post(session: string, name: string, data: Record<string, unknown>): Promise<void>;
+    read(session: string): Promise<_onekeyfe_hd_transport.MessageFromOneKey>;
+    requestDevice(): Promise<never>;
+    stop(): void;
+}
+
+export { HttpTransport as default };

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAMxF,aAAK,wBAAwB,GAAG;IAC9B,IAAI,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;IACrD,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,SAAS,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IAEnE,UAAU,UAAS;IAEnB,OAAO,UAAS;IAEhB,GAAG,EAAE,MAAM,CAAC;gBAEA,GAAG,CAAC,EAAE,MAAM;IAIxB,KAAK,CAAC,OAAO,EAAE,wBAAwB;IAYjC,IAAI;IAKJ,WAAW;IASjB,SAAS,CAAC,UAAU,EAAE,GAAG;IAMnB,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC;IAY/C,SAAS;IAMf,aAAa,CAAC,KAAK,EAAE,YAAY;IAO3B,OAAO,CAAC,KAAK,EAAE,YAAY;IAK3B,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAUzC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IA4BjE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAYjE,IAAI,CAAC,OAAO,EAAE,MAAM;IAe1B,aAAa;IAKb,IAAI;CAGL"}

package/dist/index.js

@@ -0,0 +1,216 @@
+'use strict';
+
+var transport = require('@onekeyfe/hd-transport');
+var axios = require('axios');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var transport__default = /*#__PURE__*/_interopDefaultLegacy(transport);
+var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(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());
+    });
+}
+
+function contentType(body) {
+    if (typeof body === 'string') {
+        return 'text/plain';
+    }
+    return 'application/json';
+}
+function wrapBody(body) {
+    if (typeof body === 'string') {
+        return body;
+    }
+    return JSON.stringify(body);
+}
+function parseResult(text) {
+    try {
+        return JSON.parse(text);
+    }
+    catch (e) {
+        return text;
+    }
+}
+function request(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fetchOptions = {
+            url: options.url,
+            method: options.method,
+            data: wrapBody(options.body),
+            withCredentials: false,
+            headers: {
+                'Content-Type': contentType(options.body == null ? '' : options.body),
+            },
+        };
+        const res = yield axios__default["default"].request(fetchOptions);
+        if (+res.status === 200) {
+            return parseResult(res.data);
+        }
+        const resJson = parseResult(res.data);
+        if (typeof resJson === 'object' && resJson != null && resJson.error != null) {
+            throw new Error(resJson.error);
+        }
+        else {
+            throw new Error(res.data);
+        }
+    });
+}
+
+const DEFAULT_URL = 'http://localhost:21320';
+
+const { check, buildOne, receiveOne, parseConfigure } = transport__default["default"];
+class HttpTransport {
+    constructor(url) {
+        this.configured = false;
+        this.stopped = false;
+        this.url = url == null ? DEFAULT_URL : url;
+    }
+    _post(options) {
+        if (this.stopped) {
+            return Promise.reject('Transport stopped.');
+        }
+        return request(Object.assign(Object.assign({}, options), { method: 'POST', url: this.url + options.url }));
+    }
+    init() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bridgeVersion = yield this._silentInit();
+            return bridgeVersion;
+        });
+    }
+    _silentInit() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const infoS = yield request({
+                url: this.url,
+                method: 'POST',
+            });
+            const info = check.info(infoS);
+            return info.version;
+        });
+    }
+    configure(signedData) {
+        const messages = parseConfigure(signedData);
+        this.configured = true;
+        this._messages = messages;
+    }
+    listen(old) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (old === null) {
+                throw new Error('Http-Transport does not support listen without previous.');
+            }
+            const devicesS = yield this._post({
+                url: '/listen',
+                body: old,
+            });
+            const devices = check.devices(devicesS);
+            return devices;
+        });
+    }
+    enumerate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const devicesS = yield this._post({ url: '/enumerate' });
+            const devices = check.devices(devicesS);
+            return devices;
+        });
+    }
+    _acquireMixed(input) {
+        const previousStr = input.previous == null ? 'null' : input.previous;
+        const url = `/acquire/${input.path}/${previousStr}`;
+        return this._post({ url });
+    }
+    acquire(input) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const acquireS = yield this._acquireMixed(input);
+            return check.acquire(acquireS);
+        });
+    }
+    release(session, onclose) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = this._post({
+                url: `/release/${session}`,
+            });
+            if (onclose) {
+                return;
+            }
+            yield res;
+        });
+    }
+    call(session, name, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._messages == null) {
+                throw new Error('Transport not configured.');
+            }
+            const messages = this._messages;
+            console.log('transport-http', 'call-', 'messages: ', messages, ' name: ', name, ' data: ', data);
+            const o = buildOne(messages, name, data);
+            const outData = o.toString('hex');
+            const resData = yield this._post({
+                url: `/call/${session}`,
+                body: outData,
+            });
+            if (typeof resData !== 'string') {
+                throw new Error('Returning data is not string.');
+            }
+            const jsonData = receiveOne(messages, resData);
+            return check.call(jsonData);
+        });
+    }
+    post(session, name, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._messages == null) {
+                throw new Error('Transport not configured.');
+            }
+            const messages = this._messages;
+            const outData = buildOne(messages, name, data).toString('hex');
+            yield this._post({
+                url: `/post/${session}`,
+                body: outData,
+            });
+        });
+    }
+    read(session) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._messages == null) {
+                throw new Error('Transport not configured.');
+            }
+            const messages = this._messages;
+            const resData = yield this._post({
+                url: `/read/${session}`,
+            });
+            if (typeof resData !== 'string') {
+                throw new Error('Returning data is not string.');
+            }
+            const jsonData = receiveOne(messages, resData);
+            return check.call(jsonData);
+        });
+    }
+    requestDevice() {
+        return Promise.reject();
+    }
+    stop() {
+        this.stopped = true;
+    }
+}
+
+module.exports = HttpTransport;

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@onekeyfe/hd-transport-http",
+  "version": "0.0.1",
+  "description": "hardware http transport",
+  "author": "OneKey",
+  "homepage": "https://github.com/OneKeyHQ/hardware-js-sdk#readme",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OneKeyHQ/hardware-js-sdk.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "echo \"Error: run tests from root\" && exit 1",
+    "build": "rimraf dist && rollup -c ../../build/rollup.config.js",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  },
+  "bugs": {
+    "url": "https://github.com/OneKeyHQ/hardware-js-sdk/issues"
+  },
+  "dependencies": {
+    "@onekeyfe/hd-transport": "^0.0.1",
+    "axios": "^0.27.2"
+  },
+  "gitHead": "20ce0ad2bd0388f9286be7b08cb76d94946a48c1"
+}

package/src/constants.ts

@@ -0,0 +1 @@
+export const DEFAULT_URL = 'http://localhost:21320';

package/src/http.ts

@@ -0,0 +1,53 @@
+import axios, { AxiosRequestConfig } from 'axios';
+
+export type HttpRequestOptions = {
+  body?: Array<any> | Record<string, unknown> | string;
+  url: string;
+  method: 'POST' | 'GET';
+};
+
+function contentType(body: any) {
+  if (typeof body === 'string') {
+    return 'text/plain';
+  }
+  return 'application/json';
+}
+
+function wrapBody(body: any) {
+  if (typeof body === 'string') {
+    return body;
+  }
+  return JSON.stringify(body);
+}
+
+function parseResult(text: string) {
+  try {
+    return JSON.parse(text);
+  } catch (e) {
+    return text;
+  }
+}
+
+export async function request(options: HttpRequestOptions) {
+  const fetchOptions: AxiosRequestConfig = {
+    url: options.url,
+    method: options.method,
+    data: wrapBody(options.body),
+    withCredentials: false,
+    headers: {
+      'Content-Type': contentType(options.body == null ? '' : options.body),
+    },
+  };
+
+  const res = await axios.request(fetchOptions);
+
+  if (+res.status === 200) {
+    return parseResult(res.data);
+  }
+  const resJson = parseResult(res.data);
+  if (typeof resJson === 'object' && resJson != null && resJson.error != null) {
+    throw new Error(resJson.error);
+  } else {
+    throw new Error(res.data);
+  }
+}

package/src/index.ts

@@ -0,0 +1,161 @@
+import transport from '@onekeyfe/hd-transport';
+import type { AcquireInput, OneKeyDeviceInfoWithSession } from '@onekeyfe/hd-transport';
+import { request as http } from './http';
+import { DEFAULT_URL } from './constants';
+
+const { check, buildOne, receiveOne, parseConfigure } = transport;
+
+type IncompleteRequestOptions = {
+  body?: Array<any> | Record<string, unknown> | string;
+  url: string;
+};
+
+export default class HttpTransport {
+  _messages: ReturnType<typeof transport.parseConfigure> | undefined;
+
+  configured = false;
+
+  stopped = false;
+
+  url: string;
+
+  constructor(url?: string) {
+    this.url = url == null ? DEFAULT_URL : url;
+  }
+
+  _post(options: IncompleteRequestOptions) {
+    if (this.stopped) {
+      // eslint-disable-next-line prefer-promise-reject-errors
+      return Promise.reject('Transport stopped.');
+    }
+    return http({
+      ...options,
+      method: 'POST',
+      url: this.url + options.url,
+    });
+  }
+
+  async init() {
+    const bridgeVersion = await this._silentInit();
+    return bridgeVersion;
+  }
+
+  async _silentInit() {
+    const infoS = await http({
+      url: this.url,
+      method: 'POST',
+    });
+    const info = check.info(infoS);
+    return info.version;
+  }
+
+  configure(signedData: any) {
+    const messages = parseConfigure(signedData);
+    this.configured = true;
+    this._messages = messages;
+  }
+
+  async listen(old?: Array<OneKeyDeviceInfoWithSession>) {
+    if (old === null) {
+      throw new Error('Http-Transport does not support listen without previous.');
+    }
+    const devicesS = await this._post({
+      url: '/listen',
+      body: old,
+    });
+    const devices = check.devices(devicesS);
+    return devices;
+  }
+
+  async enumerate() {
+    const devicesS = await this._post({ url: '/enumerate' });
+    const devices = check.devices(devicesS);
+    return devices;
+  }
+
+  _acquireMixed(input: AcquireInput) {
+    const previousStr = input.previous == null ? 'null' : input.previous;
+    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+    const url = `/acquire/${input.path}/${previousStr}`;
+    return this._post({ url });
+  }
+
+  async acquire(input: AcquireInput) {
+    const acquireS = await this._acquireMixed(input);
+    return check.acquire(acquireS);
+  }
+
+  async release(session: string, onclose: boolean) {
+    const res = this._post({
+      url: `/release/${session}`,
+    });
+    if (onclose) {
+      return;
+    }
+    await res;
+  }
+
+  async call(session: string, name: string, data: Record<string, unknown>) {
+    if (this._messages == null) {
+      throw new Error('Transport not configured.');
+    }
+    const messages = this._messages;
+    console.log(
+      'transport-http',
+      'call-',
+      'messages: ',
+      messages,
+      ' name: ',
+      name,
+      ' data: ',
+      data
+    );
+    const o = buildOne(messages, name, data);
+    const outData = o.toString('hex');
+    const resData = await this._post({
+      url: `/call/${session}`,
+      body: outData,
+    });
+    if (typeof resData !== 'string') {
+      throw new Error('Returning data is not string.');
+    }
+    const jsonData = receiveOne(messages, resData);
+    return check.call(jsonData);
+  }
+
+  async post(session: string, name: string, data: Record<string, unknown>) {
+    if (this._messages == null) {
+      throw new Error('Transport not configured.');
+    }
+    const messages = this._messages;
+    const outData = buildOne(messages, name, data).toString('hex');
+    await this._post({
+      url: `/post/${session}`,
+      body: outData,
+    });
+  }
+
+  async read(session: string) {
+    if (this._messages == null) {
+      throw new Error('Transport not configured.');
+    }
+    const messages = this._messages;
+    const resData = await this._post({
+      url: `/read/${session}`,
+    });
+    if (typeof resData !== 'string') {
+      throw new Error('Returning data is not string.');
+    }
+    const jsonData = receiveOne(messages, resData);
+    return check.call(jsonData);
+  }
+
+  requestDevice() {
+    // eslint-disable-next-line prefer-promise-reject-errors
+    return Promise.reject();
+  }
+
+  stop() {
+    this.stopped = true;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.lib.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+  },
+  "include": ["./src"]
+}