-
Notifications
You must be signed in to change notification settings - Fork 375
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into aaronmgdr/biscuit
* master: (61 commits) Remove locales as website is now just in English (#1050) Add MetadataURL to account struct (#1103) Allow validators to use any valid combination of gold commitments as stake (#885) Fix blockscout websocket jsonrpc url (#1096) [Wallet] Preliminary iOS support (#1098) [Wallet] Set security fee description translation in Spanish (#1097) Exclude generated in vscode file watcher setting (#1082) Update .env and .env.integration files (#1087) Allow a testnet to run without ethstats (#1085) Collect exchange rate time series using notification service (#1020) Return to preview view when Fee Education is closed (#1068) [Wallet] Pin Setup Flow v2 (#1054) Added a variable for electoral threshold (#1023) [celotool]Store .env config on GCS after deployment (#1086) Group size limit (#1035) Fix governance unit tests (#1084) Add getExchangeRate to ContractKit (#1083) [CLI]Unlock till the geth exits (#1070) Add Quorum and Refactor Governance (#430) Shuffle elected validators using block randomness (#1033) ...
- Loading branch information
Showing
563 changed files
with
13,594 additions
and
10,678 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# README GUIDE FOR CELO DEVELOPERS | ||
|
||
## How to publish a new npm package | ||
|
||
First checkout the alfajores branch. | ||
|
||
``` | ||
celo-monorepo $ git checkout alfajores | ||
celo-monorepo $ yarn | ||
``` | ||
|
||
Before publishing a new celocli package, test in isolation using Docker. This confirms that it is locally installable and does not have implict dependency on rest of the celo-monorepo or have an implicit dependency which is an explicit dependency of another celo-monorepo package. | ||
|
||
``` | ||
# To test utils package, change $PWD/packages/cli to $PWD/packages/utils | ||
# To test contractkit package, change $PWD/packages/contractkit to $PWD/packages/contractkit | ||
celo-monorepo $ docker run -v $PWD/packages/cli:/tmp/npm_package -it --entrypoint bash node:8 | ||
root@e0d56700584f:/# mkdir /tmp/tmp1 && cd /tmp/tmp1 | ||
root@e0d56700584f:/tmp/tmp1# npm install /tmp/npm_package/ | ||
``` | ||
|
||
After testing, exit the docker container, and publish the package. Do note that all our packages are prefixed with "@celo/" and only members listed [here](https://www.npmjs.com/settings/celo/members) can publish new packages or update the existing ones. | ||
|
||
``` | ||
# Publish the package publicly | ||
celo-monorepo/packages/cli $ yarn publish --access=public | ||
# Increment the version number, after testing, we will push that commit to GitHub | ||
``` | ||
|
||
Let's say the published package version number 0.0.15, verify that it is installable | ||
|
||
``` | ||
/tmp/tmp1 $ npm install @celo/[email protected] | ||
``` | ||
|
||
Once you publish do some manual tests, for example, after publishing `celocli` | ||
|
||
``` | ||
# Docker for an isolated environment again | ||
celo-monorepo $ docker run -it --entrypoint bash node:8 | ||
root@e0d56700584f:/# mkdir /tmp/tmp1 && cd /tmp/tmp1 | ||
root@e0d56700584f:/tmp/tmp1# npm install @celo/[email protected] | ||
/tmp/tmp1# ./node_modules/.bin/celocli | ||
CLI Tool for transacting with the Celo protocol | ||
VERSION | ||
@celo/celocli/0.0.20 linux-x64 node-v8.16.1 | ||
USAGE | ||
$ celocli [COMMAND] | ||
COMMANDS | ||
account Manage your account, send and receive Celo Gold and Celo Dollars | ||
bonds Manage bonded deposits to participate in governance and earn rewards | ||
config Configure CLI options which persist across commands | ||
exchange Commands for interacting with the Exchange | ||
help display help for celocli | ||
node Manage your full node | ||
validator View validator information and register your own | ||
validatorgroup View validator group information and cast votes | ||
root@f8c51e3c7bc3:/tmp/tmp1# ./node_modules/.bin/celocli account:new | ||
This is not being stored anywhere, so, save the mnemonic somewhere to use this account at a later point | ||
mnemonic: wall school patrol also peasant enroll build merit health reduce junior obtain awful sword warfare sponsor honey display resemble bubble trend elevator ostrich assist | ||
privateKey: a9531609ca3d1c224e0742a4bb9b9e2fae67cc9d872797869092804e1500d67c | ||
publicKey: 0429b83753806f2b61ddab2e8a139214c3c8a5dfd0557557830b13342f2490bad6f61767e1b0707be51685e5e13683e6fa276333cbdb06f07768a09b8070e27259accountAddress: 0xf63e0F60DFcd84090D2863e0Dfa452B871fdC6d7 | ||
``` | ||
|
||
Now push your changes `git push origin alfajores`. | ||
If you don't have access to the repo, you might have to open a PR. |
Oops, something went wrong.