[bisq-network/projects] Prepare roll out of API for January or February release (#46)
Stan
notifications at github.com
Mon Jan 4 15:26:54 CET 2021
> Where is the best place to get a background of what has been developed to date?
@pazza83 Sorry, no api documentation yet, but the code explains a lot.
See `:cli` supbroject's `CliMain` class for a list of currently available CLI commands:
```
private enum Method {
createoffer,
canceloffer,
getoffer,
getoffers,
takeoffer,
gettrade,
confirmpaymentstarted,
confirmpaymentreceived,
keepfunds,
withdrawfunds,
getpaymentmethods,
getpaymentacctform,
createpaymentacct,
getpaymentaccts,
getversion,
getbalance,
getaddressbalance,
getfundingaddresses,
getunusedbsqaddress,
sendbsq,
sendbtc,
gettxfeerate,
settxfeerate,
unsettxfeerate,
gettransaction,
lockwallet,
unlockwallet,
removewalletpassword,
setwalletpassword,
registerdisputeagent
}
```
This won't work on Windows (not meant to). It's meant for *nix only. Seemed to work OK when I tried it on OSX some months ago.
To see (linux) CLI help, get latest master, and build with options needed for running api tests later:
./gradlew clean build :apitest:installDaoSetup
CLI help: `./bisq-cli --help`
To see server side implementation, you can drill down starting from the `:daemon` subproject's `bisq.daemon.grpc.GrpcServer`.
If you want, you can run the `:apitest` suite (almost 5 minutes to complete):
./gradlew :apitest:test -DrunApiTests=true
The test cases are in the `:apitest` `src/test` folder, the `src/main` (ignore it) folder is where the test harness lives. If you want to run individual `method` tests you'll need to comment out the `@Disabled` annotation. And you'll need to add the JVM argument
`-DrunApiTests=true` to your IDE's `Gradle` launcher template.
Again, this test harness only works on *nix, and depends on `bash`. Windows support is not in the scope of the api project at this stage.
I am working on a simple trading script that simulates Bob & Alice using the CLI to buy and sell BTC with EUR. But I haven't checked it in yet -- it needs more testing, load limits are being found as I test, and some api protections have been implemented, but not clearly defined and applied to specific api methods yet.
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/projects/issues/46#issuecomment-754005282
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20210104/5d9bf350/attachment.htm>
More information about the bisq-github
mailing list