Compare commits
4 Commits
lum/easy-t
...
v0.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b77f572b82 | ||
| c832763240 | |||
| 941b9e6b65 | |||
| 0fcf2eb3bc |
22
CHANGELOG.md
Normal file
22
CHANGELOG.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Changelog
|
||||
|
||||
<!--next-version-placeholder-->
|
||||
|
||||
## v0.1.0 (2022-03-16)
|
||||
### Feature
|
||||
* Add interactive deployment and switch to poetry' ([#2](https://git.grassecon.net/cicnet/cic-cli/issues/2)) ([`0fcf2eb`](https://git.grassecon.net/cicnet/cic-cli/commit/0fcf2eb3bc807111db02e9e47e469ec0a965797f))
|
||||
* **wizard:** Add ability to select wallet address ([`556366a`](https://git.grassecon.net/cicnet/cic-cli/commit/556366a93384bba51aa617d54bcf50f4473b790a))
|
||||
* Add token symbol proof metadata references ([`a707f12`](https://git.grassecon.net/cicnet/cic-cli/commit/a707f120865186c8e4a7840d53c9dcf5f4257ab3))
|
||||
|
||||
### Fix
|
||||
* Add getpass ([`47a9b25`](https://git.grassecon.net/cicnet/cic-cli/commit/47a9b259ae54c34df9af4aa1fb176070d305296a))
|
||||
* Incorrect var name ([`41dbd5a`](https://git.grassecon.net/cicnet/cic-cli/commit/41dbd5a400287d4687d0830017466b9a43054ecf))
|
||||
* **ext:** Allow loading chain_spec from config ([`1d4b051`](https://git.grassecon.net/cicnet/cic-cli/commit/1d4b0512ad65b4d2903bd7d022e562cda158a592))
|
||||
* Change name to cic-cli ([`40e386d`](https://git.grassecon.net/cicnet/cic-cli/commit/40e386db1175839394f2480a1a3e1bbfc52edea9))
|
||||
* Add missing json import ([`48ee805`](https://git.grassecon.net/cicnet/cic-cli/commit/48ee8050c17edb21b0dc4065bf0018b1502d4a8c))
|
||||
* Broken imports ([`4f219e3`](https://git.grassecon.net/cicnet/cic-cli/commit/4f219e3d1853befa197f46a19dc8a8a76ef26811))
|
||||
|
||||
### Documentation
|
||||
* Add cluter deployment info ([`941b9e6`](https://git.grassecon.net/cicnet/cic-cli/commit/941b9e6b650163c4f35e4b08203fb10c9309ee91))
|
||||
* Rename prod config to testnet ([`67f947a`](https://git.grassecon.net/cicnet/cic-cli/commit/67f947a9af16dc01fb68459a51629320264d281f))
|
||||
* Add badge ([`be5d988`](https://git.grassecon.net/cicnet/cic-cli/commit/be5d988fa4d03dfcd44f71c7c6d4a562b780da09))
|
||||
40
README.md
40
README.md
@@ -9,10 +9,35 @@ token deployments.
|
||||
pip install --extra-index-url https://pip.grassrootseconomics.net cic[eth]
|
||||
```
|
||||
## Setup
|
||||
### Importing a wallet from metamask
|
||||
- Export the accounts private key [Instructions](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-Export-an-Account-Private-Key)
|
||||
- Save the private key to a file
|
||||
- Run `eth-keyfile -k <file> > ~/.config/cic/keystore/keyfile.json`
|
||||
### Requirements
|
||||
- Install [poetry](https://python-poetry.org/docs/#installation)
|
||||
<details>
|
||||
<summary>Install Kubectl</summary>
|
||||
|
||||
```bash
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y apt-transport-https ca-certificates curl
|
||||
sudo curl -fsSLo /usr/share/keyrings/kubernetes-archive-keyring.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg
|
||||
echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee /etc/apt/sources.list.d/kubernetes.list
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y kubectl
|
||||
```
|
||||
</details>
|
||||
|
||||
### Deploy to the testnet
|
||||
|
||||
- Download testnet cluster config from https://cloud.digitalocean.com/kubernetes/clusters
|
||||
- Move the config to `$HOME/.kube/`
|
||||
- Run `kubectl -n grassroots --kubeconfig=$HOME/.kube/<config_file_name>.yaml get pods`
|
||||
- Copy the name of the meta pod (e.g `cic-meta-server-67dc7c6468-8rhdq`)
|
||||
- Port foward the meta pod to the local machine using `kubectl port-forward pods/<name_of_meta_pod> 6700:8000 -n grassroots --kubeconfig=$HOME/.kube/<config_file_name>.yaml`
|
||||
- Clone this repository to your local machine
|
||||
- Run `poetry install -E eth` in the repo root
|
||||
- Open `./config/testnet/config.ini` and change
|
||||
- [auth]keyfile_path
|
||||
- [wallet]key_file
|
||||
- Open a new terminal and run `poetry run cic wizard -c ./config/testnet ./somewhere`
|
||||
|
||||
|
||||
## Usage
|
||||
### Using the wizard
|
||||
@@ -51,8 +76,7 @@ state of the package contains interface to EVM only. Thus, the examples
|
||||
below are limited to the context of the EVM.
|
||||
|
||||
## Development
|
||||
### Requirements
|
||||
- [poetry](https://python-poetry.org/docs/#installation)
|
||||
|
||||
### Setup
|
||||
|
||||
```
|
||||
@@ -68,6 +92,10 @@ below are limited to the context of the EVM.
|
||||
```bash
|
||||
poetry run cic wizard ./somewhere -c ./config/docker
|
||||
```
|
||||
### Importing a wallet from metamask
|
||||
- Export the accounts private key [Instructions](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-Export-an-Account-Private-Key)
|
||||
- Save the private key to a file
|
||||
- Run `eth-keyfile -k <file> > ~/.config/cic/keystore/keyfile.json`
|
||||
|
||||
### Tests
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
__version__ = "0.0.2"
|
||||
__version__ = "0.1.0"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[tool.poetry]
|
||||
name = "cic-cli"
|
||||
version = "0.0.2"
|
||||
version = "0.1.0"
|
||||
description = "Generic cli tooling for the CIC token network"
|
||||
authors = [
|
||||
"Louis Holbrook <dev@holbrook.no>",
|
||||
@@ -48,7 +48,7 @@ chainlib = "~0.0.17"
|
||||
cbor2 = "5.4.1"
|
||||
|
||||
chainlib-eth = { version = "~0.0.25", optional = true }
|
||||
eth-token-index = { version = "0.2.4", optional = true }
|
||||
eth-token-index = { version = "~0.2.4", optional = true }
|
||||
eth-address-index = { version = "~0.2.4", optional = true }
|
||||
okota = { version = "~0.2.5", optional = true }
|
||||
cic_eth_registry = { version = "~0.6.6", optional = true }
|
||||
@@ -87,7 +87,7 @@ testpaths = ["tests"]
|
||||
[tool.semantic_release]
|
||||
version_variable = ["cic/__init__.py:__version__", "pyproject.toml:version"]
|
||||
version_source = "commit"
|
||||
branch = "main"
|
||||
branch = "master"
|
||||
upload_to_repository = true
|
||||
upload_to_release = true
|
||||
build_command = "pip install poetry && poetry build"
|
||||
|
||||
Reference in New Issue
Block a user