From ee477bbd7e61287b9a3abf09eaeccb06aadd60a2 Mon Sep 17 00:00:00 2001 From: Daniel Lima Date: Thu, 28 Nov 2024 12:38:16 -0300 Subject: [PATCH] Feat: Add docs --- docs/aribtrum.md | 19 +++++++++++++++++++ docs/cctp.md | 18 ++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 docs/aribtrum.md create mode 100644 docs/cctp.md diff --git a/docs/aribtrum.md b/docs/aribtrum.md new file mode 100644 index 0000000..2f9f896 --- /dev/null +++ b/docs/aribtrum.md @@ -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 \ No newline at end of file diff --git a/docs/cctp.md b/docs/cctp.md new file mode 100644 index 0000000..a2118c5 --- /dev/null +++ b/docs/cctp.md @@ -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 \ No newline at end of file