Skip to content

Commit eb27801

Browse files
committed
frames on photos
1 parent 0e39175 commit eb27801

9 files changed

+17
-20
lines changed

cw20-swaps.mdx

+1-2
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,8 @@ In particular, this means you cannot perform the following actions in 1 transact
6060

6161
* IBC transfer after purchasing a cw20 asset
6262

63-
![Chain 1 is the origin chain where the cw20 token can be swapped freely, but it cannot be transferred to another chain in the same transaction.](/images/9afddc0-case1.jpg)
63+
<Frame caption="Chain 1 is the origin chain where the cw20 token can be swapped freely, but it cannot be transferred to another chain in the same transaction.">![Chain 1 is the origin chain where the cw20 token can be swapped freely, but it cannot be transferred to another chain in the same transaction.](/images/9afddc0-case1.jpg)</Frame>
6464

65-
Chain 1 is the origin chain where the cw20 token can be swapped freely, but it cannot be transferred to another chain in the same transaction.
6665

6766
* Call a contract on a remote chain after purchasing a cw20 asset (e.g. since this requires an IBC transfer under the hood)
6867

embed-a-swap-widget.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ description: "This guide provides step-by-step instructions to embed the Skip AP
88
1. Go to [https://ibc.fun](https://ibc.fun)
99
2. Modify the source/destination chains and assets to set the default route (optional)
1010
3. Click the "Embed" button
11-
![](/images/d0c5fda-Screen_Shot_2024-06-04_at_12.15.27_AM.png)
11+
<Frame>![](/images/d0c5fda-Screen_Shot_2024-06-04_at_12.15.27_AM.png)</Frame>
1212
4. Copy the code
13-
![](/images/d893b9d-Screen_Shot_2024-06-04_at_12.16.24_AM.png)
13+
<Frame>![](/images/d893b9d-Screen_Shot_2024-06-04_at_12.16.24_AM.png)</Frame>
1414
5. Paste it in to your project, and you're done!
1515

1616
### Helpful Tips

getting-started.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Introduction"
33
description: "This pages explains what the Skip API is, gives examples of applications built with it, and provides guidance on standard ways to use it."
44
---
55

6-
![](/images/4f92aa7-DALLE_Cover_Photo_1..png)
6+
<Frame>![](/images/4f92aa7-DALLE_Cover_Photo_1..png)</Frame>
77

88
## 👋 Introduction
99

handling-cross-chain-failure-cases.mdx

+2-4
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@ There are two types of IBC failures that may occur when a user attempts to trave
2020
* The user attempts to transfer tokens from Neutron to the hub, but the packet isn't picked up by a relayer for more than 5 minutes (past the timeout\_timestamp). When a relayer finally comes online, it relays a timeout message to Neutron, releasing the user's ATOM back to their address on Neutron where they first had it.
2121
* **For transfer-only routes:** This is the only kind of failure that may happen on a route that only contains transfers. Either the user's tokens will reach their destination chain as intended, or they will wind up with the same tokens, on the same chain where they started.
2222

23-
![In a pre-swap or swap related error, the user will end up with the same tokens they started with on their initial chain (e.g. ATOM on Neutron in this example)](/images/6744b96-error-1-diagram.png)
23+
<Frame caption="In a pre-swap or swap related error, the user will end up with the same tokens they started with on their initial chain (e.g. ATOM on Neutron in this example)">![In a pre-swap or swap related error, the user will end up with the same tokens they started with on their initial chain (e.g. ATOM on Neutron in this example)](/images/6744b96-error-1-diagram.png)</Frame>
2424

25-
In a pre-swap or swap related error, the user will end up with the same tokens they started with on their initial chain (e.g. ATOM on Neutron in this example)
2625

2726
2. **Post-swap failures:**
2827
* **Description**: These are failures that occur on the sequence of transfers between the swap venue chain and the user's destination chain, after the user's origin tokens have already been successfully swapped for their desired destination asset.
@@ -34,9 +33,8 @@ In a pre-swap or swap related error, the user will end up with the same tokens t
3433
* **Examples:** Consider a route where the source asset is ATOM on Neutron, the destination asset is STRIDE on Stride, and the swap takes place on Osmosis:
3534
* Suppose the swap took place and the transfer to Stride has been initiated, but the Relayer between Osmosis and Stride is down. So the packet’s timeout occurs after 5 minutes. When the Relayer comes back online after 8 minutes, it relays a timeout message to Osmosis, releasing the user’s STRIDE, which gets forwarded to their Osmosis address
3635

37-
![In a post-swap error, the user will end up with their destination asset tokens in their address on the chain where the swap took place (e.g. STRIDE on Osmosis in this example)](/images/5c93590-error-type-2.png)
36+
<Frame caption="In a post-swap error, the user will end up with their destination asset tokens in their address on the chain where the swap took place (e.g. STRIDE on Osmosis in this example)">![In a post-swap error, the user will end up with their destination asset tokens in their address on the chain where the swap took place (e.g. STRIDE on Osmosis in this example)](/images/5c93590-error-type-2.png)</Frame>
3837

39-
In a post-swap error, the user will end up with their destination asset tokens in their address on the chain where the swap took place (e.g. STRIDE on Osmosis in this example)
4038

4139
## Axelar Failures
4240

how-to-generate-shareable-links.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: "This guide provides step-by-step instructions to generate IBC.fun
88
1. Go to [https://ibc.fun](https://ibc.fun)
99
2. Modify the source/destination chains and assets to set the default route (optional)
1010
3. Click the "Share" button
11-
![](/images/d1281bd-Screen_Shot_2024-06-11_at_2.40.19_PM.png)
11+
<Frame>![](/images/d1281bd-Screen_Shot_2024-06-11_at_2.40.19_PM.png)</Frame>
1212
4. Voila, you're done! The sharable link is now copied to your clipboard for you to embed on your website for an easy onboarding/deposit experience, to tweet about your bags, or to simply share it with your friends!
1313

1414
### Advanced Configuration Instructions

ibc-routing-algorithm.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ description: "This page describes the IBC token routing problem and the algorith
2525

2626
IBC transfers data over "channels" that connect two chains. Channels are identified by human-readable port names (e.g. "transfer") and channel IDs (e.g. channel-1). For example, consider a transfer channel between Terra2 and Axelar:
2727

28-
![](/images/12bf3f9-Screen_Shot_2023-07-25_at_3.26.30_PM.png)
28+
<Frame>![](/images/12bf3f9-Screen_Shot_2023-07-25_at_3.26.30_PM.png)</Frame>
2929

3030
_Notice that both chains maintain their own channel IDs for the channel, which might not be the same. As an analogy, you might think of the different chains as cities and the channel as a road connecting them. IBC packets are cars driving across the road_
3131

@@ -54,11 +54,11 @@ Now that you understand that IBC denoms get their names from their paths, you un
5454

5555
Continuing the example from above, WETH.axl transferred directly from Axelar to Terra2 will have a different denom than WETH.axl transferred through Osmosis:
5656

57-
![](/images/2477aba-Screen_Shot_2023-07-25_at_3.48.15_PM.png)
57+
<Frame>![](/images/2477aba-Screen_Shot_2023-07-25_at_3.48.15_PM.png)</Frame>
5858

5959
To make matters worse, multiple channels can exist between the same two chains (IBC is permissionless afterall), and IBC uses channel identifiers--not chain identifiers--to construct denoms. That means two different versions of the same asset will exist on the destination chain even when tokens are transferred from the same source chain, if they're transferred over two different channels:
6060

61-
![](/images/eb72804-Screen_Shot_2023-07-25_at_3.59.53_PM.png)
61+
<Frame>![](/images/eb72804-Screen_Shot_2023-07-25_at_3.59.53_PM.png)</Frame>
6262

6363

6464
<Warning>

multi-chain-realtime-transaction-and-packet-tracking.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You can also use it to identify failure cases (e.g. a swap that fails due to sli
1313

1414
For example, if one of your end users initiates a swap that begins with ATOM on Neutron and concludes with JUNO on Juno, you can use the lifecycle tracking to report when the ATOM moves from Neutron to the Hub, when it reaches Osmosis, and when the JUNO finally arrives safely on Juno.
1515

16-
![](/images/cc4fe76-Screenshot_2024-03-07_at_9.12.25_AM.png)
16+
<Frame>![](/images/cc4fe76-Screenshot_2024-03-07_at_9.12.25_AM.png)</Frame>
1717

1818
## Basics
1919

overview-and-typical-usage.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,18 @@ The most important `tx` methods include:
4747
On a cross-chain swapping and transferring frontend, integrators typically:
4848

4949
1. Use the `info` methods to populate the list of potential starting & ending chains & assets
50-
![](/images/ca61685-CleanShot_2024-05-23_at_15.28.242x.png)
50+
<Frame>![](/images/ca61685-CleanShot_2024-05-23_at_15.28.242x.png)</Frame>
5151

5252
2. Use `/fungible/route` (`SkipRouter.route`) to get a quote when the user selects all their chains & tokens and inputs one of their amounts
53-
![](/images/78d8d3f-CleanShot_2024-05-23_at_15.33.182x.png)
53+
<Frame>![](/images/78d8d3f-CleanShot_2024-05-23_at_15.33.182x.png)</Frame>
5454

5555
3. Use `/fungible/msgs` (`SkipRouter.msgs`) to get a transaction for the user to sign after they've locked in the route & begun the transaction creation process
56-
![](/images/b42b522-CleanShot_2024-05-23_at_15.38.522x.png)
56+
<Frame>![](/images/b42b522-CleanShot_2024-05-23_at_15.38.522x.png)</Frame>
5757

5858
4. Use `/tx/track`(`SkipRouter.trackTransaction`) to register the transaction for tracking (or `/tx/submit` to register and submit it on-chain)
5959

6060
5. Use `/status` (`SkipRouter.transactionStatus`) to get the real-time status of the transaction as it progresses through multiple bridges/chains.
61-
![](/images/a83beaf-CleanShot_2024-05-23_at_15.59.452x.png)
61+
<Frame>![](/images/a83beaf-CleanShot_2024-05-23_at_15.59.452x.png)</Frame>
6262

6363

6464
<Check>

safe-swapping-how-to-protect-users-from-harming-themselves.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Loud visual emphasis of the values that exceed safe tolerances is the most effec
5757

5858
For example, when a swap exceeds our `PRICE_IMPACT_THRESHOLD` on [ibc.fun](ibc.fun), we auto-open the drop-down that normally hides price impact and highlight the whole field in red.
5959

60-
![](/images/5b993ce-swap-warning-image.png)
60+
<Frame>![](/images/5b993ce-swap-warning-image.png)</Frame>
6161

6262
### F.ail Transactions when they're likely to cause user harm
6363

@@ -80,7 +80,7 @@ Importantly, this is different and more disruptive than simply warning the user
8080

8181
For example, this is ibc.fun's warning screen:
8282

83-
![](/images/a61a075-swap-warning-page-image.png)
83+
<Frame>![](/images/a61a075-swap-warning-page-image.png) </Frame>
8484
* It's very clear that our expectation is that the swap will harm the user with the "Bad Trade Warning" across the top
8585
* The page explicitly reminds the user what the problem is -- foregrounding the predicted price impact and forcing them to acknowledge it again
8686
* The "happy path" or "default" path is to go back -- not to finish the swap (Notice that the "Go Back" button is highlighted)

0 commit comments

Comments
 (0)