Skip to content

Commit 64e444b

Browse files
omahstuantran1702tnv1
authored
Fix typos (#180)
* fix typos * fix typos * fix typo * fix typo * fix typos * fix typo --------- Co-authored-by: Tuan Tran <[email protected]> Co-authored-by: Tien Nguyen <[email protected]>
1 parent f2241e6 commit 64e444b

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,20 @@ Fee-abs mechanism in a nutshell:
3232

3333
3. Swap accumulated ibc-token fee:
3434

35-
- The collected ibc-token users use for tx fee is periodically swaped back to customer chain's native token using osmosis.
35+
- The collected ibc-token users use for tx fee is periodically swapped back to customer chain's native token using osmosis.
3636

37-
We'll goes into all the details now:
37+
We'll go into all the details now:
3838

3939
#### Pulling `twap data` and update exchange rate
4040

41-
For this to work, we first has to set up an ibc channel from `feeabs` to `async-icq`. This channel set-up process can be done by anyone, just like setting up an ibc transfer channel. Once that ibc channel is there, we'll use that channel to ibc-query Twap data. Let's call this the querying channel.
41+
For this to work, we first have to set up an ibc channel from `feeabs` to `async-icq`. This channel set-up process can be done by anyone, just like setting up an ibc transfer channel. Once that ibc channel is there, we'll use that channel to ibc-query Twap data. Let's call this the querying channel.
4242

4343
The process of pulling Twap data and update exchange rate :
4444

4545
![Diagram of the process of pulling Twap data and updating exchange rate](https://i.imgur.com/HJ9a26H.png "Diagram of the process of pulling Twap data and updating exchange rate")
4646

4747
Description :
48-
For every `update exchange rate period`, at fee-abs `BeginBlocker()` we submit a `InterchainQueryPacketData` which wrapped `QueryArithmeticTwapToNowRequest` to the querying channel on the customer chain's end. Then relayers will submit `MsgReceivePacket` so that our `QueryTwapPacket` which will be routed to `async-icq` module to be processed. `async-icq` module then unpack `InterchainQueryPacketData` and send query to TWAP module. The correspone response will be wrapped in the ibc acknowledgement. Relayers then submit `MsgAcknowledgement` to the customer chain so that the ibc acknowledgement is routed to fee-abs to be processed. Fee-abs then update exchange rate according to the Twap wrapped in the ibc acknowledgement.
48+
For every `update exchange rate period`, at fee-abs `BeginBlocker()` we submit an `InterchainQueryPacketData` which wrapped `QueryArithmeticTwapToNowRequest` to the querying channel on the customer chain's end. Then relayers will submit `MsgReceivePacket` so that our `QueryTwapPacket` which will be routed to `async-icq` module to be processed. `async-icq` module then unpack `InterchainQueryPacketData` and send query to TWAP module. The corresponding response will be wrapped in the ibc acknowledgement. Relayers then submit `MsgAcknowledgement` to the customer chain so that the ibc acknowledgement is routed to fee-abs to be processed. Fee-abs then update exchange rate according to the Twap wrapped in the ibc acknowledgement.
4949

5050
#### Handling txs with ibc-token fee
5151

@@ -61,10 +61,10 @@ Fee-abstraction will use osmosis's Cross chain Swap (XCS) feature to do this. We
6161

6262
###### Reverse With Path-unwinding to get Ibc-token on Osmosis
6363

64-
- Create a ibc transfer message with a specific MEMO to work with ibc [``packet-forward-middleware``](https://github.com/strangelove-ventures/packet-forward-middleware) which is path-unwinding (an ibc feature that allow to automatic define the path and ibc transfer multiple hop follow the defined path)
64+
- Create an ibc transfer message with a specific MEMO to work with ibc [``packet-forward-middleware``](https://github.com/strangelove-ventures/packet-forward-middleware) which is path-unwinding (an ibc feature that allows to automatic define the path and ibc transfer multiple hop follow the defined path)
6565
- Ibc transfer the created packet to get the fee Ibc-token on Osmosis
6666

67-
Ex: When you sent STARS on Hub to Osmosis, you will get Osmosis(Hub(STARS)) which is different with STARS on Osmosis Osmosis(STARS). It will reverse back Osmosis(Hub(STARS)) to Osmosis(STARS):
67+
Ex: When you sent STARS on Hub to Osmosis, you will get Osmosis(Hub(STARS)) which is different from STARS on Osmosis Osmosis(STARS). It will reverse back Osmosis(Hub(STARS)) to Osmosis(STARS):
6868

6969
![Diagram of the process of swapping accumulated ibc-tokens fee](https://i.imgur.com/D1wSrMm.png "Diagram of the process of swapping accumulated ibc-tokens fee")
7070

x/feeabs/spec/01_concepts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ Fee-abs implementation:
1313

1414
- Fee-abs module imported to the customer chain.
1515

16-
The implememtation also uses Osmosis swap router and async-icq module which are already deployed on Osmosis testnet.
16+
The implementation also uses Osmosis swap router and async-icq module which are already deployed on Osmosis testnet.

x/feeabs/spec/03_epoch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Epoch
22

3-
The fee abstraction levegage the Osmosis `epoch` which is used to schedule the Inter-Blockchain Communication (IBC) send packet requests. These requests are for ``QueryArithmeticTwapToNowRequest` and `SwapIBCToken`.
3+
The fee abstraction leverages the Osmosis `epoch` which is used to schedule the Inter-Blockchain Communication (IBC) send packet requests. These requests are for ``QueryArithmeticTwapToNowRequest` and `SwapIBCToken`.
44

55
The `QueryArithmeticTwapToNowRequest` packet is used to request Time-Weighted Average Price (TWAP) data from Osmosis network.
66

x/feeabs/spec/07_ibc.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ This message is expected to fail if:
5656
- `Receiver` is empty.
5757
- `TimeoutHeight` and `TimeoutTimestamp` are both zero.
5858

59-
Feeabs module will send an ibc transfer message with a sepecific data in `Memo` field. This `Memo` field data will be used in Ibc transfer middleware on counterparty chain to swap the amount of ibc token to native token on Osmosis.
59+
Feeabs module will send an ibc transfer message with specific data in `Memo` field. This `Memo` field data will be used in Ibc transfer middleware on counterparty chain to swap the amount of ibc token to native token on Osmosis.
6060

6161
# Host Chain
6262

6363
Host chain is the swap service provider that fee abstraction uses to swap a token for native fee. Currently, host chain is designed for Osmosis.
6464

6565
Fee Abstraction connection to host chain should always be kept alive unless specified FROZEN, as this is crucial to the normal function of fee abstraction.
6666

67-
A host chain config for fee abstraction will contains:
67+
A host chain config for fee abstraction will contain:
6868

6969
```proto
7070
enum HostChainFeeAbsStatus {
@@ -89,4 +89,4 @@ message HostChainFeeAbsConfig {
8989
There are four status of fee abstraction connection to host chain:
9090
* UPDATED: the connection is up - to - date.
9191
* OUTDATED: the connection is out of date after failure to ibq query, or fail to cross - chain swap after 5 retries. Should be resumed after 30 mins.
92-
* FROZEN: the connection is frozen, no further actions will be performed.
92+
* FROZEN: the connection is frozen, no further actions will be performed.

x/feeabs/spec/08_feeabs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ SECURITY:
1414
2. Query Twap price
1515
* Query twap price can be done by either submitting a message, or periodically
1616
* If failed to query TWAP, exponential backoff will kick in. The query retry will happen after [1, 2, 4, 8, 16] epochs.
17-
* If exponential backoff reachs 4, the connection will be considered OUTDATED.
18-
* If success, the connection will be considered UPDATED, reset exponential backoff
17+
* If exponential backoff reaches 4, the connection will be considered OUTDATED.
18+
* If success, the connection will be considered UPDATED, reset exponential backoff

x/feeabs/spec/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Abstract
22

3-
When making a transactions, usually users need to pay fees in native token, but `Feeabs` module enable users on any Cosmos chain which implements this module with IBC connections to pay fee using ibc token. When users use an ibc denom as fees, the ``FeeAbstrationMempoolFeeDecorator`` ante handler will check whether the chain support the transactions to be paid by that ibc denom. It will calculate the amount of ibc tokens equivalent to native token when users make a normal transaction based on Osmosis ``twap`` between ibc denom and native denom.
3+
When making a transaction, usually users need to pay fees in native token, but the `Feeabs` module enables users on any Cosmos chain which implements this module with IBC connections to pay fee using ibc token. When users use an ibc denom as fees, the ``FeeAbstrationMempoolFeeDecorator`` ante handler will check whether the chain supports the transactions to be paid by that ibc denom. It will calculate the amount of ibc tokens equivalent to native token when users make a normal transaction based on Osmosis ``twap`` between ibc denom and native denom.
44

5-
After that, the ``FeeAbstractionDeductFeeDecorate`` ante handler swaps ibc token for native token to pay for transaction fees. The accumulated ibc token will be swaped on Osmosis Dex every epoch.
5+
After that, the ``FeeAbstractionDeductFeeDecorate`` ante handler swaps ibc token for native token to pay for transaction fees. The accumulated ibc token will be swapped on Osmosis Dex every epoch.
66

7-
The `Feeabs` module fetches Osmosis [twap](https://github.com/osmosis-labs/osmosis/tree/main/x/twap) at the begin of every [epoch](01_concepts.md#Epoch) and swap all of ibc tokens left in the module to native token using `swap router` and `ibc hooks` on Osmosis.
7+
The `Feeabs` module fetches Osmosis [twap](https://github.com/osmosis-labs/osmosis/tree/main/x/twap) at the beginning of every [epoch](01_concepts.md#Epoch) and swap all of ibc tokens left in the module to native token using `swap router` and `ibc hooks` on Osmosis.
88

99
## Contents
1010

0 commit comments

Comments
 (0)