Skip to content
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

doc: add VSCode debugging docs #3356

Merged
merged 1 commit into from
Jan 16, 2025
Merged

doc: add VSCode debugging docs #3356

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
345 changes: 341 additions & 4 deletions doc/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,348 @@

Some tests depend on access to the JSON-RPC API of an Ethereum node connected to mainnet or Rinkeby.

- To run mainnet tests, the `MAINNET_ETH_URL` environment variable should be set. If the variable is not set, the mainnet tests will be skipped.
- To run Rinkeby tests, the `RINKEBY_ETH_URL` environment variable should be set. If the variable is not set, the Rinkeby tests will b eskipped
- To run mainnet tests, the `MAINNET_ETH_URL` environment variable should be set. If the variable is not set, the mainnet tests will be skipped.
- To run Rinkeby tests, the `RINKEBY_ETH_URL` environment variable should be set. If the variable is not set, the Rinkeby tests will b eskipped

To run tests:

```
```bash
bash test.sh
```
```

## Debugging

To debug the code, it is recommended to use [Visual Studio Code](https://code.visualstudio.com/) with the [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.Go). Example VSCode configuration files are provided below. For more information on how to interact with the [go-livepeer](https://github.com/livepeer/go-livepeer) software, please check out the [Livepeer Docs](https://docs.livepeer.org/orchestrators/guides/get-started).

### Configuration Files

<details>
<summary>Launch.json (transcoding)</summary>

```bash
{
"version": "0.2.0",
"configurations": [
{
"name": "Run CLI",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer_cli",
"buildFlags": "-ldflags=-extldflags=-lm", // Fix missing symbol error.
"args": [
// "--http=8935", // Uncomment for Orch CLI.
"--http=5935" // Uncomment for Gateway CLI.
]
},
{
"name": "Launch O/T (off-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-ldflags=-extldflags=-lm", // Fix missing symbol error.
"args": [
"-orchestrator",
"-transcoder",
"-serviceAddr=0.0.0.0:8935",
"-v=6",
"-nvidia=all"
]
},
{
"name": "Launch O (off-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-ldflags=-extldflags=-lm", // Fix missing symbol error.
"args": [
"-orchestrator",
"-orchSecret=orchSecret",
"-serviceAddr=0.0.0.0:8935",
"-v=6"
]
},
{
"name": "Launch T (off-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-ldflags=-extldflags=-lm", // Fix missing symbol error.
"args": [
"-transcoder",
"-orchSecret=orchSecret",
"-orchAddr=0.0.0.0:8935",
"-v=6",
"-nvidia=all"
]
},
{
"name": "Launch G (off-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-ldflags=-extldflags=-lm", // Fix missing symbol error.
"args": [
"-gateway",
"-transcodingOptions=/home/<USER>/.lpData/offchain/transcodingOptions.json",
"-orchAddr=0.0.0.0:8935",
"-httpAddr=0.0.0.0:9935",
"-v",
"6"
]
},
{
"name": "Launch O/T (on-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-tags=mainnet,experimental -ldflags=-extldflags=-lm", // Fix missing symbol error and enable mainnet.
"args": [
"-orchestrator",
"-transcoder",
"-serviceAddr=0.0.0.0:8935",
"-v=6",
"-nvidia=all",
"-network=arbitrum-one-mainnet",
"-ethUrl=https://arb1.arbitrum.io/rpc",
"-ethPassword=<ETH_SECRET>",
"-ethAcctAddr=<ETH_ACCT_ADDR>",
"-ethOrchAddr=<ORCH_ADDR>",
"-pricePerUnit=<PRICE_PER_UNIT>"
]
},
{
"name": "Launch O (on-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-tags=mainnet,experimental -ldflags=-extldflags=-lm", // Fix missing symbol error and enable mainnet.
"args": [
"-orchestrator",
"-orchSecret=orchSecret",
"-serviceAddr=0.0.0.0:8935",
"-v=6",
"-network=arbitrum-one-mainnet",
"-ethUrl=https://arb1.arbitrum.io/rpc",
"-ethPassword=<ETH_SECRET>",
"-ethAcctAddr=<ETH_ACCT_ADDR>",
"-ethOrchAddr=<ORCH_ADDR>",
"-pricePerUnit=<PRICE_PER_UNIT>"
]
},
{
"name": "Launch T (on-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-tags=mainnet,experimental -ldflags=-extldflags=-lm", // Fix missing symbol error and enable mainnet.
"args": [
"-transcoder",
"-orchSecret=orchSecret",
"-orchAddr=0.0.0.0:8935",
"-v=6",
"-nvidia=all"
]
},
{
"name": "Launch G (on-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-tags=mainnet,experimental -ldflags=-extldflags=-lm", // Fix missing symbol error and enable mainnet.
"args": [
"-gateway",
"-transcodingOptions=/home/<USER>/.lpData/offchain/transcodingOptions.json",
"-orchAddr=0.0.0.0:8935",
"-httpAddr=0.0.0.0:9935",
"-v",
"6",
"-httpIngest",
"-network=arbitrum-one-mainnet",
"-ethUrl=https://arb1.arbitrum.io/rpc",
"-ethPassword=<ETH_SECRET>",
"-ethAcctAddr=<ETH_ACCT_ADDR>"
]
}
]
}
```

</details>

<details>
<summary>Launch.json (AI)</summary>

```bash
{
"version": "0.2.0",
"configurations": [
{
"name": "Run AI CLI",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer_cli",
"buildFlags": "-ldflags=-extldflags=-lm", // Fix missing symbol error.
"args": [
// "--http=8935", // Uncomment for Orch CLI.
"--http=5935" // Uncomment for Gateway CLI.
]
},
{
"name": "Launch AI O/W (off-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-ldflags=-extldflags=-lm", // Fix missing symbol error.
"args": [
"-orchestrator",
"-aiWorker",
"-serviceAddr=0.0.0.0:8935",
"-v=6",
"-nvidia=all",
"-aiModels=/home/<USER>/.lpData/cfg/aiModels.json",
"-aiModelsDir=/home/<USER>/.lpData/models"
]
},
{
"name": "Launch AI O (off-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-ldflags='-extldflags=-lm -X github.com/livepeer/go-livepeer/core.LivepeerVersion=0.0.0'", // Fix missing symbol and version mismatch errors.
"args": [
"-orchestrator",
"-orchSecret=orchSecret",
"-serviceAddr=0.0.0.0:8935",
"-v=6"
]
},
{
"name": "Launch AI W (off-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-ldflags='-extldflags=-lm -X github.com/livepeer/go-livepeer/core.LivepeerVersion=0.0.0'", // Fix missing symbol and version mismatch errors.
"args": [
"-aiWorker",
"-orchSecret=orchSecret",
"-orchAddr=0.0.0.0:8935",
"-v=6",
"-nvidia=all",
"-aiModels=/home/<USER>/.lpData/cfg/aiModels.json",
"-aiModelsDir=/home/<USER>/.lpData/models"
]
},
{
"name": "Launch AI G (off-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-ldflags=-extldflags=-lm", // Fix missing symbol error.
"args": [
"-gateway",
"-orchAddr=0.0.0.0:8935",
"-httpAddr=0.0.0.0:9935",
"-v",
"6",
"-httpIngest"
]
},
{
"name": "Launch AI O/W (on-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-tags=mainnet,experimental -ldflags=-extldflags=-lm", // Fix missing symbol error and enable mainnet.
"args": [
"-orchestrator",
"-aiWorker",
"-serviceAddr=0.0.0.0:8935",
"-v=6",
"-nvidia=all",
"-aiModels=/home/<USER>/.lpData/cfg/aiModels.json",
"-aiModelsDir=/home/<USER>/.lpData/models",
"-network=arbitrum-one-mainnet",
"-ethUrl=https://arb1.arbitrum.io/rpc",
"-ethPassword=<ETH_SECRET>",
"-ethAcctAddr=<ETH_ACCT_ADDR>",
"-ethOrchAddr=<ORCH_ADDR>"
]
},
{
"name": "Launch AI O (on-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-tags=mainnet,experimental -ldflags='-extldflags=-lm -X github.com/livepeer/go-livepeer/core.LivepeerVersion=0.0.0'", // Fix missing symbol error, version mismatch error and enable mainnet.
"args": [
"-orchestrator",
"-orchSecret=orchSecret",
"-serviceAddr=0.0.0.0:8935",
"-v=6",
"-network=arbitrum-one-mainnet",
"-ethUrl=https://arb1.arbitrum.io/rpc",
"-ethPassword=<ETH_SECRET>",
"-ethAcctAddr=<ETH_ACCT_ADDR>",
"-ethOrchAddr=<ORCH_ADDR>",
"-pricePerUnit=0"
]
},
{
"name": "Launch AI W (on-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-tags=mainnet,experimental -ldflags='-extldflags=-lm -X github.com/livepeer/go-livepeer/core.LivepeerVersion=0.0.0'", // Fix missing symbol error, version mismatch error and enable mainnet.
"args": [
"-aiWorker",
"-orchSecret=orchSecret",
"-orchAddr=0.0.0.0:8935",
"-v=6",
"-nvidia=all",
"-aiModels=/home/<USER>/.lpData/cfg/aiModels.json",
"-aiModelsDir=/home/<USER>/.lpData/models"
]
},
{
"name": "Launch AI G (on-chain)",
"type": "go",
"request": "launch",
"mode": "debug",
"program": "cmd/livepeer",
"buildFlags": "-tags=mainnet,experimental -ldflags=-extldflags=-lm", // Fix missing symbol error and enable mainnet.
"args": [
"-gateway",
"-transcodingOptions=/home/<USER>/.lpData/offchain/transcodingOptions.json",
"-orchAddr=0.0.0.0:8935",
"-httpAddr=0.0.0.0:9935",
"-v",
"6",
"-httpIngest",
"-network=arbitrum-one-mainnet",
"-ethUrl=https://arb1.arbitrum.io/rpc",
"-ethPassword=<ETH_SECRET>",
"-ethAcctAddr=<ETH_ACCT_ADDR>"
]
}
]
}
```

</details>
Loading