Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ceramicstudio/js-3id
Authentication system for Ceramic apps that works with blockchain wallets.
https://github.com/ceramicstudio/js-3id
blockchain ceramic dids identityindex idx wallet
Last synced: 3 months ago
JSON representation
Authentication system for Ceramic apps that works with blockchain wallets.
- Host: GitHub
- URL: https://github.com/ceramicstudio/js-3id
- Owner: ceramicstudio
- License: other
- Created: 2020-10-23T17:28:29.000Z (about 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-11T15:48:41.000Z (over 1 year ago)
- Last Synced: 2024-05-22T19:35:55.768Z (6 months ago)
- Topics: blockchain, ceramic, dids, identityindex, idx, wallet
- Language: TypeScript
- Homepage:
- Size: 17.1 MB
- Stars: 107
- Watchers: 8
- Forks: 41
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome - 3ID Connect
README
[](https://discord.gg/6VRZpGP)
[](https://twitter.com/ceramicnetwork)
3ID Connect provides 3ID user account management in a iframe, an easy way to access a DID provider, specifically [ThreeIdProvider](https://github.com/ceramicstudio/js-3id-did-provider) in the browser.
It allows users to authenticate, manage, link and permission their 3ID keys to applications.
The library [js-3id-did-provider](https://github.com/ceramicstudio/js-3id-did-provider) handles most operations and the parent window (application) communicates with the iframe service over an RPC layer.
## Getting started
### Installation
```sh
npm install @3id/connect
```
### Basic usage
```ts
import { EthereumAuthProvider, ThreeIdConnect } from '@3id/connect'
// ethProvider is an Ethereum provider and addresses an array of strings
const authProvider = new EthereumAuthProvider(ethProvider, addresses[0])
const threeIdConnect = new ThreeIdConnect()
await threeIdConnect.connect(authProvider)
```
See the [example app](./apps/example) for more details
## Developement
### Prerequisites
yarn v1 and lerna v4 should be installed globally:
```sh
npm install -g lerna yarn
```
### Installation
Run `yarn install` from the root folder, this will install the dependencies and build the packages
### Scripts
In the root folder:
- `lint`: lints all apps and packages
- `build`: builds all packages
- `test:unit`: runs unit test
- `test:management`: runs integration tests for the [management lib](./packages/management) with a Ceramic server
- `test:integration`: runs integration tests from the [integration app](./apps/integration) with a Ceramic server
## Folders
### Packages
- [`@3id/common`](./packages/common): Common types and utilities used by packages
- [`@3id/connect`](./packages/connect): 3ID Connect library
- [`@3id/connect-display`](./packages/connect-display): 3ID Connect popup prompts
- [`@3id/manager`](./packages/manager): 3ID accounts storage and management
- [`@3id/test-utils`](./packages/test-utils): Testing utilities for apps and packages
- [`@3id/window-auth-provider`](./packages/window-auth-provider): cross-window AuthProvider
### Apps
- [`example`](./apps/example): Example usage of 3ID Connect with Ceramic and IDX
- [`iframe`](./apps/iframe): 3ID Connect iframe logic and UI
- [`integration`](./apps/integration): 3ID Connect integration tests
- [`management`](./apps/management): 3ID accounts management UI used by 3ID Connect
### Others
- [`public`](./public): build assets for 3idconnect.org
## Licenses
- Apache-2.0 OR MIT for published packages
- UIs used by 3ID Connect may use dependencies under other licenses