Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ezynda3 committed Dec 31, 2024
1 parent 7678c07 commit b0a1fa2
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/AcrossFacetV3.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The methods listed above take a variable labeled `_acrossData`. This data is spe
/// @param refundAddress The address that will be used for potential bridge refunds
/// @param receivingAssetId The address of the token to be received at destination chain
/// @param outputAmount The amount to be received at destination chain (after fees)
/// @param outputAmountPercent The percentage of the output amount with 2 decimal precision (7550 = 75.50%, 9900 = 99.00%)
/// @param exclusiveRelayer This is the exclusive relayer who can fill the deposit before the exclusivity deadline.
/// @param quoteTimestamp The timestamp of the Across quote that was used for this transaction
/// @param fillDeadline The destination chain timestamp until which the order can be filled
Expand All @@ -36,6 +37,7 @@ struct AcrossV3Data {
address refundAddress;
address receivingAssetId;
uint256 outputAmount;
uint16 outputAmountPercent;
address exclusiveRelayer;
uint32 quoteTimestamp;
uint32 fillDeadline;
Expand All @@ -44,6 +46,13 @@ struct AcrossV3Data {
}
```

The `outputAmountPercent` field allows specifying the desired output amount as a percentage of the input amount, with two decimal places of precision. For example:
- 8500 represents 85.00%
- 9375 represents 93.75%
- 10000 represents 100.00%

When using `swapAndStartBridgeTokensViaAcrossV3`, the `outputAmount` will be automatically calculated using the specified percentage.

## Swap Data

Some methods accept a `SwapData _swapData` parameter.
Expand Down

0 comments on commit b0a1fa2

Please sign in to comment.