Adds KdfResponses component #571

smk762 · 2025-08-07T12:35:13Z

Pairs with https://github.com/gcharang/komodo-docs-revamp-2023/pull/194

Migrates KDF activation responses to use new KdfResponse component, which links by common key to a CodeGroup request (one to many).
adds validation script to identify errors or missing request/response pairs.

shamardy · 2025-08-14T14:54:31Z

Great idea, just took a quick look at the PR and remembered this in KDF https://github.com/KomodoPlatform/komodo-defi-framework/blob/main/mm2src/mm2_test_helpers/src/for_tests.rs
So once we extract all the jsons, we can have them in KDF and use one source for both docs and KDF tests instead of our for_tests. Would it make more sense if we categorized the methods by wallets/swaps/etc.. in addition to v1 and v2? This way we can place them in the right place from KDF side and it might be easier to generate them in the right place in docs straight away.

shamardy

First review!

shamardy · 2025-08-19T11:55:43Z

utils/py/validate_kdf_responses.py

+        self.valid_response_types = {'success', 'error'}
+
+        # Valid request key pattern (alphanumeric, camelCase/PascalCase)
+        self.request_key_pattern = re.compile(r'^[A-Z][a-zA-Z0-9]*$')


nit: This doesn't allow camelCase

Fixed in cc71c88

Everything is PascalCase so dropped the camel, but made provision for numeric entry (e.g. 1InchMethods)

shamardy · 2025-08-19T12:07:23Z

utils/py/validate_kdf_responses.py

+    parser.add_argument('--fix-minor-issues', action='store_true', 
+                       help='Automatically fix minor formatting issues')


Is there any usage of fix-minor-issues arg / flag? I can't find any

nope looks like a remnant. removed in e8f3759

shamardy · 2025-08-19T12:08:23Z

utils/py/validate_kdf_responses.py

+                f"Error reading file: {str(e)}"
+            ))
+
+    def _validate_file_structure(self, file_path: Path, data: Dict, version: str):


version is never used

thanks, removed in acfdaed

shamardy · 2025-08-19T12:24:44Z

src/data/kdf_responses/v2/coin_activation.json

+              "platform_coin": {
+                "platform": "ETH",
+                "ticker": "MATIC"
+              },


Is the response returned like this, I didn't look at kdf but I think you duplicated ticker here

Responses will be pruned and live-generated once #582 is wired up.

shamardy · 2025-08-19T12:25:24Z

src/data/kdf_responses/legacy/coin_activation.json

+        "title": "Transport error",
+        "notes": "Connection to ETH node failed",
+        "json": {
+          "error": "Transport error: JsonRpcError { client_info: \"coin: ETH\", request: JsonRpcRequest { jsonrpc: \"2.0\", id: \"9\", method: \"eth_getBalance\", params: [String(\"0x7Bc1bBDD6A0a722fC9bffc49c921B685ECB84b94\"), String(\"latest\")] }, error: Transport(\"All electrum servers unavailable!\") }"


Enable eth shouldn't have All electrum servers unavailable in errors :)

Responses will be pruned and live-generated once #582 is wired up.

github-actions · 2025-08-22T10:42:28Z

Documentation Preview Links

Preview for commit: be1e274
Base URL: https://e57d324b.komodo-docs.pages.dev/en/docs

Changed Documentation Files

Commit: abc4d37 - Merge pull request #578 from KomodoPlatform/lint-fix-patches/responses-component

…nks, formatted md content, checked presence of file and dirs based on sidebar, checked presence of h1 in every file, update Komodo DeFi Framework methods table, adds/updates preview images when base is main

…s-component

…nks, formatted md content, checked presence of file and dirs based on sidebar, checked presence of h1 in every file, update Komodo DeFi Framework methods table, adds/updates preview images when base is main

…rm/komodo-docs-mdx into responses-component

…s-component

…nks, formatted md content, checked presence of file and dirs based on sidebar, checked presence of h1 in every file, update Komodo DeFi Framework methods table, adds/updates preview images when base is main

…s-component

…rm/komodo-docs-mdx into responses-component

smk762 · 2025-08-25T08:35:05Z

Great idea, just took a quick look at the PR and remembered this in KDF https://github.com/KomodoPlatform/komodo-defi-framework/blob/main/mm2src/mm2_test_helpers/src/for_tests.rs So once we extract all the jsons, we can have them in KDF and use one source for both docs and KDF tests instead of our for_tests. Would it make more sense if we categorized the methods by wallets/swaps/etc.. in addition to v1 and v2? This way we can place them in the right place from KDF side and it might be easier to generate them in the right place in docs straight away.

I'm happy to follow whichever structure is most convenient for KDF team (and if required, make changes to mirror the same in docs repo).

smk762 added 11 commits August 7, 2025 00:52

separate request json from component

bf22275

fix missing "

5627514

Merge branch 'dev' into update/codegroup

46be1a0

migrates v2 activation to CompactTables

76f91ff

adds request example electrum/node update script and workflow

546b00a

migrate legacy activation methods to CodeGroup external json souce

188cefd

migrate legacy activation tables to CompactTable component

9b32d65

migrate v2 activation to CompactTable

c763518

fix json refname format

62d5c33

rm CompactTable import (now global)

01bdc9d

Migrate legacy activation responses to KdfResponses component

c76404d

smk762 requested a review from gcharang August 7, 2025 12:35

smk762 mentioned this pull request Aug 14, 2025

initial workflow for AI generated drafts #574

Merged

shamardy self-requested a review August 14, 2025 14:51

shamardy reviewed Aug 19, 2025

View reviewed changes

gcharang added 4 commits August 21, 2025 23:06

update kdfresponses request key

8612a3a

update kdfresponses request key to response key

c43bbf8

updates style guide

82acb6b

updates validation

d297d8f

github-actions bot deployed to komodo-docs (Preview) August 22, 2025 10:41 View deployment

gcharang and others added 3 commits August 22, 2025 10:42

[Bot] File and author data updated, validated and updated internal li…

fa1eb6d

…nks, formatted md content, checked presence of file and dirs based on sidebar, checked presence of h1 in every file, update Komodo DeFi Framework methods table, adds/updates preview images when base is main

updates cf publish action to wrangler

20af07d

Merge pull request #578 from KomodoPlatform/lint-fix-patches/response…

abc4d37

…s-component

github-actions bot deployed to preview August 22, 2025 11:07 View deployment

gcharang and others added 4 commits August 22, 2025 11:07

[Bot] File and author data updated, validated and updated internal li…

9dc53b4

…nks, formatted md content, checked presence of file and dirs based on sidebar, checked presence of h1 in every file, update Komodo DeFi Framework methods table, adds/updates preview images when base is main

attempt to fix cache

3421f59

Merge branch 'responses-component' of https://github.com/KomodoPlatfo…

31d2ecb

…rm/komodo-docs-mdx into responses-component

Merge pull request #579 from KomodoPlatform/lint-fix-patches/response…

053bf31

…s-component

github-actions bot deployed to preview August 22, 2025 11:15 View deployment

github-actions bot deployed to preview August 22, 2025 11:28 View deployment

gcharang and others added 2 commits August 22, 2025 11:28

[Bot] File and author data updated, validated and updated internal li…

d135fda

…nks, formatted md content, checked presence of file and dirs based on sidebar, checked presence of h1 in every file, update Komodo DeFi Framework methods table, adds/updates preview images when base is main

Merge pull request #580 from KomodoPlatform/lint-fix-patches/response…

6bc2e95

…s-component

github-actions bot deployed to preview August 22, 2025 12:33 View deployment

gcharang added 4 commits August 22, 2025 18:58

attempt to fix cache

b36f8a5

Merge branch 'responses-component' of https://github.com/KomodoPlatfo…

0de33f4

…rm/komodo-docs-mdx into responses-component

rm spurious files

1e7b55a

rm spurious files

be1e274

github-actions bot deployed to preview August 22, 2025 15:17 View deployment

smk762 changed the base branch from inject/electrums to inject-clean-electrums August 26, 2025 05:53

smk762 merged commit cd00d3f into inject-clean-electrums Aug 26, 2025
2 checks passed

smk762 mentioned this pull request Aug 26, 2025

Inject clean electrums #581

Merged

		parser.add_argument('--fix-minor-issues', action='store_true',
		help='Automatically fix minor formatting issues')

Adds KdfResponses component #571

Adds KdfResponses component #571

Uh oh!

Conversation

smk762 commented Aug 7, 2025

Uh oh!

shamardy commented Aug 14, 2025

Uh oh!

shamardy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Preview Links

Changed Documentation Files

Uh oh!

smk762 commented Aug 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Aug 22, 2025 •

edited

Loading