ceramicnetwork / ceramicnetwork/js-ceramic

3id-did-resolver README.md should be update

Open
#2,328 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
423
Forks
126
PR merge metrics
No merged PRs in 30d

Description

Hi, usage code in the 3id-did-resolver's README.md doesn't match the actual code.

If I use usage code in README as below :
``` typescript
import ThreeIdResolver from '@ceramicnetwork/3id-did-resolver'
import { Resolver } from 'did-resolver'

// You need an instance of Ceramic to call getResolver.
// This can be either @ceramicnetwork/core or @ceramicnetwork/http-client.
// You can also set an address for your own ethr-did-registry contract
const ceramic = // ...

// getResolver will return an object with a key/value pair of { '3': resolver }
// where resolver is a function used by the generic did resolver.
const threeIdResolver = ThreeIdResolver.getResolver(ceramic)
const didResolver = Resolver(threeIdResolver)

const doc = await didResolver.resolve('did:ethr:0xf3beac30c498d9e26865f34fcaa57dbb935b0d74')
console.log(doc)
````
It will comes the error like :
截圖 2022-07-17 下午3 42 04

Usage code in README should be modified to :
``` typescript
import { getResolver } from '@ceramicnetwork/3id-did-resolver'
import { Resolver } from 'did-resolver'

// You need an instance of Ceramic to call getResolver.
// This can be either @ceramicnetwork/core or @ceramicnetwork/http-client.
// You can also set an address for your own ethr-did-registry contract
const ceramic = // ...

// getResolver will return an object with a key/value pair of { '3': resolver }
// where resolver is a function used by the generic did resolver.
const threeIdResolver = getResolver(ceramic)
const didResolver = new Resolver(threeIdResolver)

const doc = await didResolver.resolve('did:ethr:0xf3beac30c498d9e26865f34fcaa57dbb935b0d74')
console.log(doc)
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the 3id-did-resolver README.md usage example and compare its imports and Resolver construction with the package's current API. Update the example so it matches the working usage shown in the issue; it is done when the documented snippet is consistent with the actual exports and can be followed without the reported error.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.