Skip to content

Commit 2e99dc4

Browse files
committed
[docs] Note BOLT 12 currency conversion APIs
Add a pending changelog entry for currency-denominated BOLT 12 offers. The entry calls out the new conversion requirement, the ChannelManager construction change, and validation for unsupported or invalid currency amounts.
1 parent 29c9055 commit 2e99dc4

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# API Updates
2+
3+
* BOLT 12 offers may now use ISO 4217 currency-denominated amounts. Users who
4+
create or pay such offers must provide a `CurrencyConversion` implementation
5+
so LDK can convert the currency amount to millisatoshis and verify returned
6+
invoice amounts.
7+
8+
* `ChannelManager::new` and `ChannelManagerReadArgs` now take a
9+
`currency_conversion` argument. Users who do not support currency conversion
10+
may use `NullCurrencyConversion`.
11+
12+
* BOLT 12 offer and invoice builders now thread currency conversion through
13+
their construction paths. Unsupported currencies or invalid converted amounts
14+
fail offer, invoice request, or invoice construction instead of being
15+
accepted without conversion.

0 commit comments

Comments
 (0)