nim-dagger/docker
Ben Bierens 4e8630791a
Rework circuit downloader (#882)
* Introduces a start method to prover

* Moves backend creation into start method

* sets up three paths for backend initialization

* Extracts backend initialization to backend-factory

* Implements loading backend from cli files or previously downloaded local files

* Wires up downloading and unzipping

* functional implementation

* Fixes testprover.nim

* Sets up tests for backendfactory

* includes libzip-dev

* pulls in updated contracts

* removes integration cli tests for r1cs, wasm, and zkey file arguments.

* Fixes issue where inner-scope values are lost before returning

* sets local proof verification for dist-test images

* Adds two traces and bumps nim-ethers

* Adds separate path for circuit files

* Create circuit dir if not exists

* fix: make sure requestStorage is mined

* fix: correct place to plug confirm

* test: fixing contracts tests

* Restores gitmodules

* restores nim-datastore reference

* Sets up downloader exe

* sets up tool skeleton

* implements getting of circuit hash

* Implements downloader tool

* sets up test skeleton

* Implements test for cirdl

* includes testTools in testAll

* Cleanup building.md

* cleans up previous downloader implementation

* cleans up testbackendfactory

* moves start of prover into node.nim

* Fills in arguments in example command

* Initializes backend in prover constructor

* Restores tests

* Restores tests for cli instructions

* Review comments by Dmitriy, part 1

* Quotes path in download instruction.

* replaces curl with chronos http session

* Moves cirdl build output to 'build' folder.

* Fixes chronicles log output

* Add cirdl support to the codex Dockerfile

Signed-off-by: Slava <20563034+veaceslavdoina@users.noreply.github.com>

* Add cirdl support to the docker entrypoint

Signed-off-by: Slava <20563034+veaceslavdoina@users.noreply.github.com>

* Add cirdl support to the release workflow

Signed-off-by: Slava <20563034+veaceslavdoina@users.noreply.github.com>

* Disable verify_circuit flag for releases

Signed-off-by: Slava <20563034+veaceslavdoina@users.noreply.github.com>

* Removes backendFactory placeholder type

* wip

* Replaces zip library with status-im/zippy library (which supports zip and tar)

* Updates cirdl to not change circuitdir folder

* Switches from zip to tar.gz

* Review comments by Dmitriy

* updates codex-contracts-eth

* Adds testTools to CI

* Adds check for access to config.circuitdir

* Update fixture circuit zkey

* Update matrix to run tools tests on Windows

* Adds 'deps' dependency for cirdl

* Adjust docker-entrypoint.sh to use CODEX_CIRCUIT_DIR env var

* Review comments by Giuliano

---------

Signed-off-by: Slava <20563034+veaceslavdoina@users.noreply.github.com>
Co-authored-by: Adam Uhlíř <adam@uhlir.dev>
Co-authored-by: Veaceslav Doina <20563034+veaceslavdoina@users.noreply.github.com>
2024-09-23 14:37:17 +00:00
..
README.md Updates rust in docker. Pins circom-compat to pinned FFI branch (#818) 2024-05-31 08:23:11 +00:00
codex.Dockerfile Rework circuit downloader (#882) 2024-09-23 14:37:17 +00:00
docker-compose.yaml Adds option to automatically announce codex by its public IP (#621) 2023-11-17 13:48:25 +00:00
docker-entrypoint.sh Rework circuit downloader (#882) 2024-09-23 14:37:17 +00:00

README.md

Codex Docker Image

Codex provides pre-built docker images and they are stored in the codexstorage/nim-codex repository.

Run

We can run Codex Docker image using CLI

# Default run
docker run --rm codexstorage/nim-codex

# Mount local datadir
docker run -v ./datadir:/datadir --rm codexstorage/nim-codex codex --data-dir=/datadir

And Docker Compose

# Run in detached mode
docker-compose up -d

Arguments

Docker image is based on the codex.Dockerfile and there is

ENTRYPOINT ["/docker-entrypoint.sh"]
CMD ["codex"]

It means that at the image run it will just run codex application without any arguments and we can pass them as a regular arguments, by overriding command

docker run codexstorage/nim-codex codex --api-bindaddr=0.0.0.0 --api-port=8080

Environment variables

We can configure Codex using Environment variables and docker-compose.yaml file can be useful as an example.

We also added a temporary environment variable NAT_IP_AUTO to the entrypoint which is set as false for releases and true for regular builds. That approach is useful for Dist-Tests.

# Disable NAT_IP_AUTO for regular builds
docker run -e NAT_IP_AUTO=false codexstorage/nim-codex

Slim

  1. Build the image using docker build -t codexstorage/codexsetup:latest -f codex.Dockerfile ..
  2. The docker image can then be minified using slim. Install slim on your path and then run:
    slim # brings up interactive prompt
    >>> build --target status-im/codexsetup --http-probe-off true
    
  3. This should output an image with name status-im/codexsetup.slim
  4. We can then bring up the image using docker-compose up -d.