Skip to content
This repository has been archived by the owner on Apr 15, 2020. It is now read-only.

Commit

Permalink
Preparing for release
Browse files Browse the repository at this point in the history
  • Loading branch information
oed committed Apr 8, 2017
1 parent f670029 commit e5b6106
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
14 changes: 9 additions & 5 deletions README.md
Expand Up @@ -9,14 +9,18 @@ The registry has been deployed at the following locations:
- Kovan: `0xea8ac9cf5c3d02cfc30f65c04ed921d713062745`
- Mainnet: `0xab5c8051b9a1df1aab0149f8b0630848b7ecabf6`

## Installation
```
$ npm i --save uport-registry
```

## Using the contract
By installing this library you get access to a truffle-contract compatible json file. You can import this into your project to use the uport registry on any network it is deployed on, truffle-contract will automatically detect which network you are on.
Use the following code to get the deployed uport registry:
Use the following code to get the deployed instance of the registry:
```javascript
const regsitryContract = require('uport-registry')
const regsitryArtifact = require('uport-registry')
const Contract = require('truffle-contract')
const Registry = Contract(regsitryContract)
const Registry = Contract(regsitryArtifact)
Registry.setProvider(web3prov)
let registry = Registry.deployed()
```
Expand Down Expand Up @@ -54,7 +58,7 @@ Clone the repo and install `yarn` on your system.
run `yarn install` to install all node_modules.

### Compiling
After making changes to the contract use `yarn compile-contract` to create the json file with the contract data that can be used with `truffle-contract`.
After making changes to the contract use `yarn compile-contract` to create the json artifact.

### Running tests
```
Expand All @@ -63,7 +67,7 @@ yarn test
Note: The tests currently timeout instead of throwing exceptions

### Deployment
To deploy the registry we used truffle, but our deploy script has a special option in order to specify the previous version of the registry. So to deploy do the following:
To deploy the registry we used truffle, but our deploy script has a special option in order to specify the previous version of the registry. So to deploy a new version of the registry, do the following:
```
truffle migrate --network <name of eth network> --prevAddr <address of previous registry version>
```
4 changes: 4 additions & 0 deletions RELEASE-NOTES.md
@@ -1,5 +1,9 @@
# Release Notes #

## Version 5.0.0 - 2017-04-08

* Removed the javascript library. This repo now only provides the contract itself and a truffle artifact with ABI + network information

## Version 4.0.1 - 2017-02-03

* Added warnings in the readme that our mobile uport app and infrastructure will not support this registry yet. added a tag to the commit that does work with out mobile app. console log from the constructor of the same. we will depricate the npm package so npm installers using it get a message.
Expand Down
2 changes: 1 addition & 1 deletion test/providerUtil.js
@@ -1,6 +1,6 @@
const TestRPC = require('ethereumjs-testrpc')

let web3Provider, ipfsProvider
let web3Provider

module.exports = (cb) => {
if (!web3Provider) {
Expand Down

0 comments on commit e5b6106

Please sign in to comment.