11
2- # Cardano Testnet (docker) Node Toolkit 🤠
2+ # Cardano Testnet Node Toolkit 🤠
33
4- A simple dockerized Cardano node toolkit,
5- for running a Cardano testnet nodes and interacting with Cardano networks .
4+ A simple Cardano node toolkit,
5+ interact with Cardano nodes running in docker or connect via socket file .
66
7- ** Current node version:** ` 10.5.3 `
7+ Allowing the user to run multiple dockerised nodes,
8+ with different versions and across networks.
9+
10+ ** Docker node version choices:** ` 10.5.3 ` , ` 10.5.1 `
811
912## Prerequisites
1013
1114### ` Docker `
1215
1316Install docker desktop for your operating system.
17+
1418- < https://docs.docker.com/engine/install >
1519
1620If you are using Apple silicon (M1, M2, M3 processor) make sure you have Rosetta enabled via Docker desktop settings.
1721
1822### Visual Studio Code
1923
2024Install VSCode so we can more easily navigate directories, and inspect files.
25+
2126- < https://code.visualstudio.com/ >
2227
2328### Mac Specific Prerequisites
@@ -29,6 +34,7 @@ xcode-select --install
2934```
3035
31362 . Rosetta.
37+
3238``` zsh
3339softwareupdate --install-rosetta
3440```
@@ -41,7 +47,7 @@ Windows Subsystem for Linux.
4147
4248## Setup Guide
4349
44- ### 1. Clone this repository.
50+ ### 1. Clone this repository
4551
4652You may want to make a nice folder/directory for this first.
4753
@@ -51,19 +57,19 @@ Clone into current directory.
5157git clone https://github.com/Ryun1/testnet-docker-node.git
5258```
5359
54- ### 2. Open ` testnet-docker-node ` from within Visual Studio Code.
60+ ### 2. Open ` testnet-docker-node ` from within Visual Studio Code
5561
5662Open Visual Studio Code and then go ` File > Open Folder ` selecting ` testnet-docker-node ` folder.
5763
5864![ Open Folder VS Code] ( ./docs/images/setup-2.png )
5965
60- ### 3. Open a terminal in Visual Studio Code.
66+ ### 3. Open a terminal in Visual Studio Code
6167
6268Open a terminal inside of VSCode.
6369
6470![ Open Terminal Console] ( ./docs/images/setup-3.png )
6571
66- ### 4. Update script permissions.
72+ ### 4. Update script permissions
6773
6874Inside the terminal console, give scripts execute file permissions.
6975
7480```
7581
7682Run the following command.
83+
7784``` zsh
7885chmod +x ./start-node.sh ./stop-nodes.sh ./scripts/*
7986```
@@ -123,7 +130,7 @@ And then click on the new terminal.
123130
124131![ Navigate to new terminal] ( ./docs/images/usage-check-1-b.png )
125132
126- #### 2. Query tip of node.
133+ #### 2. Query tip of node
127134
128135Run the node query tip script.
129136
@@ -186,11 +193,12 @@ Now you have a node you can actually ✨*do fun stuff*✨
186193
187194### Setup keys and get tAda
188195
189- #### 1. Generate keys, addresses and a DRep ID.
196+ #### 1. Generate keys, addresses and a DRep ID
190197
191198We have a script that:
199+
192200- randomly generates a set of payment, stake and DRep keys
193- - from keys, creates addresses and a DRep ID
201+ - from keys, creates addresses and a DRep ID
194202
195203In a terminal execute:
196204
@@ -202,7 +210,7 @@ This will create you a keys directory with some fun things inside, looks like th
202210
203211![ New keys and addresses] ( ./docs/images/doing-1.png )
204212
205- #### 2. Get some tAda.
213+ #### 2. Get some tAda
206214
207215Get yourself some test ada, so you can pay for transaction fees.
208216
@@ -218,21 +226,21 @@ I will give an example of what you could do.
218226
219227Make sure you have a node running for these.
220228
221- #### Become a DRep, delegate to self and vote.
229+ #### Become a DRep, delegate to self and vote
222230
223- ##### 1. Register as a DRep.
231+ ##### 1. Register as a DRep
224232
225233``` bash
226234./scripts/drep/register.sh
227235```
228236
229- ##### 2. Register your stake key (needed before delegating).
237+ ##### 2. Register your stake key (needed before delegating)
230238
231239``` bash
232240./scripts/stake/key-register.sh
233241```
234242
235- ##### 3. Delegate your tAda's voting rights to yourself.
243+ ##### 3. Delegate your tAda's voting rights to yourself
236244
237245``` bash
238246./scripts/drep/delegate-to-self.sh
@@ -274,19 +282,6 @@ export CARDANO_NODE_NETWORK_ID=1 # 1=preprod, 2=preview, 4=sanchonet
274282- ** preprod** : Network ID ` 1 `
275283- ** preview** : Network ID ` 2 `
276284- ** sanchonet** : Network ID ` 4 `
277- - ** mainnet** : Network ID ` 764824073 ` (blocked for external nodes)
278-
279- ### Docker Container Selection
280-
281- Specify which Docker container to use:
282-
283- ``` bash
284- # Use specific container
285- CARDANO_CONTAINER_NAME=" node-preprod-10.5.3-container" ./scripts/query/tip.sh
286-
287- # Use different container
288- CARDANO_CONTAINER_NAME=" node-preview-10.5.3-container" ./scripts/query/tip.sh
289- ```
290285
291286### Multiple Docker Containers
292287
0 commit comments