@reality.eth/contracts 3.0.3 → 3.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -28,7 +28,6 @@ See [example.js](example.js) for more examples.
28
28
 
29
29
  The above are combined into JSON files under *generated/* using `npm run-script generate`.
30
30
 
31
-
32
31
  *development/contracts/* contains source files and build files for contracts from the original build, as laid out by truffle. These files are no longer supported as a way of managing contract addresses.
33
32
 
34
33
  *config/templates.json* contains information about templates deployed by the constructor to save fetching them from the event logs.
@@ -63,6 +62,8 @@ You will need the private key of an account with funds to deploy on the relevant
63
62
 
64
63
  The `.gitignore` file should prevent it from being checked into Git, but be careful not to share it.
65
64
 
65
+ If it's the first time for the token you intend to use to be deployed on the chain you intend to use, add a JSON file describing your token under *tokens/* then run `npm run-script generate`.
66
+
66
67
  To deploy contracts using the code compiled under contracts/bytecode, use
67
68
 
68
69
  `$ cd packages/contracts/scripts`
@@ -71,8 +72,13 @@ To deploy contracts using the code compiled under contracts/bytecode, use
71
72
 
72
73
  This will add contract addresses to the existing deployed contract .json definitions, and deploy per-token versions in the format expected by the `@reality.eth/dapp` ui.
73
74
 
74
- If the token or network was not previously supported, you will need to add its configuration files and run `npm run-script generate`.
75
+ Supported networks are hard-coded in the `deploy.js` file. You may also wish to edit it to alter gas limits, etc.
76
+
77
+ Once the deployment is complete, run `npm run-script generate`.
75
78
 
76
79
  ## Adding your contracts to the dapp
77
80
 
78
- If you have added Reality.eth for a new token, or a new arbitrator, or both, please submit the changes to this repo as a PR.
81
+ For a new deployment to show up in the dapp it is necessary to rebuild the dapp with the updated `packages/contracts`. For Graph support to work in the dapp, the Subgraph will also need to be republished, using the code under `packages/graph`.
82
+
83
+ If you have added Reality.eth for a new token, or a new arbitrator, or both, please submit the changes to this repo as a PR so that we can update the dapp at reality.eth and the Subgraphs we maintain.
84
+