Skip to content

Commit 6165056

Browse files
jacogrjacogr
authoredJul 12, 2019
extension-inject (no direct globals for extension/dapp) (#75)
* extension-inject (no direct globals for extension/dapp) * Update tsconfig.json * Update index.ts
·
dust-v0.41.2-a
1 parent 039acf8 commit 6165056

17 files changed

+301
-42
lines changed
 

‎README.md

+26-15
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The repo is split into a number of packages -
3333
- [extension](packages/extension/) - All the injection and background processing logic (the main entry)
3434
- [extension-ui](packages/extension-ui/) - The UI components for the extension, do build up the popup
3535
- [extension-dapp](packages/extension-dapp/) - A convenience wrapper to work with the injected objects, simplifying data extraction for any dapp that wishes to integrate the extension (or any extension that supports the interface)
36+
- [extension-inject](packages/extension-inject/) - A convience wrapper that allows extension developers to inject their extension for use by dapp developers
3637

3738
## Dapp developers
3839

@@ -43,23 +44,11 @@ This approach is used to support multiple external signers in for instance [apps
4344

4445
## Technical
4546

46-
The extension injects `injectedWeb3` into the global `window` object, exposing the following: (This is meant to be generic accross extensions, allowing any dapp to utilize multiple signers, as they are available)
47+
The extension injection interfaces are generic, i.e. it is designed to allow any extension developer to easily inject extensions (that conforms to a specific interface) and at the same time it allows for any dapp developer to easily enable the interfaces from multiple extensions at the same time. It is not an all-or-nothing approch, but rather it is an ecosystem where the user can choose which extensions fit his style best.
4748

48-
```js
49-
window.injectedWeb3 = {
50-
// this is the name for this extension, there could be multiples injected,
51-
// each with their own keys, here `polkadot-js` is for this extension
52-
'polkadot-js': {
53-
// semver for the package
54-
version: '0.1.0',
49+
From a dapp developer perspective, the only work needed is to include the [@polkadot/extension-dapp](packages/extension-dapp/) package and call the appropriate enabling function to retrieve all the extensions and their associated interfaces.
5550

56-
// this is called to enable the injection, and returns an injected
57-
// object containing the accounts, signer and provider interfaces
58-
// (or it will reject if not authorized)
59-
enable (originName: string): Promise<Injected>
60-
}
61-
}
62-
```
51+
From an extension developer perspective, the only work required is to enable the extension via the razor-thin [@polkadot/extension-inject](packages/extension-inject/) wrapper. Any dapp using the above interfaces will have access.
6352

6453
When there is more than one extension, each will populate an entry above, so from an extension implementation perspective, the structure should not be overridded. The `Injected` interface, as returned via `enable`, contains the following and is what any compliant extension supplies -
6554

@@ -96,6 +85,28 @@ interface Signer extends SignerInterface {
9685
}
9786
```
9887

88+
# Technical information
89+
90+
This information may change and evolve. It is therefore recommended that all access is done via the `-dapp` and `-inject` packages, which removes the need to work with the lower-level targets.
91+
92+
The extension injects `injectedWeb3` into the global `window` object, exposing the following: (This is meant to be generic accross extensions, allowing any dapp to utilize multiple signers, as they are available)
93+
94+
```js
95+
window.injectedWeb3 = {
96+
// this is the name for this extension, there could be multiples injected,
97+
// each with their own keys, here `polkadot-js` is for this extension
98+
'polkadot-js': {
99+
// semver for the package
100+
version: '0.1.0',
101+
102+
// this is called to enable the injection, and returns an injected
103+
// object containing the accounts, signer and provider interfaces
104+
// (or it will reject if not authorized)
105+
enable (originName: string): Promise<Injected>
106+
}
107+
}
108+
```
109+
99110
The app can use all or any of these, depending on needs. To instantiate the `@polkadot/api` signer (allowing the extension to sign messages) can be done via (assuming a known, single extension) -
100111

101112
```js

‎packages/extension-dapp/package.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
{
22
"name": "@polkadot/extension-dapp",
3-
"description": "An injector dapps that manages the injected environment",
3+
"description": "Provides an interfaces around the injected globals for ease of access by dapp developers.",
44
"version": "0.3.0-beta.1",
55
"author": "Jaco Greeff <jacogr@gmail.com>",
66
"license": "Apache-2",
7+
"dependencies": {
8+
"@polkadot/extension-inject": "0.3.0-beta.0"
9+
},
710
"peerDependencies": {
811
"@babel/runtime": "^7.5.4",
912
"@polkadot/api": "*"

‎packages/extension-dapp/src/compat/singleSource.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// of the Apache-2.0 license. See the LICENSE file for details.
44

55
import { Signer } from '@polkadot/api/types';
6-
import { Injected, InjectedAccount, InjectedWindow } from '../types';
6+
import { Injected, InjectedAccount, InjectedWindow } from '@polkadot/extension-inject/types';
77

88
// RxJs interface, only the bare-bones of what we need here
99
interface Subscriber<T> {

‎packages/extension-dapp/src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// This software may be modified and distributed under the terms
33
// of the Apache-2.0 license. See the LICENSE file for details.
44

5-
import { Injected, InjectedAccount, InjectedAccountWithMeta, InjectedExtension, InjectedExtensionInfo, InjectedWindow, Unsubcall } from './types';
5+
import { Injected, InjectedAccount, InjectedAccountWithMeta, InjectedExtension, InjectedExtensionInfo, InjectedWindow, Unsubcall } from '@polkadot/extension-inject/types';
66

77
// our extension adaptor for other kinds of extensions
88
import compatInjector from './compat';

‎packages/extension-inject/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎packages/extension-inject/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# @polkadot/extension-inject
2+
3+
This is a basic extension injector that manages access to the global objects available. As an extension developer, you don't need to manage access to the windo object manually, by just calling enable here, the global object is setup and managed properly. From here any dapp can access it with the `@polkadot/extension-dapp` package;
4+
5+
## Usage
6+
7+
```js
8+
import { injectExtension } from '@polkadot/extension-inject';
9+
10+
// this a the function that will be exposed to be callable by the dapp. It resolves a promise
11+
// with the injected interface, (see `Injected`) when the dapp at `originName` (url) is allowed
12+
// to access functionality
13+
function enableFn (originName: string): Promise<Injected> {
14+
...
15+
}
16+
17+
// injects the extension into the page
18+
injectExtension(enableFn, { name: 'myExtension', version: '1.0.1' });
19+
```

‎packages/extension-inject/package.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "@polkadot/extension-inject",
3+
"description": "A generic injector (usable to any extension), that populates the base exposed interfaces to be used by dapps.",
4+
"version": "0.3.0-beta.0",
5+
"author": "Jaco Greeff <jacogr@gmail.com>",
6+
"license": "Apache-2",
7+
"peerDependencies": {
8+
"@babel/runtime": "^7.5.4",
9+
"@polkadot/api": "*"
10+
}
11+
}

‎packages/extension-inject/src/index.ts

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Copyright 2019 @polkadot/extension-dapp authors & contributors
2+
// This software may be modified and distributed under the terms
3+
// of the Apache-2.0 license. See the LICENSE file for details.
4+
5+
import { Injected, InjectedWindow, InjectOptions } from './types';
6+
7+
// It is recomemender to always use the function below to shield the extension and dapp from
8+
// any future changes. The exposed interface will manage access between the 2 environments,
9+
// be it via window (current), postMessage (under consideration) or any other mechanism
10+
export function injectExtension (enable: (origin: string) => Promise<Injected>, { name, version }: InjectOptions): void {
11+
// small helper with the typescript types, just cast window
12+
const windowInject = window as InjectedWindow;
13+
14+
// don't clobber the existing object, we will add it it (or create as needed)
15+
windowInject.injectedWeb3 = windowInject.injectedWeb3 || {};
16+
17+
// add our enable function
18+
windowInject.injectedWeb3[name] = {
19+
enable: (origin: string): Promise<Injected> =>
20+
enable(origin),
21+
version
22+
};
23+
}

‎packages/extension-dapp/src/types.ts ‎packages/extension-inject/src/types.ts

+2
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,5 @@ export interface InjectedWindow extends Window {
4747
}
4848

4949
export type InjectedExtension = InjectedExtensionInfo & Injected;
50+
51+
export type InjectOptions = InjectedExtensionInfo;

‎packages/extension/manifest.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"author": "polkadot.{js}",
3-
"description": "Manage your Polkadot & Substrate keys independent for the dapps. Injects the accounts into dapps and allows the dapp to request transactions to be signed.",
3+
"description": "Manage your Polkadot accounts outside of dapps. Injects the accounts and allows signing transactions for a specific account.",
44
"homepage_url": "https://github.com/polkadot-js/extension",
55
"name": "polkadot{.js} extension",
66
"manifest_version": 2,

‎packages/extension/src/page/Accounts.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// This software may be modified and distributed under the terms
33
// of the Apache-2.0 license. See the LICENSE file for details.
44

5-
import { InjectedAccounts, InjectedAccount, Unsubcall } from '@polkadot/extension-dapp/types';
5+
import { InjectedAccounts, InjectedAccount, Unsubcall } from '@polkadot/extension-inject/types';
66
import { SendRequest } from './types';
77

88
let sendRequest: SendRequest;

‎packages/extension/src/page/Injected.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// This software may be modified and distributed under the terms
33
// of the Apache-2.0 license. See the LICENSE file for details.
44

5-
import { Injected as InjectedInjected } from '@polkadot/extension-dapp/types';
5+
import { Injected as InjectedInjected } from '@polkadot/extension-inject/types';
66
import { SendRequest } from './types';
77

88
import Accounts from './Accounts';

‎packages/extension/src/page/Signer.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
// of the Apache-2.0 license. See the LICENSE file for details.
44

55
import { SignerOptions } from '@polkadot/api/types';
6-
import { InjectedSigner } from '@polkadot/extension-dapp/types';
6+
import { InjectedSigner } from '@polkadot/extension-inject/types';
77
import { IExtrinsic } from '@polkadot/types/types';
88
import { SendRequest } from './types';
99

10-
import { Hash } from '@polkadot/types';
1110
import { SubmittableResult } from '@polkadot/api/SubmittableExtrinsic';
11+
import { Hash } from '@polkadot/types';
1212

1313
let sendRequest: SendRequest;
1414

‎packages/extension/src/page/index.ts

+5-10
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
// This software may be modified and distributed under the terms
33
// of the Apache-2.0 license. See the LICENSE file for details.
44

5-
import { InjectedWindow } from '@polkadot/extension-dapp/types';
65
import { MessageTypes } from '../background/types';
76

7+
import { injectExtension } from '@polkadot/extension-inject';
8+
89
import Injected from './Injected';
910

1011
// when sending a message from the injector to the extension, we
@@ -24,8 +25,6 @@ interface Handler {
2425

2526
type Handlers = Record<string, Handler>;
2627

27-
// small helper with the typescript types, just cast window
28-
const windowInject = window as InjectedWindow;
2928
const handlers: Handlers = {};
3029
let idCounter = 0;
3130

@@ -76,11 +75,7 @@ window.addEventListener('message', ({ data, source }): void => {
7675
}
7776
});
7877

79-
// don't clobber the existing object, we will add it it (or create as needed)
80-
windowInject.injectedWeb3 = windowInject.injectedWeb3 || {};
81-
82-
// add our enable function
83-
windowInject.injectedWeb3['polkadot-js'] = {
84-
enable,
78+
injectExtension(enable, {
79+
name: 'polkadot-js',
8580
version: process.env.PKG_VERSION as string
86-
};
81+
});

‎packages/extension/webpack.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ const manifest = require('./manifest.json');
1414

1515
const packages = [
1616
'extension',
17+
'extension-inject',
1718
'extension-ui'
1819
];
1920

‎tsconfig.json

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
"@polkadot/extension/*": ["packages/extension/src/*"],
1010
"@polkadot/extension-dapp": ["packages/extension-dapp/src"],
1111
"@polkadot/extension-dapp/*": ["packages/extension-dapp/src/*"],
12+
"@polkadot/extension-inject": ["packages/extension-inject/src"],
13+
"@polkadot/extension-inject/*": ["packages/extension-inject/src/*"],
1214
"@polkadot/extension-ui": ["packages/extension-ui/src"],
1315
"@polkadot/extension-ui/*": ["packages/extension-ui/src/*"]
1416
},

‎tslint.json

-9
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.