uport-registry

uPort Registry

##Warning:

Our mobile uport app and supporting infrastructure does not use this registry yet. If you need to integrate with the mobile app or our servers, lock your package.json to version 2.0.6 for the time being: "uport-registry": "2.0.6".

Deployed Contracts

The registry has been deployed at the following locations:

• Ropsten Testnet: 0x41566e3a081f5032bdcad470adb797635ddfe1f0
• Mainnet: 0xab5c8051b9a1df1aab0149f8b0630848b7ecabf6

About

The uPort registry library lets you set the attributes of a uPort identity. The attributes needs to be in a JSON format. Right now we are focusing on

• Full Name
• Profile Picture

but we intend to support the full Schema.org Person schema. The Full Name and Profile Picture is stored in IPFS as a JSON structure that corresponds to the schema.org schema:

{
   "@context": "http://schema.org/",
   "@type": "Person",
   "name": "Christian Lundkvist",
   "image": [{"@type": "ImageObject",
             "name": "avatar",
             "contentUrl" : "/ipfs/QmUSBKeGYPmeHmLDAEHknAm5mFEvPhy2ekJc6sJwtrQ6nk"}]
}

and an IPFS hash of this structure is stored in the contract as a bytes structure.

uPort Registry Library

The uPort Registry Library allows you to set attributes of and/or view attributes of uPort identities in your Dapp.

Running tests

npm run test

Note: The tests currently timeout instead of throwing exceptions

Development of this code base

After making changes to contracts/ use npm run build-contract to create .sol.js js abstraction objects. After making changes to src/, build with npm run build:es5 (this puts them in lib/)

Only then run tests.

Finally use npm run build to create the dist/uportregistry.js file

Usage

To use the library, first include it in your project:

var UportRegistry = require("uport-registry");
var registry = new UportRegistry()

IPFS Setup

It defaults to the Infura IPFS server but you can easily set it to a local server or use another client library using setIpfsProvider

You can change the ipfs connection details by passing a configuration object containing a

var registry = new UportRegistry({
  ipfs: { host: '127.0.0.1', port: 5001 }
});

We also support a full ipfs-js-api compliant client:

const ipfsApi = require('ipfs-api');
var registry = new UportRegistry({
  ipfs: ipfsAPI('localhost', '5001', {protocol: 'http'})
});

Customize Web3 Provider

By default it connects to Infura's ropsten network. But you can change it by passing in your own web3 provider.

var Web3    = require('web3');
var registry = new UportRegistry({
  web3prov: new Web3.providers.HttpProvider('https://ropsten.infura.io/uport-registry')
});

Change uport registry address

By default it uses the ropsten uport registry at 0x41566e3a081f5032bdcad470adb797635ddfe1f0. You can change this using the registryAddress setting.

var Web3    = require('web3');
var registry = new UportRegistry({
  web3prov: new Web3.providers.HttpProvider('https://mainnet.infura.io/uport-registry'),
  registryAddress: '0xab5c8051b9a1df1aab0149f8b0630848b7ecabf6'
});

Setting uportRegistry Attributes

var attributes =
{
   "@context": "http://schema.org",
   "@type": "Person",
   "name": "Christian Lundkvist",
   "image": [{"@type": "ImageObject",
             "name": "avatar",
             "contentUrl" : "/ipfs/QmUSBKeGYPmeHmLDAEHknAm5mFEvPhy2ekJc6sJwtrQ6nk"}]
}

registry.setAttributes( attributes,
                        {from: myAddr}
                      ).then(function ()
                            {console.log('Attributes set.')})

Getting attributes

If you have an address of the current uPort identity, you can get their associated attributes using the command uPortRegistry.getAttributes(). This command looks up the attributes and returns a JSON structure.

var registryAddress = '0x41566e3a081f5032bdcad470adb797635ddfe1f0'
var uportId = '0xdb24b49d8f7e47d30498ee2a846375c3ba771d3e'

registry.getAttributes(uportId).then(function (attributes)
                            {console.log(attributes)})