ceramicnetwork / ceramicnetwork/js-ceramic

CeramicClient 0.10.0 is incompatible with ThreeIDProvider.CeramicAPI.

Open
#1,152 5 comments 0 reactions 0 assignees View on GitHub
dontclose need/triage
Dominant language
TypeScript
Stars
423
Forks
126
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**
With "3id-did-provider": "^0.5.1" and "@ceramicnetwork/http-client": "^0.10.0", it seems that CeramicClient is incompatible with ThreeIDProvider.CeramicAPI.

**To Reproduce**
Steps to reproduce the behavior:
1. yarn add 3id-did-provider @ceramicnetwork/http-client
2. Write function
````
const API_URL = 'https://ceramic-clay.3boxlabs.com';
const ceramic = new CeramicClient(API_URL);
const threeIdProvider = await ThreeIdProvider.create({ ceramic: ceramic, getPermission: async () => ['/'], seed: new Uint8Array(randomBytes(32)) });

````
3. Should see type error for ThreeIdProvider.create
4. yarn add "@ceramicnetwork/http-client": "^0.9.6",
5. Type error resolves

**Expected behavior**
Expected no type error :)

**Screenshots**
![image](https://user-images.githubusercontent.com/4772930/112297549-52f98780-8c96-11eb-8a6d-23059a8e92a3.png)

**Ceramic versions**
"@ceramicnetwork/http-client": "^0.10.0"
"3id-did-provider": "^0.5.1"

**Machine, OS, browser information (please complete the following information):**
MACOS

**Additional context**
Add any other context about the problem here.

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the type error using @ceramicnetwork/http-client 0.10.0 with 3id-did-provider 0.5.1, then compare the relevant CeramicClient and ThreeIdProvider.CeramicAPI type declarations with version 0.9.6. Done means ThreeIdProvider.create accepts the 0.10.0 CeramicClient without a type error while preserving the reported setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.