Document Algodv2 methods #486
Conversation
jasonpaulos
left a comment
jasonpaulos
left a comment
There was a problem hiding this comment.
Thank you for the contribution, this is a great improvement! I just have a few comments
src/client/v2/algod/algod.ts
Outdated
| * const getPendingTxns = algodClient.pendingTransactionsInformation(); | ||
| * getPendingTxns.max(maxTxns); | ||
| * const pendingTxns = await getPendingTxns.do(); |
There was a problem hiding this comment.
nit: a simpler way to do this would be:
const pendingTxns = await algodClient
.pendingTransactionsInformation()
.max(maxTxns)
.do();Also applies to pendingTransactionByAddress
There was a problem hiding this comment.
Oh right, done! btw pendingTransactionByAddress is returning PendingTransactionsByAddress 🤔
src/client/v2/serviceClient.ts
Outdated
| } | ||
|
|
||
| /** | ||
| * @ignore |
There was a problem hiding this comment.
Why ignore this? It's a useful method
There was a problem hiding this comment.
I thought developers using the sdk probably don't need to know about it
fionnachan
force-pushed
the
algodv2-doc
branch
from
0401112 to
9245191
Compare
| * ``` | ||
| * @remarks | ||
| * The above configuration is for a sandbox private network. | ||
| * For applications on production, you are encouraged to run your own node, or use an Algorand REST API provider with a dedicated API key. |
There was a problem hiding this comment.
Given the recent outage, I've changed the base server example from algoexplorer to sandbox and added the remarks. Can you see if this is okay? @jasonpaulos
jasonpaulos
left a comment
jasonpaulos
left a comment
There was a problem hiding this comment.
Sorry for the delay, this looks good!
* Document Algodv2 methods * Link to relevant methods on Algodv2 doc * Replace algoexplorer api with sandbox api * Clean up pendingTxns examples * Show setIntEncoding method on docs
2 participants
I was looking at this repo's source code and cross-checking with the REST APIs doc and got super annoyed....
Live Deployment
https://js-algosdk.netlify.app/classes/algodv2