Update all examples - major overhaul #87
Conversation
| @@ -3,12 +3,12 @@ | |||
| ## Default Listeners | |||
| ```shell--visible | |||
| # With curl you just send HTTP Requests based on further docs | |||
| # Only thing to have in mind is Authentication, which is described in Auth section. | |||
| # Only thing to keep in mind is authentication, which is described in the "Authentication" section. | |||
There was a problem hiding this comment.
should we add a link to the Authentication section?
|
|
||
| ```shell--visible | ||
| # You can use config file |
There was a problem hiding this comment.
It should still be possible to use a conf file and will be looked for by bclient. We should also include some information about how the wallet will look for a separate conf file (this should be documented in the changelog)
| export BCOIN_NETWORK=regtest | ||
| export BCOIN_API_KEY=yoursecret | ||
| export BCOIN_API_KEY=api-key |
There was a problem hiding this comment.
maybe preface with a $ to denote a variable and show that this is just a place holder
| There are two objects: `bcoin.http.Client` for general API and `bcoin.http.Wallet` for wallet API. | ||
| You can also use the API with a Javascript library (used by `bcoin-cli`). | ||
| There are two objects: `NodeClient` for general API and `WalletClient` for wallet API. | ||
| `bcoin` also provides an object `Network` and its method `get` which will return the appropriate configuration paramaters for a specified network. |
There was a problem hiding this comment.
"default configuration" might be better than "appropriate" since you can actually use different ports for example than what is set by default.
|
|
||
| `bcoin.http.Client` options: | ||
| `NodeClient` and `WalletClient` options: |
There was a problem hiding this comment.
Good catch! You're really digging deep :)
| @@ -107,12 +113,10 @@ let blockhash; | |||
| ``` | |||
|
|
|||
| ```shell--vars | |||
| blockhash='0000000000000dca8da883af9515dd90443d59139adbda3f9eeac1d18397fec3'; | |||
| ``` | |||
| blockhash='1896e628f8011b77ea80f4582c29c21b3376183683f587ee863050376add3891'``` | |||
There was a problem hiding this comment.
for readability and consistency I think we should keep the triple back tick ``` on a new line
| ``` | ||
|
|
||
| ```shell--cli | ||
| bwallet-cli --id=$id tx $hash | ||
| ``` | ||
|
|
||
| ```shell--curl | ||
| curl $url/wallet/$id/tx/$hash | ||
| curl $walleturl/$id/tx/$hash |
There was a problem hiding this comment.
don't these still have to have /wallet/ in the path?
There was a problem hiding this comment.
I'm cheating a bit here: at the top of the docs I add a new environment variable:
in _wallet.md L#61:
# examples in these docs will use an environment variable:
walleturl=http://x:api-key@127.0.0.1:48334/wallet/
curl $walleturl/$id
| } | ||
|
|
||
| const walletClient = new WalletClient(walletOptions); | ||
| const wallet = walletClient.wallet(id); |
There was a problem hiding this comment.
You may have already had this somewhere and I missed it, but I think we should document the difference between walletClient.wallet(id) version of the client and the client where you pass in the id as an argument like: walletClient.getInfo('id'). This is new and it tripped me up at first so it's a little confusing but also super useful to have both available (so you can create different clients for different wallets, or just use one walletClient to access different wallets depending on the id you pass it). it also makes the function signature slightly different depending on if you have the walletClient.wallet client or the normal walletClient client.
There was a problem hiding this comment.
added to #the-walletdb-and-object
|
|
||
| (async () => { | ||
| const response = await wallet.getRange(account, {start: start, end: end}); | ||
| console.log(response); | ||
| const result = await wallet.getRange(account, {start: start, end: end}); |
There was a problem hiding this comment.
yeah, I got the current UTC timestamp date +%s on my system, subtracted 2000 and 1000 seconds respectively for start and end, got a few transactions I'd mined over the past half hour or so
api-docs-slate/source/index.html.md
Outdated
|
|
||
| # Authentication | ||
| ## Auth | ||
|
|
||
| ```shell--curl | ||
| curl http://x:[api-key]@127.0.0.1:8332/ | ||
| # port determines network type (48332 for regtest), API key required in URL |
There was a problem hiding this comment.
This isn't necessarily true. As mentioned in another comment, you can set custom ports when starting up your node (I believe there is a port argument) so these are just the default, not necessarily what determines your network type.
This PR represents a week or so of testing all examples in the docs, trying every function for cURL, CLI and JS. Most changes were in the JS examples since the structure of the system has changed so much. I am going to continue to add commits to this branch to clean up typos, and add a few more examples for functions that were not listed before. I'm not totally happy with the style of all my fixes, (some examples are written for testnet and others for regtest, for example). So I intend to keep working on the docs and make every single example copy-paste-executable from top to bottom in all three interfaces. I figured this was a good point to squash commits and submit for review while I clean up the rest.