Skip to content

Commit 76e4424

Browse files
committed
sync upstream rename-komododefi
2 parents aade72a + ad51cda commit 76e4424

File tree

15 files changed

+3500
-443
lines changed

15 files changed

+3500
-443
lines changed

.github/workflows/get_data_lint_files_deploy.yml

+4
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,10 @@ jobs:
7171
if: github.base_ref == 'main' || github.ref == 'refs/heads/main'
7272
run: node utils/js/ensure_changelog_update.js
7373

74+
- name: Generate Search Index
75+
if: github.base_ref == 'main' || github.ref == 'refs/heads/main'
76+
run: node utils/js/create_search_index.js
77+
7478
- name: Set lint-fix branch name
7579
id: vars
7680
shell: bash

filepathSlugs.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -5449,12 +5449,12 @@
54495449
"antara-integration-layer-2"
54505450
],
54515451
"src/pages/start-here/core-technology-discussions/atomicdex/index.mdx": [
5452-
"atomic-dex-and-atomic-swaps",
5452+
"komodo-de-fi-framework-and-atomic-swaps",
54535453
"introduction",
54545454
"current-problems-in-cryptocurrency-exchange",
54555455
"centralized-exchanges-are-popular-but-limited",
54565456
"the-concept-and-shortcomings-of-a-normal-decentralized-exchange",
5457-
"atomic-dex-a-complete-solution",
5457+
"komodo-de-fi-framework-a-complete-solution",
54585458
"the-decentralized-orderbook",
54595459
"order-matching-with-full-relay-and-non-relay-nodes",
54605460
"one-passphrase-many-addresses",

src/pages/antara/api/assets/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Command:
235235

236236
<CollapsibleSection expandedText="Hide Response" collapsedText="Show Response">
237237
```bash
238-
0100000001484256677a6417030dd99716a47b8c9cb06fba6e57ff4617e9932a6cde2972830100000049483045022100fc1926401b27ba044bbf17c36f36030adae52a188594efc75fe42861ab0b997802205e729d6f5587e5a5296b5649a154ce1fe3c581078fac7ae4e2b4577978c05c8901ffffffff0300e8764817000000302ea22c80201ab400e039122028345520ba041ac3e6ec81ad28d8415e78d760d55f41097dd58103120c008203000401cc10d262684a0300002321028bb4ae66aa4f1960a4aa822907e800eb688d9ab2605c8067a34b421748c67e27ac00000000000000004f6a4c4ce362c5bbc34e6517c483afc910a3b0585c40da5c09b7c5d2d9757c5c5075e2d41b59e80300000000000021028bb4ae66aa4f1960a4aa822907e800eb688d9ab2605c8067a34b421748c67e2700000000`
238+
0100000001484256677a6417030dd99716a47b8c9cb06fba6e57ff4617e9932a6cde2972830100000049483045022100fc1926401b27ba044bbf17c36f36030adae52a188594efc75fe42861ab0b997802205e729d6f5587e5a5296b5649a154ce1fe3c581078fac7ae4e2b4577978c05c8901ffffffff0300e8764817000000302ea22c80201ab400e039122028345520ba041ac3e6ec81ad28d8415e78d760d55f41097dd58103120c008203000401cc10d262684a0300002321028bb4ae66aa4f1960a4aa822907e800eb688d9ab2605c8067a34b421748c67e27ac00000000000000004f6a4c4ce362c5bbc34e6517c483afc910a3b0585c40da5c09b7c5d2d9757c5c5075e2d41b59e80300000000000021028bb4ae66aa4f1960a4aa822907e800eb688d9ab2605c8067a34b421748c67e2700000000
239239
```
240240
</CollapsibleSection>
241241

src/pages/antara/api/gaming/index.mdx

+41-35
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The `load_configuration` function loads customizable configuration settings from
2828

2929
#### Usage Pattern
3030

31-
```cpp
31+
```c
3232
template<typename TConfig>
3333

3434
TConfig antara::gaming::config::load_configuration(std::filesystem::path &&config_path, std::string filename)
@@ -76,7 +76,7 @@ The `version` function returns the current version of the Antara Gaming SDK.
7676

7777
#### Usage Pattern
7878

79-
```cpp
79+
```c
8080
#include <antara/gaming/core/version.hpp>
8181

8282
constexpr const char *antara::gaming::version()
@@ -163,11 +163,9 @@ int main()
163163

164164
Public member functions.
165165

166-
{/* The description in the documentation was unclear to me. Can you please provide more information about what "Public member functions" means here? Thx */}
167-
168166
#### Usage Pattern
169167

170-
```cpp
168+
```c
171169
void receive_add_base_system(const ecs::event::add_base_system &evt)
172170
```
173171

@@ -183,7 +181,9 @@ void receive_add_base_system(const ecs::event::add_base_system &evt)
183181
| ------ | ---- | ----------- |
184182
| (none) | void | |
185183

184+
<DevComment>
186185
{/* needs an example */}
186+
</DevComment>
187187

188188
### start
189189

@@ -215,7 +215,9 @@ system_manager_instance.start();
215215
| ------ | ---- | ----------- |
216216
| (none) | void | |
217217

218+
<DevComment>
218219
{/* Does this return something such as a bool value, for successful execution, by chance? */}
220+
</DevComment>
219221

220222
#### 📌 Example
221223

@@ -279,7 +281,7 @@ int main()
279281
entt::dispatcher& dispatcher{registry.set<entt::dispatcher>()};
280282
antara::gaming::ecs::system_manager system_manager{entity_registry};
281283
system_manager.start();
282-
// ... add 5 differents systems here
284+
// ... add 5 different systems here
283285
std::size_t nb_systems_updated = system_manager.update();
284286
if (nb_systems_updated != 5) {
285287
std::cerr << "Expect 5 system updates from system_manager.update(), but received only " << nb_systems_updated << std::endl;
@@ -331,7 +333,7 @@ int main()
331333
entt::dispatcher& dispatcher{registry.set<entt::dispatcher>()};
332334
antara::gaming::ecs::system_manager system_manager{entity_registry};
333335
system_manager.start();
334-
// ... add 5 differents systems here
336+
// ... add 5 different systems here
335337
std::size_t nb_systems_updated = system_manager.update();
336338
if (nb_systems_updated != 5) {
337339
std::cerr << "Expect 5 system updates from system_manager.update(), but received only " << nb_systems_updated << std::endl;
@@ -348,7 +350,7 @@ The `get_system` function uses a template parameter to return a reference to a s
348350

349351
#### Usage Pattern
350352

351-
```cpp
353+
```c
352354
template<typename TSystem>
353355
const TSystem &get_system() const
354356
```
@@ -365,7 +367,9 @@ const TSystem &get_system() const
365367
| ------- | --------- | --------------------------------------------------- |
366368
| TSystem | \&TSystem | a reference to the template chosen by the developer |
367369
370+
<DevComment>
368371
{/* Need an example here */}
372+
</DevComment>
369373
370374
### get\_system | 2
371375
@@ -377,7 +381,7 @@ This overloaded function accepts different parameters.
377381
378382
#### Usage Pattern
379383
380-
```cpp
384+
```c
381385
template<typename TSystem>
382386
383387
TSystem &get_system()
@@ -426,7 +430,7 @@ This function recursively calls the [get\_system](/antara/api/gaming/#get-system
426430

427431
#### Usage Pattern
428432

429-
```cpp
433+
```c
430434
template<typename ...TSystems>
431435
std::tuple<std::add_lvalue_reference_t<TSystems>...> get_systems()
432436
```
@@ -456,7 +460,7 @@ int main()
456460
entt::dispatcher& dispatcher{registry.set<entt::dispatcher>()};
457461
antara::gaming::ecs::system_manager system_manager{entity_registry};
458462
system_manager.start();
459-
// ... added 2 differents systems here (render_system, and a log_system)
463+
// ... added 2 different systems here (render_system, and a log_system)
460464
auto& render_system = system_manager.get_system<game::render_system>();
461465

462466
const auto& log_system = system_manager.get_system<game::log_system>();
@@ -476,7 +480,7 @@ An overloaded version of the [get\_systems](/antara/api/gaming/#get-systems-1) f
476480

477481
#### Usage Pattern
478482

479-
```cpp
483+
```c
480484
template<typename ...TSystems>
481485
std::tuple<std::add_lvalue_reference_t<std::add_const_t<TSystems>>...> get_systems() const
482486
```
@@ -505,7 +509,7 @@ int main()
505509
entt::registry entity_registry;
506510
entt::dispatcher& dispatcher{registry.set<entt::dispatcher>()};
507511
antara::gaming::ecs::system_manager system_manager{entity_registry};
508-
// ... added differents systems here
512+
// ... added different systems here
509513
// Called from a const context
510514
auto &&[system_foo, system_bar] = system_manager.get_systems<system_foo, system_bar>();
511515

@@ -526,7 +530,7 @@ The `has_system` function verifies whether or not a system is already registered
526530

527531
#### Usage Pattern
528532

529-
```cpp
533+
```c
530534
template<typename TSystem>
531535
bool has_system() const
532536
```
@@ -625,7 +629,7 @@ The `has_systems` function verifies whether or not a list of systems is already
625629

626630
#### Usage Pattern
627631

628-
```cpp
632+
```c
629633
template<typename ...TSystems>
630634
bool has_systems() const
631635
```
@@ -730,7 +734,7 @@ This function recursively calls the [has\_system](/antara/api/gaming/#has-system
730734

731735
#### Usage Pattern
732736

733-
```cpp
737+
```c
734738
template<typename ...TSystems>
735739
bool has\_systems() const
736740
```
@@ -776,7 +780,7 @@ The`mark_system` function marks a system for destruction at the next tick of the
776780

777781
#### Usage Pattern
778782

779-
```cpp
783+
```c
780784
template<typename TSystem>
781785
bool mark_system()
782786
```
@@ -823,7 +827,7 @@ The`mark_systems` function marks a system for destruction at the next tick of th
823827

824828
#### Usage Pattern
825829

826-
```cpp
830+
```c
827831
template<typename TSystem>
828832
bool mark_system()
829833
```
@@ -876,7 +880,7 @@ This function recursively calls the [mark\_system](/antara/api/gaming/#mark-syst
876880

877881
#### Usage Pattern
878882

879-
```cpp
883+
```c
880884
template<typename ...TSystems>
881885
bool mark_systems()
882886
```
@@ -923,7 +927,7 @@ The `enable_system` function enables a system.
923927

924928
#### Usage Pattern
925929

926-
```cpp
930+
```c
927931
template<typename TSystem>
928932
bool enable_system()
929933
```
@@ -972,7 +976,7 @@ This function recursively calls the [enable\_system](/antara/api/gaming/#enable-
972976

973977
#### Usage Pattern
974978

975-
```cpp
979+
```c
976980
template<typename ...TSystems>
977981
bool enable_systems()
978982
```
@@ -1020,7 +1024,7 @@ A disabled system is ignored during the game loop, but the system is not destroy
10201024

10211025
#### Usage Pattern
10221026

1023-
```cpp
1027+
```c
10241028
template<typename TSystem>
10251029
bool disable_system()
10261030
```
@@ -1068,7 +1072,7 @@ This function recursively calls the [disable\_system](/antara/api/gaming/#disabl
10681072

10691073
#### Usage Pattern
10701074

1071-
```cpp
1075+
```c
10721076
template<typename ...TSystems>
10731077
bool disable_systems()
10741078
```
@@ -1206,7 +1210,7 @@ This function is a factory.
12061210

12071211
#### Usage Pattern
12081212

1209-
```cpp
1213+
```c
12101214
template<typename TSystem, typename ...TSystemArgs>
12111215
TSystem &create_system(TSystemArgs&&... args)
12121216
```
@@ -1246,11 +1250,13 @@ int main()
12461250

12471251
#### Public Function
12481252

1253+
<DevComment>
12491254
{/* Requires documentation */}
1255+
</DevComment>
12501256

12511257
#### Usage Pattern
12521258

1253-
```cpp
1259+
```c
12541260
template<typename TSystem, typename ...TSystemArgs>
12551261
void create_system_rt(TSystemArgs&&... args)
12561262
```
@@ -1261,13 +1267,11 @@ void create_system_rt(TSystemArgs&&... args)
12611267

12621268
The `load_systems` function loads many os systems.
12631269

1264-
{/* What does "os" mean above? Operating systems? That would make it operating systems systems */}
1265-
12661270
This function recursively calls the [create\_system](/antara/api/gaming/#create-system) function.
12671271

12681272
#### Usage Pattern
12691273

1270-
```cpp
1274+
```c
12711275
template<typename ...TSystems, typename ...TArgs>
12721276
auto load_systems(TArgs&&... args)
12731277
```
@@ -1383,8 +1387,6 @@ using systems_queue = std::queue<system_ptr>
13831387
base*system &add_system*(system_ptr &&system, system_type sys_type)
13841388
```
13851389

1386-
{/* Not clear about any of this, just placing here for now in the format */}
1387-
13881390
### entity\_registry\_
13891391

13901392
#### Private Data Members
@@ -1414,9 +1416,7 @@ This is the principal constructor for key-press functions.
14141416
###### Usage Pattern
14151417

14161418
```cpp
1417-
14181419
key_pressed(input::key key_, bool alt_, bool control_, bool shift_, bool system_)
1419-
14201420
```
14211421

14221422
###### Template Type
@@ -1454,7 +1454,9 @@ int main()
14541454

14551455
The `key_pressed` function that takes no arguments is the default constructor, provided for scripting-system convenience.
14561456

1457+
<DevComment>
14571458
{/* Is there more information we can provide here? */}
1459+
</DevComment>
14581460

14591461
Please see the [key\_pressed | 1](/antara/api/gaming/#key-pressed-1) function for more information.
14601462

@@ -1662,7 +1664,9 @@ quit_game()
16621664

16631665
##### return\_value\_
16641666

1667+
<DevComment>
16651668
{/* need more information to edit this part */}
1669+
</DevComment>
16661670

16671671
###### Usage Pattern
16681672

@@ -1696,7 +1700,7 @@ The `antara::gaming::sfml::audio_system` class provides audio-related functions
16961700
16971701
###### Usage Pattern
16981702
1699-
```cpp
1703+
```c
17001704
class audio_system : public antara::gaming::ecs::system<audio_system>
17011705
```
17021706

@@ -1708,7 +1712,7 @@ class audio_system : public antara::gaming::ecs::system<audio_system>
17081712

17091713
###### Usage Pattern
17101714

1711-
```cpp
1715+
```c
17121716
audio_system(entt::registry &registry)
17131717
```
17141718
@@ -1730,7 +1734,7 @@ The `update` function destroys and clears the sounds when they are finished.
17301734
17311735
###### Usage Pattern
17321736
1733-
```cpp
1737+
```c
17341738
void update()
17351739
```
17361740

@@ -1756,4 +1760,6 @@ The `antara::gaming::sfml::component_sound` struct contains sound and the sound'
17561760

17571761
The `sf::Sound sound` object is the SFML Sound instance and contains the sound data.
17581762

1763+
<DevComment>
17591764
{/* Any other information here */}
1765+
</DevComment>

src/pages/atomicdex/api/v20-dev/non_fungible_tokens/get_nft_list/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ Returns a list of the NFTs owned by the user, shown in descending order of the `
310310

311311
The supported chains are
312312

313-
```
313+
```json
314314
{
315315
"mmrpc":"2.0",
316316
"error":"Error parsing request: UnsupportedChainType",

src/pages/atomicdex/api/v20-dev/non_fungible_tokens/get_nft_metadata/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ export const description =
100100

101101
## Error responses
102102

103-
```
103+
```json
104104
{
105105
"mmrpc": "2.0",
106106
"error": "Token: token_address 0xfd913a305d70a60aac4faac70c739563738e1f81, token_id 214300044414 was not found in wallet",

0 commit comments

Comments
 (0)