Document Algodv2 methods #486
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jasonpaulos
reviewed
Dec 16, 2021
src/client/v2/algod/algod.ts
Outdated
Comment on lines
191
to
193
| * 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
| @@ -66,6 +68,7 @@ export default abstract class ServiceClient { | |||
| } | |||
|
|
|||
| /** | |||
| * @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
fionnachan
commented
Dec 16, 2021
| * ``` | ||
| * @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
approved these changes
Jan 10, 2022
aldur
pushed a commit
that referenced
this pull request
Jan 20, 2022
* 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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