search

input-output-hk / partner-chains-smart-contracts

Command Line Tool and Cardano Plutus Contracts for interacting with Partner Chains.
Apache License 2.0
9 stars 2 forks source link

Add documented steps on how to use the CLI app for running the different commands in an e2e scenario #41

Open koslambrou opened 7 months ago

koslambrou commented 7 months ago

As a user of the trustless-sidechain CLI app, I want to read e2e examples in the documentation of how to run/use the CLI app so that

Proposed solution:

We have this nice Nix script (nix run .#ctl-runtime-preview) which runs all the required containers. However, to run most CLI commands, we need a way to interact with the node mainly by submitting transactions and querying the state.

I propose to use cardano-cli as the main tool for interacting with the node (in the documentation, not in the code) as it is a nice high-level way of expressing what you are doing.

If we go in this direction, cardano-cli would need to have access to the cardano-node.socket file which is inside the container. To achieve, we can have Docker expose that file outside of the container.

IOG Jira: https://input-output.atlassian.net/browse/ETCM-6871

jstolarek commented 7 months ago

A kind reminder to create a corresponding Jira ticket.