init

Author: bendanzhentan

.gitignore

@@ -0,0 +1,57 @@
+.DS_Store
+node_modules
+results
+temp
+.nyc_output
+coverage.json
+*.tsbuildinfo
+**/lcov.info
+
+yarn-error.log
+.yarn/*
+!.yarn/releases
+!.yarn/plugins
+.pnp.*
+
+dist
+artifacts
+cache
+
+packages/contracts-bedrock/deployments/devnetL1
+packages/contracts-bedrock/deployments/anvil
+
+# vim
+*.sw*
+
+# jetbrains
+.idea/
+
+.secrets
+.env
+.env*
+!.env.example
+*.log
+
+.devnet
+
+# Ignore local fuzzing results
+**/testdata/fuzz/
+
+coverage.out
+
+# Ignore bedrock go bindings local output files
+op-bindings/bin
+op-exporter
+
+
+__pycache__
+
+# Ignore echidna artifacts
+crytic-export
+
+# Ignore building artifacts
+build/
+bot
+
+# Ignore the configuration files
+bot.toml

Dockerfile

@@ -0,0 +1,28 @@
+FROM --platform=$BUILDPLATFORM golang:1.21.1-alpine3.18 as builder
+
+RUN apk add --no-cache make ca-certificates gcc musl-dev linux-headers git jq bash
+
+COPY ./go.mod /app/go.mod
+COPY ./go.sum /app/go.sum
+
+WORKDIR /app
+
+RUN go mod download
+
+COPY ./core        /app/core
+COPY ./cmd         /app/cmd
+COPY ./Makefile    /app/Makefile
+COPY ./bot.toml    /app/bot.toml
+
+WORKDIR /app/
+
+RUN make build-go
+
+FROM alpine:3.18
+
+COPY --from=builder /app/bot /usr/local/bin
+COPY --from=builder /app/bot.toml /app/bot.toml
+
+WORKDIR /app
+
+CMD ["bot", "run", "--config", "/app/bot.toml"]

Makefile

@@ -0,0 +1,19 @@
+GITCOMMIT := $(shell git rev-parse HEAD)
+GITDATE := $(shell git show -s --format='%ct')
+
+LDFLAGSSTRING +=-X main.GitCommit=$(GITCOMMIT)
+LDFLAGSSTRING +=-X main.GitDate=$(GITDATE)
+LDFLAGS := -ldflags "$(LDFLAGSSTRING)"
+
+build-go:
+	env GO111MODULE=on go build -v $(LDFLAGS) ./cmd/bot
+
+build-solidity:
+	pushd contracts; \
+	forge build; \
+	popd;
+
+.PHONY: \
+	bot  \
+	build-go \
+	build-solidity

README.md

@@ -0,0 +1,58 @@
+# opbnb-bridge-bot
+
+## Description
+
+The opbnb-bridge-bot project primarily maintains a Layer2 contract named `L2StandardBridgeBot`. This contract, when called, initiates withdrawal transactions and collects a fixed fee for every withdrawals. The project promises that after the withdrawal transaction has can be proven and finalized after the required time window, a third-party account would complete the corresponding L1 proven withdrawal transactions and L1 finalized withdrawal transactions, thus completing the entire withdrawal process.
+
+## Design Principle and Working Mechanism
+
+This project consists of an on-chain contract `contracts/src/L2StandardBridgeBot.sol` and an off-chain bot.
+
+The `L2StandardBridgeBot` contract provides a `withdrawTo` function, which charges a fixed fee for every execution and then forwards the call to the `L2StandardBridge.withdraw`.
+
+The off-chain bot watches the `L2StandardBridgeBot.WithdrawTo` events and based on these events, re-constructs the corresponding withdrawals. We name these withdrawals as **bot-delegated withdrawals**. As time go out of the bot-delegated withdrawal's proven and finalized time window, our bot will send proven and finalized transactions to complete the entire withdrawal process.
+
+## User Guide
+
+### Getting Started at opBNB testnet
+
+1. Prepare a PostgreSQL database
+
+```
+docker-compose up -d
+```
+
+2. Compile the off-chain bot and output the artifact to `./bot`
+
+```
+make build-go
+```
+
+3. Run the off-chain bot
+
+```
+OPBNB_BRIDGE_BOT_PRIVKEY=<bot privkey> ./bot --config ./bot.toml
+```
+
+### Deploy Contracts
+
+1. Compile the contract using `forge`
+
+```
+make build-solidity
+```
+
+2. Deploy contract
+
+```
+cd contracts
+
+forge create \
+    --rpc-url $OPBNB_TESTNET \
+    --private-key $OP_DEPLOYER_PRIVKEY \
+    src/L2StandardBridgeBot.sol:L2StandardBridgeBot --constructor-args $OP_DEPLOYER_ADDRESS 1000000000000000
+```
+
+## License
+
+MIT

bot.toml

@@ -0,0 +1,25 @@
+[rpcs]
+l1-rpc = 
+l2-rpc = 
+
+[db]
+host = "0.0.0.0"
+port = 5434
+user = "db_username"
+password = "db_password"
+name = "db_name"
+
+[l1-contracts]
+address-manager                 = "0x1111111111111111111111111111111111111111"
+system-config                   = "0x406ac857817708eaf4ca3a82317ef4ae3d1ea23b"
+optimism-portal                 = "0x4386c8abf2009ac0c263462da568dd9d46e52a31"
+l2-output-oracle                = "0xff2394bb843012562f4349c6632a0ecb92fc8810"
+l1-cross-domain-messenger       = "0xd506952e78eecd5d4424b1990a0c99b1568e7c2c"
+l1-standard-bridge              = "0x1111111111111111111111111111111111111111"
+# l1-erc721-bridge                = "0x17e1454015bfb3377c75be7b6d47b236fd2ddbe7"
+l1-erc721-bridge                = "0x1111111111111111111111111111111111111111"
+
+[misc]
+l2-standard-bridge-bot = "0x4c3171982cd7f62690f4d6e086b91f434b97332f"
+propose-time-window = 60
+challenge-time-window = 60