diff --git a/README.md b/README.md index a7966dc..bc5ffde 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,19 @@ -# cic-internal-integration +# Community Inclusion Currency Stack (CIC Stack) + +A custodial evm wallet for executing transactions via USSD ## Getting started This repo uses docker-compose and docker buildkit. Set the following environment variables to get started: - ``` export COMPOSE_DOCKER_CLI_BUILD=1 export DOCKER_BUILDKIT=1 ``` -start services, database, redis and local ethereum node -``` -docker-compose up -d -``` +To get started see [./apps/contract-migration/README.md](./apps/contract-migration/README.md) -Run app/contract-migration to deploy contracts -``` -RUN_MASK=3 docker-compose up contract-migration -``` +## Documentation -stop cluster -``` -docker-compose down -``` +[https://docs.grassecon.org/cic_stack/](https://docs.grassecon.org/cic_stack/) -stop cluster and delete data -``` -docker-compose down -v --remove-orphans -``` - -rebuild an images -``` -docker-compose up --build -``` - -to delete the buildkit cache -``` -docker builder prune --filter type=exec.cachemount -``` diff --git a/apps/contract-migration/README.md b/apps/contract-migration/README.md index e3e72d6..fd3a523 100644 --- a/apps/contract-migration/README.md +++ b/apps/contract-migration/README.md @@ -27,6 +27,7 @@ In the current version of the scripts, two token types may be deployed; [`giftab This step may be run multiple times, as long as the token symbol is different from all previously deployed tokens. + ## 4. Initialize custodial engine. Adds system accounts to the custodial engine, and unlocks the initialization seal. After this step, the custodial system is ready to use. @@ -35,10 +36,12 @@ Adds system accounts to the custodial engine, and unlocks the initialization sea ## Services dependency graph 1. evm -2. bootstrap runlevel 1 -3. bootstrap runlevel 2 -4. bootstrap runlevel 3 +2. bootstrap runlevel 1 - deploy global contracts (RUN_MASK=1 docker-compose up bootstrap) +3. bootstrap runlevel 2 - deploy instance contracts (RUN_MASK=2 docker-compose up bootstrap) +4. bootstrap runlevel 4 - deploy token (RUN_MASK=4 docker-compose up bootstrap) 5. redis 6. postgres -7. cic-eth-tasker -8. boostrap runlevel 4 +7. cic-eth-tasker +8. boostrap runlevel 8 - deploy custodial contracts (RUN_MASK=8 docker-compose up bootstrap) +9. boostrap runlevel 16 - data seeding for development (RUN_MASK=16 docker-compose up bootstrap) +10. bring up the remainig services (docker-compose up -d) diff --git a/docker-compose.yml b/docker-compose.yml index a310b6d..c2b610d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -67,7 +67,7 @@ services: RUN_MASK: ${RUN_MASK:-0} TOKEN_NAME: $TOKEN_NAME TOKEN_SYMBOL: $TOKEN_SYMBOL - TOKEN_TYPE: $TOKEN_TYPE + TOKEN_TYPE: ${TOKEN_TYPE:-giftable_erc20_token} TOKEN_DECIMALS: $TOKEN_DECIMALS TOKEN_REDISTRIBUTION_PERIOD: $TOKEN_REDISTRIBUTION_PERIOD TOKEN_SUPPLY_LIMIT: $TOKEN_SUPPLY_LIMIT