Skip to content

Conversation

@bryanchriswhite
Copy link
Collaborator

@bryanchriswhite bryanchriswhite commented Jun 30, 2025

Summary

Add IBC documentaton.

Issue

Type of change

Select one or more from the following:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Sanity Checklist

  • I have updated the GitHub Issue Metadata: assignees, reviewers, labels, project, iteration and milestone
  • For docs: make docusaurus_start
  • For small changes: make go_develop_and_test and make test_e2e
  • For major changes: devnet-test-e2e label to run E2E tests in CI
  • For migration changes: make test_e2e_oneshot
  • 'TODO's, configurations and other docs

@bryanchriswhite bryanchriswhite self-assigned this Jun 30, 2025
@bryanchriswhite bryanchriswhite changed the base branch from main to chore/ibc-osmosis June 30, 2025 18:18
@bryanchriswhite bryanchriswhite added documentation Improvements or additions to documentation ibc everything IBC related labels Jun 30, 2025
@bryanchriswhite bryanchriswhite linked an issue Jun 30, 2025 that may be closed by this pull request
9 tasks
@bryanchriswhite bryanchriswhite changed the base branch from chore/ibc-osmosis to chore/ibc-axelar July 2, 2025 07:16
bryanchriswhite and others added 18 commits July 8, 2025 14:32
* chore/ibc-axelar:
  fixup! ibc-axelar make targets
  chore: update ibc shell scripts
  fixup! ibc makefiles
  revert: whitespace changes
* pokt/main: (69 commits)
  Refactor Tiltfile structure and enhance Pocketdex support. (#1640)
  [Morse Recovery] Updated Recovery Allowlist (#1651)
  [RelayMiner] Improve SafeReadBody concurrency safety by copying buffer data (#1650)
  Add a configurable max body size parameter to RelayMiner configuration. (#1566)
  Update upgrade_tx_v0.1.25_alpha.json
  feat: Improve relay request unmarshaling error handling and logging (#1649)
  [Docs] v0.1.25/26 upgrage artifacts (#1648)
  Remove settlement result from `EventClaimSettled` in `v0.127` release. (#1647)
  Revert "feat: Remove settlement result from EventClaimSettled" (#1643)
  [Code Health] Fix linter issues & attempt to fix flaky tests (#1646)
  Updating config-path-x.yaml with: schema header, owned app for config-path-1
  [Shannon SDK] Update the `shannon-sdk` in prep for `v0.1.26` (#1641)
  [RelayMiner] Add chain version retrieval functionality to block client (#1639)
  [RelayMiner] Avoid concurrent access to shared logger (#1636)
  [Telegram] Add Korbit channel to broadcast workflow (#1634)
  upgrade: Prepare upgrade plan for v0.1.26 (#1635)
  [RelayMiner] Add proper timeout handling for RelayMiner HTTP requests (#1595)
  [Code only] fix: implement backward compatible relay response signatures  (from #1629) (#1630)
  [Misc] Misc fixes & improvements (#1632)
  Added pocket-knife to ecosystem tools (#1622)
  ...
* refs/heads/chore/ibc: (69 commits)
  Refactor Tiltfile structure and enhance Pocketdex support. (#1640)
  [Morse Recovery] Updated Recovery Allowlist (#1651)
  [RelayMiner] Improve SafeReadBody concurrency safety by copying buffer data (#1650)
  Add a configurable max body size parameter to RelayMiner configuration. (#1566)
  Update upgrade_tx_v0.1.25_alpha.json
  feat: Improve relay request unmarshaling error handling and logging (#1649)
  [Docs] v0.1.25/26 upgrage artifacts (#1648)
  Remove settlement result from `EventClaimSettled` in `v0.127` release. (#1647)
  Revert "feat: Remove settlement result from EventClaimSettled" (#1643)
  [Code Health] Fix linter issues & attempt to fix flaky tests (#1646)
  Updating config-path-x.yaml with: schema header, owned app for config-path-1
  [Shannon SDK] Update the `shannon-sdk` in prep for `v0.1.26` (#1641)
  [RelayMiner] Add chain version retrieval functionality to block client (#1639)
  [RelayMiner] Avoid concurrent access to shared logger (#1636)
  [Telegram] Add Korbit channel to broadcast workflow (#1634)
  upgrade: Prepare upgrade plan for v0.1.26 (#1635)
  [RelayMiner] Add proper timeout handling for RelayMiner HTTP requests (#1595)
  [Code only] fix: implement backward compatible relay response signatures  (from #1629) (#1630)
  [Misc] Misc fixes & improvements (#1632)
  Added pocket-knife to ecosystem tools (#1622)
  ...

# Conflicts:
#	Makefile
#	Tiltfile
(cherry picked from commit a0c92e329fb4e18f127ac98e1082d985d22da934)
* pokt/main: (34 commits)
  [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633)
  [Morse Recovery] Added new addresses for recovery (#1667)
  [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666)
  [Foundation] Remove `pulsar` (#1661)
  [RelayMiner] Add timeout support and improved logging to query clients (#1657)
  [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658)
  [Testing] Fixing flaky unit tests to make CI more reliable (#1662)
  [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660)
  [Morse Recovery] Add recovery addresses for issue #1654 (#1656)
  Refactor Tiltfile structure and enhance Pocketdex support. (#1640)
  [Morse Recovery] Updated Recovery Allowlist (#1651)
  [RelayMiner] Improve SafeReadBody concurrency safety by copying buffer data (#1650)
  Add a configurable max body size parameter to RelayMiner configuration. (#1566)
  Update upgrade_tx_v0.1.25_alpha.json
  feat: Improve relay request unmarshaling error handling and logging (#1649)
  [Docs] v0.1.25/26 upgrage artifacts (#1648)
  Remove settlement result from `EventClaimSettled` in `v0.127` release. (#1647)
  Revert "feat: Remove settlement result from EventClaimSettled" (#1643)
  [Code Health] Fix linter issues & attempt to fix flaky tests (#1646)
  Updating config-path-x.yaml with: schema header, owned app for config-path-1
  ...
* pokt/chore/ibc:
  fix: TODOs
  fix: onchain upgrade
  [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633)
  [Morse Recovery] Added new addresses for recovery (#1667)
  [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666)
  [Foundation] Remove `pulsar` (#1661)
  [RelayMiner] Add timeout support and improved logging to query clients (#1657)
  [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658)
  [Testing] Fixing flaky unit tests to make CI more reliable (#1662)
  [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660)
  [Morse Recovery] Add recovery addresses for issue #1654 (#1656)
  First review
* pokt/main:
  [Disk Utilization] refactor: remove unnecessary Msg.*Response fields (#1670)
  [RelayMiner] Bump SMT version (#1675)
  [IBC] Prepare pocket for IBC connectivity (#1262)
* chore/localnet/tilt: (88 commits)
  [Disk Utilization] refactor: remove unnecessary Msg.*Response fields (#1670)
  [RelayMiner] Bump SMT version (#1675)
  [IBC] Prepare pocket for IBC connectivity (#1262)
  fix: TODOs
  fix: onchain upgrade
  [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633)
  [Morse Recovery] Added new addresses for recovery (#1667)
  [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666)
  [Foundation] Remove `pulsar` (#1661)
  [RelayMiner] Add timeout support and improved logging to query clients (#1657)
  [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658)
  [Testing] Fixing flaky unit tests to make CI more reliable (#1662)
  [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660)
  [Morse Recovery] Add recovery addresses for issue #1654 (#1656)
  fixup! upgrade
  fixup! upgrade
  revertme: testing
  fixup! upgrade
  Refactor Tiltfile structure and enhance Pocketdex support. (#1640)
  [Morse Recovery] Updated Recovery Allowlist (#1651)
  ...
* chore/ibc-axelar: (88 commits)
  [Disk Utilization] refactor: remove unnecessary Msg.*Response fields (#1670)
  [RelayMiner] Bump SMT version (#1675)
  [IBC] Prepare pocket for IBC connectivity (#1262)
  fix: TODOs
  fix: onchain upgrade
  [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633)
  [Morse Recovery] Added new addresses for recovery (#1667)
  [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666)
  [Foundation] Remove `pulsar` (#1661)
  [RelayMiner] Add timeout support and improved logging to query clients (#1657)
  [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658)
  [Testing] Fixing flaky unit tests to make CI more reliable (#1662)
  [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660)
  [Morse Recovery] Add recovery addresses for issue #1654 (#1656)
  fixup! upgrade
  fixup! upgrade
  revertme: testing
  fixup! upgrade
  Refactor Tiltfile structure and enhance Pocketdex support. (#1640)
  [Morse Recovery] Updated Recovery Allowlist (#1651)
  ...
  - Add new IBC documentation pages:
    - ica.md: Interchain Accounts implementation and usage
    - pfm.md: Packet Forward Middleware with client failure resilience
    - integration.md: IBC integration patterns and best practices
    - testing.md: Testing strategies for IBC functionality

  - Enhance existing documentation:
    - localnet.md: Fix make targets, improve troubleshooting formatting
    - overview.md: Updated structure and cross-references
    - _category_.json: Add new pages to navigation

  - Key improvements:
    - Consistent ASCII diagrams with proper character encoding
    - Comprehensive troubleshooting sections with proper formatting
    - Added PFM client failure scenarios and recovery strategies
    - Removed non-existent make targets from ICA documentation

  🤖 Generated with [Claude Code](https://claude.ai/code)

  Co-Authored-By: Claude <[email protected]>
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Shannon Jul 22, 2025
@bryanchriswhite bryanchriswhite moved this from 📋 Backlog to 👀 In review in Shannon Jul 22, 2025
@bryanchriswhite bryanchriswhite marked this pull request as ready for review July 22, 2025 08:20
@bryanchriswhite bryanchriswhite changed the title [Docs] IBC/localnet [Docs] IBC Jul 22, 2025
bryanchriswhite and others added 4 commits August 15, 2025 10:42
* pokt/main: (34 commits)
  [GOVERNANCE][PARAMS][CUTTM] Updating global CUTTM per Foundation requirement (#1727)
  Update docusaurus/docs/4_develop/upgrades/4_upgrade_list.md w/ v0.1.28 MainNet block
  Updating bulk_params_main/tokenomics_params.json so proposer gets rewards again
  Update upgrade_tx_v0.1.28_main.json
  [Morse Recovery] Add recovery allowlist entries for issues #1718 and #1719 (#1723)
  [Upgrade]: Update v0.1.28 upgrade list docs (#1722)
  [Upgrade] v0.1.28 upgrade txs (#1721)
  [Upgrade] Add v0.1.28 upgrade plan (#1720)
  [CometBFT] Use Pocket's fork temporarily (#1717)
  Use use_cometbft_fork_v038.17 (#1714)
  [RelayMiner] Add session lifetime caching (#1713)
  Update recovery allowlist for recovery-8aug2025 (#1716)
  [Tokenomics] Validator proper decoding (#1710)
  [Session Rollovers] First attempt at solving session rollovers from RelayMiner's POV (#1705)
  [RelayMiner] Add comprehensive relay timing and gRPC call metrics (#1703)
  [Shared Module] Increase `ComputeUnitsPerRelayMax` (#1709)
  [RelayMiner] Improve non-2xx errors visibility, do not mine 5xx (#1695)
  [Governance] - Updated Params to match the ones in the forum  (#1707)
  [RelayMiner] Improve RelayMiner timeout handling and test reliability (#1691)
  [Morse Recovery] Updated Allowlist for Recovery (#1696)
  ...
* chore/localnet/tilt: (36 commits)
  [GOVERNANCE][PARAMS][CUTTM] Updating global CUTTM per Foundation requirement (#1727)
  Update docusaurus/docs/4_develop/upgrades/4_upgrade_list.md w/ v0.1.28 MainNet block
  Updating bulk_params_main/tokenomics_params.json so proposer gets rewards again
  Update upgrade_tx_v0.1.28_main.json
  [Morse Recovery] Add recovery allowlist entries for issues #1718 and #1719 (#1723)
  [Upgrade]: Update v0.1.28 upgrade list docs (#1722)
  [Upgrade] v0.1.28 upgrade txs (#1721)
  [Upgrade] Add v0.1.28 upgrade plan (#1720)
  [CometBFT] Use Pocket's fork temporarily (#1717)
  Use use_cometbft_fork_v038.17 (#1714)
  [RelayMiner] Add session lifetime caching (#1713)
  Update recovery allowlist for recovery-8aug2025 (#1716)
  [Tokenomics] Validator proper decoding (#1710)
  [Session Rollovers] First attempt at solving session rollovers from RelayMiner's POV (#1705)
  [RelayMiner] Add comprehensive relay timing and gRPC call metrics (#1703)
  [Shared Module] Increase `ComputeUnitsPerRelayMax` (#1709)
  [RelayMiner] Improve non-2xx errors visibility, do not mine 5xx (#1695)
  [Governance] - Updated Params to match the ones in the forum  (#1707)
  [RelayMiner] Improve RelayMiner timeout handling and test reliability (#1691)
  [Morse Recovery] Updated Allowlist for Recovery (#1696)
  ...

# Conflicts:
#	tiltfiles/ibc.tilt
* refs/heads/chore/ibc-axelar: (36 commits)
  [GOVERNANCE][PARAMS][CUTTM] Updating global CUTTM per Foundation requirement (#1727)
  Update docusaurus/docs/4_develop/upgrades/4_upgrade_list.md w/ v0.1.28 MainNet block
  Updating bulk_params_main/tokenomics_params.json so proposer gets rewards again
  Update upgrade_tx_v0.1.28_main.json
  [Morse Recovery] Add recovery allowlist entries for issues #1718 and #1719 (#1723)
  [Upgrade]: Update v0.1.28 upgrade list docs (#1722)
  [Upgrade] v0.1.28 upgrade txs (#1721)
  [Upgrade] Add v0.1.28 upgrade plan (#1720)
  [CometBFT] Use Pocket's fork temporarily (#1717)
  Use use_cometbft_fork_v038.17 (#1714)
  [RelayMiner] Add session lifetime caching (#1713)
  Update recovery allowlist for recovery-8aug2025 (#1716)
  [Tokenomics] Validator proper decoding (#1710)
  [Session Rollovers] First attempt at solving session rollovers from RelayMiner's POV (#1705)
  [RelayMiner] Add comprehensive relay timing and gRPC call metrics (#1703)
  [Shared Module] Increase `ComputeUnitsPerRelayMax` (#1709)
  [RelayMiner] Improve non-2xx errors visibility, do not mine 5xx (#1695)
  [Governance] - Updated Params to match the ones in the forum  (#1707)
  [RelayMiner] Improve RelayMiner timeout handling and test reliability (#1691)
  [Morse Recovery] Updated Allowlist for Recovery (#1696)
  ...
@Olshansk Olshansk changed the base branch from chore/ibc-axelar to main September 5, 2025 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ibc everything IBC related infra Infra or tooling related improvements, additions or fixes localnet tooling Tooling - CLI, scripts, helpers, off-chain, etc...

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

[IBC] Kickoff IBC Support & Integrations with Axelar & ICF

4 participants