From 89dad985fbc542e75c05e3d261c02a1b12f18a9c Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Sat, 21 Mar 2020 11:07:11 +0100 Subject: [PATCH] Pull out extension-base (#271) * Create a extension-base package * Fix lint and test * Update to beta.3 * Yarn install * Update package * Fix merge errors * Remove useless single-entry folders Co-authored-by: Jaco Greeff --- jest.config.js | 2 +- packages/extension-base/LICENSE | 201 ++++++++++++++++++ packages/extension-base/README.md | 8 + packages/extension-base/package.json | 14 ++ .../src/background/RequestBytesSign.ts | 0 .../src/background/RequestExtrinsicSign.ts | 0 .../src/background/handlers/Extension.test.ts | 7 +- .../src/background/handlers/Extension.ts | 0 .../src/background/handlers/State.ts | 0 .../src/background/handlers/Tabs.ts | 0 .../src/background/handlers/index.ts | 0 .../src/background/handlers/subscriptions.ts | 0 .../src/background/types.ts | 0 .../src/defaults.ts | 0 .../src/page/Accounts.ts | 0 .../src/page/Injected.ts | 0 .../src/page/PostMessageProvider.ts | 0 .../src/page/Signer.ts | 0 .../src/page/index.ts | 37 +--- .../src/page/types.ts | 0 .../src/Popup/Accounts/Account.tsx | 2 +- .../src/Popup/Authorize/Authorize.test.tsx | 2 +- .../src/Popup/Authorize/Request.tsx | 2 +- .../src/Popup/Signing/Request.tsx | 2 +- .../src/Popup/Signing/Signing.test.tsx | 2 +- .../extension-ui/src/Popup/Signing/index.tsx | 2 +- packages/extension-ui/src/Popup/index.tsx | 2 +- .../extension-ui/src/components/Address.tsx | 4 +- .../extension-ui/src/components/contexts.tsx | 2 +- packages/extension-ui/src/messaging.ts | 4 +- packages/extension/package.json | 9 +- .../{background/index.ts => background.ts} | 5 +- packages/extension/src/content.ts | 3 +- packages/extension/src/page.ts | 25 +++ packages/extension/webpack.config.js | 5 +- tsconfig.json | 2 + yarn.lock | 25 ++- 37 files changed, 301 insertions(+), 66 deletions(-) create mode 100644 packages/extension-base/LICENSE create mode 100644 packages/extension-base/README.md create mode 100644 packages/extension-base/package.json rename packages/{extension => extension-base}/src/background/RequestBytesSign.ts (100%) rename packages/{extension => extension-base}/src/background/RequestExtrinsicSign.ts (100%) rename packages/{extension => extension-base}/src/background/handlers/Extension.test.ts (83%) rename packages/{extension => extension-base}/src/background/handlers/Extension.ts (100%) rename packages/{extension => extension-base}/src/background/handlers/State.ts (100%) rename packages/{extension => extension-base}/src/background/handlers/Tabs.ts (100%) rename packages/{extension => extension-base}/src/background/handlers/index.ts (100%) rename packages/{extension => extension-base}/src/background/handlers/subscriptions.ts (100%) rename packages/{extension => extension-base}/src/background/types.ts (100%) rename packages/{extension => extension-base}/src/defaults.ts (100%) rename packages/{extension => extension-base}/src/page/Accounts.ts (100%) rename packages/{extension => extension-base}/src/page/Injected.ts (100%) rename packages/{extension => extension-base}/src/page/PostMessageProvider.ts (100%) rename packages/{extension => extension-base}/src/page/Signer.ts (100%) rename packages/{extension => extension-base}/src/page/index.ts (60%) rename packages/{extension => extension-base}/src/page/types.ts (100%) rename packages/extension/src/{background/index.ts => background.ts} (90%) create mode 100644 packages/extension/src/page.ts diff --git a/jest.config.js b/jest.config.js index e6fb2a9d..2be5c0e1 100644 --- a/jest.config.js +++ b/jest.config.js @@ -4,7 +4,7 @@ const config = require('@polkadot/dev/config/jest'); module.exports = Object.assign({}, config, { browser: true, moduleNameMapper: { - '@polkadot/extension-(chains|dapp|inject|ui)(.*)$': '/packages/extension-$1/src/$2', + '@polkadot/extension-(base|chains|dapp|inject|ui)(.*)$': '/packages/extension-$1/src/$2', '@polkadot/extension(.*)$': '/packages/extension/src/$1', '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '/__mocks__/fileMock.js', '\\.(css|less)$': 'empty/object' diff --git a/packages/extension-base/LICENSE b/packages/extension-base/LICENSE new file mode 100644 index 00000000..0d381b2e --- /dev/null +++ b/packages/extension-base/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/packages/extension-base/README.md b/packages/extension-base/README.md new file mode 100644 index 00000000..21b07d64 --- /dev/null +++ b/packages/extension-base/README.md @@ -0,0 +1,8 @@ +# @polkadot/extension-base + +Functions, classes and other utilities used in `@polkadot/extension`. These include: +- background script handlers, +- message passing, +- scripts injected inside pages. + +They are primarily meant to be used in `@polkadot/extension`, and can be broken without any notice to cater for `@polkadot/extension`'s needs. They are exported here if you wish to use part of them in the development of your own extension. diff --git a/packages/extension-base/package.json b/packages/extension-base/package.json new file mode 100644 index 00000000..49583b22 --- /dev/null +++ b/packages/extension-base/package.json @@ -0,0 +1,14 @@ +{ + "name": "@polkadot/extension-base", + "description": "Functions, classes and other utilities used in @polkadot/extension", + "version": "0.23.0-beta.5", + "author": "Jaco Greeff ", + "license": "Apache-2", + "dependencies": { + "@babel/runtime": "^7.9.0", + "@polkadot/api": "^1.7.0-beta.16", + "@polkadot/keyring": "^2.6.2", + "@polkadot/ui-keyring": "^0.52.0-beta.14", + "extensionizer": "^1.0.1" + } +} diff --git a/packages/extension/src/background/RequestBytesSign.ts b/packages/extension-base/src/background/RequestBytesSign.ts similarity index 100% rename from packages/extension/src/background/RequestBytesSign.ts rename to packages/extension-base/src/background/RequestBytesSign.ts diff --git a/packages/extension/src/background/RequestExtrinsicSign.ts b/packages/extension-base/src/background/RequestExtrinsicSign.ts similarity index 100% rename from packages/extension/src/background/RequestExtrinsicSign.ts rename to packages/extension-base/src/background/RequestExtrinsicSign.ts diff --git a/packages/extension/src/background/handlers/Extension.test.ts b/packages/extension-base/src/background/handlers/Extension.test.ts similarity index 83% rename from packages/extension/src/background/handlers/Extension.test.ts rename to packages/extension-base/src/background/handlers/Extension.test.ts index 4dc11e2c..c23e8a61 100644 --- a/packages/extension/src/background/handlers/Extension.test.ts +++ b/packages/extension-base/src/background/handlers/Extension.test.ts @@ -2,14 +2,15 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { ResponseAccountExport } from '@polkadot/extension/background/types'; +import { ResponseAccountExport } from '../types'; -import Extension from '@polkadot/extension/background/handlers/Extension'; -import State from '@polkadot/extension/background/handlers/State'; import keyring from '@polkadot/ui-keyring'; import ExtensionStore from '@polkadot/ui-keyring/stores/Extension'; import { cryptoWaitReady } from '@polkadot/util-crypto'; +import Extension from './Extension'; +import State from './State'; + describe('Extension', () => { async function createExtension (): Promise { await cryptoWaitReady(); diff --git a/packages/extension/src/background/handlers/Extension.ts b/packages/extension-base/src/background/handlers/Extension.ts similarity index 100% rename from packages/extension/src/background/handlers/Extension.ts rename to packages/extension-base/src/background/handlers/Extension.ts diff --git a/packages/extension/src/background/handlers/State.ts b/packages/extension-base/src/background/handlers/State.ts similarity index 100% rename from packages/extension/src/background/handlers/State.ts rename to packages/extension-base/src/background/handlers/State.ts diff --git a/packages/extension/src/background/handlers/Tabs.ts b/packages/extension-base/src/background/handlers/Tabs.ts similarity index 100% rename from packages/extension/src/background/handlers/Tabs.ts rename to packages/extension-base/src/background/handlers/Tabs.ts diff --git a/packages/extension/src/background/handlers/index.ts b/packages/extension-base/src/background/handlers/index.ts similarity index 100% rename from packages/extension/src/background/handlers/index.ts rename to packages/extension-base/src/background/handlers/index.ts diff --git a/packages/extension/src/background/handlers/subscriptions.ts b/packages/extension-base/src/background/handlers/subscriptions.ts similarity index 100% rename from packages/extension/src/background/handlers/subscriptions.ts rename to packages/extension-base/src/background/handlers/subscriptions.ts diff --git a/packages/extension/src/background/types.ts b/packages/extension-base/src/background/types.ts similarity index 100% rename from packages/extension/src/background/types.ts rename to packages/extension-base/src/background/types.ts diff --git a/packages/extension/src/defaults.ts b/packages/extension-base/src/defaults.ts similarity index 100% rename from packages/extension/src/defaults.ts rename to packages/extension-base/src/defaults.ts diff --git a/packages/extension/src/page/Accounts.ts b/packages/extension-base/src/page/Accounts.ts similarity index 100% rename from packages/extension/src/page/Accounts.ts rename to packages/extension-base/src/page/Accounts.ts diff --git a/packages/extension/src/page/Injected.ts b/packages/extension-base/src/page/Injected.ts similarity index 100% rename from packages/extension/src/page/Injected.ts rename to packages/extension-base/src/page/Injected.ts diff --git a/packages/extension/src/page/PostMessageProvider.ts b/packages/extension-base/src/page/PostMessageProvider.ts similarity index 100% rename from packages/extension/src/page/PostMessageProvider.ts rename to packages/extension-base/src/page/PostMessageProvider.ts diff --git a/packages/extension/src/page/Signer.ts b/packages/extension-base/src/page/Signer.ts similarity index 100% rename from packages/extension/src/page/Signer.ts rename to packages/extension-base/src/page/Signer.ts diff --git a/packages/extension/src/page/index.ts b/packages/extension-base/src/page/index.ts similarity index 60% rename from packages/extension/src/page/index.ts rename to packages/extension-base/src/page/index.ts index b4135d74..174699ec 100644 --- a/packages/extension/src/page/index.ts +++ b/packages/extension-base/src/page/index.ts @@ -4,8 +4,6 @@ import { ResponseTypes, TransportRequestMessage, TransportResponseMessage, MessageTypes, RequestTypes, MessageTypesWithNullRequest, SubscriptionMessageTypes, MessageTypesWithNoSubscriptions, MessageTypesWithSubscriptions } from '../background/types'; -import { injectExtension } from '@polkadot/extension-inject'; - import Injected from './Injected'; // when sending a message from the injector to the extension, we @@ -15,7 +13,7 @@ import Injected from './Injected'; // - this injector, listens on the events, maps it to the original // - resolves/rejects the promise with the result (or sub data) -interface Handler { +export interface Handler { // eslint-disable-next-line @typescript-eslint/no-explicit-any resolve: (data: any) => void; reject: (error: Error) => void; @@ -23,18 +21,18 @@ interface Handler { subscriber?: (data: any) => void; } -type Handlers = Record; +export type Handlers = Record; const handlers: Handlers = {}; let idCounter = 0; // a generic message sender that creates an event, returning a promise that will // resolve once the event is resolved (by the response listener just below this) -function sendMessage(message: TMessageType): Promise; -function sendMessage(message: TMessageType, request: RequestTypes[TMessageType]): Promise; -function sendMessage (message: TMessageType, request: RequestTypes[TMessageType], subscriber: (data: SubscriptionMessageTypes[TMessageType]) => void): Promise; +export function sendMessage(message: TMessageType): Promise; +export function sendMessage(message: TMessageType, request: RequestTypes[TMessageType]): Promise; +export function sendMessage(message: TMessageType, request: RequestTypes[TMessageType], subscriber: (data: SubscriptionMessageTypes[TMessageType]) => void): Promise; // eslint-disable-next-line @typescript-eslint/no-explicit-any -function sendMessage (message: TMessageType, request?: RequestTypes[TMessageType], subscriber?: (data: any) => void): Promise { +export function sendMessage (message: TMessageType, request?: RequestTypes[TMessageType], subscriber?: (data: any) => void): Promise { return new Promise((resolve, reject): void => { const id = `${Date.now()}.${++idCounter}`; @@ -52,14 +50,14 @@ function sendMessage (message: TMessageType, } // the enable function, called by the dapp to allow access -async function enable (origin: string): Promise { +export async function enable (origin: string): Promise { await sendMessage('pub(authorize.tab)', { origin }); return new Injected(sendMessage); } // eslint-disable-next-line @typescript-eslint/no-explicit-any -function handleResponse (data: TransportResponseMessage & { subscription?: any }): void { +export function handleResponse (data: TransportResponseMessage & { subscription?: any }): void { const handler = handlers[data.id]; if (!handler) { @@ -79,22 +77,3 @@ function handleResponse (data: TransportRespo handler.resolve(data.response); } } - -// setup a response listener (events created by the loader for extension responses) -window.addEventListener('message', ({ data, source }): void => { - // only allow messages from our window, by the loader - if (source !== window || data.origin !== 'content') { - return; - } - - if (data.id) { - handleResponse(data); - } else { - console.error('Missing id for response.'); - } -}); - -injectExtension(enable, { - name: 'polkadot-js', - version: process.env.PKG_VERSION as string -}); diff --git a/packages/extension/src/page/types.ts b/packages/extension-base/src/page/types.ts similarity index 100% rename from packages/extension/src/page/types.ts rename to packages/extension-base/src/page/types.ts diff --git a/packages/extension-ui/src/Popup/Accounts/Account.tsx b/packages/extension-ui/src/Popup/Accounts/Account.tsx index 24e03af0..2dc021c5 100644 --- a/packages/extension-ui/src/Popup/Accounts/Account.tsx +++ b/packages/extension-ui/src/Popup/Accounts/Account.tsx @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { AccountJson } from '@polkadot/extension/background/types'; +import { AccountJson } from '@polkadot/extension-base/background/types'; import React, { useContext, useState } from 'react'; import styled from 'styled-components'; diff --git a/packages/extension-ui/src/Popup/Authorize/Authorize.test.tsx b/packages/extension-ui/src/Popup/Authorize/Authorize.test.tsx index c93ad645..2bb2054e 100644 --- a/packages/extension-ui/src/Popup/Authorize/Authorize.test.tsx +++ b/packages/extension-ui/src/Popup/Authorize/Authorize.test.tsx @@ -9,7 +9,7 @@ import { ThemeProvider } from 'styled-components'; import { AuthorizeContext, themes, Header, Icon } from '@polkadot/extension-ui/components'; import Authorize from '.'; import { configure, mount, ReactWrapper } from 'enzyme'; -import { AuthorizeRequest } from '@polkadot/extension/background/types'; +import { AuthorizeRequest } from '@polkadot/extension-base/background/types'; import Request from './Request'; configure({ adapter: new Adapter() }); diff --git a/packages/extension-ui/src/Popup/Authorize/Request.tsx b/packages/extension-ui/src/Popup/Authorize/Request.tsx index 5330ea65..cf8518e1 100644 --- a/packages/extension-ui/src/Popup/Authorize/Request.tsx +++ b/packages/extension-ui/src/Popup/Authorize/Request.tsx @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { RequestAuthorizeTab } from '@polkadot/extension/background/types'; +import { RequestAuthorizeTab } from '@polkadot/extension-base/background/types'; import React, { useContext } from 'react'; import styled from 'styled-components'; diff --git a/packages/extension-ui/src/Popup/Signing/Request.tsx b/packages/extension-ui/src/Popup/Signing/Request.tsx index 5201ae5d..9a7788ef 100644 --- a/packages/extension-ui/src/Popup/Signing/Request.tsx +++ b/packages/extension-ui/src/Popup/Signing/Request.tsx @@ -3,7 +3,7 @@ // of the Apache-2.0 license. See the LICENSE file for details. import { ExtrinsicPayload } from '@polkadot/types/interfaces'; -import { AccountJson, RequestSign } from '@polkadot/extension/background/types'; +import { AccountJson, RequestSign } from '@polkadot/extension-base/background/types'; import { SignerPayloadJSON, SignerPayloadRaw } from '@polkadot/types/types'; import React, { useContext, useState, useEffect } from 'react'; diff --git a/packages/extension-ui/src/Popup/Signing/Signing.test.tsx b/packages/extension-ui/src/Popup/Signing/Signing.test.tsx index 7178ec3d..a436ed53 100644 --- a/packages/extension-ui/src/Popup/Signing/Signing.test.tsx +++ b/packages/extension-ui/src/Popup/Signing/Signing.test.tsx @@ -8,7 +8,7 @@ import Adapter from 'enzyme-adapter-react-16'; import { configure, mount, ReactWrapper } from 'enzyme'; import { act } from 'react-dom/test-utils'; import * as messaging from '@polkadot/extension-ui/messaging'; -import { AccountJson, SigningRequest } from '@polkadot/extension/background/types'; +import { AccountJson, SigningRequest } from '@polkadot/extension-base/background/types'; import { flushAllPromises } from '@polkadot/extension-ui/testHelpers'; import { AccountContext, diff --git a/packages/extension-ui/src/Popup/Signing/index.tsx b/packages/extension-ui/src/Popup/Signing/index.tsx index f7e33491..5c000756 100644 --- a/packages/extension-ui/src/Popup/Signing/index.tsx +++ b/packages/extension-ui/src/Popup/Signing/index.tsx @@ -7,7 +7,7 @@ import React, { useContext, useState, useEffect } from 'react'; import { Header, Loading, SigningContext } from '../../components'; import Request from './Request'; import TransactionIndex from './TransactionIndex'; -import { SigningRequest } from '@polkadot/extension/background/types'; +import { SigningRequest } from '@polkadot/extension-base/background/types'; export default function Signing (): React.ReactElement<{}> { const requests = useContext(SigningContext); diff --git a/packages/extension-ui/src/Popup/index.tsx b/packages/extension-ui/src/Popup/index.tsx index 6e1ab165..8bd53651 100644 --- a/packages/extension-ui/src/Popup/index.tsx +++ b/packages/extension-ui/src/Popup/index.tsx @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { AccountJson, AuthorizeRequest, SigningRequest } from '@polkadot/extension/background/types'; +import { AccountJson, AuthorizeRequest, SigningRequest } from '@polkadot/extension-base/background/types'; import React, { useEffect, useState } from 'react'; import { Route, Switch } from 'react-router'; diff --git a/packages/extension-ui/src/components/Address.tsx b/packages/extension-ui/src/components/Address.tsx index 4369581d..5e4d6d20 100644 --- a/packages/extension-ui/src/components/Address.tsx +++ b/packages/extension-ui/src/components/Address.tsx @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { AccountJson } from '@polkadot/extension/background/types'; +import { AccountJson } from '@polkadot/extension-base/background/types'; import { Chain } from '@polkadot/extension-chains/types'; import React, { useContext, useEffect, useRef, useState } from 'react'; @@ -224,7 +224,7 @@ const Banner = styled.div` top: 0; `; -const MovableMenu = styled(Menu)<{ isMoved: boolean }>` +const MovableMenu = styled(Menu) <{ isMoved: boolean }>` ${({ isMoved }): string => isMoved ? 'bottom: 50px' : ''}; `; diff --git a/packages/extension-ui/src/components/contexts.tsx b/packages/extension-ui/src/components/contexts.tsx index dbbac2e8..ad248892 100644 --- a/packages/extension-ui/src/components/contexts.tsx +++ b/packages/extension-ui/src/components/contexts.tsx @@ -2,7 +2,7 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { AccountJson, AuthorizeRequest, SigningRequest } from '@polkadot/extension/background/types'; +import { AccountJson, AuthorizeRequest, SigningRequest } from '@polkadot/extension-base/background/types'; import React from 'react'; import { AvailableThemes } from '.'; diff --git a/packages/extension-ui/src/messaging.ts b/packages/extension-ui/src/messaging.ts index 3518eebc..0ce20515 100644 --- a/packages/extension-ui/src/messaging.ts +++ b/packages/extension-ui/src/messaging.ts @@ -2,11 +2,11 @@ // This software may be modified and distributed under the terms // of the Apache-2.0 license. See the LICENSE file for details. -import { AccountJson, AuthorizeRequest, SigningRequest, RequestTypes, MessageTypes, ResponseTypes, SeedLengths, SubscriptionMessageTypes, MessageTypesWithNullRequest, MessageTypesWithNoSubscriptions, MessageTypesWithSubscriptions } from '@polkadot/extension/background/types'; +import { AccountJson, AuthorizeRequest, SigningRequest, RequestTypes, MessageTypes, ResponseTypes, SeedLengths, SubscriptionMessageTypes, MessageTypesWithNullRequest, MessageTypesWithNoSubscriptions, MessageTypesWithSubscriptions } from '@polkadot/extension-base/background/types'; import { KeypairType } from '@polkadot/util-crypto/types'; import extension from 'extensionizer'; -import { PORT_EXTENSION } from '@polkadot/extension/defaults'; +import { PORT_EXTENSION } from '@polkadot/extension-base/defaults'; interface Handler { // eslint-disable-next-line @typescript-eslint/no-explicit-any diff --git a/packages/extension/package.json b/packages/extension/package.json index 8fefb6ca..dd1aed1b 100644 --- a/packages/extension/package.json +++ b/packages/extension/package.json @@ -5,14 +5,11 @@ "author": "Jaco Greeff ", "license": "Apache-2", "dependencies": { - "@polkadot/api": "^1.8.0-beta.7", - "@polkadot/extension-ui": "0.23.0-beta.5", - "@polkadot/keyring": "^2.6.2", - "@polkadot/ui-keyring": "^0.52.0-beta.16", - "extensionizer": "^1.0.1" + "@babel/runtime": "^7.9.0", + "@polkadot/extension-base": "0.23.0-beta.5", + "@polkadot/extension-ui": "0.23.0-beta.5" }, "devDependencies": { - "@babel/runtime": "^7.9.0", "@polkadot/dev": "^0.51.6", "@types/chrome": "^0.0.101", "@types/firefox-webext-browser": "^70.0.1", diff --git a/packages/extension/src/background/index.ts b/packages/extension/src/background.ts similarity index 90% rename from packages/extension/src/background/index.ts rename to packages/extension/src/background.ts index 83f3b903..e803e232 100644 --- a/packages/extension/src/background/index.ts +++ b/packages/extension/src/background.ts @@ -6,14 +6,13 @@ import extension from 'extensionizer'; // Runs in the extension background, handling all keyring access +import handlers from '@polkadot/extension-base/background/handlers'; +import { PORT_CONTENT, PORT_EXTENSION } from '@polkadot/extension-base/defaults'; import keyring from '@polkadot/ui-keyring'; import ExtensionStore from '@polkadot/ui-keyring/stores/Extension'; import { assert } from '@polkadot/util'; import { cryptoWaitReady } from '@polkadot/util-crypto'; -import { PORT_CONTENT, PORT_EXTENSION } from '../defaults'; -import handlers from './handlers'; - // setup the notification (same a FF default background, white text) extension.browserAction.setBadgeBackgroundColor({ color: '#d90000' }); diff --git a/packages/extension/src/content.ts b/packages/extension/src/content.ts index 054a9dc6..8ecfe152 100644 --- a/packages/extension/src/content.ts +++ b/packages/extension/src/content.ts @@ -3,8 +3,7 @@ // of the Apache-2.0 license. See the LICENSE file for details. import extension from 'extensionizer'; - -import { PORT_CONTENT } from './defaults'; +import { PORT_CONTENT } from '@polkadot/extension-base/defaults'; // connect to the extension const port = extension.runtime.connect({ name: PORT_CONTENT }); diff --git a/packages/extension/src/page.ts b/packages/extension/src/page.ts new file mode 100644 index 00000000..8ac1f0ca --- /dev/null +++ b/packages/extension/src/page.ts @@ -0,0 +1,25 @@ +// Copyright 2019-2020 @polkadot/extension authors & contributors +// This software may be modified and distributed under the terms +// of the Apache-2.0 license. See the LICENSE file for details. + +import { enable, handleResponse } from '@polkadot/extension-base/page'; +import { injectExtension } from '@polkadot/extension-inject'; + +// setup a response listener (events created by the loader for extension responses) +window.addEventListener('message', ({ data, source }): void => { + // only allow messages from our window, by the loader + if (source !== window || data.origin !== 'content') { + return; + } + + if (data.id) { + handleResponse(data); + } else { + console.error('Missing id for response.'); + } +}); + +injectExtension(enable, { + name: 'polkadot-js', + version: process.env.PKG_VERSION as string +}); diff --git a/packages/extension/webpack.config.js b/packages/extension/webpack.config.js index c5716f08..db43a99b 100644 --- a/packages/extension/webpack.config.js +++ b/packages/extension/webpack.config.js @@ -14,6 +14,7 @@ const manifest = require('./manifest.json'); const packages = [ 'extension', + 'extension-base', 'extension-chains', 'extension-inject', 'extension-ui' @@ -27,10 +28,10 @@ function createWebpack ({ alias = {}, context }) { context, devtool: false, entry: { - background: './src/background/index.ts', + background: './src/background.ts', content: './src/content.ts', extension: './src/extension.ts', - page: './src/page/index.ts' + page: './src/page.ts' }, mode: ENV, output: { diff --git a/tsconfig.json b/tsconfig.json index 51eaef32..fcf097bc 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -10,6 +10,8 @@ "paths": { "@polkadot/extension": ["packages/extension/src"], "@polkadot/extension/*": ["packages/extension/src/*"], + "@polkadot/extension-base": ["packages/extension-base/src"], + "@polkadot/extension-base/*": ["packages/extension-base/src/*"], "@polkadot/extension-chains": ["packages/extension-chains/src"], "@polkadot/extension-chains/*": ["packages/extension-chains/src/*"], "@polkadot/extension-dapp": ["packages/extension-dapp/src"], diff --git a/yarn.lock b/yarn.lock index 6ab6c56b..2fdeef7d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2862,6 +2862,18 @@ __metadata: languageName: node linkType: hard +"@polkadot/extension-base@0.23.0-beta.5, @polkadot/extension-base@workspace:packages/extension-base": + version: 0.0.0-use.local + resolution: "@polkadot/extension-base@workspace:packages/extension-base" + dependencies: + "@babel/runtime": ^7.9.0 + "@polkadot/api": ^1.7.0-beta.16 + "@polkadot/keyring": ^2.6.2 + "@polkadot/ui-keyring": ^0.52.0-beta.14 + extensionizer: ^1.0.1 + languageName: unknown + linkType: soft + "@polkadot/extension-chains@workspace:packages/extension-chains": version: 0.0.0-use.local resolution: "@polkadot/extension-chains@workspace:packages/extension-chains" @@ -2929,15 +2941,12 @@ __metadata: resolution: "@polkadot/extension@workspace:packages/extension" dependencies: "@babel/runtime": ^7.9.0 - "@polkadot/api": ^1.8.0-beta.7 "@polkadot/dev": ^0.51.6 + "@polkadot/extension-base": 0.23.0-beta.5 "@polkadot/extension-ui": 0.23.0-beta.5 - "@polkadot/keyring": ^2.6.2 - "@polkadot/ui-keyring": ^0.52.0-beta.16 "@types/chrome": ^0.0.101 "@types/firefox-webext-browser": ^70.0.1 babel-loader: ^8.1.0 - extensionizer: ^1.0.1 extract-loader: ^5.0.1 file-loader: ^6.0.0 html-loader: ^1.0.0 @@ -3069,9 +3078,9 @@ __metadata: languageName: node linkType: hard -"@polkadot/ui-keyring@npm:^0.52.0-beta.16": - version: 0.52.0-beta.17 - resolution: "@polkadot/ui-keyring@npm:0.52.0-beta.17" +"@polkadot/ui-keyring@npm:^0.52.0-beta.14": + version: 0.52.0-beta.16 + resolution: "@polkadot/ui-keyring@npm:0.52.0-beta.16" dependencies: "@babel/runtime": ^7.9.0 "@ledgerhq/hw-transport-node-hid": ^5.11.0 @@ -3089,7 +3098,7 @@ __metadata: dependenciesMeta: "@ledgerhq/hw-transport-node-hid": optional: true - checksum: 2/ccc46d3782ecc3519cdb14df38c49793a12cac5a69448f8d9763390c2bdb43dea667830df682271cccbd543acf243d19f197f895b56ff189117a647cfcfe54f9 + checksum: 2/0d18ddfbdc6d29daa7e7a1ca9db7cfd14ac4ab238ff3944ba7b72fe5acd63e099f347aaf924395b73602992ebdba68a445c02e088ba3761e4c82eaaf5160b111 languageName: node linkType: hard