Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc typos #3

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/pages/concepts/interchain-transaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ transactions to be executed on one or more blockchain networks - encoded in a me
- The leafs of the tree are the transactions contained in the interchain transaction. They define all of the actions which can be
executed by the iTx.

- The root hash of the merkle tree is called the **Interchain Transcation Hash**
- The root hash of the merkle tree is called the **Interchain Transaction Hash**

- Every `iTx` is uniquely defined by it's iTx hash

- In order to execute the `iTx`, the user signs the `iTx hash` with their private key and sends the signed hash, togehter with
- In order to execute the `iTx`, the user signs the `iTx hash` with their private key and sends the signed hash, together with
the list of the `leaf` transactions - to a Klaster Node.

- The first transaction in the `iTx` is always the transaction fee payment transaction.
Expand Down
11 changes: 5 additions & 6 deletions docs/pages/zero-to-hero-klaster-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,15 +177,15 @@ const mUSDC = intersectTokenAndClients(mcUSDC, mcClient);

## Create a Bridging Plugin

Klaster introduces a concept of _Bridging Plugigs_. Yoa can think of them as templates, which the Klaster SDK
Klaster introduces a concept of _Bridging Plugins_. Yoa can think of them as templates, which the Klaster SDK
uses to encode and execute a bridging action whenever it needs to. Since Klaster is an agnostic protocol and SDK,
every function that might require bridging can accept the function of type `BridgePlugin` as input.

For this tutorial we have prepared a [LiFi]('https://li.fi') bridging plugin example.

But in general, what is a Klaster Bridging Plugin?

It's a simple function which provides a `data` object containing things needed to encode a brdiging transaction such as
It's a simple function which provides a `data` object containing things needed to encode a bridging transaction such as
`sourceChainId`, `destinationChainId`, `sourceToken`, `destinationToken`, `amount`, etc... and expects an object in return
which tells the Klaster SDK i) which transactions need to be executed ii) how much will be received on destination.

Expand Down Expand Up @@ -290,12 +290,11 @@ So, for this demo, we'll say that we want to send the amount we receive from bri
### Encoding the bridging operations

In your own project, you'll be able to encode arbitrarily complex actions across any number of blockchains. For example, in
the AAVE case, after a token lands on the destination chain, the `supply` function is called on the AAVE Smart Contract

the AAVE case, after a token lands on the destination chain, the `supply` function is called on the AAVE Smart Contract.
Anyways let's continue. The SDK is intelligent enough to calculate on its own the required steps to get some amount of
tokens on some desired destination chain.

Let's assume a following situation. You have:
Let's assume the following situation. You have:

- 10 USDC on Polygon
- 20 USDC on Optimism
Expand Down Expand Up @@ -346,7 +345,7 @@ const sendERC20Op = rawTx({

Note one thing here, the usage of `bridgingOps.totalReceivedOnDestination` - this is a variable which has calculated
how much assets will be available on the destination chain _after_ bridging has completed. If you had zero on the destination
then this will be the total amount available. If you had `> 0` available then the total available will be
then this will be the total amount available. If you had `> 0` available then the total available will be:

`totalReceivedOnDestination + balanceOnDestination`

Expand Down