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
16- If you are using Apple silicon (M1, M2, M3 processor) make sure you have Rosetta enabled via Docker desktop settings.
20+ If you are using Apple silicon (M1, M2, M3 processor) make sure you have Rosetta
21+ enabled via Docker desktop settings.
1722
1823### Visual Studio Code
1924
2025Install VSCode so we can more easily navigate directories, and inspect files.
26+
2127- < https://code.visualstudio.com/ >
2228
2329### Mac Specific Prerequisites
@@ -29,6 +35,7 @@ xcode-select --install
2935```
3036
31372 . Rosetta.
38+
3239``` zsh
3340softwareupdate --install-rosetta
3441```
@@ -41,7 +48,7 @@ Windows Subsystem for Linux.
4148
4249## Setup Guide
4350
44- ### 1. Clone this repository.
51+ ### 1. Clone this repository
4552
4653You may want to make a nice folder/directory for this first.
4754
@@ -51,19 +58,19 @@ Clone into current directory.
5158git clone https://github.com/Ryun1/testnet-docker-node.git
5259```
5360
54- ### 2. Open ` testnet-docker-node ` from within Visual Studio Code.
61+ ### 2. Open ` testnet-docker-node ` from within Visual Studio Code
5562
5663Open Visual Studio Code and then go ` File > Open Folder ` selecting ` testnet-docker-node ` folder.
5764
5865![ Open Folder VS Code] ( ./docs/images/setup-2.png )
5966
60- ### 3. Open a terminal in Visual Studio Code.
67+ ### 3. Open a terminal in Visual Studio Code
6168
6269Open a terminal inside of VSCode.
6370
6471![ Open Terminal Console] ( ./docs/images/setup-3.png )
6572
66- ### 4. Update script permissions.
73+ ### 4. Update script permissions
6774
6875Inside the terminal console, give scripts execute file permissions.
6976
7481```
7582
7683Run the following command.
84+
7785``` zsh
7886chmod +x ./start-node.sh ./stop-nodes.sh ./scripts/*
7987```
@@ -123,7 +131,7 @@ And then click on the new terminal.
123131
124132![ Navigate to new terminal] ( ./docs/images/usage-check-1-b.png )
125133
126- #### 2. Query tip of node.
134+ #### 2. Query tip of node
127135
128136Run the node query tip script.
129137
@@ -186,11 +194,12 @@ Now you have a node you can actually ✨*do fun stuff*✨
186194
187195### Setup keys and get tAda
188196
189- #### 1. Generate keys, addresses and a DRep ID.
197+ #### 1. Generate keys, addresses and a DRep ID
190198
191199We have a script that:
200+
192201- randomly generates a set of payment, stake and DRep keys
193- - from keys, creates addresses and a DRep ID
202+ - from keys, creates addresses and a DRep ID
194203
195204In a terminal execute:
196205
@@ -202,7 +211,7 @@ This will create you a keys directory with some fun things inside, looks like th
202211
203212![ New keys and addresses] ( ./docs/images/doing-1.png )
204213
205- #### 2. Get some tAda.
214+ #### 2. Get some tAda
206215
207216Get yourself some test ada, so you can pay for transaction fees.
208217
@@ -218,21 +227,21 @@ I will give an example of what you could do.
218227
219228Make sure you have a node running for these.
220229
221- #### Become a DRep, delegate to self and vote.
230+ #### Become a DRep, delegate to self and vote
222231
223- ##### 1. Register as a DRep.
232+ ##### 1. Register as a DRep
224233
225234``` bash
226235./scripts/drep/register.sh
227236```
228237
229- ##### 2. Register your stake key (needed before delegating).
238+ ##### 2. Register your stake key (needed before delegating)
230239
231240``` bash
232241./scripts/stake/key-register.sh
233242```
234243
235- ##### 3. Delegate your tAda's voting rights to yourself.
244+ ##### 3. Delegate your tAda's voting rights to yourself
236245
237246``` bash
238247./scripts/drep/delegate-to-self.sh
@@ -274,19 +283,6 @@ export CARDANO_NODE_NETWORK_ID=1 # 1=preprod, 2=preview, 4=sanchonet
274283- ** preprod** : Network ID ` 1 `
275284- ** preview** : Network ID ` 2 `
276285- ** 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- ```
290286
291287### Multiple Docker Containers
292288
0 commit comments