Skip to content

fix local-setup.md and devnet-info.md #48

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Apr 29, 2025
Merged

fix local-setup.md and devnet-info.md #48

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1ec6774
fix local-setup.md and devnet-info.md
Jiu-hong Apr 23, 2025
f68bde8
modify method of changing branch
Jiu-hong Apr 23, 2025
2e11201
change to the current 2.0.0 version
Jiu-hong Apr 29, 2025
5c9ca7d
change condor to 2.0
Jiu-hong Apr 29, 2025
7c17b9e
update current commit-hash
Jiu-hong Apr 29, 2025
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
36 changes: 18 additions & 18 deletions condor/devnet-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,43 +17,43 @@ Once your request has been processed, you will be notified and provided with a l

## What is the latest commit/release candidate deployed on to the Devnet?

- Release Candidate: Condor/2.0.0 - RC6
- Commit Hash: `2178ad3aad9488076b38d8de467e6d1123f4b66b`
- Latest Devnet Release Date: 08-Jan-2025
- Release Candidate: Casper 2.0 - RC10
- Commit Hash: `a7e4ff100549d6b34aa6b800812f29313378663b`
- Latest Devnet Release Date: 04-Apr-2025

## What are the Condor/2.0.0 Compatible branches/commits of downstream components?
## What are the Casper 2.0 Compatible branches/commits of downstream components?

**casper-sidecar:**
- Release Candidate : `release-1.0.0-rc5_node-2.0.0-rc6`
- Branch/Repo : [casper-sidecar-release-1.0.0-rc5_node-2.0.0-rc6](https://github.com/casper-network/casper-sidecar/tree/release-1.0.0-rc5_node-2.0.0-rc6)
- Release Candidate : `v1.0.4`
- Branch/Repo : [casper-sidecar-v1.0.4](https://github.com/casper-network/casper-sidecar/commit/a7b552832aa44390d90b96c3ace67fdefce24670)

**casper-client-rs:**
- Release Candidate : `release-3.0.1-rc2_node-2.0.0-rc6`
- Branch/Repo : [casper-client-release-3.0.1-rc2_node-2.0.0-rc6](https://github.com/casper-ecosystem/casper-client-rs/tree/release-3.0.1-rc2_node-2.0.0-rc6)
- Release Candidate : `v3.0.1`
- Branch/Repo : [casper-client-v3.0.1](https://github.com/casper-ecosystegitm/casper-client-rs/commit/305adf13a08d6b0dac016fa30cec77841ca0a8ca)

**NCTL:**
- New NCTL image with `v200-rc6` available on Docker Hub:
- `makesoftware/casper-nctl:v200-rc6`
- New NCTL image with `v200-rc10` available on Docker Hub:
- `makesoftware/casper-nctl:v200-rc10`

**CEP-18:**
- A version of CEP-18 compatible with Condor RC5/6 is available in the forked repository [here](https://github.com/davidatwhiletrue/cep18-limited/tree/casper-2.0.0-rc5)
- A version of CEP-18 compatible with Casper 2.0 is available in the forked repository [here](https://github.com/casper-ecosystem/cep18/tree/feat-2.0)

- Please note that this is meant for testing SDKs and scripts

**CEP-78:**
- Work in progress
- A version of CEP-78 compatible with Casper 2.0 is available in the forked repository [here](https://github.com/casper-ecosystem/cep-78-enhanced-nft/tree/feat-2.0)


**SDKs:**
- JavaScript/TypeScript
- Github release : [casper-js-sdk-v5.0.3-beta2](https://github.com/casper-ecosystem/casper-js-sdk/releases/tag/5.0.3-beta2)
- npm : [casper-js-sdk-v5.0.3-beta2](https://www.npmjs.com/package/casper-js-sdk/v/5.0.3-beta2)
- Github release : [casper-js-sdk-5.0.4](https://github.com/casper-ecosystem/casper-js-sdk/releases/tag/5.0.4)
- npm : [casper-js-sdk-5.0.4](https://www.npmjs.com/package/casper-js-sdk/v/5.0.4)

- .NET
- Github release : [casper-net-sdk-v3.0.0-beta2](https://github.com/make-software/casper-net-sdk/releases/tag/v3.0.0-beta2)
- Nuget package : [Casper.Network.SDK 3.0.0-beta2](https://www.nuget.org/packages/Casper.Network.SDK/3.0.0-beta2)
- Github release : [casper-net-sdk-v3.0.0](https://github.com/make-software/casper-net-sdk/releases/tag/v3.0.0)
- Nuget package : [Casper.Network.SDK 3.0.0](https://www.nuget.org/packages/Casper.Network.SDK/3.0.0)

- Go
- Github release : [casper-go-sdk-v2.0.0-beta2](https://github.com/make-software/casper-go-sdk/releases/tag/v2.0.0-beta2)
- Github release : [casper-go-sdk-2.0.3-beta1](https://github.com/make-software/casper-go-sdk/releases/tag/v2.0.3-beta1)
- Java (WIP)
- Python (WIP)
- Rust (WIP)
Expand Down
242 changes: 168 additions & 74 deletions condor/local-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,40 +32,102 @@ NCTL is your tool for managing the Casper network. We'll use a Dockerized versio
```bash
git checkout feat-2.0
```

Modify the casper-node's branch to dev inside casper-nctl-condor.Dockerfile

```
...
RUN git clone -b dev https://github.com/casper-network/casper-node.git ~/casper-node
...
```


3. **Clone the `casper-node` Repository:**
```bash
git clone https://github.com/casper-network/casper-node.git
cd casper-node
git checkout release-2.0.0-rc3
git checkout dev
```
Ensure you're in the `casper-nctl-docker` directory when running this command

4. **Build the Docker Image:**
```bash
docker build -f casper-nctl-condor.Dockerfile -t casper-nctl:rc3 .
docker build -f casper-nctl-condor.Dockerfile -t casper-nctl:dev .
```
This may take a while
This may take a while.

5. **Verify the Image:**
```bash
docker image ls
```
Look for the `casper-nctl:rc3` image in the output
Look for the `casper-nctl:dev` image in the output
```
REPOSITORY TAG IMAGE ID CREATED SIZE
casper-nctl rc3 9fd1e7b25d42 40 hours ago 433MB
REPOSITORY TAG IMAGE ID CREATED SIZE
casper-nctl dev 0e3e3cd50a5a 11 hours ago 442MB
```

6. **Start the NCTL Docker Container:**
* **Docker Compose (Recommended):** If you're using the `docker-compose.yml` file, make sure that the `image` under the `mynctl` service points to `casper-nctl:rc3`. Then run `docker-compose up`.

There are two ways to start the NCTL Docker containers.
Docker Compose brings up an additional NCTL Explorer container, while the manual command does not.
* **Docker Compose (Recommended):**

If you're using the `docker-compose.yml` file, make sure that the `image` under the `casper-nctl` service points to the image you just built (`casper-nctl:dev`) from the previous step, like this:

docker-compose.yml

```yaml
...
services:
casper-nctl:
image: casper-nctl:dev
container_name: casper-nctl
...
```

Start the containers. This will start an NCTL container and an NCTL Explorer container.

```bash
docker-compose up
```
"Ensure you're in the `casper-nctl-docker` directory when running this command.


* **Manual Docker Command:**

Below is the command to start an NCTL container named `mynctl`.

```bash
docker run -d --name mynctl -p 11101:11101 casper-nctl:rc3
docker run -d --name mynctl -p 11101:11101 casper-nctl:dev
```

Once it is up and running you should see that there are 5 nodes and 5 sidecars running and another 5 nodes and 5 sidecars that are inactive:
```

7. **Activate nctl-\* commands:**

In a Linux or macOS terminal, run:
```bash
source nctl-activate.sh <container_name>
```
In a Powershell terminal, run:
```
. .\nctl-activate.ps1 <container_name>
```
Ensure you're in the `casper-nctl-docker` directory when running this command.



7. **Confirm the nctl status**

```bash
nctl-status
```

Once it is up and running issue the command `nctl-status` then you should see that there are 5 nodes and 5 sidecars running and another 5 nodes and 5 sidecars that are inactive:

<details>
<summary>Click me</summary>

```json
casper-nctl | validators-1:casper-net-1-node-1 RUNNING pid 996, uptime 0:00:03
casper-nctl | validators-1:casper-net-1-node-2 RUNNING pid 998, uptime 0:00:03
casper-nctl | validators-1:casper-net-1-node-3 RUNNING pid 1002, uptime 0:00:03
Expand All @@ -86,16 +148,17 @@ NCTL is your tool for managing the Casper network. We'll use a Dockerized versio
casper-nctl | validators-3:casper-net-1-sidecar-7 STOPPED Not started
casper-nctl | validators-3:casper-net-1-sidecar-8 STOPPED Not started
casper-nctl | validators-3:casper-net-1-sidecar-9 STOPPED Not started
```
```

</details>

## Part 2: Casper Client (Rust)

To interact with your local Casper 2.0 network, we'll use the Casper Client. You have two options for using the Casper Client:

**Option 1: Using the Casper Client from the Docker Image**

* The `casper-nctl:rc3` Docker image already includes the `casper-client`.
* The `casper-nctl:dev` Docker image already includes the `casper-client`.
* You can skip the next two steps if you want to use the pre-installed client.

**Option 2: Using Your Local Casper Client**
Expand All @@ -108,92 +171,121 @@ To interact with your local Casper 2.0 network, we'll use the Casper Client. You

2. **Switch to the Casper 2.0-Compatible Branch (Optional):**
```bash
git checkout feat-track-node-2.0
git checkout dev
```

3. **Build casper-client:**

Prerequisite: Install rustup

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

3. **Activate NCTL scripts:**
Build the Casper Client:

```bash
source nctl-activate.sh casper-nctl
cargo build --release
```

4 **Test Your Setup:**
4. **Test Your Setup:**
```bash
nctl-view-node-status
casper-client get-block -n http://localhost:11101
```

This command should return the status of all the nodes running in your local network, indicating a successful setup. The output should look similar to this:
```
------------------------------------------------------------------------------------------------------------------------------------
2024-07-10T15:31:42.181535 [INFO] [2043] NCTL :: node #1 :: status:

<details>
<summary>Click me</summary>


```json
{
"api_version": "2.0.0",
"peers": [
{
"node_id": "tls:05b5..7b39",
"address": "127.0.0.1:22103"
},
{
"node_id": "tls:527e..37d2",
"address": "127.0.0.1:22105"
},
{
"node_id": "tls:b1d0..870f",
"address": "127.0.0.1:22102"
},
{
"node_id": "tls:dcdf..e348",
"address": "127.0.0.1:22104"
"jsonrpc": "2.0",
"id": -2049464589362040719,
"result": {
"api_version": "2.0.0",
"block_with_signatures": {
"block": {
"Version2": {
"hash": "9e7c32760b6fefcd4e1a579a9dce0835e1d564e5a5aedaf06911d76f64af9e0c",
"header": {
"parent_hash": "ecd94fd34417032d4e7b77b0dce3c48164398d1946d95a57b50c73eaee59cf90",
"state_root_hash": "ad53786aed35ef7e5a608552329ff0ab33055c4e4bf6764124a3603fce49990a",
"body_hash": "18937e8cf4338b5f5fdc2581f8d7d6a47de736d2799e3f3bc9b0ff9f1e7cf106",
"random_bit": false,
"accumulated_seed": "1ce9cae18eccdea58c1a6b22474c6f98e4a4bf17d53a306390f528a18d264f59",
"era_end": null,
"timestamp": "2025-04-23T03:41:03.130Z",
"era_id": 94,
"height": 1028,
"protocol_version": "2.0.0",
"proposer": "0190664e16a17594ed2d0e3c279c4cf5894e8db0da15e3b91c938562a1caae32ab",
"current_gas_price": 1,
"last_switch_block_hash": "db222beace01c5c624cbd84a62c92feb0a23f3e0c3372dd5cba9e7ce51db63cf"
},
"body": {
"transactions": {},
"rewarded_signatures": [
[
248
],
[
0
],
[
0
]
]
}
}
},
"proofs": [
{
"public_key": "01509254f22690fbe7fb6134be574c4fbdb060dfa699964653b99753485e518ea6",
"signature": "01fbe5ca7584cd517b51cc2ee1c79c055eaccb523470b5f460f23c365d476dabf40d62d753b0f1c1003568dd555b64848cda2029d3f31bf9ee548ea6aefca72506"
},
{
"public_key": "0190664e16a17594ed2d0e3c279c4cf5894e8db0da15e3b91c938562a1caae32ab",
"signature": "014ebd115e50169c79dd469f6118df18869232839bc07c3cff079837657ba9d31d913d367da886442f1532fbef66e86985d693346037b4863ef0ec90c1476e3403"
},
{
"public_key": "01c867ff3cf1d4e4e68fc00922fdcb740304def196e223091dee62012f444b9eba",
"signature": "01d183f46c1a0af713c2f0629ea0436cb37c04ef300f8c25f84384607a91817e869956ccf47a4902f9d51c173cb8c3f6949391c792e343bc93968274b4c692e50c"
},
{
"public_key": "01f58b94526d280881f79744effebc555426190950d5dfdd2f8aaf10ceaec010c6",
"signature": "01308ad12b69bc92497ad3b9d169d685a436ee4194a0e291a14e022bc0e70e5ee881a2f0be5301752ad9888a790bd9c4a7cbff1481df472166f3dce29df9ec9d00"
},
{
"public_key": "01fed662dc7f1f7af43ad785ba07a8cc05b7a96f9ee69613cfde43bc56bec1140b",
"signature": "01bac3f6529816492daaa019a4ecf5bd3ef68757a266e4b4a0382a56268fdbc86a65ec037feb87cda554e244f25c3c9e525961a1a660b39ebd6f1aee2e64ce0006"
}
]
}
}
],
"build_version": "2.0.0-d5c0d238f",
"chainspec_name": "casper-net-1",
"starting_state_root_hash": "2d92cf9f3ff3eb70f40be598b61cbf747c1b5ea67df9596d84a88c5458028a80",
"last_added_block_info": {
"hash": "c1056e0e5978e725777f48e4488462d7794e6547f25b1fbcc4ba261ca2864395",
"timestamp": "2024-07-10T15:31:38.601Z",
"era_id": 19,
"height": 205,
"state_root_hash": "6c5502c3443f526e943fa5a5421349e938464c063c8dd0ada616c997e3805612",
"creator": "0190664e16a17594ed2d0e3c279c4cf5894e8db0da15e3b91c938562a1caae32ab"
},
"our_public_signing_key": "01fed662dc7f1f7af43ad785ba07a8cc05b7a96f9ee69613cfde43bc56bec1140b",
"round_length": "4s 96ms",
"next_upgrade": null,
"uptime": "13m 15s",
"reactor_state": "Validate",
"last_progress": "2024-07-10T15:18:26.354Z",
"available_block_range": {
"low": 0,
"high": 205
},
"block_sync": {
"historical": null,
"forward": null
},
"latest_switch_block_hash": "5192198c783ed8b66e206c37b34c5e268c84be2f4b78dd9899eecf5f37fb9f68"
}
.
.
.
```
</details>

## Troubleshooting

**If sidecars or nodes are not running:** If you see `null` values under each node in the output of `nctl-view-node-status`, it means the version of `casper-sidecar` is not compatible with the `casper-node`.

**Solution:**
1. Go to the `casper-node/ci/ci.json` file.
2. Change the `casper-sidecar` branch under `external_deps` from:
2. Change the `casper-sidecar` branch under `external_deps` to the casper-node's compatible branch:
```json
"branch": "feat-2.0"
"branch": "xxx"
```
to:
```json
"branch": "release-1.0.0rc2_node-2.0.0rc3"
"branch": "dev"
```

This is because the `casper-node` we are using is `release-2.0.0-rc3`. The required combination of versions of `casper-sidecar` and `casper-node` may change in the future (rc4 etc.).
Make sure that `casper-node` and `casper-sidecar` are compatible.

3. Rebuild the NCTL image: `docker build -f casper-nctl-condor.Dockerfile -t casper-nctl:rc3 .`
3. Rebuild the NCTL image: `docker build -f casper-nctl-condor.Dockerfile -t casper-nctl:dev .`

## Using the Casper Client

Expand All @@ -202,7 +294,9 @@ To interact with your local Casper 2.0 network, we'll use the Casper Client. You

## Accessing the NCTL Block Web Explorer

The NCTL Docker setup includes a web-based block explorer. You can access it in your browser at:
This is only available if you started the container using `docker compose up`.

The NCTL Docker setup using docker compose includes a web-based block explorer. You can access it in your browser at:

```
http://127.0.0.1:8080
Expand All @@ -216,4 +310,4 @@ This allows you to visually explore blocks, transactions, and other details of y

## Additional Tips

* **Community Resources:** Join the [Casper Telegram](https://t.me/CSPRCondor) for help and discussion.
* **Community Resources:** Join the [Casper Telegram](https://t.me/CSPRCondor) or [Casper Discord](https://discord.gg/caspernetwork) for help and discussion.