chore: sprinter react docs + updates #60
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
Collaborator
haochizzle
commented
Sep 25, 2024
•
haochizzle
commented
- add sprinter-react docs
- update sprinter-sdk class reference docs
- update API documentation
BeroBurny
approved these changes
Sep 30, 2024
Comment on lines
9
to
18
| :::tip | ||
| `FetchOptions` is an object that contains settings for configuring how the fetch requests are made by the SDK. There are two parameters that can be adjusted including `signal`, which hides the request, and `baseURL`, which sets the target for either mainnet or testnet. | ||
| `AggregateBalances` represents the user's token balances across multiple blockchains. It maps a token symbol to the balance information, which includes the total balance and an array of token balances for each chain. | ||
| ::: | ||
|
|
||
| ## Methods | ||
|
|
||
| ### `constructor(fetchOptions: Omit<FetchOptions, "signal">)` | ||
|
|
||
| Initializes the SDK with the given Ethereum provider. | ||
| Initializes the SDK with the given fetch options. The `signal` property is explicitly excluded from the fetch options because it is meant to be provided dynamically when individual requests are made, allowing developers to abort those requests if necessary. |
There was a problem hiding this comment.
the signal is not a part of the constructor method, used for special cases in methods
There was a problem hiding this comment.
so as i understand it (very roughly), the constructor is "initialized" with the fetchOption of "signal" being omitted from this method. i guess i was trying to communicate this but this is more confusing?
apologies if this is not clear
Comment on lines
125
to
135
|
|
||
| // For contract call solution | ||
| const contractSolutionSettings = { | ||
| contractCall: true, | ||
| // Other contract call-specific options... | ||
| }; | ||
|
|
||
| sprinter.getSolution(contractSolutionSettings).then(contractSolution => { | ||
| console.log('Contract call solution:', contractSolution); | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
this is misleading
const settings = {
account: "0x3e101ec02e7a48d16dade204c96bff842e7e2519",
destinationChain: 11155111,
token: "USDC",
amount: "100000000",
contractCall: {
callData: "0xabcdef", // encoded contract call data
contractAddress: "0x1234567890abcdef",
gasLimit: 21000,
recipient: "0xRecipientAddress" // for native contract call (usually is contract that will receive tokens)
},
this one is more precise for exampling data
There was a problem hiding this comment.
updated, @BeroBurny can you verify again?
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.