diff --git a/.babelrc.js b/.babelrc.js new file mode 100644 index 0000000000..5188ea0422 --- /dev/null +++ b/.babelrc.js @@ -0,0 +1 @@ +module.exports = require('./babel.config.js'); diff --git a/.codeclimate.yml b/.codeclimate.yml new file mode 100644 index 0000000000..dd0a3cdb69 --- /dev/null +++ b/.codeclimate.yml @@ -0,0 +1,6 @@ +exclude_patterns: +- "**/*.spec.js" +- "**/*.spec.ts" +- "**/*.test.js" +- "**/*.test.ts" +- "docs/**/*.js" diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000..3c229b5dc1 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +root = true +[*] +indent_style=space +indent_size=2 +tab_width=2 +end_of_line=lf +charset=utf-8 +trim_trailing_whitespace=true +max_line_length=120 +insert_final_newline=true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..699fcad7d9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +build/ +coverage/ +node_modules/ +tmp/ +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local +.npmrc +lerna-debug.log* +npm-debug.log* +yarn-debug.log* +yarn-error.log* +package-lock.json +_book +docs/html diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/.npmignore @@ -0,0 +1 @@ + diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000000..f599e28b8a --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +10 diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000000..39da1a400a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,14 @@ +language: node_js +node_js: + - "10" +before_install: + - curl -o- -L https://yarnpkg.com/install.sh | bash + - export PATH=$HOME/.yarn/bin::$(yarn global bin):$PATH +cache: + yarn: true + directories: + - node_modules +install: + - yarn +script: + - yarn polkadot-dev-build-travis diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..947952e851 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing + +## What? + +Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. +A project is more like an open wiki than a standard guarded open source project. + +## Rules + +There are a few basic ground-rules for contributors (including the maintainer(s) of the project): + +1. **No `--force` pushes** or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo. +2. **Non-master branches**, prefixed with a short name moniker (e.g. `-`) must be used for ongoing work. +3. **All modifications** must be made in a **pull-request** to solicit feedback from other contributors. +4. A pull-request *must not be merged until CI* has finished successfully. + +#### Merging pull requests once CI is successful: +- A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well. +- No PR should be merged until all reviews' comments are addressed. + +#### Reviewing pull requests: +When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in: + +- Buggy behaviour. +- Undue maintenance burden. +- Breaking with house coding style. +- Pessimisation (i.e. reduction of speed as measured in the projects benchmarks). +- Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on). +- Uselessness (i.e. it does not strictly add a feature or fix a known issue). + +#### Reviews may not be used as an effective veto for a PR because: +- There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix. +- It does not fit well with some other contributors' longer-term vision for the project. + +## Releases + +Declaring formal releases remains the prerogative of the project maintainer(s). + +## Changes to this arrangement + +This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change. + +## Heritage + +These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: [https://github.com/Level/community/blob/master/CONTRIBUTING.md](https://github.com/Level/community/blob/master/CONTRIBUTING.md) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..0d381b2e97 --- /dev/null +++ b/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/README.md b/README.md new file mode 100644 index 0000000000..c1232e88e4 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# @polkadot/extension + +A very simple scaffolding browser extension that injects a [@polkadot/api](https://github.com/polkadot-js/api) Signer into a page, along with any associated accounts, allowing for use by the application. This is an extensible POC implementation of a Polkadot/Substrate browser signer. + +As it stands, it does one thing: it _only_ manages accounts and allows the signing of transactions with those accounts. (It does not inject providers for use by dapps, not does it perform the function of a wallet where it submits txs to the network). + +# Running + +Currently is not packaged since it is under heavy development. To use - + +1. Build via `yarn build` or `yarn watch` +2. Add the extension under `chrome://extensions/` (ensure you have the Development flag set) and "Load unpacked" +3. When visiting `http://localhost:3000` or `https://polkadot.js.org/apps/` it will inject (the menifest currently only lists these 2 endpoints) + +Once added, you can create an account (via a generated seed) or import via an existing seed. + +## Overview + +It injects `injectedWeb3` into the global `window` object, exposing the following: + +```js +// a version that identifies the actual injection version (future-use) +type Version = 0; + +// an interface describing an account +interface Account { + readonly address: string; // ss-58 encoded address + readonly name?: string; // optional name for display +} + +// exposes accounts +interface Accounts { + readonly all: Array; +} + +// a signer that communicates with the extension via sendMessage +interface Signer extends SignerInterface { + // no specific signer extensions +} + +interface Injected { + readonly accounts: Accounts; + readonly signer: Signer; + readonly version: Version; +} +``` + +The app can use all or any of these, depending on needs. To instantiate the `@polkadot/api` with the provider (app does not have it's own) and the signer (allowing the extension to sign messages) can be done via - + +```js +import { ApiPromise } from '@polkadot/api'; + +const { signer } = window.injectedWeb3; +const api = await Api.create({ signer }); +``` diff --git a/babel.config.js b/babel.config.js new file mode 100644 index 0000000000..1fbbeda85f --- /dev/null +++ b/babel.config.js @@ -0,0 +1,3 @@ +module.exports = { + extends: '@polkadot/dev/config/babel' +}; diff --git a/jest.config.js b/jest.config.js new file mode 100644 index 0000000000..be2373a85a --- /dev/null +++ b/jest.config.js @@ -0,0 +1,13 @@ +const config = require('@polkadot/dev/config/jest'); + +module.exports = Object.assign({}, config, { + moduleNameMapper: { + '@polkadot/extension-(ui)(.*)$': '/packages/extension-$1/src/$2', + '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': 'empty/object', + '\\.(css|less)$': 'empty/object' + }, + modulePathIgnorePatterns: [ + '/packages/extension/build', + '/packages/extension-ui/build' + ] +}); diff --git a/lerna.json b/lerna.json new file mode 100644 index 0000000000..781ca9b670 --- /dev/null +++ b/lerna.json @@ -0,0 +1,13 @@ +{ + "npmClient": "yarn", + "useWorkspaces": true, + "command": { + "publish": { + "allowBranch": "master" + } + }, + "packages": [ + "packages/*" + ], + "version": "0.1.0" +} diff --git a/package.json b/package.json new file mode 100644 index 0000000000..bc38fa3ff9 --- /dev/null +++ b/package.json @@ -0,0 +1,34 @@ +{ + "name": "@polkadot/extension", + "version": "0.1.0", + "description": "A sample signer extension for the @polkadot/api", + "repository": "https://github.com/polkadot-js/extension", + "author": "Jaco Greeff ", + "license": "Apache-2", + "private": true, + "workspaces": [ + "packages/*" + ], + "engines": { + "node": ">=10.13.0", + "yarn": "^1.10.1" + }, + "resolutions": { + "babel-core": "^7.0.0-bridge.0", + "typescript": "^3.4.5" + }, + "scripts": { + "build": "NODE_ENV=production polkadot-dev-build-ts", + "check": "yarn lint", + "lint": "tslint --project . && tsc --noEmit --pretty", + "clean": "polkadot-dev-clean-build", + "postinstall": "polkadot-dev-yarn-only", + "test": "jest --coverage", + "watch": "cd packages/extension && webpack --config webpack.config.js --watch" + }, + "devDependencies": { + "@babel/core": "^7.4.4", + "@polkadot/dev-react": "^0.30.0-beta.4", + "@polkadot/ts": "^0.1.56" + } +} diff --git a/packages/extension-ui/package.json b/packages/extension-ui/package.json new file mode 100644 index 0000000000..b8647f5636 --- /dev/null +++ b/packages/extension-ui/package.json @@ -0,0 +1,14 @@ +{ + "name": "@polkadot/extension-ui", + "description": "A sample signer extension for the @polkadot/api", + "version": "0.1.0", + "author": "Jaco Greeff ", + "license": "Apache-2", + "dependencies": { + "@polkadot/extension-inject": "^0.1.0", + "@polkadot/ui-identicon": "^0.39.0-beta.5", + "@types/react-router-dom": "^4.3.2", + "react-router": "^5.0.0", + "react-router-dom": "^5.0.0" + } +} diff --git a/packages/extension-ui/src/Popup/Accounts.tsx b/packages/extension-ui/src/Popup/Accounts.tsx new file mode 100644 index 0000000000..3b3142f82c --- /dev/null +++ b/packages/extension-ui/src/Popup/Accounts.tsx @@ -0,0 +1,42 @@ +// Copyright 2019 @polkadot/extension-ui 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 { KeyringJson } from '@polkadot/ui-keyring/types'; + +import React from 'react'; + +import { Address, Button, Header, Tip } from '../components'; + +type Props = { + accounts: Array +}; + +export default function Accounts ({ accounts }: Props) { + return ( +
+
+ { + (accounts.length === 0) + ? You currently don't have any accounts. Either create a new account or if you have an existing account you wish to use, import it with the seed phrase + : accounts.map(({ address, meta: { name } }) => ( +
+ )) + } +
+ ); +} diff --git a/packages/extension-ui/src/Popup/Create.tsx b/packages/extension-ui/src/Popup/Create.tsx new file mode 100644 index 0000000000..2db922408a --- /dev/null +++ b/packages/extension-ui/src/Popup/Create.tsx @@ -0,0 +1,69 @@ +// Copyright 2019 @polkadot/extension-ui 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 React, { useState, useEffect } from 'react'; + +import { Address, Button, Header, Loading, TextArea } from '../components'; +import { createAccount, createSeed } from '../messaging'; +import { Back, Name, Password } from '../partials'; + +type Props = {}; + +export default function Create (props: Props) { + const [account, setAccount] = useState(null as null | { address: string, seed: string }); + const [name, setName] = useState(null as string | null); + const [password, setPassword] = useState(null as string | null); + + useEffect(() => { + createSeed() + .then(setAccount) + .catch(console.error); + }, []); + + // FIXME Duplicated between here and Import.tsx + const _onCreate = (): void => { + // this should always be the case + if (name && password && account) { + createAccount(name, password, account.seed) + .then(() => { + window.location.hash = '/'; + }) + .catch(console.error); + } + }; + + return ( +
+
+ + {account && ( + <> +