Skip to content

Commit

Permalink
add readme for bridge indexer (#19912)
Browse files Browse the repository at this point in the history
## Description 

as title

## Test plan 

How did you test the new or updated feature?

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] REST API:

---------

Co-authored-by: ronny-mysten <[email protected]>
  • Loading branch information
longbowlu and ronny-mysten authored Oct 21, 2024
1 parent df0cb67 commit a2eac64
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions crates/sui-bridge-indexer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## Overview

Sui Bridge Indexer is a binary that scans Sui Bridge transactions on Sui and Ethereum networks, and indexes the processed data for further use.

## Get Binary

```bash
cargo build --bin bridge-indexer --release
```

The pre-built Docker image for Bridge Indexer can be found in `mysten/sui-tools:{SHA}`

## Run Binary

```
bridge-indexer --config-path config.yaml
```


## Config

```yaml
---
remote_store_url: https://checkpoints.mainnet.sui.io
eth_rpc_url: {eth rpc url}
sui_rpc_url: {sui rpc url}

concurrency: 500
checkpoints_path: {path-for-checkpoints}

eth_sui_bridge_contract_address: 0xda3bD1fE1973470312db04551B65f401Bc8a92fD # <-- mainnet, 0xAE68F87938439afEEDd6552B0E83D2CbC2473623 for testnet
metric_port: {port to export metrics}

sui_bridge_genesis_checkpoint: 55455583 # <-- mainnet, 43917829 for testnet
# genesis block number for eth
eth_bridge_genesis_block: 20811249 # <-- mainnet, 5997013 for testnet

eth_ws_url: {eth websocket url}

```

0 comments on commit a2eac64

Please sign in to comment.