https://github.com/ipfs-shipyard/js-ipid-did-resolver

IPID resolver to be used with the did-resolver package
https://github.com/ipfs-shipyard/js-ipid-did-resolver

did ipfs ipid ipld ipns resolver

Last synced: about 2 months ago
JSON representation

IPID resolver to be used with the did-resolver package

• Host: GitHub
• URL: https://github.com/ipfs-shipyard/js-ipid-did-resolver
• Owner: ipfs-shipyard
• License: mit
• Created: 2019-06-11T11:01:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T23:54:46.000Z (almost 2 years ago)
• Last Synced: 2024-04-26T07:21:05.302Z (8 months ago)
• Topics: did, ipfs, ipid, ipld, ipns, resolver
• Language: JavaScript
• Homepage:
• Size: 1.67 MB
• Stars: 4
• Watchers: 8
• Forks: 1
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ipid-did-resolver

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url]

[npm-url]:https://npmjs.org/package/ipid-did-resolver

[downloads-image]:http://img.shields.io/npm/dm/ipid-did-resolver.svg

[npm-image]:http://img.shields.io/npm/v/ipid-did-resolver.svg

[travis-url]:https://travis-ci.org/ipfs-shipyard/js-ipid-did-resolver

[travis-image]:http://img.shields.io/travis/ipfs-shipyard/js-ipid-did-resolver/master.svg

[codecov-url]:https://codecov.io/gh/ipfs-shipyard/js-ipid-did-resolver

[codecov-image]:https://img.shields.io/codecov/c/github/ipfs-shipyard/js-ipid-did-resolver/master.svg

[david-dm-url]:https://david-dm.org/ipfs-shipyard/js-ipid-did-resolver

[david-dm-image]:https://img.shields.io/david/ipfs-shipyard/js-ipid-did-resolver.svg

[david-dm-dev-url]:https://david-dm.org/ipfs-shipyard/js-ipid-did-resolver?type=dev

[david-dm-dev-image]:https://img.shields.io/david/dev/ipfs-shipyard/js-ipid-did-resolver.svg

IPID resolver to be used with the generic [did-resolver](https://github.com/uport-project/did-resolver) package.

## Installation

```sh

$ npm install did-resolver ipid-did-resolver

```

This library is written in modern JavaScript and is published in both CommonJS and ES module transpiled variants. If you target older browsers please make sure to transpile accordingly.

## Usage

```js

import registerResolver from 'ipid-did-resolver';

import resolve from 'did-resolver';

registerResolver(ipfs);

await (async () => {

    const didDocument = await resolve('did:ipid:xxxxxxx');

    console.log(didDocument);

})();

```

You must provide a valid [`ipfs`](https://github.com/ipfs/js-ipfs) instance to the `registerResolver` function

## Tests

```sh

$ npm test

$ npm test -- --watch # during development

```

## License

Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).