diff --git a/.github/workflows/openapi-sync.yml b/.github/workflows/openapi-sync.yml deleted file mode 100644 index 331ceba..0000000 --- a/.github/workflows/openapi-sync.yml +++ /dev/null @@ -1,200 +0,0 @@ -name: OpenAPI Sync - -on: - # Manual trigger - workflow_dispatch: - inputs: - source: - description: 'Source to regenerate (leave empty for all)' - required: false - type: string - - # Webhook trigger from source repositories - repository_dispatch: - types: [openapi-update] - - # Scheduled daily sync - schedule: - - cron: '0 6 * * *' # 6 AM UTC daily - -jobs: - generate-openapi: - name: Generate OpenAPI Specifications - runs-on: ubuntu-latest - - permissions: - contents: write - pull-requests: write - - steps: - - name: Checkout documentation repository - uses: actions/checkout@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - fetch-depth: 0 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: '3.11' - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install pyyaml requests protobuf grpcio-tools - - - name: Install protoc and grpc-gateway tools - run: | - # Install protoc - PROTOC_VERSION=23.4 - wget https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/protoc-${PROTOC_VERSION}-linux-x86_64.zip - unzip protoc-${PROTOC_VERSION}-linux-x86_64.zip -d /tmp/protoc - sudo mv /tmp/protoc/bin/protoc /usr/local/bin/ - sudo mv /tmp/protoc/include/* /usr/local/include/ - - # Install grpc-gateway protoc plugins - go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest - go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest - go install google.golang.org/protobuf/cmd/protoc-gen-go@latest - go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest - - - name: Configure Git - run: | - git config --local user.email "action@github.com" - git config --local user.name "GitHub Action" - - - name: Verify webhook signature (if webhook triggered) - if: github.event_name == 'repository_dispatch' - env: - WEBHOOK_SECRET: ${{ secrets.OPENAPI_WEBHOOK_SECRET }} - run: | - # Verify webhook signature for security - echo "Webhook triggered by: ${{ github.event.client_payload.repository }}" - # Add signature verification logic here - - - name: Determine sources to update - id: sources - run: | - if [ "${{ github.event_name }}" == "repository_dispatch" ]; then - # Webhook triggered - determine source from payload - SOURCE="${{ github.event.client_payload.source || 'all' }}" - elif [ "${{ github.event.inputs.source }}" != "" ]; then - # Manual trigger with specific source - SOURCE="${{ github.event.inputs.source }}" - else - # Scheduled or manual trigger without source - update all - SOURCE="all" - fi - echo "source=${SOURCE}" >> $GITHUB_OUTPUT - echo "Updating source: ${SOURCE}" - - - name: Generate OpenAPI specifications - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - python scripts/openapi-gen/generate.py \ - --config scripts/openapi-gen/config.yaml \ - ${{ steps.sources.outputs.source != 'all' && format('--source {0}', steps.sources.outputs.source) || '' }} - - - name: Run Mintlify scraper to generate MDX files - run: | - # Install Mintlify CLI - npm install -g @mintlify/scraping - - # Generate MDX files for each OpenAPI spec - for spec in docs/api-specs/*.json; do - if [ -f "$spec" ]; then - echo "Generating MDX files for $spec" - output_dir="docs/api-reference/$(basename "$spec" .json)" - npx @mintlify/scraping@latest openapi-file "$spec" -o "$output_dir" - fi - done - - - name: Update navigation in docs.json - run: | - python scripts/openapi-gen/update-navigation.py - - - name: Check for changes - id: changes - run: | - git add . - if git diff --staged --quiet; then - echo "changed=false" >> $GITHUB_OUTPUT - echo "No changes detected" - else - echo "changed=true" >> $GITHUB_OUTPUT - echo "Changes detected" - git diff --staged --name-only - fi - - - name: Create Pull Request - if: steps.changes.outputs.changed == 'true' - uses: peter-evans/create-pull-request@v5 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: | - feat: update OpenAPI specifications - - Auto-generated by OpenAPI sync workflow - Source: ${{ steps.sources.outputs.source }} - Triggered by: ${{ github.event_name }} - title: "🔄 Update OpenAPI Specifications" - body: | - ## OpenAPI Sync Update - - This PR contains automatically generated updates to the OpenAPI specifications and documentation. - - **Details:** - - **Source**: ${{ steps.sources.outputs.source }} - - **Trigger**: ${{ github.event_name }} - - **Timestamp**: ${{ github.event.head_commit.timestamp || github.run_id }} - - **Changes include:** - - Updated OpenAPI specifications in `docs/api-specs/` - - Generated/updated MDX pages in `docs/api-reference/` - - Updated navigation structure in `docs.json` - - **Review checklist:** - - [ ] Verify API endpoints are correctly documented - - [ ] Check code examples render properly - - [ ] Ensure navigation structure is logical - - [ ] Test interactive API playground functionality - - > This PR was automatically created by the OpenAPI sync workflow. - branch: openapi-sync/${{ github.run_id }} - delete-branch: true - labels: | - automated - documentation - api - - - name: Auto-merge if minor changes - if: steps.changes.outputs.changed == 'true' && github.event_name == 'schedule' - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - # For scheduled runs, auto-merge if changes are minimal - # This could include logic to check if only certain files changed - echo "Scheduled update - consider auto-merging after validation" - - - name: Notify on failure - if: failure() - uses: 8398a7/action-slack@v3 - with: - status: failure - text: | - OpenAPI sync workflow failed - Repository: ${{ github.repository }} - Source: ${{ steps.sources.outputs.source }} - Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} - env: - SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} - - - name: Summary - if: always() - run: | - echo "## OpenAPI Sync Summary" >> $GITHUB_STEP_SUMMARY - echo "- **Source**: ${{ steps.sources.outputs.source }}" >> $GITHUB_STEP_SUMMARY - echo "- **Trigger**: ${{ github.event_name }}" >> $GITHUB_STEP_SUMMARY - echo "- **Changes**: ${{ steps.changes.outputs.changed }}" >> $GITHUB_STEP_SUMMARY - echo "- **Status**: ${{ job.status }}" >> $GITHUB_STEP_SUMMARY \ No newline at end of file diff --git a/.gitignore b/.gitignore index 77a00f4..62c3995 100644 --- a/.gitignore +++ b/.gitignore @@ -65,10 +65,15 @@ proto-sources/ # Misc +docs/logs/ +logs/ dist/ build/ .yarn/ +docs/devnet/tests/* +scripts/* # Markdown lint cache .md-cache +.claude/settings.local.json diff --git a/docs.json b/docs.json index c1ab0ae..fee3cab 100644 --- a/docs.json +++ b/docs.json @@ -4,8 +4,8 @@ "description": "Build the future of the internet of blockchains with Cosmos.", "theme": "mint", "colors": { - "primary": "#40eff2", - "light": "#FAFAFA", + "primary": "#000", + "light": "#cccccc", "dark": "#0E0E0E" }, "icons": { @@ -14,7 +14,10 @@ "styling": { "codeblocks": "system" }, - "favicon": "/assets/brand/cosmos.svg", + "favicon": { + "light": "/assets/brand/cosmos.svg", + "dark": "/assets/brand/cosmos-dark.svg" + }, "logo": { "light": "/assets/brand/cosmos-wordmark-dark.svg", "dark": "/assets/brand/cosmos-wordmark.svg" @@ -31,23 +34,6 @@ "docs/devnet/connect-to-the-network", "docs/devnet/run-a-full-node", "docs/devnet/get-tokens", - { - "group": "Precompiles", - "pages": [ - "docs/devnet/precompiles/overview", - "docs/devnet/precompiles/bank", - "docs/devnet/precompiles/bech32", - "docs/devnet/precompiles/callbacks", - "docs/devnet/precompiles/distribution", - "docs/devnet/precompiles/erc20", - "docs/devnet/precompiles/evidence", - "docs/devnet/precompiles/governance", - "docs/devnet/precompiles/ics20", - "docs/devnet/precompiles/p256", - "docs/devnet/precompiles/slashing", - "docs/devnet/precompiles/staking" - ] - }, { "group": "Tooling & Resources", "pages": [ @@ -58,16 +44,52 @@ ] } ] + }, + { + "group": "EVM", + "pages": [ + "docs/evm/index", + "docs/evm/single-token-representation", + { + "group": "Smart Contracts", + "pages": [ + "docs/evm/developers/smart-contracts/index", + "docs/evm/developers/smart-contracts/overview" + ] + }, + { + "group": "Precompiles", + "pages": [ + "docs/evm/precompiles/overview", + "docs/evm/precompiles/bank", + "docs/evm/precompiles/bech32", + "docs/evm/precompiles/callbacks", + "docs/evm/precompiles/distribution", + "docs/evm/precompiles/erc20", + "docs/evm/precompiles/evidence", + "docs/evm/precompiles/governance", + "docs/evm/precompiles/ics20", + "docs/evm/precompiles/p256", + "docs/evm/precompiles/slashing", + "docs/evm/precompiles/staking", + "docs/evm/precompiles/werc20" + ] + } + ] } ] }, { "tab": "Developer Guides (Coming Soon)", - "pages": ["docs/guides/coming-soon"] + "pages": [ + "docs/guides/coming-soon" + ] }, { "tab": "API Reference (Coming Soon)", - "pages": ["docs/api-reference/coming-soon"] + "pages": [ + "docs/api-reference/coming-soon" + ] } ] }, @@ -75,7 +97,7 @@ "socials": { "twitter": "https://twitter.com/cosmos", "github": "https://github.com/cosmos", - "discord": "https://discord.gg/cosmosnetwork", + "discord": "https://discord.gg/interchain", "website": "https://cosmos.network" } }, diff --git a/docs/api-reference/coming-soon.mdx b/docs/api-reference/coming-soon.mdx index ee983f4..2066e19 100644 --- a/docs/api-reference/coming-soon.mdx +++ b/docs/api-reference/coming-soon.mdx @@ -1,3 +1,3 @@ --- -title: 'Coming Soon' +Title: coming soon --- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/app/config.mdx b/docs/api-reference/cosmos-rest/app/config.mdx deleted file mode 100644 index 37e5b65..0000000 --- a/docs/api-reference/cosmos-rest/app/config.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/app/v1alpha1/config ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/auth/accounts.mdx b/docs/api-reference/cosmos-rest/auth/accounts.mdx deleted file mode 100644 index 24381d3..0000000 --- a/docs/api-reference/cosmos-rest/auth/accounts.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/auth/v1beta1/accounts ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/auth/updateparams.mdx b/docs/api-reference/cosmos-rest/auth/updateparams.mdx deleted file mode 100644 index af6a0be..0000000 --- a/docs/api-reference/cosmos-rest/auth/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/auth/v1beta1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/authz/exec.mdx b/docs/api-reference/cosmos-rest/authz/exec.mdx deleted file mode 100644 index fdad7d4..0000000 --- a/docs/api-reference/cosmos-rest/authz/exec.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/authz/v1beta1/exec ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/authz/grant.mdx b/docs/api-reference/cosmos-rest/authz/grant.mdx deleted file mode 100644 index 77c6e9e..0000000 --- a/docs/api-reference/cosmos-rest/authz/grant.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/authz/v1beta1/grant ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/authz/grants.mdx b/docs/api-reference/cosmos-rest/authz/grants.mdx deleted file mode 100644 index af25b3b..0000000 --- a/docs/api-reference/cosmos-rest/authz/grants.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/authz/v1beta1/grants ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/authz/revoke.mdx b/docs/api-reference/cosmos-rest/authz/revoke.mdx deleted file mode 100644 index fa55089..0000000 --- a/docs/api-reference/cosmos-rest/authz/revoke.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/authz/v1beta1/revoke ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/autocli/appoptions.mdx b/docs/api-reference/cosmos-rest/autocli/appoptions.mdx deleted file mode 100644 index 72ae7d7..0000000 --- a/docs/api-reference/cosmos-rest/autocli/appoptions.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/autocli/v1/appoptions ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/bank/balance.mdx b/docs/api-reference/cosmos-rest/bank/balance.mdx deleted file mode 100644 index 24543f4..0000000 --- a/docs/api-reference/cosmos-rest/bank/balance.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/bank/v1beta1/balance ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/bank/multisend.mdx b/docs/api-reference/cosmos-rest/bank/multisend.mdx deleted file mode 100644 index ea3577d..0000000 --- a/docs/api-reference/cosmos-rest/bank/multisend.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/bank/v1beta1/multisend ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/bank/send.mdx b/docs/api-reference/cosmos-rest/bank/send.mdx deleted file mode 100644 index eafffa2..0000000 --- a/docs/api-reference/cosmos-rest/bank/send.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/bank/v1beta1/send ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/bank/updateparams.mdx b/docs/api-reference/cosmos-rest/bank/updateparams.mdx deleted file mode 100644 index cbd0f5a..0000000 --- a/docs/api-reference/cosmos-rest/bank/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/bank/v1beta1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/base/config.mdx b/docs/api-reference/cosmos-rest/base/config.mdx deleted file mode 100644 index 40b9654..0000000 --- a/docs/api-reference/cosmos-rest/base/config.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/base/reflection/v1beta1/config ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/base/getauthndescriptor.mdx b/docs/api-reference/cosmos-rest/base/getauthndescriptor.mdx deleted file mode 100644 index 44d86bf..0000000 --- a/docs/api-reference/cosmos-rest/base/getauthndescriptor.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/base/reflection/v1beta1/getauthndescriptor ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/base/getnodeinfo.mdx b/docs/api-reference/cosmos-rest/base/getnodeinfo.mdx deleted file mode 100644 index ec0dd86..0000000 --- a/docs/api-reference/cosmos-rest/base/getnodeinfo.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/base/reflection/v1beta1/getnodeinfo ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/base/listallinterfaces.mdx b/docs/api-reference/cosmos-rest/base/listallinterfaces.mdx deleted file mode 100644 index ab31b72..0000000 --- a/docs/api-reference/cosmos-rest/base/listallinterfaces.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/base/reflection/v1beta1/listallinterfaces ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/benchmark/loadtest.mdx b/docs/api-reference/cosmos-rest/benchmark/loadtest.mdx deleted file mode 100644 index 6093f3f..0000000 --- a/docs/api-reference/cosmos-rest/benchmark/loadtest.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/benchmark/v1/loadtest ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/circuit/account.mdx b/docs/api-reference/cosmos-rest/circuit/account.mdx deleted file mode 100644 index 65de554..0000000 --- a/docs/api-reference/cosmos-rest/circuit/account.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/circuit/v1/account ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/circuit/authorizecircuitbreaker.mdx b/docs/api-reference/cosmos-rest/circuit/authorizecircuitbreaker.mdx deleted file mode 100644 index e651587..0000000 --- a/docs/api-reference/cosmos-rest/circuit/authorizecircuitbreaker.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/circuit/v1/authorizecircuitbreaker ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/circuit/resetcircuitbreaker.mdx b/docs/api-reference/cosmos-rest/circuit/resetcircuitbreaker.mdx deleted file mode 100644 index 8233fcd..0000000 --- a/docs/api-reference/cosmos-rest/circuit/resetcircuitbreaker.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/circuit/v1/resetcircuitbreaker ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/circuit/tripcircuitbreaker.mdx b/docs/api-reference/cosmos-rest/circuit/tripcircuitbreaker.mdx deleted file mode 100644 index edf04ec..0000000 --- a/docs/api-reference/cosmos-rest/circuit/tripcircuitbreaker.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/circuit/v1/tripcircuitbreaker ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/applysnapshotchunk.mdx b/docs/api-reference/cosmos-rest/cometbft/applysnapshotchunk.mdx deleted file mode 100644 index c147e84..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/applysnapshotchunk.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/applysnapshotchunk ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/checktx.mdx b/docs/api-reference/cosmos-rest/cometbft/checktx.mdx deleted file mode 100644 index 3302a0d..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/checktx.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/checktx ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/commit.mdx b/docs/api-reference/cosmos-rest/cometbft/commit.mdx deleted file mode 100644 index 2958695..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/commit.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/commit ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/echo.mdx b/docs/api-reference/cosmos-rest/cometbft/echo.mdx deleted file mode 100644 index db011dd..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/echo.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/echo ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/extendvote.mdx b/docs/api-reference/cosmos-rest/cometbft/extendvote.mdx deleted file mode 100644 index 9234aad..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/extendvote.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/extendvote ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/finalizeblock.mdx b/docs/api-reference/cosmos-rest/cometbft/finalizeblock.mdx deleted file mode 100644 index ea9b8e7..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/finalizeblock.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/finalizeblock ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/flush.mdx b/docs/api-reference/cosmos-rest/cometbft/flush.mdx deleted file mode 100644 index cd18acd..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/flush.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/flush ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/info.mdx b/docs/api-reference/cosmos-rest/cometbft/info.mdx deleted file mode 100644 index e9c671f..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/info.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/info ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/initchain.mdx b/docs/api-reference/cosmos-rest/cometbft/initchain.mdx deleted file mode 100644 index 1e11fe4..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/initchain.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/initchain ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/listsnapshots.mdx b/docs/api-reference/cosmos-rest/cometbft/listsnapshots.mdx deleted file mode 100644 index 25873bb..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/listsnapshots.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/listsnapshots ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/loadsnapshotchunk.mdx b/docs/api-reference/cosmos-rest/cometbft/loadsnapshotchunk.mdx deleted file mode 100644 index b2b87d8..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/loadsnapshotchunk.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/loadsnapshotchunk ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/offersnapshot.mdx b/docs/api-reference/cosmos-rest/cometbft/offersnapshot.mdx deleted file mode 100644 index b5fd569..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/offersnapshot.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/offersnapshot ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/prepareproposal.mdx b/docs/api-reference/cosmos-rest/cometbft/prepareproposal.mdx deleted file mode 100644 index e7da987..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/prepareproposal.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/prepareproposal ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/processproposal.mdx b/docs/api-reference/cosmos-rest/cometbft/processproposal.mdx deleted file mode 100644 index 4037170..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/processproposal.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/processproposal ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/query.mdx b/docs/api-reference/cosmos-rest/cometbft/query.mdx deleted file mode 100644 index 94fb7bf..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/query.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/query ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/cometbft/verifyvoteextension.mdx b/docs/api-reference/cosmos-rest/cometbft/verifyvoteextension.mdx deleted file mode 100644 index ecb490a..0000000 --- a/docs/api-reference/cosmos-rest/cometbft/verifyvoteextension.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cometbft/abci/v2/verifyvoteextension ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/consensus/params.mdx b/docs/api-reference/cosmos-rest/consensus/params.mdx deleted file mode 100644 index cf598a1..0000000 --- a/docs/api-reference/cosmos-rest/consensus/params.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/consensus/v1/params ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/consensus/updateparams.mdx b/docs/api-reference/cosmos-rest/consensus/updateparams.mdx deleted file mode 100644 index acb6e6e..0000000 --- a/docs/api-reference/cosmos-rest/consensus/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/consensus/v1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/counter/getcount.mdx b/docs/api-reference/cosmos-rest/counter/getcount.mdx deleted file mode 100644 index efc8b2b..0000000 --- a/docs/api-reference/cosmos-rest/counter/getcount.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/counter/v1/getcount ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/counter/increasecount.mdx b/docs/api-reference/cosmos-rest/counter/increasecount.mdx deleted file mode 100644 index 2a909da..0000000 --- a/docs/api-reference/cosmos-rest/counter/increasecount.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/counter/v1/increasecount ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/crisis/updateparams.mdx b/docs/api-reference/cosmos-rest/crisis/updateparams.mdx deleted file mode 100644 index bb9aae7..0000000 --- a/docs/api-reference/cosmos-rest/crisis/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/crisis/v1beta1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/crisis/verifyinvariant.mdx b/docs/api-reference/cosmos-rest/crisis/verifyinvariant.mdx deleted file mode 100644 index 4bf9e07..0000000 --- a/docs/api-reference/cosmos-rest/crisis/verifyinvariant.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/crisis/v1beta1/verifyinvariant ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/distribution/fundcommunitypool.mdx b/docs/api-reference/cosmos-rest/distribution/fundcommunitypool.mdx deleted file mode 100644 index af1936e..0000000 --- a/docs/api-reference/cosmos-rest/distribution/fundcommunitypool.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/distribution/v1beta1/fundcommunitypool ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/distribution/params.mdx b/docs/api-reference/cosmos-rest/distribution/params.mdx deleted file mode 100644 index 411e3f4..0000000 --- a/docs/api-reference/cosmos-rest/distribution/params.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/distribution/v1beta1/params ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/distribution/setwithdrawaddress.mdx b/docs/api-reference/cosmos-rest/distribution/setwithdrawaddress.mdx deleted file mode 100644 index 4f0947d..0000000 --- a/docs/api-reference/cosmos-rest/distribution/setwithdrawaddress.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/distribution/v1beta1/setwithdrawaddress ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/distribution/updateparams.mdx b/docs/api-reference/cosmos-rest/distribution/updateparams.mdx deleted file mode 100644 index 5bd5ad1..0000000 --- a/docs/api-reference/cosmos-rest/distribution/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/distribution/v1beta1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/distribution/withdrawdelegatorreward.mdx b/docs/api-reference/cosmos-rest/distribution/withdrawdelegatorreward.mdx deleted file mode 100644 index 8cb8111..0000000 --- a/docs/api-reference/cosmos-rest/distribution/withdrawdelegatorreward.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/distribution/v1beta1/withdrawdelegatorreward ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/distribution/withdrawvalidatorcommission.mdx b/docs/api-reference/cosmos-rest/distribution/withdrawvalidatorcommission.mdx deleted file mode 100644 index 9798d86..0000000 --- a/docs/api-reference/cosmos-rest/distribution/withdrawvalidatorcommission.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/distribution/v1beta1/withdrawvalidatorcommission ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/epochs/epochinfos.mdx b/docs/api-reference/cosmos-rest/epochs/epochinfos.mdx deleted file mode 100644 index 7649f7b..0000000 --- a/docs/api-reference/cosmos-rest/epochs/epochinfos.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/epochs/v1beta1/epochinfos ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/erc20/converterc20.mdx b/docs/api-reference/cosmos-rest/erc20/converterc20.mdx deleted file mode 100644 index 912f809..0000000 --- a/docs/api-reference/cosmos-rest/erc20/converterc20.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/evm/erc20/v1/converterc20 ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/erc20/tokenpairs.mdx b/docs/api-reference/cosmos-rest/erc20/tokenpairs.mdx deleted file mode 100644 index 0f87638..0000000 --- a/docs/api-reference/cosmos-rest/erc20/tokenpairs.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/evm/erc20/v1/tokenpairs ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/evidence/evidence.mdx b/docs/api-reference/cosmos-rest/evidence/evidence.mdx deleted file mode 100644 index f6cabe1..0000000 --- a/docs/api-reference/cosmos-rest/evidence/evidence.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/evidence/v1beta1/evidence ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/evidence/submitevidence.mdx b/docs/api-reference/cosmos-rest/evidence/submitevidence.mdx deleted file mode 100644 index 419f36c..0000000 --- a/docs/api-reference/cosmos-rest/evidence/submitevidence.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/evidence/v1beta1/submitevidence ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/feegrant/allowance.mdx b/docs/api-reference/cosmos-rest/feegrant/allowance.mdx deleted file mode 100644 index a674cca..0000000 --- a/docs/api-reference/cosmos-rest/feegrant/allowance.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/feegrant/v1beta1/allowance ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/feegrant/grantallowance.mdx b/docs/api-reference/cosmos-rest/feegrant/grantallowance.mdx deleted file mode 100644 index 2cd1b85..0000000 --- a/docs/api-reference/cosmos-rest/feegrant/grantallowance.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/feegrant/v1beta1/grantallowance ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/feegrant/pruneallowances.mdx b/docs/api-reference/cosmos-rest/feegrant/pruneallowances.mdx deleted file mode 100644 index c1d5b1b..0000000 --- a/docs/api-reference/cosmos-rest/feegrant/pruneallowances.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/feegrant/v1beta1/pruneallowances ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/feegrant/revokeallowance.mdx b/docs/api-reference/cosmos-rest/feegrant/revokeallowance.mdx deleted file mode 100644 index 7018dd9..0000000 --- a/docs/api-reference/cosmos-rest/feegrant/revokeallowance.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/feegrant/v1beta1/revokeallowance ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/feemarket/params.mdx b/docs/api-reference/cosmos-rest/feemarket/params.mdx deleted file mode 100644 index 755774f..0000000 --- a/docs/api-reference/cosmos-rest/feemarket/params.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/evm/feemarket/v1/params ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/feemarket/updateparams.mdx b/docs/api-reference/cosmos-rest/feemarket/updateparams.mdx deleted file mode 100644 index 1635fb9..0000000 --- a/docs/api-reference/cosmos-rest/feemarket/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/evm/feemarket/v1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/gov/constitution.mdx b/docs/api-reference/cosmos-rest/gov/constitution.mdx deleted file mode 100644 index fe426d1..0000000 --- a/docs/api-reference/cosmos-rest/gov/constitution.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/gov/v1beta1/constitution ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/gov/proposal.mdx b/docs/api-reference/cosmos-rest/gov/proposal.mdx deleted file mode 100644 index 55f1dd1..0000000 --- a/docs/api-reference/cosmos-rest/gov/proposal.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/gov/v1beta1/proposal ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/gov/submitproposal.mdx b/docs/api-reference/cosmos-rest/gov/submitproposal.mdx deleted file mode 100644 index d83cc10..0000000 --- a/docs/api-reference/cosmos-rest/gov/submitproposal.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/gov/v1beta1/submitproposal ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/gov/vote.mdx b/docs/api-reference/cosmos-rest/gov/vote.mdx deleted file mode 100644 index 1015cec..0000000 --- a/docs/api-reference/cosmos-rest/gov/vote.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/gov/v1beta1/vote ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/gov/voteweighted.mdx b/docs/api-reference/cosmos-rest/gov/voteweighted.mdx deleted file mode 100644 index bfc9d37..0000000 --- a/docs/api-reference/cosmos-rest/gov/voteweighted.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/gov/v1beta1/voteweighted ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/creategroup.mdx b/docs/api-reference/cosmos-rest/group/creategroup.mdx deleted file mode 100644 index efe9e0c..0000000 --- a/docs/api-reference/cosmos-rest/group/creategroup.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/creategroup ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/creategrouppolicy.mdx b/docs/api-reference/cosmos-rest/group/creategrouppolicy.mdx deleted file mode 100644 index 4af414e..0000000 --- a/docs/api-reference/cosmos-rest/group/creategrouppolicy.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/creategrouppolicy ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/creategroupwithpolicy.mdx b/docs/api-reference/cosmos-rest/group/creategroupwithpolicy.mdx deleted file mode 100644 index d14ae7f..0000000 --- a/docs/api-reference/cosmos-rest/group/creategroupwithpolicy.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/creategroupwithpolicy ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/exec.mdx b/docs/api-reference/cosmos-rest/group/exec.mdx deleted file mode 100644 index b7bf5db..0000000 --- a/docs/api-reference/cosmos-rest/group/exec.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/exec ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/groupinfo.mdx b/docs/api-reference/cosmos-rest/group/groupinfo.mdx deleted file mode 100644 index 68c3f12..0000000 --- a/docs/api-reference/cosmos-rest/group/groupinfo.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/group/v1/groupinfo ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/leavegroup.mdx b/docs/api-reference/cosmos-rest/group/leavegroup.mdx deleted file mode 100644 index ecc72c7..0000000 --- a/docs/api-reference/cosmos-rest/group/leavegroup.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/leavegroup ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/submitproposal.mdx b/docs/api-reference/cosmos-rest/group/submitproposal.mdx deleted file mode 100644 index c05f7c6..0000000 --- a/docs/api-reference/cosmos-rest/group/submitproposal.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/submitproposal ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/updategroupadmin.mdx b/docs/api-reference/cosmos-rest/group/updategroupadmin.mdx deleted file mode 100644 index 46b1e6a..0000000 --- a/docs/api-reference/cosmos-rest/group/updategroupadmin.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/updategroupadmin ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/updategroupmembers.mdx b/docs/api-reference/cosmos-rest/group/updategroupmembers.mdx deleted file mode 100644 index 2b0d8ed..0000000 --- a/docs/api-reference/cosmos-rest/group/updategroupmembers.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/updategroupmembers ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/updategroupmetadata.mdx b/docs/api-reference/cosmos-rest/group/updategroupmetadata.mdx deleted file mode 100644 index 7a2b109..0000000 --- a/docs/api-reference/cosmos-rest/group/updategroupmetadata.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/updategroupmetadata ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/updategrouppolicyadmin.mdx b/docs/api-reference/cosmos-rest/group/updategrouppolicyadmin.mdx deleted file mode 100644 index 4e83462..0000000 --- a/docs/api-reference/cosmos-rest/group/updategrouppolicyadmin.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/updategrouppolicyadmin ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/updategrouppolicydecisionpolicy.mdx b/docs/api-reference/cosmos-rest/group/updategrouppolicydecisionpolicy.mdx deleted file mode 100644 index 9fbe9f2..0000000 --- a/docs/api-reference/cosmos-rest/group/updategrouppolicydecisionpolicy.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/updategrouppolicydecisionpolicy ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/updategrouppolicymetadata.mdx b/docs/api-reference/cosmos-rest/group/updategrouppolicymetadata.mdx deleted file mode 100644 index c165e5f..0000000 --- a/docs/api-reference/cosmos-rest/group/updategrouppolicymetadata.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/updategrouppolicymetadata ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/vote.mdx b/docs/api-reference/cosmos-rest/group/vote.mdx deleted file mode 100644 index 2586add..0000000 --- a/docs/api-reference/cosmos-rest/group/vote.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/vote ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/group/withdrawproposal.mdx b/docs/api-reference/cosmos-rest/group/withdrawproposal.mdx deleted file mode 100644 index 674621f..0000000 --- a/docs/api-reference/cosmos-rest/group/withdrawproposal.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/group/v1/withdrawproposal ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/index.mdx b/docs/api-reference/cosmos-rest/index.mdx deleted file mode 100644 index ccfe733..0000000 --- a/docs/api-reference/cosmos-rest/index.mdx +++ /dev/null @@ -1,263 +0,0 @@ ---- -title: "Overview" -description: "Cosmos LCD REST API" ---- - -## Overview - -Cosmos SDK chains implement a comprehensive REST API that provides access to all blockchain functionality through standard HTTP endpoints. This API follows OpenAPI specifications and enables developers to interact with Cosmos chains using familiar REST patterns, making it easy to integrate with web applications, mobile apps, and backend services. - -## Supported Cosmos REST API Modules - -*Based on Cosmos SDK v0.50* - -| Module | Description | Key Endpoints | Goto | -|--------|-------------|---------------|---------| -| **Core Modules** ||||| -| `auth` | Account management and authentication | accounts, updateparams | [📖](./auth) | -| `bank` | Token transfers and balances | balance, send, multisend | [📖](./bank) | -| `staking` | Proof-of-stake operations | delegate, undelegate, validators | [📖](./staking) | -| `distribution` | Staking reward distribution | withdraw rewards, community pool | [📖](./distribution) | -| `gov` | On-chain governance | proposals, voting, constitution | [📖](./gov) | -| `slashing` | Validator penalty system | signing info, params | [📖](./slashing) | -| `mint` | Token inflation mechanism | inflation, params | [📖](./mint) | -| **Authorization & Permissions** ||||| -| `authz` | Message authorization framework | grants, exec | [📖](./authz) | -| `feegrant` | Fee payment delegation | allowances, grants | [📖](./feegrant) | -| `group` | Multi-signature group management | policies, proposals, voting | [📖](./group) | -| **Specialized Modules** ||||| -| `nft` | Non-fungible token support | balance, send, collections | [📖](./nft) | -| `vesting` | Token vesting schedules | vesting accounts, schedules | [📖](./vesting) | -| `evidence` | Misbehavior evidence handling | submit evidence, queries | [📖](./evidence) | -| `circuit` | Emergency circuit breaker | disable/enable modules | [📖](./circuit) | -| `crisis` | Invariant checking | invariant checks | [📖](./crisis) | -| `upgrade` | Chain upgrade coordination | plans, applied upgrades | [📖](./upgrade) | -| **Infrastructure** ||||| -| `tx` | Transaction broadcasting | simulate, broadcast | [📖](./tx) | -| `base` | Chain configuration | node info, auth descriptors | [📖](./base) | -| `reflection` | API introspection | service discovery | [📖](./reflection) | -| `consensus` | Consensus parameters | params, validators | [📖](./consensus) | -| `params` | Chain parameter management | subspaces, params | [📖](./params) | -| **EVM Extensions** ||||| -| `evm` | Ethereum Virtual Machine | EVM-specific operations | [📖](./evm) | -| `erc20` | ERC20 token bridge | token mappings, conversions | [📖](./erc20) | -| `feemarket` | Dynamic fee market (EIP-1559) | fee market params, base fee | [📖](./feemarket) | -| `vm` | Virtual machine operations | account queries, bytecode | [📖](./vm) | -| **Advanced Features** ||||| -| `epochs` | Epoch-based operations | epoch info, hooks | [📖](./epochs) | -| `protocolpool` | Community fund management | pool balances, distributions | [📖](./protocolpool) | -| `precisebank` | Precise decimal handling | remainders, fractional balances | [📖](./precisebank) | -| `autocli` | Automatic CLI generation | command configuration | [📖](./autocli) | -| `cometbft` | CometBFT consensus integration | block info, validator sets | [📖](./cometbft) | -| **Development Tools** ||||| -| `app` | Application configuration | app config, version info | [📖](./app) | -| `benchmark` | Performance benchmarking | benchmark operations | [📖](./benchmark) | -| `counter` | Example counter module | increment, query counter | [📖](./counter) | -| `store` | State store operations | store queries, proofs | [📖](./store) | - -## API Patterns - -### Standard Request Format - -Cosmos REST APIs follow standard HTTP conventions: - - -```bash GET Request - Query Data -curl -X GET "https://api.cosmos.network/cosmos/bank/v1beta1/balances/cosmos1..." \ - -H "accept: application/json" -``` - -```bash POST Request - Submit Transaction -curl -X POST "https://api.cosmos.network/cosmos/tx/v1beta1/txs" \ - -H "accept: application/json" \ - -H "Content-Type: application/json" \ - -d '{ - "tx_bytes": "base64-encoded-transaction", - "mode": "BROADCAST_MODE_SYNC" - }' -``` - - -### Response Format - -All responses follow a consistent structure: - -```json Standard Success Response -{ - "result": { - // Module-specific data - }, - "pagination": { - "next_key": "base64-key", - "total": "100" - } -} -``` - -```json Error Response -{ - "code": 3, - "message": "account not found", - "details": [] -} -``` - -## Common Operations - -### Account Management - - -```bash Get Account Information -curl "https://api.cosmos.network/cosmos/auth/v1beta1/accounts/cosmos1..." -``` - -```bash Check Account Balance -curl "https://api.cosmos.network/cosmos/bank/v1beta1/balances/cosmos1..." -``` - -```bash Get Account Transaction History -curl "https://api.cosmos.network/cosmos/tx/v1beta1/txs?events=transfer.recipient='cosmos1...'" -``` - - -### Staking Operations - - -```bash Query Validators -curl "https://api.cosmos.network/cosmos/staking/v1beta1/validators" -``` - -```bash Get Delegation Info -curl "https://api.cosmos.network/cosmos/staking/v1beta1/delegations/cosmos1..." -``` - -```bash Check Staking Rewards -curl "https://api.cosmos.network/cosmos/distribution/v1beta1/delegators/cosmos1.../rewards" -``` - - -### Governance - - -```bash List Proposals -curl "https://api.cosmos.network/cosmos/gov/v1beta1/proposals" -``` - -```bash Get Proposal Details -curl "https://api.cosmos.network/cosmos/gov/v1beta1/proposals/1" -``` - -```bash Check Vote -curl "https://api.cosmos.network/cosmos/gov/v1beta1/proposals/1/votes/cosmos1..." -``` - - -## Authentication & Authorization - -### Transaction Signing -Transactions must be signed before submission: - -1. **Build Transaction**: Create transaction message -2. **Sign Transaction**: Sign with private key -3. **Broadcast**: Submit via `/cosmos/tx/v1beta1/txs` - -### API Keys -Most public endpoints don't require authentication for read operations, but some providers may implement: -- API key headers -- Rate limiting by IP -- Request quotas - -## Pagination - -Most list endpoints support pagination: - - -```bash Paginated Request -curl "https://api.cosmos.network/cosmos/staking/v1beta1/validators?pagination.limit=10&pagination.offset=20" -``` - -```bash Using Page Key -curl "https://api.cosmos.network/cosmos/staking/v1beta1/validators?pagination.key=base64-encoded-key" -``` - - -## Error Handling - -Standard HTTP status codes and gRPC error codes: - -| HTTP Code | gRPC Code | Description | Common Causes | -|-----------|-----------|-------------|---------------| -| 400 | 3 | Invalid Argument | Malformed request, invalid parameters | -| 401 | 16 | Unauthenticated | Missing or invalid credentials | -| 403 | 7 | Permission Denied | Insufficient permissions | -| 404 | 5 | Not Found | Resource doesn't exist | -| 429 | 8 | Resource Exhausted | Rate limit exceeded | -| 500 | 13 | Internal Error | Server-side issues | -| 503 | 14 | Unavailable | Service temporarily unavailable | - -## Performance Considerations - -### Public API Limits -- **Rate Limiting**: Most public endpoints implement request limits -- **Pagination**: Large result sets are paginated with `limit` and `offset` -- **Historical Data**: Most public endpoints prune to a limited number of recent blocks -- **Concurrent Requests**: Connection limits may apply - -### Optimization Tips -- Use pagination for large datasets (`limit`, `page_key`) -- Implement exponential backoff for retries -- Cache frequently accessed data -- Use specific queries rather than broad scans -- Deploy your own node or hire a private service for heavier use-cases - -## Testing Your Integration - - -```bash Health Check -curl "https://api.cosmos.network/cosmos/base/tendermint/v1beta1/node_info" -``` - -```bash Check Chain Status -curl "https://api.cosmos.network/cosmos/base/tendermint/v1beta1/syncing" -``` - -```bash Validate Address Format -curl "https://api.cosmos.network/cosmos/auth/v1beta1/accounts/cosmos1..." -``` - -```bash Simulate Transaction -curl -X POST "https://api.cosmos.network/cosmos/tx/v1beta1/simulate" \ - -H "Content-Type: application/json" \ - -d '{ - "tx_bytes": "base64-encoded-transaction-bytes" - }' -``` - - -## SDK Integration - -Popular SDKs for Cosmos REST API integration: - -- **CosmJS**: TypeScript/JavaScript SDK for Cosmos chains -- **Cosmos SDK Go**: Native Go client -- **CosmPy**: Python wrapper for Cosmos APIs -- **Cosmos Rust**: Rust implementation - -## Related Documentation - - - - Learn how to submit and track transactions - - - Delegate, undelegate, and manage staking operations - - - Submit proposals and participate in governance - - - Query account information and authentication - - - ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/mint/params.mdx b/docs/api-reference/cosmos-rest/mint/params.mdx deleted file mode 100644 index 394a06d..0000000 --- a/docs/api-reference/cosmos-rest/mint/params.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/mint/v1beta1/params ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/mint/updateparams.mdx b/docs/api-reference/cosmos-rest/mint/updateparams.mdx deleted file mode 100644 index 86f520b..0000000 --- a/docs/api-reference/cosmos-rest/mint/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/mint/v1beta1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/nft/balance.mdx b/docs/api-reference/cosmos-rest/nft/balance.mdx deleted file mode 100644 index 1a443f5..0000000 --- a/docs/api-reference/cosmos-rest/nft/balance.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/nft/v1beta1/balance ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/nft/send.mdx b/docs/api-reference/cosmos-rest/nft/send.mdx deleted file mode 100644 index 52b834e..0000000 --- a/docs/api-reference/cosmos-rest/nft/send.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/nft/v1beta1/send ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/params/params.mdx b/docs/api-reference/cosmos-rest/params/params.mdx deleted file mode 100644 index 885986b..0000000 --- a/docs/api-reference/cosmos-rest/params/params.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/params/v1beta1/params ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/precisebank/remainder.mdx b/docs/api-reference/cosmos-rest/precisebank/remainder.mdx deleted file mode 100644 index 35d4123..0000000 --- a/docs/api-reference/cosmos-rest/precisebank/remainder.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/evm/precisebank/v1/remainder ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/protocolpool/cancelcontinuousfund.mdx b/docs/api-reference/cosmos-rest/protocolpool/cancelcontinuousfund.mdx deleted file mode 100644 index e1dc32d..0000000 --- a/docs/api-reference/cosmos-rest/protocolpool/cancelcontinuousfund.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/protocolpool/v1/cancelcontinuousfund ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/protocolpool/communitypool.mdx b/docs/api-reference/cosmos-rest/protocolpool/communitypool.mdx deleted file mode 100644 index 3b3382d..0000000 --- a/docs/api-reference/cosmos-rest/protocolpool/communitypool.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/protocolpool/v1/communitypool ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/protocolpool/communitypoolspend.mdx b/docs/api-reference/cosmos-rest/protocolpool/communitypoolspend.mdx deleted file mode 100644 index a26faee..0000000 --- a/docs/api-reference/cosmos-rest/protocolpool/communitypoolspend.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/protocolpool/v1/communitypoolspend ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/protocolpool/createcontinuousfund.mdx b/docs/api-reference/cosmos-rest/protocolpool/createcontinuousfund.mdx deleted file mode 100644 index 15b7ff6..0000000 --- a/docs/api-reference/cosmos-rest/protocolpool/createcontinuousfund.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/protocolpool/v1/createcontinuousfund ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/protocolpool/fundcommunitypool.mdx b/docs/api-reference/cosmos-rest/protocolpool/fundcommunitypool.mdx deleted file mode 100644 index c4c4e64..0000000 --- a/docs/api-reference/cosmos-rest/protocolpool/fundcommunitypool.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/protocolpool/v1/fundcommunitypool ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/protocolpool/updateparams.mdx b/docs/api-reference/cosmos-rest/protocolpool/updateparams.mdx deleted file mode 100644 index 73d3963..0000000 --- a/docs/api-reference/cosmos-rest/protocolpool/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/protocolpool/v1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/reflection/filedescriptors.mdx b/docs/api-reference/cosmos-rest/reflection/filedescriptors.mdx deleted file mode 100644 index e0e8b74..0000000 --- a/docs/api-reference/cosmos-rest/reflection/filedescriptors.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/reflection/v1/filedescriptors ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/slashing/params.mdx b/docs/api-reference/cosmos-rest/slashing/params.mdx deleted file mode 100644 index 26b5468..0000000 --- a/docs/api-reference/cosmos-rest/slashing/params.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/slashing/v1beta1/params ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/slashing/unjail.mdx b/docs/api-reference/cosmos-rest/slashing/unjail.mdx deleted file mode 100644 index 32eb861..0000000 --- a/docs/api-reference/cosmos-rest/slashing/unjail.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/slashing/v1beta1/unjail ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/slashing/updateparams.mdx b/docs/api-reference/cosmos-rest/slashing/updateparams.mdx deleted file mode 100644 index 9994bfb..0000000 --- a/docs/api-reference/cosmos-rest/slashing/updateparams.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/slashing/v1beta1/updateparams ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/staking/beginredelegate.mdx b/docs/api-reference/cosmos-rest/staking/beginredelegate.mdx deleted file mode 100644 index 0d2f2c6..0000000 --- a/docs/api-reference/cosmos-rest/staking/beginredelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/staking/v1beta1/beginredelegate ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/staking/cancelunbondingdelegation.mdx b/docs/api-reference/cosmos-rest/staking/cancelunbondingdelegation.mdx deleted file mode 100644 index 76cc6b3..0000000 --- a/docs/api-reference/cosmos-rest/staking/cancelunbondingdelegation.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/staking/v1beta1/cancelunbondingdelegation ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/staking/createvalidator.mdx b/docs/api-reference/cosmos-rest/staking/createvalidator.mdx deleted file mode 100644 index 326cf97..0000000 --- a/docs/api-reference/cosmos-rest/staking/createvalidator.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/staking/v1beta1/createvalidator ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/staking/delegate.mdx b/docs/api-reference/cosmos-rest/staking/delegate.mdx deleted file mode 100644 index 8956a80..0000000 --- a/docs/api-reference/cosmos-rest/staking/delegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/staking/v1beta1/delegate ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/staking/editvalidator.mdx b/docs/api-reference/cosmos-rest/staking/editvalidator.mdx deleted file mode 100644 index 3431e6a..0000000 --- a/docs/api-reference/cosmos-rest/staking/editvalidator.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/staking/v1beta1/editvalidator ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/staking/undelegate.mdx b/docs/api-reference/cosmos-rest/staking/undelegate.mdx deleted file mode 100644 index 0b6c5fc..0000000 --- a/docs/api-reference/cosmos-rest/staking/undelegate.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/staking/v1beta1/undelegate ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/staking/validators.mdx b/docs/api-reference/cosmos-rest/staking/validators.mdx deleted file mode 100644 index f75f9df..0000000 --- a/docs/api-reference/cosmos-rest/staking/validators.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: get /cosmos/staking/v1beta1/validators ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/store/listencommit.mdx b/docs/api-reference/cosmos-rest/store/listencommit.mdx deleted file mode 100644 index a1a0ab9..0000000 --- a/docs/api-reference/cosmos-rest/store/listencommit.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/store/streaming/abci/listencommit ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/store/listenfinalizeblock.mdx b/docs/api-reference/cosmos-rest/store/listenfinalizeblock.mdx deleted file mode 100644 index e613067..0000000 --- a/docs/api-reference/cosmos-rest/store/listenfinalizeblock.mdx +++ /dev/null @@ -1,3 +0,0 @@ ---- -openapi: post /cosmos/store/streaming/abci/listenfinalizeblock ---- \ No newline at end of file diff --git a/docs/api-reference/cosmos-rest/tx-post.mdx b/docs/api-reference/cosmos-rest/tx-post.mdx deleted file mode 100644 index 83446c2..0000000 --- a/docs/api-reference/cosmos-rest/tx-post.mdx +++ /dev/null @@ -1,297 +0,0 @@ ---- -title: "Transaction Operations" -description: "How to perform state-changing operations in Cosmos SDK chains" ---- - -## Overview - -Unlike query operations which use direct REST endpoints, **state-changing operations** in Cosmos SDK chains require signed transactions. Operations like sending tokens, delegating stake, voting on proposals, and other state modifications cannot be performed through direct POST requests to module endpoints. - - -**Important**: The individual module endpoints (e.g., `/cosmos/bank/v1beta1/send`, `/cosmos/staking/v1beta1/delegate`) are **not direct POST endpoints**. These paths are used for message type definitions and client-side transaction construction, but all state changes must go through the transaction broadcasting system. - - -## How State-Changing Operations Work - -All state-changing operations follow this pattern: - -1. **Build Transaction Message** - Create the appropriate message type -2. **Sign Transaction** - Sign with your private key -3. **Broadcast Transaction** - Submit via `/cosmos/tx/v1beta1/txs` -4. **Monitor Result** - Check transaction status and events - -## Transaction Broadcasting Endpoint - -All state-changing operations use the unified transaction endpoint: - -``` -POST /cosmos/tx/v1beta1/txs -``` - -### Request Format - -```json -{ - "tx_bytes": "base64-encoded-signed-transaction", - "mode": "BROADCAST_MODE_SYNC" | "BROADCAST_MODE_ASYNC" | "BROADCAST_MODE_BLOCK" -} -``` - -### Broadcast Modes - -- **SYNC**: Wait for CheckTx (transaction validation) -- **ASYNC**: Return immediately after submission -- **BLOCK**: Wait for transaction to be included in a block - -## Common State-Changing Operations - -### Bank Operations - -#### Send Tokens -```json Message Type -{ - "@type": "/cosmos.bank.v1beta1.MsgSend", - "from_address": "cosmos1...", - "to_address": "cosmos1...", - "amount": [{"denom": "stake", "amount": "1000000"}] -} -``` - -#### Multi-Send -```json Message Type -{ - "@type": "/cosmos.bank.v1beta1.MsgMultiSend", - "inputs": [...], - "outputs": [...] -} -``` - -### Staking Operations - -#### Delegate -```json Message Type -{ - "@type": "/cosmos.staking.v1beta1.MsgDelegate", - "delegator_address": "cosmos1...", - "validator_address": "cosmosvaloper1...", - "amount": {"denom": "stake", "amount": "1000000"} -} -``` - -#### Undelegate -```json Message Type -{ - "@type": "/cosmos.staking.v1beta1.MsgUndelegate", - "delegator_address": "cosmos1...", - "validator_address": "cosmosvaloper1...", - "amount": {"denom": "stake", "amount": "1000000"} -} -``` - -#### Redelegate -```json Message Type -{ - "@type": "/cosmos.staking.v1beta1.MsgBeginRedelegate", - "delegator_address": "cosmos1...", - "validator_src_address": "cosmosvaloper1...", - "validator_dst_address": "cosmosvaloper1...", - "amount": {"denom": "stake", "amount": "1000000"} -} -``` - -### Governance Operations - -#### Submit Proposal -```json Message Type -{ - "@type": "/cosmos.gov.v1beta1.MsgSubmitProposal", - "content": {...}, - "initial_deposit": [...], - "proposer": "cosmos1..." -} -``` - -#### Vote -```json Message Type -{ - "@type": "/cosmos.gov.v1beta1.MsgVote", - "proposal_id": "1", - "voter": "cosmos1...", - "option": "VOTE_OPTION_YES" -} -``` - -#### Deposit -```json Message Type -{ - "@type": "/cosmos.gov.v1beta1.MsgDeposit", - "proposal_id": "1", - "depositor": "cosmos1...", - "amount": [{"denom": "stake", "amount": "1000000"}] -} -``` - -### Distribution Operations - -#### Withdraw Rewards -```json Message Type -{ - "@type": "/cosmos.distribution.v1beta1.MsgWithdrawDelegatorReward", - "delegator_address": "cosmos1...", - "validator_address": "cosmosvaloper1..." -} -``` - -#### Set Withdraw Address -```json Message Type -{ - "@type": "/cosmos.distribution.v1beta1.MsgSetWithdrawAddress", - "delegator_address": "cosmos1...", - "withdraw_address": "cosmos1..." -} -``` - -## Transaction Construction - -### Using CosmJS (JavaScript/TypeScript) - -```javascript -import { SigningStargateClient, GasPrice } from "@cosmjs/stargate"; - -const client = await SigningStargateClient.connectWithSigner( - "https://rpc.cosmos.network", - signer, - { gasPrice: GasPrice.fromString("0.025uatom") } -); - -// Send tokens -const result = await client.sendTokens( - senderAddress, - recipientAddress, - [{ denom: "uatom", amount: "1000000" }], - "auto" -); - -// Delegate -const result = await client.delegateTokens( - delegatorAddress, - validatorAddress, - { denom: "uatom", amount: "1000000" }, - "auto" -); -``` - -### Using CLI - -```bash -# Send tokens -cosmos tx bank send --chain-id - -# Delegate -cosmos tx staking delegate --from --chain-id - -# Vote -cosmos tx gov vote