This repository has been archived by the owner on Jan 20, 2025. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,4 @@ | ||
# Rex | ||
|
||
Proof of Concept Elixir implementation of Cardano's Ouroboros networking mini-protocols. | ||
Moved to https://github.com/wowica/xander | ||
|
||
## Running | ||
|
||
#### Via local UNIX socket | ||
|
||
Run the following command using your own Cardano node's socket path: | ||
|
||
```bash | ||
CARDANO_NODE_SOCKET_PATH=/your/cardano/node.socket mix query_current_era | ||
``` | ||
|
||
🚨 The N2C protocol on the Haskell cardano-node only works via Unix socket. It does not allow connection through an IP or hostname. | ||
|
||
##### Setting up Unix socket mapping | ||
|
||
1. Run socat on the remote server with the following command: | ||
|
||
```bash | ||
socat TCP-LISTEN:3002,reuseaddr,fork UNIX-CONNECT:/home/cardano_node/socket/node.socket | ||
``` | ||
|
||
2. Run socat on the local machine with the following command: | ||
|
||
```bash | ||
socat UNIX-LISTEN:/tmp/cardano_node.socket,reuseaddr,fork TCP:localhost:3002 | ||
``` | ||
|
||
3. Start an SSH tunnel from the local machine to the remote server with the following command: | ||
|
||
```bash | ||
ssh -N -L 3002:localhost:3002 user@remote-server-ip | ||
``` | ||
|
||
#### Via TLS to a URL | ||
|
||
To connect to a node at a URL like demeter.run, set the `CARDANO_NODE_URL` to the URL of the node. | ||
Make sure the `CARDANO_NODE_SOCKET_PATH` is not set, or it will override the URL configuration. | ||
|
||
|
||
## Catalyst Proposal | ||
|
||
F13 proposal for further development of this project: | ||
[https://cardano.ideascale.com/c/cardano/idea/131598](https://cardano.ideascale.com/c/cardano/idea/131598) |