Skip to content

Commit 1a09a0b

Browse files
authored
Merge branch 'dev' into update/kdf/sign_raw_transaction
2 parents e76a84b + c860054 commit 1a09a0b

File tree

19 files changed

+767
-200
lines changed

19 files changed

+767
-200
lines changed

filepathSlugs.json

+32-2
Original file line numberDiff line numberDiff line change
@@ -2015,6 +2015,11 @@
20152015
"coin-protocol",
20162016
"coin-protocol-data",
20172017
"evm-node",
2018+
"v2-1-0-current-release",
2019+
"v2-2-0",
2020+
"tendermint-node",
2021+
"v2-1-0-current-release-2",
2022+
"v2-2-0-2",
20182023
"tokens-request",
20192024
"utxo-merge-params"
20202025
],
@@ -2148,8 +2153,12 @@
21482153
"taker-payment-wait-for-spend-failed",
21492154
"maker-payment-spend-failed",
21502155
"maker-payment-spent",
2156+
"maker-payment-spend-confirmed",
2157+
"maker-payment-spend-confirm-failed",
2158+
"maker-payment-spent-by-watcher",
21512159
"taker-payment-wait-refund-started",
21522160
"taker-payment-refund-started",
2161+
"taker-payment-refunded-by-watcher",
21532162
"taker-payment-refund-failed",
21542163
"taker-payment-refunded",
21552164
"taker-payment-refund-finished",
@@ -2802,10 +2811,12 @@
28022811
"request-parameters",
28032812
"response-parameters",
28042813
"examples",
2805-
"request-default-optional-values",
2814+
"request-using-rpc-urls-parameter-kdf-version-2-2-0",
28062815
"response",
28072816
"request-with-get-balances-set-to-false",
28082817
"response-2",
2818+
"request-using-nodes-parameter-kdf-version-2-2-0",
2819+
"response-3",
28092820
"error-types",
28102821
"platform-config-is-not-found-error",
28112822
"platform-is-already-activated-error",
@@ -2853,6 +2864,14 @@
28532864
"command",
28542865
"response-success"
28552866
],
2867+
"src/pages/komodo-defi-framework/api/v20/get_enabled_coins/index.mdx": [
2868+
"get-enabled-coins",
2869+
"parameters",
2870+
"response",
2871+
"examples",
2872+
"command",
2873+
"response-2"
2874+
],
28562875
"src/pages/komodo-defi-framework/api/v20/get_public_key/index.mdx": [
28572876
"get-public-key",
28582877
"arguments",
@@ -2922,7 +2941,6 @@
29222941
"example-without-balances",
29232942
"balance-info",
29242943
"derivation-method",
2925-
"evm-node",
29262944
"coin-protocol",
29272945
"coin-protocol-data",
29282946
"confirmation-targets",
@@ -3161,6 +3179,7 @@
31613179
"response-success-6",
31623180
"withdraw-qrc-20-coins-with-gas-limit",
31633181
"withdraw-tendermint-coins-with-a-memo-and-custom-gas-fee",
3182+
"withdraw-tendermint-ibc-coins",
31643183
"error-responses",
31653184
"invalid-request-unknown-fee-type",
31663185
"invalid-request-wrong-parameter-type",
@@ -3945,6 +3964,17 @@
39453964
"src/pages/komodo-wallet/desktop/view-your-wallet-address/index.mdx": [
39463965
"viewing-your-wallet-address-in-komodo-wallet-desktop"
39473966
],
3967+
"src/pages/komodo-wallet/guides/how-to-find-the-right-ibc-channel-for-transfers/index.mdx": [
3968+
"how-to-find-the-right-ibc-channel-for-transfers-on-komodo-wallet",
3969+
"understanding-ibc-channels",
3970+
"sources-to-find-the-ibc-channel-information",
3971+
"example-transferring-from-iris-to-osmosis",
3972+
"verifying-transfers",
3973+
"staying-updated"
3974+
],
3975+
"src/pages/komodo-wallet/guides/index.mdx": [
3976+
"komodo-wallet-general-guides"
3977+
],
39483978
"src/pages/komodo-wallet/index.mdx": [
39493979
"komodo-wallet-guides"
39503980
],

src/data/sidebar.json

+17
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,19 @@
177177
"titleLink": "/komodo-wallet/",
178178
"links": []
179179
},
180+
{
181+
"title": "User Guides (General)",
182+
"links": [
183+
{
184+
"title": "Introduction",
185+
"href": "/komodo-wallet/guides/"
186+
},
187+
{
188+
"title": "Finding IBC Channels for Transfers",
189+
"href": "/komodo-wallet/guides/how-to-find-the-right-ibc-channel-for-transfers/"
190+
}
191+
]
192+
},
180193
{
181194
"title": "User Guides (Mobile)",
182195
"links": [
@@ -504,6 +517,10 @@
504517
{
505518
"title": "Wallet",
506519
"links": [
520+
{
521+
"title": "get_enabled_coins",
522+
"href": "/komodo-defi-framework/api/v20/get_enabled_coins/"
523+
},
507524
{
508525
"title": "get_public_key",
509526
"href": "/komodo-defi-framework/api/v20/get_public_key/"
48 KB
Loading

src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx

+57-5
Original file line numberDiff line numberDiff line change
@@ -144,16 +144,68 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig
144144

145145
The `EvmNode` object includes the following items for a given coin or token:
146146

147-
| Parameter | Type | Description |
148-
| --------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
149-
| url | string | URL of an RPC node |
150-
| gui\_auth | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run officially by the Komodo Platform team |
147+
| Parameter | Type | Description |
148+
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------- |
149+
| url | string | URL of an RPC node |
150+
| komodo\_auth | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run officially by the Komodo Platform team |
151+
152+
#### v2.1.0 (current release)
151153

152154
<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
153155
```json
154156
{
155157
"url": "http://eth1.cipig.net:8555",
156-
"gui_auth": false
158+
"komodo_proxy": false
159+
}
160+
```
161+
</CollapsibleSection>
162+
163+
<Note>
164+
Prior to the v2.2.0 release, the `gui_auth` field was used to access RPC nodes run officially by the Komodo Platform team. This field was replaced with the `komodo_proxy` field in the v2.2.0 release.
165+
</Note>
166+
167+
#### v2.2.0+
168+
169+
<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
170+
```json
171+
{
172+
"url": "https://nucleus-rpc.alpha.komodo.earth",
173+
"komodo_proxy": true
174+
}
175+
```
176+
</CollapsibleSection>
177+
178+
### TendermintNode
179+
180+
The `TendermintNode` object includes the following items for a given coin or token:
181+
182+
| Parameter | Type | Description |
183+
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
184+
| url | string | URL of an RPC node |
185+
| komodo\_auth | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run behind [komodo-defi-proxy](https://github.com/KomodoPlatform/komodo-defi-proxy) |
186+
187+
#### v2.1.0 (current release)
188+
189+
<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
190+
```json
191+
{
192+
"url": "http://eth1.cipig.net:8555",
193+
"komodo_proxy": false
194+
}
195+
```
196+
</CollapsibleSection>
197+
198+
<Note>
199+
Prior to the v2.2.0 release, the `gui_auth` field was used to access RPC nodes run officially by the Komodo Platform team. This field was replaced with the `komodo_proxy` field in the v2.2.0 release.
200+
</Note>
201+
202+
#### v2.2.0+
203+
204+
<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
205+
```json
206+
{
207+
"url": "https://nucleus-rpc.alpha.komodo.earth",
208+
"komodo_proxy": true
157209
}
158210
```
159211
</CollapsibleSection>

src/pages/komodo-defi-framework/api/common_structures/swaps/maker_events/index.mdx

+5-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ export const description = "A description of events and outcomes for each step o
33

44
# Maker Swap Events
55

6-
<DevComment>
7-
Needs update for watchtower events
8-
</DevComment>
6+
The atomic swap process goes through a series of steps to perform and confirm transactions, then release funds accordingly. If a swap fails, the taker payment will be returned to the taker's address (minus network transaction fees). Sometimes failed swaps were due to a taker or maker going offline in the middle of a swap, so `Swap Watcher` seednodes were created to process certain events on behalf of the maker/taker.
7+
8+
Swap watchers act to complete a swap or refund if one or both sides go offline for too long. This is done in a non-custodial manner, and funds are still governed by HTLC which can only be released to either the maker or the taker's address, and only after specific conditions are met, such as completion on the side that is online and/or a timeout.
9+
10+
Takers send all the necessary information to watch the swap on taker/maker chains together with two signed transactions to watchers: one to spend the maker payment (maker payment spend) and the other to refund the taker payment (taker payment refund). If the maker proceeds with the swap and spends the taker payment (and therefore exposes the secret), and the taker doesn't respond for a duration, the watcher sends the maker payment spend transaction to the chain on behalf of the taker (after appending the secret to the redeem script). If the taker sends the taker payment but the maker doesn't spend it, and the taker doesn't send the refund transaction for a duration, then the watchers complete the process by sending the taker payment refund transaction to the chain.
911

1012
## Maker Success Events
1113

src/pages/komodo-defi-framework/api/common_structures/swaps/taker_events/index.mdx

+208-13
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)