PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

0.3.4

npm

3id-blockchain-utils

Blockchain utils for 3ID

Published18 May 2020
Direct dependencies12
Transitive dependenciesNot calculated

README

Current package documentation

3id-blockchain-utils

standard-readme compliant CircleCI npm npm Codecov

This package contains a bunch of utilities that is used by 3ID and 3Box in order to create and verify links from blockchain addresses.

Tabel of Contents

Install

$ npm install --save 3id-blockchain-utils

Usage

Import the package into your project

import { createLink, validateLink, authenticate } from '3id-blockchain-utils'

Use the library to create and verify links:

const did = 'did:3:bafypwg9834gf...'
const proof = await createLink(did, '0x123abc...', ethereumProvider)
console.log(proof)

const verified = await validateLink(proof)
if (verified) {
  console.log('Proof is valid', proof)
} else {
  console.log('Proof is invalid')
}

Use the library for 3ID authenticate:

await authenticate(message, '0x123abc...', ethereumProvider)

Supported blockchains

Below you can see a table which lists supported blockchains and their provider objects.

BlockchainCAIP-2 namespaceSupported providers
Ethereumeip155metamask-like ethereum provider
FilecoinfilFilecoin Wallet Provider

Maintainers

@oed

Adding support for a blockchain

If you want to add support for a new blockchain to 3ID this is the place to do so. This library uses CAIP-10 to represent accounts in a blockchain agnostic way. If the blockchain you want to add isn't already part of the CAIP standards you shold make sure to add it there.

To begin adding support for a given blockchain add a file with the path: src/blockchains/<blockchain-name>.js. This module needs to export three functions:

  • createLink - creates a LinkProof object which associates the specified AccountID with the DID
  • validateLink - validates the given LinkProof
  • authenticate - signs a message and returns some entropy based on the signature. Needs to be deterministic

It also needs to export a constant called namespace. This constant is a string which contains the CAIP-2 chainId namespace.

Please see src/blockchains/ethereum.js for an example of how this is implemented for the eip155 (ethereum) CAIP-2 namespace.

Finally add support for your blockchain in src/index.js. Simply add it to the handlers array.

Test

Test the code by running:

$ npm test

Licence

Apache-2.0 OR MIT

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 12

Native requirements
12 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@ethersproject/contracts
Environment
{
  "local_name": "@ethersproject/contracts",
  "alias": false,
  "peer_metadata": null
}
5.0.0-beta.152runtime
@ethersproject/providers
Environment
{
  "local_name": "@ethersproject/providers",
  "alias": false,
  "peer_metadata": null
}
5.0.0-beta.144runtime
@ethersproject/wallet
Environment
{
  "local_name": "@ethersproject/wallet",
  "alias": false,
  "peer_metadata": null
}
5.0.0-beta.136runtime
@babel/cli
Environment
{
  "local_name": "@babel/cli",
  "alias": false,
  "peer_metadata": null
}
^7.7.0development
@babel/core
Environment
{
  "local_name": "@babel/core",
  "alias": false,
  "peer_metadata": null
}
^7.7.2development
@babel/plugin-transform-modules-commonjs
Environment
{
  "local_name": "@babel/plugin-transform-modules-commonjs",
  "alias": false,
  "peer_metadata": null
}
^7.7.0development
@babel/preset-env
Environment
{
  "local_name": "@babel/preset-env",
  "alias": false,
  "peer_metadata": null
}
^7.7.1development
babel-jest
Environment
{
  "local_name": "babel-jest",
  "alias": false,
  "peer_metadata": null
}
^24.9.0development
eth-sig-util
Environment
{
  "local_name": "eth-sig-util",
  "alias": false,
  "peer_metadata": null
}
^2.5.3development
ganache-core
Environment
{
  "local_name": "ganache-core",
  "alias": false,
  "peer_metadata": null
}
^2.10.1development
jest
Environment
{
  "local_name": "jest",
  "alias": false,
  "peer_metadata": null
}
^24.9.0development
standard
Environment
{
  "local_name": "standard",
  "alias": false,
  "peer_metadata": null
}
^14.3.1development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "integrity": "sha512-GS3IfeXWnaLasHaOGvQukr9Gm+9IgofbysfkZF5X6lNztVysXhj5ZXv+Az5FmDNg3Q/ssVw7FfwK/r7HJYNi+g==",
  "shasum": "7cad4d32bdc76772436b8977e56476c3d37ef05e",
  "tarball": "https://registry.npmjs.org/3id-blockchain-utils/-/3id-blockchain-utils-0.3.4.tgz",
  "fileCount": 20,
  "unpackedSize": 45805,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJewrkCCRA9TVsSAnZWagAAnvYQAIjIrt4VrJEsSyU2lEO7\nEfxQhFM76PVTqPTTTCoWxqL31/McT9oGlmxWmxzHfbNCSQ0Ifp0slAe89ltA\nxx36p4YA5Jt1S/SMm2pWrc25EZDC5E56vVVf1EvykGMjsGif0Ydm4chpR8GR\n/7Scpsu7gA6BvWUaZbszRpyBbYoxfZr11k3GShICGP6mGVmAwmX0XsmwCj7Q\n94gm/m5RNkwd78Vb88PBEEgdGSIPd2URp5Dbj5ATKQkHDWhrHnZo/vrzDprW\nom9oNmtveIJq07c6nYRjDBizFMat5amW8HkwE0N0uHDU8uErcQXISJvHgiBq\nMPJJ2AgrxQBqxqI1EDyic49MHv2U49qwSSesBzysxKgvLkYAQP+lfDg+U4xf\npL2+CfXvsPkaC237uZqx0wMDkoDRYuPvjkgJyHeZgzROetXujqLtj+IUAxX0\neFXXYemChGNx2S8KkMtDcrN06+0DtZh3XCtmoVgm38ibTmQwRnv2IhFrGFgk\n1zdOUI+Mhs6vDcODFQUdZisDVp6eVu0eITHJOUS0YPunUUWuJdfhR8Wqapu2\n1RMoAJeydMwjn/g6Chrx+PH9qxE/4yhBq3L4lUFiVvi5sykgbQ8bCPs+wLYd\nTmiHfM2c6ztC4CJoOfrsGRr77pkq61zzKzygBWSe+rDp8wbiTHDh9D6zxtDw\nIRWh\r\n=xuq/\r\n-----END PGP SIGNATURE-----\r\n",
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEUCICt5OxDug+baXcj54yT6TxG7u9Ol7kYbKeHiUGLhm18SAiEAvUC1gztpOWJEF4Eftk38bIq09tFT+4D4A2KjvBe6yHc="
    }
  ]
}

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:45 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:104e1d768419571fa77b6429ff68cb9baeeaf80dbc504b7fc4f33ca48f8d2954

Other collected versions

1.3.116 Dec1.3.016 Dec1.2.09 Dec1.1.124 Nov1.1.018 Nov1.0.011 AugView all collected versions →