> For the complete documentation index, see [llms.txt](https://docs.bitbadges.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bitbadges.io/other-modules/x-custom-ibc-hooks/x-custom-ibc-hooks.md).

# Overview

This directory contains comprehensive developer documentation for the BitBadges blockchain's `x/custom-ibc-hooks` module.

The Custom IBC Hooks module extends IBC transfer functionality by allowing users to execute custom actions (such as swaps and transfers) automatically when receiving IBC tokens. This enables complex cross-chain workflows in a single transaction (e.g. Skip:Go compatibility or other IBC aggregators).

## Key Features

* **Swap and Transfer**: Automatically swap received tokens and transfer the output to a destination
* **Swap and IBC Transfer**: Swap received tokens and send them to another chain via IBC
* **Cross-chain DeFi**: Enable seamless cross-chain DeFi operations without manual intervention
* **Atomic Execution**: All operations are executed atomically - either all succeed or all fail

## Architecture

The module operates as an IBC middleware hook that:

1. Intercepts incoming IBC transfer packets
2. Parses hook data from the transfer memo
3. Executes the IBC transfer first (to receive the tokens)
4. Executes the custom hook actions (swap, transfer, etc.)
5. Returns an error acknowledgement if the hook fails, rolling back the entire transaction

## Table of Contents

1. [Introduction](/other-modules/x-custom-ibc-hooks/overview.md) - Overview and key concepts


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.bitbadges.io/other-modules/x-custom-ibc-hooks/x-custom-ibc-hooks.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.