Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add btc deposit format explanation #318

Merged
merged 2 commits into from
Jul 10, 2024
Merged

chore: add btc deposit format explanation #318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f79355
add btc deposit format explanation;
tcar121293 Jun 25, 2024
748868f
rename the deposit docs file;
tcar121293 Jun 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/general/Arhitecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
## Components

- **[CLI commands](/docs/general/CLI.md)** - overview of CLI commands
- **[Deposit](/docs/general/Deposit.md)** - Deposit data overview
- **[Fees](/docs/general/Fees.md)** - high-level overview of handling fees
- **[Relayers](/docs/Home.md)** - relayer technical documentation
- **[Topology Map](/docs/general/Topology.md)** - overview of topology map usage
Expand Down
17 changes: 17 additions & 0 deletions docs/general/Deposit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Deposit
This document describes the expected format of the deposit for different networks
## BTC Deposit
## Format

### OP_RETURN Output

- **Purpose**: Stores arbitrary data within the transaction.
- **Requirements**:
- There should be at most one output with a `ScriptPubKey.Type` of `OP_RETURN`.
- The `OP_RETURN` data must be formatted as `receiverEVMAddress_destinationDomainID`.


### Amount Calculation

- The total deposit amount is calculated by summing the values of the outputs that match the resource address.
- Only outputs with script types of `witness_v1_taproot` are considered for the amount calculation.
Loading