diff --git a/apitest/docs/README.md b/apitest/docs/README.md index 625dadddc9..1f24def3e4 100644 --- a/apitest/docs/README.md +++ b/apitest/docs/README.md @@ -3,3 +3,4 @@ - [build-run.md](build-run.md): Build and run API tests at the command line and from Intellij. - [test-categories.md](test-categories.md): How to categorize a test case as `method`, `scenario` or `e2e`. - [regtest-port-conflicts.md](regtest-port-conflicts.md): Avoid port conflicts when running multiple bitcoin-core apps in regtest mode. + - [api-beta-test-guide.md](api-beta-test-guide.md): How to run the test harness and tutorial script, and beta test the API with the new CLI. diff --git a/apitest/docs/api-beta-test-guide.md b/apitest/docs/api-beta-test-guide.md index 4be69e61c9..dddf75b1e7 100644 --- a/apitest/docs/api-beta-test-guide.md +++ b/apitest/docs/api-beta-test-guide.md @@ -152,6 +152,25 @@ CLI command unless you change the server’s `–apiPort=`. In `9998`, Bob’s is `9999`. When you manually test the Api using the test harness, be aware of the port numbers being used in the CLI commands, so you know which server (Bob’s or Alice’s) the CLI is sending requests to. +### Registering Test Dispute Agents + +If you ran the `trade-simulation.sh` script in your currently running test harness, dispute agents have +already been registered in the arbitration node, and you can run any of the commands described in the following +sections. + +If you have not run the `trade-simulation.sh` script against the test harness, you will need to +manually register dispute agents in the arbitration node before you can initiate a trade. Copy, paste and run +the following CLI commands to register a `mediator` and a `refundagent`. Do not change the commands' port `9997` +option (the test arbitration node's listening port). +``` +$ ./bisq-cli --password=xyz --port=9997 registerdisputeagent --dispute-agent-type=mediator + --registration-key=6ac43ea1df2a290c1c8391736aa42e4339c5cb4f110ff0257a13b63211977b7a + +$ ./bisq-cli --password=xyz --port=9997 registerdisputeagent --dispute-agent-type=refundagent + --registration-key=6ac43ea1df2a290c1c8391736aa42e4339c5cb4f110ff0257a13b63211977b7a +``` +_Note: The API cannot be used to register dispute agents on nodes connected to `mainnet`._ + ### CLI Help Useful information can be found using the CLI’s `--help` option.