Skip to content

Commit

Permalink
Feat: Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
karacurt committed Nov 28, 2024
1 parent 3c03278 commit ee477bb
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/aribtrum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Setup arbitrum bifrost and call

This checklist describes how to bridge tokens

## Bifrost between arbitrum related chains (eth, arbitrum, orbit)

```bash
bin/bifrost arbitrum \
--inbox $INBOX \
--l1-rpc $L1_RPC \
--l2-rpc $L2_RPC \
--to $TO \
--amount $AMOUNT \
--l2-calldata $L2_CALLDATA \
--keyfile $KEY \
--password $PASSWORD
```

Output: Transaction Hash
18 changes: 18 additions & 0 deletions docs/cctp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Setup CCTP bifrost and call

This checklist describes how to bridge tokens between any chain implementing CCTP

## Bifrost between any chain implementing CCTP

```bash
bin/bifrost cctp \
--keyfile $WB_WALLET \
--rpc $ETH_SEPOLIA_RPC \
--recipient $RECIPIENT \
--amount $AMOUNT \
--token $TOKEN \
--contract $CONTRACT \
--domain $DOMAIN # 0 for ethereum, 3 for arbitrum
```

Output: Transaction Hash

0 comments on commit ee477bb

Please sign in to comment.