feat!: refactor api #61
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
BeroBurny
commented
Oct 1, 2024
|
Lets TRIPLE MAKE SURE, the docs are reflective before we merge because there will be breaking changes for B3. Let's give them notice once we deploy to testnet, and will only propogate changes to mainnet once they are confirmed to be working on testnet. |
mpetrunic
reviewed
Oct 18, 2024
docs/docs/03-sdk/04-methods-reference/bridge-aggregate/bridgeAggregateBalance.md
Outdated
Show resolved
Hide resolved
docs/docs/03-sdk/04-methods-reference/bridge-aggregate/bridgeAggregateBalanceAndCall.md
Outdated
Show resolved
Hide resolved
github-actions
bot
temporarily deployed
to
gopher-docs-preview (Preview)
|
|
||
| function App() { | ||
| return ( | ||
| <SprinterContext baseUrl={Environment.MAINNET}> |
There was a problem hiding this comment.
maybe change the name of baseUrl to environment
| ```typescript | ||
| import { setBaseUrl } from '@chainsafe/sprinter-sdk'; | ||
|
|
||
| setBaseUrl("https://api.sprinter.buildwithsygma.com"); |
There was a problem hiding this comment.
same for this one, setEnvironment can be used here
| ### Example: Using `fetchOptions` | ||
|
|
||
| ```typescript | ||
| sprinter.bridgeAndCall(settings, { baseUrl: 'https://custom.api.url' }).then(solution => { |
There was a problem hiding this comment.
both parameters can be combined into a single object
{ settings, fetchOptions }There was a problem hiding this comment.
fetchOptions is an optional paramether, and then you will have { setting: { bla bla...} }
There was a problem hiding this comment.
maybe have baseUrl/environment inside settings directly and rest of fetchOptions nested inside settings like:
settings: {
env: MAINNET,
fetchOptions: FetchOptionsWithoutBaseUrl
}
| return previousValue; | ||
| }, | ||
| { | ||
| ["ETH"]: { |
There was a problem hiding this comment.
ETH might not be a native token on all EVM chains
github-actions
bot
temporarily deployed
to
gopher-docs-preview (Preview)
github-actions
bot
temporarily deployed
to
gopher-docs-preview (Preview)
mpetrunic
approved these changes
Oct 24, 2024
MakMuftic
approved these changes
Oct 24, 2024
Merged
MakMuftic
pushed a commit
that referenced
this pull request
Oct 24, 2024
🤖 I have created a release *beep* *boop* --- <details><summary>sprinter-sdk: 1.0.0</summary> ## [1.0.0](sprinter-sdk-v0.3.0...sprinter-sdk-v1.0.0) (2024-10-24) ### ⚠ BREAKING CHANGES * All functions renamed, different API and flows, please consult docs or reach out to us directly! ### Features * get bridge history for an address ([#68](#68)) ([4d524c6](4d524c6)) * refactor api ([#61](#61)) ([d6b1e9c](d6b1e9c)) </details> <details><summary>sprinter-react: 1.0.0</summary> ## [1.0.0](sprinter-react-v0.2.1...sprinter-react-v1.0.0) (2024-10-24) ### ⚠ BREAKING CHANGES * All functions renamed, different API and flows, please consult docs or reach out to us directly! ### Features * get bridge history for an address ([#68](#68)) ([4d524c6](4d524c6)) * refactor api ([#61](#61)) ([d6b1e9c](d6b1e9c)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Merged
Tbaut
added a commit
that referenced
this pull request
Jan 16, 2025
🤖 I have created a release *beep* *boop* --- <details><summary>docs: 1.0.0</summary> ## [1.0.0](docs-v0.0.1...docs-v1.0.0) (2025-01-13) ### ⚠ BREAKING CHANGES * All functions renamed, different API and flows, please consult docs or reach out to us directly! ### Features * add enableSwaps in `transferWithHook` and `transfer` ([#97](#97)) ([bd21311](bd21311)), closes [#94](#94) * add relay to the docs ([#103](#103)) ([310c506](310c506)) * Add sweep function ([#115](#115)) ([efaaa2b](efaaa2b)), closes [#110](#110) * cross chain contract call ([#21](#21)) ([69c0128](69c0128)) * depricate provider param from sdk ([#41](#41)) ([72297fe](72297fe)) * docs POC ([#14](#14)) ([8cd800d](8cd800d)) * dynamic supported network and tokens in docs ([#32](#32)) ([abe5618](abe5618)), closes [#29](#29) * erc20 with contract call ([#39](#39)) ([77e1d8d](77e1d8d)), closes [#38](#38) * native tokens transfers ([#40](#40)) ([d4edf35](d4edf35)), closes [#36](#36) * refactor api ([#61](#61)) ([d6b1e9c](d6b1e9c)) </details> <details><summary>sprinter-sdk: 1.2.0</summary> ## [1.2.0](sprinter-sdk-v1.1.2...sprinter-sdk-v1.2.0) (2025-01-13) ### Features * Add sweep function ([#115](#115)) ([efaaa2b](efaaa2b)), closes [#110](#110) ### Bug Fixes * webpack import meta error ([#114](#114)) ([f5f6fcf](f5f6fcf)) </details> <details><summary>sprinter-react: 1.2.0</summary> ## [1.2.0](sprinter-react-v1.1.2...sprinter-react-v1.2.0) (2025-01-13) ### Features * Add sweep function ([#115](#115)) ([efaaa2b](efaaa2b)), closes [#110](#110) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Thibaut Sardan <[email protected]>
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.
closes #58
BREAKING CHANGE: All functions renamed, different API and flows, please consult docs or reach out to us directly!