# @gooddollar/ceramic-seed-sdk

> Manage a privatekey or seed by multiple Ids

Latest version **1.0.9** (published 2022-01-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install @gooddollar/ceramic-seed-sdk
pnpm add @gooddollar/ceramic-seed-sdk
yarn add @gooddollar/ceramic-seed-sdk
bun add @gooddollar/ceramic-seed-sdk
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2022-01-20 |
| First published | 2021-12-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 42.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | sirpush, alexey-goddollar, aliberkhslgd |

## Links

- npm: https://www.npmjs.com/package/@gooddollar/ceramic-seed-sdk
- Repository: https://github.com/GoodDollar/CeramicSeedSDK
- Homepage: https://github.com/GoodDollar/CeramicSeedSDK#readme
- Issues: https://github.com/GoodDollar/CeramicSeedSDK/issues
- npm.io page: https://npm.io/package/@gooddollar/ceramic-seed-sdk

## Dependencies (5)

- [bn.js](https://npm.io/package/bn.js.md) ^5.2.0
- [3id-did-provider](https://npm.io/package/3id-did-provider.md) ^1.1.1
- [key-did-resolver](https://npm.io/package/key-did-resolver.md) ^1.4.0
- [@ceramicnetwork/http-client](https://npm.io/package/@ceramicnetwork/http-client.md) ^1.5.1
- [@ceramicnetwork/stream-tile](https://npm.io/package/@ceramicnetwork/stream-tile.md) ^1.5.2

## Recent versions

- 1.0.9 (latest) — 2022-01-20
- 1.0.8 — 2022-01-19
- 1.0.7 — 2022-01-14
- 1.0.6 — 2022-01-06
- 1.0.4 — 2022-01-04
- 1.0.3 — 2021-12-27

## README

# CeramicSeedSDK
Manage a privatekey or seed by multiple Ids

# Getting Started

Install Ceramic-seed-sdk into your project 

```bash
yarn add @gooddollar/ceramic-seed-sdk
```
# Usage 

```js
import { CeramicSDK } from '@gooddollar/ceramic-seed-sdk'
```

- Create a new instance of the sdk: 

```js

const sdk = new CeramicSDK("https://ceramic-clay.3boxlabs.com");

```

- Initialize a DID based on private key and create a new one if none exists:

```js
    const sdkClient = new CeramicSDK(NODE_URL_3BOXLABS);
    const myPrvkey = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"; // Length need to be 32
    const res = await sdkClient.initialize(myPrvkey, "pubkeyToUseAsAuthId");
```

- Add the given private key as another authSecret that can access the DID seed: 

```js
    const res = await sdkClient.addAuthenticator(myNewPrvkey, derivedPubkey2);
```

- Remove the provided authenticator:

```js
    const removed = await sdkClient.removeAuthenticator(pubkey);
```

- Retrieves the unencrypted master seed: 

```js
    const ms = await sdkClient.getMasterSeed();
```

---
_Source: https://npm.io/package/@gooddollar/ceramic-seed-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
