https://github.com/3box/3id-connect
3ID account management application run in an iFrame
https://github.com/3box/3id-connect
Last synced: 6 months ago
JSON representation
3ID account management application run in an iFrame
- Host: GitHub
- URL: https://github.com/3box/3id-connect
- Owner: 3box
- License: other
- Archived: true
- Created: 2019-04-04T12:56:30.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2021-08-09T12:13:05.000Z (almost 4 years ago)
- Last Synced: 2024-10-31T18:08:15.815Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.87 MB
- Stars: 26
- Watchers: 7
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# ⚠️ ⚠️ Deprecated in favor of Ceramic ⚠️ ⚠️
> 3box.js and related tools built by 3Box Labs are deprecated and no loger supported. Developers are encurraged to build with https://ceramic.network which is a more secure and decentralized protocol for sovereign data.
# 3ID-Connect
> ⚠️ This package has been moved to https://github.com/ceramicstudio/3id-connect
[Find 3ID-Connect on Ceramic here.](https://github.com/ceramicstudio/3id-connect)
3ID-Connect is a 3ID account management service run in an iframe. It allows you to authenicate, manage, and permission your 3ID keys to applications. Used by default in [3box-js](https://github.com/3box/3box-js). [identity-wallet-js](https://github.com/3box/identity-wallet-js) handles most operations and the parent window (application) communicates with iframe service over RPC layer as defined by [3ID JSON-RPC](https://github.com/3box/3box/blob/master/3IPs/3ip-10.md)
Right now you authenticate and link ethereum accounts to mange your 3ID, in the future other keypairs, blockchain accounts, and authentication methods can be added.
The next verion of 3ID-Connect is being developed on [Ceramic](https://ceramic.network) and [identity-wallet-js V2](https://github.com/3box/identity-wallet-js). It is being developed in parallel with the current version. You can find 3ID-Connect with Ceramic support in the [following repo](https://github.com/ceramicstudio/3id-connect). In the future this repo will be depracated. It is released at 3id-connect@next and available at 3idconnect.org.
* **/src** - Core logic and consumable interfaces for clients and iframe
* **/threeIdConnect.js** - Application interface (RPC client) to load iframe and return 3ID provider.
* **/threeIdConnectService.js** - Identity wallet instance and RPC 'server' to handle requests
* **/threeIdProviderProxy.js** - 3ID provider interface that relays request through RPC layer
* **/iframe** - all html, css, js, design assets for iframe and flow
* **/public** - build assets deployed for iframe
Clone and install dependencies
#### Run Locally
Will serve iframe locally on port 30001
```
$ npm run start
```
#### Build
```
$ npm run build
```
## Maintainers
[@zachferland](https://github.com/zachferland)