mirrors/bisq
1
0
Fork 0
mirror of https://github.com/bisq-network/bisq.git synced 2025-03-13 19:16:43 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #5421 from ghubstan/02-update-docs

Browse source 
Update apitest docs for bitcoin-core v0.21 compat
This commit is contained in:
sqrrm 2021-04-20 11:52:32 +02:00 • committed by GitHub
commit e7446b0604
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 7 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
apitest/docs/api-beta-test-guide.md
View file

@ -19,7 +19,7 @@ option adjustments to compensate.
**Java SDK**: Version 10, 11, or 12 **Java SDK**: Version 10, 11, or 12
**Bitcoin-Core**: Version 0.19 or 0.20 **Bitcoin-Core**: Version 0.19, 0.20, or 0.21
**Git Client** **Git Client**
@ -152,25 +152,6 @@ CLI command unless you change the server’s `–apiPort=<listening-port>`. In
`9998`, Bob’s is `9999`. When you manually test the Api using the test harness, be aware of the port numbers being `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. 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 ### CLI Help
Useful information can be found using the CLI’s `--help` option. Useful information can be found using the CLI’s `--help` option.

2
apitest/scripts/limit-order-simulation.sh
View file

@ -6,7 +6,7 @@
# #
# Prerequisites: # Prerequisites:
# #
# - Linux or OSX with bash, Java 10, or Java 11-12 (JDK language compatibility 10), and bitcoin-core (v0.19, v0.20). # - Linux or OSX with bash, Java 10, or Java 11-12 (JDK language compatibility 10), and bitcoin-core (v0.19, v0.20, v0.21).
# #
# - Bisq must be fully built with apitest dao setup files installed. # - Bisq must be fully built with apitest dao setup files installed.
# Build command: `./gradlew clean build :apitest:installDaoSetup` # Build command: `./gradlew clean build :apitest:installDaoSetup`

2
apitest/scripts/rolling-offer-simulation.sh
View file

@ -10,7 +10,7 @@
# #
# Prerequisites: # Prerequisites:
# #
# - Linux or OSX with bash, Java 10, or Java 11-12 (JDK language compatibility 10), and bitcoin-core (v0.19, v0.20). # - Linux or OSX with bash, Java 10, or Java 11-12 (JDK language compatibility 10), and bitcoin-core (v0.19, v0.20, v0.21).
# #
# - Bisq must be fully built with apitest dao setup files installed. # - Bisq must be fully built with apitest dao setup files installed.
# Build command: `./gradlew clean build :apitest:installDaoSetup` # Build command: `./gradlew clean build :apitest:installDaoSetup`

2
apitest/scripts/trade-simulation.sh
View file

@ -7,7 +7,7 @@
# #
# Prerequisites: # Prerequisites:
# #
# - Linux or OSX with bash, Java 10, or Java 11-12 (JDK language compatibility 10), and bitcoin-core (v0.19, v0.20). # - Linux or OSX with bash, Java 10, or Java 11-12 (JDK language compatibility 10), and bitcoin-core (v0.19, v0.20, or v0.21).
# #
# - Bisq must be fully built with apitest dao setup files installed. # - Bisq must be fully built with apitest dao setup files installed.
# Build command: `./gradlew clean build :apitest:installDaoSetup` # Build command: `./gradlew clean build :apitest:installDaoSetup`

2
apitest/src/main/java/bisq/apitest/ApiTestMain.java
View file

@ -43,7 +43,7 @@ import bisq.apitest.config.ApiTestConfig;
* *
* All method, scenario and end to end tests are found in the test sources folder. * All method, scenario and end to end tests are found in the test sources folder.
* *
* Requires bitcoind v0.19.x * Requires bitcoind v0.19, v0.20, or v0.21.
*/ */
@Slf4j @Slf4j
public class ApiTestMain { public class ApiTestMain {

4
apitest/src/main/java/bisq/apitest/linux/AbstractLinuxProcess.java
View file

@ -108,8 +108,8 @@ abstract class AbstractLinuxProcess implements LinuxProcess {
File bitcoindExecutable = Paths.get(config.bitcoinPath, "bitcoind").toFile(); File bitcoindExecutable = Paths.get(config.bitcoinPath, "bitcoind").toFile();
if (!bitcoindExecutable.exists() || !bitcoindExecutable.canExecute()) if (!bitcoindExecutable.exists() || !bitcoindExecutable.canExecute())
throw new IllegalStateException(format("'%s' cannot be found or executed.%n" throw new IllegalStateException(format("'%s' cannot be found or executed.%n"
+ "A bitcoin-core v0.19.X installation is required, and" + + "A bitcoin-core v0.19, v0.20, or v0.21 installation is required," +
" the 'bitcoinPath' must be configured in 'apitest.properties'", " and the 'bitcoinPath' must be configured in 'apitest.properties'",
bitcoindExecutable.getAbsolutePath())); bitcoindExecutable.getAbsolutePath()));
File bitcoindDatadir = new File(config.bitcoinDatadir); File bitcoindDatadir = new File(config.bitcoinDatadir);