Octus Bridge Integration Guide

Developer documentation, interactive code samples, and API references for integrating with Octus Bridge.

---

Overview

Octus Bridge is a universal cross-chain bridge that connects Everscale, EVM-compatible networks, and other blockchain ecosystems. This repository contains the public integration guide for teams building token transfers, custom payload flows, relayer-aware event handling, and DAO/API integrations on top of the bridge.

The documentation covers both bridge directions:

• Everscale to EVM: locking, burning, event confirmation, minting, releasing, and manual saveWithdraw flows.
• EVM to Everscale: deposits, event deployment, credit module flows, relayer confirmations, and token release/mint mechanics.
• Custom data bridging: configuration and event-contract concepts required for DAO-approved bridge extensions.

Highlights

Area	What is included
Transfer mechanics	Step-by-step guides for native coins, native tokens, alien tokens, and EVM gas tokens.
Interactive samples	Vue/VitePress examples for wallet connections, payload builders, transfers, event deployment, and withdraw saving.
Contract artifacts	EVM ABIs, Everscale ABI/TVC/code artifacts, constants, and helper utilities used by samples.
Open API docs	Bridge and DAO API references for relayers, transfers, staking, proposals, voters, and votes.
Production build	Static VitePress build served through nginx with Docker support.

Documentation Map

• Introduction
• Everscale to EVM mechanics
• EVM to Everscale mechanics
• Concepts
• Open API
• Contract addresses and links
• FAQ
• Code sample prerequisites
• Everscale to EVM code samples
• EVM to Everscale code samples

Tech Stack

• VitePress for the documentation site
• Vue 3 for custom demo components
• TypeScript for sample providers and helpers
• ethers and web3 for EVM interactions
• everscale-inpage-provider for Everscale wallet flows
• nginx and Docker for production serving

Getting Started

Prerequisites

• Node.js 18+
• npm
• Wallet tooling for the flows you want to test, such as MetaMask and an Everscale-compatible wallet

Install

npm install

Run Locally

npm run dev

VitePress will print the local URL in your terminal, usually http://localhost:5173.

Build

npm run build:docs

This runs ESLint, removes the previous docs build, and generates a static VitePress site.

Preview Production Build

npm run prod

WebAssembly Asset

The project uses eth-ton-abi-converter, which ships a WASM file. If your local dev or preview environment needs the converter copied manually, use:

npm run dev-copy:wasm
npm run prod-copy:wasm

Docker

Build and run the documentation site with nginx:

docker build -t octus-bridge-integration-guide .
docker run --rm -p 8080:80 octus-bridge-integration-guide

Then open http://localhost:8080.

Project Structure

.
|-- .vitepress/                 # VitePress config, theme, layout, and shared UI components
|-- docs/                       # Main documentation pages and API references
|-- public/                     # Static images and public assets
|-- src/
|   |-- api/                    # API access helpers
|   |-- codeSamples/            # Markdown guides, providers, artifacts, and bridge helpers
|   |-- components/             # Demo components used in docs
|   `-- providers/              # Wallet/provider composition helpers
|-- Dockerfile                  # Static build and nginx runtime image
|-- nginx-custom.conf           # SPA-friendly nginx config
`-- package.json                # Scripts and dependencies

Useful Links

• Octus Bridge
• Octus Bridge App
• Octus Bridge DAO
• Octus Bridge Docs
• Discord
• Telegram
• Medium
• YouTube

Contributing

1. Create a focused branch for your change.
2. Update the relevant Markdown guide, sample provider, or theme component.
3. Run linting and build checks before opening a pull request.

npm run lint
npm run build:docs

License

MIT License

Copyright (c) 2026 Octus Bridge Integration Guide contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.