Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADR02: atomkraft init #12

Draft
wants to merge 3 commits into
base: dev
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions doc/src/adr03-atomkraft-init.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ADR-03: Atomkraft init subcommand

| authors | revision | revision date |
| --------------- | -------: | ------------: |
| Ranadeep Biswas | 1 | July 13, 2022 |

## Status

Proposed

## Context

We are figuring out how a user will use Atomkraft - produce tests, interact with test setup, and execute them.

The idea is to provide an `atomkraft` cli, which initializes a [poetry](https://python-poetry.org) project with [pytest](https://docs.pytest.org) dependency and other necessary configurations.

## Decision

To set up an `atomkraft` project,

- `atomkraft init BINARY DIR` is executed which sets up a poetry project at `DIR`.
- After changing the directory to `DIR`, a user should be able to execute some kick-the-tire tests (included in Atomkraft) for standard Cosmos-SDK modules right out of the box.
- The chain parameters can be queried/modified using `atomkraft chain config CONFIGFILE KEYPATH [VALUE]`
- A testnet can be started via `atomkraft chain up [-d]`.
- A testnet can be shut down via `atomkraft chain down`.

## Summary

- `atomkraft init` to initialize atomkraft project as a poetry project with python 3.10 and pytest dependency
- `atomkraft test-drive` to execute a set of standard Cosmos-SDK tests using provided chain binary.
- `atomkraft chain config CONFIGFILE KEYPATH [VALUE]` to update chain configuration.
- `atomkraft chain [up|down]` to control a testnet.