You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+67-2Lines changed: 67 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
8
8
## [[Unreleased]]
9
9
10
+
## [4.1.0] - 2025-2-13
11
+
10
12
### Added
11
-
- Add support for the `PermissionedDomains` feature
12
-
- Support `AMMClawback` amendment (XLS-73d).
13
+
14
+
- Support for `Deep Freeze` (XLS-77d)
15
+
- Support for `PermissionedDomains` (XLS-80)
16
+
- Support `AMMClawback` amendment (XLS-73d)
13
17
- Support for the `simulate` RPC ([XLS-69](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0069d-simulate))
14
18
15
19
### Fixed
@@ -18,42 +22,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
18
22
## [4.0.0] - 2024-12-23
19
23
20
24
### Added
25
+
21
26
- Support for the Multi-Purpose Tokens (MPT) amendment (XLS-33)
22
27
- Add `include_deleted` to ledger_entry request
23
28
- Add support for XLS-70d (Credentials)
24
29
25
30
### BREAKING CHANGE:
31
+
26
32
- Remove Python 3.7 support to fix dependency installation and use 3.8 as new default.
27
33
28
34
### Fixed
35
+
29
36
- Grab the FeeSettings values from the latest validated ledger. Remove hard-coded reference to 10 drops as the reference transaction cost.
30
37
31
38
## [3.0.0] - 2024-07-16
32
39
33
40
### BREAKING CHANGE
41
+
34
42
- Use rippled API v2 as default in requests
35
43
36
44
### Added
45
+
37
46
- Support for the DeliverMax field in Payment transactions
38
47
- Support for the `feature` RPC
39
48
40
49
### Fixed
50
+
41
51
- Allow empty strings for the purpose of removing fields in DIDSet transaction
42
52
- Use `NetworkID` in faucet processing to produce a non-ambiguous URL for faucet hosts.
43
53
44
54
### Removed
55
+
45
56
- Remove deprecated `full`, `accounts`, and `type` parameters from ledger request model
46
57
47
58
## [2.6.0] - 2024-06-03
48
59
49
60
### Added
61
+
50
62
- Support for the Price Oracles amendment (XLS-47).
51
63
- Add `nfts_by_issuer` clio-only API definition
52
64
- Included `ctid` field in the `tx` request.
53
65
-`from_xrpl` method accepts input dictionary keys exclusively in the proper XRPL format.
54
66
- Support for DynamicNFT amendment (XLS-46)
55
67
56
68
### Fixed
69
+
57
70
- Added support for `XChainModifyBridge` flag maps (fixing an issue with `NFTokenCreateOffer` flag names)
58
71
- Fixed `XChainModifyBridge` validation to allow just clearing of `MinAccountCreateAmount`
59
72
- Added support for IDE auto-completion of model constructors
@@ -63,57 +76,74 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
63
76
- Add the missing `AMMDeposit` Flag `TF_TWO_ASSET_IF_EMPTY`
64
77
65
78
### Removed:
79
+
66
80
- Remove Hooks faucet since it's now on the Xahau testnet.
67
81
68
82
## [2.5.0] - 2023-11-30
69
83
70
84
### Added
85
+
71
86
- Support for the DID amendment (XLS-40).
72
87
- Support for `server_definitions` RPC
73
88
74
89
### Fixed
90
+
75
91
- Exported `get_nftoken_id` and `parse_nftoken_id` at the `xrpl.utils` level
76
92
- Fixed issue in `get_nftoken_id` where error is opaque when there are no `NFTokenPage`s
77
93
78
94
### Changed
95
+
79
96
- Removed sidechain-net1 Devnet faucet support as it has been decommissioned. Users should instead use the bridge between Devnet and sidechain-net2 for testing.
80
97
- Removed amm-devnet faucet support as is will soon be decommissioned
81
98
82
99
## [2.4.0] - 2023-09-27
100
+
83
101
### Added
102
+
84
103
- Added new syntax for `SetFee` pseudo transaction sent after the [XRPFees](https://xrpl.org/known-amendments.html#xrpfees) amendment. (Backwards compatible)
85
104
- Support for [XLS-38d (XChainBridge)](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-38d-XChainBridge)
86
105
87
106
### Fixed
107
+
88
108
- Update request models related to AMM
89
109
- Better error handling for when a `Wallet` is passed into an account or destination field
90
110
- Fixed AMMBid fields (BidMin, BidMax) with correct type IssuedCurrencyAmount
91
111
92
112
## [2.3.0] - 2023-08-24
113
+
93
114
### Added
115
+
94
116
- Add AMM support [XLS-30](https://github.com/XRPLF/XRPL-Standards/discussions/78)
95
117
96
118
## [2.2.0] - 2023-08-07
119
+
97
120
### Added
121
+
98
122
- Added new `Clawback` transaction as per [XLS-39](https://github.com/XRPLF/XRPL-Standards/discussions/94)
99
123
100
124
## [2.1.0] - 2023-07-24
125
+
101
126
### Fixed
127
+
102
128
- Replaced alias for `classic_address` with separate property to work around this mypy issue:
- The default signing algorithm in the `Wallet` was changed from secp256k1 to ed25519
108
136
109
137
### Added:
138
+
110
139
- Wallet support for regular key compatibility
111
140
- Added new ways of wallet generation: `from_seed`, `from_secret`, `from_entropy`, `from_secret_numbers`
112
141
- Added `address` alias to `Wallet.classic_address`
113
142
- Replaced `Wallet.classic_address` with `Wallet.address` to avoid confusion. (`classic_address` is the same as your XRPL account `address`, and is only called classic since it's an older standard than `x-address`)
114
143
- Added `network_id` to clients in order to use the `Client` with networks beyond mainnet
115
144
116
145
### Changed:
146
+
117
147
- Updated params for `Wallet` class constructor
118
148
-`Wallet.address` is now readonly
119
149
- Removed `sequence` from `Wallet` class
@@ -126,11 +156,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
126
156
-`XRP.to_amount` now converts from XRP to drops, instead of expecting a drops amount
127
157
128
158
### Fixed:
159
+
129
160
- Added a sort of the account IDs in `multisign`, so that the `multisign` always works.
130
161
- Add `ledger_hash` and `ledger_index` to `account_nfts`, `nft_buy_offers`, and `nft_sell_offers` requests.
131
162
- Add `nft_page` to `ledger_entry` request.
132
163
133
164
### Removed:
165
+
134
166
-`send_reliable_submission` has been replaced by `submit_and_wait`
135
167
- Longer aliases for signing/submitting functions have been removed. Specifically
136
168
-`submit_transaction` is now `submit`
@@ -146,26 +178,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
146
178
-`get_transaction_from_hash`
147
179
148
180
## [1.9.0] - 2023-06-13
181
+
149
182
### Added:
183
+
150
184
- Added `submit_and_wait` to sign (if needed), autofill, submit a transaction and wait for its final outcome
151
185
-`submit` and `send_reliable_submission` now accept an optional boolean param `fail_hard` (if `True` halt the submission if it's not immediately validated)
152
186
- Added sidechain devnet support to faucet generation
153
187
- Added `user_agent` and `usage_context` to `generate_faucet_wallet`
154
188
155
189
### Changed:
190
+
156
191
- Allowed keypairs.sign to take a hex string in addition to bytes
157
192
158
193
### Fixed:
194
+
159
195
- Refactored `does_account_exist` and `get_balance` to avoid deprecated methods and use `ledger_index` parameter
160
196
- Fixed crashes in the `SignerListSet` validation
161
197
- Improved error messages in `send_reliable_submission`
162
198
- Better error handling in reliable submission
163
199
164
200
### Removed:
201
+
165
202
- RPCs and utils related to the old sidechain design
166
203
167
204
## [1.8.0] - 2023-04-10
205
+
168
206
### Added:
207
+
169
208
- Created function alias to `safe_sign_transaction` called `sign` - safe originally used to indicate local offline signing (keys aren't exposed)
170
209
- Created function alias to `safe_sign_and_autofill_transaction` called `autofill_and_sign` to reflect order of operations
171
210
- Created function alias to `submit_transaction` called `submit`
@@ -176,21 +215,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
176
215
- Added the algorithm used to encode a wallet's seed to the wallet.
177
216
178
217
### Changed:
218
+
179
219
-`check_fee` now has a higher limit that is less likely to be hit
180
220
- When connected hooks v2 testnet generate_faucet_wallet now defaults to using the faucet instead of requiring specification
181
221
- Deprecated `get_account_info`, `get_transaction_from_hash`, `get_account_payment_transactions` for direct requests
182
222
- Private function `request_impl` has been renamed to `_request_impl`. Users should always use `request` over `request_impl`.
183
223
- Removed nft-devnet faucet support as it has been decommissioned ([Blog Post](https://xrpl.org/blog/2023/nft-devnet-decommission.html))
184
224
185
225
### Fixed:
226
+
186
227
- Properly type the instance functions of NestedModel
187
228
- Add additional check to `txnNotFound` error from `reliable_submission` due to race condition
188
229
- Add `nft_offer` type in `AccountObjects`
189
230
- Handle errors better in `send_reliable_submission`
190
231
- Made `send_reliable_submission` wait the full duration until `LastLedgerSequence` passes by
191
232
192
233
## [1.7.0] - 2022-10-12
234
+
193
235
### Added:
236
+
194
237
- Support for ExpandedSignerList amendment that expands the maximum signer list to 32 entries
195
238
- Function to parse the final account balances from a transaction's metadata
196
239
- Function to parse order book changes from a transaction's metadata
@@ -200,42 +243,53 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
200
243
- Common field `ticket_sequence` to Transaction class
201
244
202
245
### Fixed:
246
+
203
247
- Typing for factory classmethods on models
204
248
- Use properly encoded transactions in `Sign`, `SignFor`, and `SignAndSubmit`
205
249
- Fix Sphinx build errors due to incompatible version bumps
206
250
207
251
## [1.6.0] - 2022-06-02
252
+
208
253
### Added:
254
+
209
255
- Support for dynamic fee calculation
210
256
- Function to parse account balances from a transaction's metadata
211
257
- Better error handling for invalid client URL
212
258
- Exported SubscribeBook
213
259
214
260
### Fixed
261
+
215
262
- Resolve `txnNotFound` error with `send_reliable_submission` when waiting for a submitted malformed transaction
216
263
- Small typing mistake in GenericRequest
217
264
- Fix bug in GenericRequest.to_dict()
218
265
219
266
## [1.5.0] - 2022-04-25
267
+
220
268
### Added
269
+
221
270
- Support setting flags with booleans. For each transaction type supporting flags there is a `FlagInterface` to set the flags with booleans.
222
271
-`federator_info` RPC support
223
272
- Helper method for creating a cross-chain payment to/from a sidechain
224
273
- Helper method for parsing an NFTokenID
225
274
226
275
### Fixed
276
+
227
277
- Updated NFT names to match new 1.9.0 rippled names
228
278
-`xrpl.asyncio.clients` exports (now includes `request_to_websocket`, `websocket_to_response`)
229
279
- Adds optional `owner` field to NFTokenBurn
230
280
- Allows lower-case currency codes
231
281
232
282
## [1.4.0] - 2022-02-24
283
+
233
284
### Added
285
+
234
286
- Sync and async `generate_faucet_wallet` functions now support a custom
235
287
faucet host
236
288
237
289
## [1.3.0] - 2021-12-17
290
+
238
291
### Added
292
+
239
293
- Support for the [XLS-20 NFT proposal](https://github.com/XRPLF/XRPL-Standards/discussions/46)
240
294
-`xrpl.models.amounts.get_amount_value` helper function
241
295
-`xrpl.utils.str_to_hex` and `xrpl.utils.hex_to_str` helpers
@@ -249,6 +303,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
249
303
- Exports `Transaction`, `Response`, pseudo-transactions at the `xrpl.models` level
250
304
251
305
### Fixed
306
+
252
307
- Improves typing of `Response.result`
253
308
- Makes the default ledger version for `get_next_valid_seq_number``current` instead of `validated`
254
309
- Stops erroring on non-`tesSUCCESS` responses in reliable transaction submission
@@ -262,21 +317,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
262
317
- Fixes bug where autofilling using an `xAddress` with `None` in the Destination Tag threw a KeyError
263
318
264
319
## [1.2.0] - 2021-11-09
320
+
265
321
### Added
322
+
266
323
- Support for Python 3.10
267
324
268
325
### Fixed
326
+
269
327
- Improves documentation on using websocket clients.
270
328
- Fixes an issue sending NoRippleCheck requests
271
329
- Allows projects that use xrpl-py as a dependency to use typing
272
330
273
331
## [1.1.1] - 2021-07-02
332
+
274
333
### Fixed
334
+
275
335
- Fixes an issue encoding some non-standard currency values
276
336
- Corrects installation instructions in documentation
277
337
278
338
## [1.1.0] - 2021-06-16
339
+
279
340
### Added
341
+
280
342
- Option for `Transaction.flags` to be a `List` of `int`s instead of just an `int`
281
343
- Instance method in `Transaction` objects to calculate their hashes locally
282
344
- Additional reliability to `send_reliable_submission` by getting the hash before submitting
@@ -292,6 +354,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
292
354
- A general `from_dict` method for `Request` models, analogous to `Transaction.from_dict`
293
355
294
356
### Fixed
357
+
295
358
- Typos in docs/tests
296
359
- Improved readability of the README/documentation
297
360
- Expose `xrpl.utils` at the top level
@@ -302,6 +365,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
302
365
- Better error message reporting
303
366
304
367
## [1.0.0] - 2021-03-31
368
+
305
369
### Added
370
+
306
371
- Initial release! Please open up an issue in our repo if you have any
0 commit comments