Skip to content

Commit cacf233

Browse files
committed
docs: add release notes
1 parent 239613a commit cacf233

File tree

2 files changed

+153
-0
lines changed

2 files changed

+153
-0
lines changed
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Release Notes
2+
- [Bug Fixes](#bug-fixes)
3+
- [New Features](#new-features)
4+
- [Functional Enhancements](#functional-enhancements)
5+
- [RPC Additions](#rpc-additions)
6+
- [tapcli Additions](#tapcli-additions)
7+
- [Improvements](#improvements)
8+
- [Functional Updates](#functional-updates)
9+
- [RPC Updates](#rpc-updates)
10+
- [tapcli Updates](#tapcli-updates)
11+
- [Breaking Changes](#breaking-changes)
12+
- [Performance Improvements](#performance-improvements)
13+
- [Deprecations](#deprecations)
14+
- [Technical and Architectural Updates](#technical-and-architectural-updates)
15+
- [BIP/bLIP Spec Updates](#bipblip-spec-updates)
16+
- [Testing](#testing)
17+
- [Database](#database)
18+
- [Code Health](#code-health)
19+
- [Tooling and Documentation](#tooling-and-documentation)
20+
21+
# Bug Fixes
22+
23+
# New Features
24+
25+
## Functional Enhancements
26+
27+
- [Two new configuration values were added to improve privacy when using public
28+
or untrusted third-party price
29+
oracles](https://github.com/lightninglabs/taproot-assets/pull/1677):
30+
`experimental.rfq.sendpricehint` controls whether a price hint is queried
31+
from the local price oracle and sent to the peer when requesting a price
32+
quote (opt-in, default `false`). `experimental.rfq.priceoraclesendpeerid`
33+
controls whether the peer's identity public key is sent to the local price
34+
oracle when querying asset price rates.
35+
36+
## RPC Additions
37+
38+
- The [price oracle RPC calls now have an intent, optional peer ID and metadata
39+
field](https://github.com/lightninglabs/taproot-assets/pull/1677) for more
40+
context to help the oracle return an optimal asset price rate. The intent
41+
distinguishes between paying an asset invoice vs. creating an asset invoice
42+
and the three distinct phases of those two processes: Asking for a price hint
43+
before creating the request, requesting an actual price for a swap and
44+
validating a price returned from a peer. See `priceoraclerpc.Intent` in the
45+
[API
46+
docs](https://lightning.engineering/api-docs/api/taproot-assets/price-oracle/query-asset-rates/#priceoraclerpcintent)
47+
for more information on the different values and their meaning.
48+
- The `SendPayment`, `AddInvoice` and `DecodeAssetPayReq` RPCs now have a [new
49+
`price_oracle_metadata` field the user can specify to send additional metadata
50+
to a price oracle](https://github.com/lightninglabs/taproot-assets/pull/1677)
51+
when requesting quotes. The field can contain optional user or authentication
52+
information that helps the price oracle to decide on the optimal price rate to
53+
return.
54+
55+
## tapcli Additions
56+
57+
# Improvements
58+
59+
## Functional Updates
60+
61+
## RPC Updates
62+
63+
## tapcli Updates
64+
65+
## Code Health
66+
67+
## Breaking Changes
68+
69+
## Performance Improvements
70+
71+
## Deprecations
72+
73+
# Technical and Architectural Updates
74+
75+
## BIP/bLIP Spec Updates
76+
77+
## Testing
78+
79+
## Database
80+
81+
## Code Health
82+
83+
## Tooling and Documentation
84+
85+
- [Two new sequence diagrams were
86+
added](https://github.com/lightninglabs/taproot-assets/pull/1677) to the [RFQ
87+
section of the RFQ and decimal display
88+
document](https://github.com/lightninglabs/taproot-assets/blob/main/docs/rfq-and-decimal-display.md#rfq)
89+
that show the interaction between `tapd` and its price oracle for the two
90+
different flows.
91+
92+
# Contributors (Alphabetical Order)
93+
94+
- Oliver Gugger
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Release Notes
2+
- [Bug Fixes](#bug-fixes)
3+
- [New Features](#new-features)
4+
- [Functional Enhancements](#functional-enhancements)
5+
- [RPC Additions](#rpc-additions)
6+
- [tapcli Additions](#tapcli-additions)
7+
- [Improvements](#improvements)
8+
- [Functional Updates](#functional-updates)
9+
- [RPC Updates](#rpc-updates)
10+
- [tapcli Updates](#tapcli-updates)
11+
- [Breaking Changes](#breaking-changes)
12+
- [Performance Improvements](#performance-improvements)
13+
- [Deprecations](#deprecations)
14+
- [Technical and Architectural Updates](#technical-and-architectural-updates)
15+
- [BIP/bLIP Spec Updates](#bipblip-spec-updates)
16+
- [Testing](#testing)
17+
- [Database](#database)
18+
- [Code Health](#code-health)
19+
- [Tooling and Documentation](#tooling-and-documentation)
20+
21+
# Bug Fixes
22+
23+
# New Features
24+
25+
## Functional Enhancements
26+
27+
## RPC Additions
28+
29+
## tapcli Additions
30+
31+
# Improvements
32+
33+
## Functional Updates
34+
35+
## RPC Updates
36+
37+
## tapcli Updates
38+
39+
## Code Health
40+
41+
## Breaking Changes
42+
43+
## Performance Improvements
44+
45+
## Deprecations
46+
47+
# Technical and Architectural Updates
48+
49+
## BIP/bLIP Spec Updates
50+
51+
## Testing
52+
53+
## Database
54+
55+
## Code Health
56+
57+
## Tooling and Documentation
58+
59+
# Contributors (Alphabetical Order)

0 commit comments

Comments
 (0)