Skip to content

Commit be569fc

Browse files
committed
Merge branch 'main' into definitions-generation
2 parents ee68c0a + 271c141 commit be569fc

File tree

10 files changed

+269
-16
lines changed

10 files changed

+269
-16
lines changed

.ci-config/rippled.cfg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ fixNFTokenPageLinks
194194
fixInnerObjTemplate2
195195
fixEnforceNFTokenTrustline
196196
fixReducedOffersV2
197+
DeepFreeze
197198
PermissionedDomains
198199

199200
# This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode

CHANGELOG.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [[Unreleased]]
99

10+
## [4.1.0] - 2025-2-13
11+
1012
### 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)
1317
- Support for the `simulate` RPC ([XLS-69](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0069d-simulate))
1418

1519
### Fixed
@@ -18,42 +22,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1822
## [4.0.0] - 2024-12-23
1923

2024
### Added
25+
2126
- Support for the Multi-Purpose Tokens (MPT) amendment (XLS-33)
2227
- Add `include_deleted` to ledger_entry request
2328
- Add support for XLS-70d (Credentials)
2429

2530
### BREAKING CHANGE:
31+
2632
- Remove Python 3.7 support to fix dependency installation and use 3.8 as new default.
2733

2834
### Fixed
35+
2936
- Grab the FeeSettings values from the latest validated ledger. Remove hard-coded reference to 10 drops as the reference transaction cost.
3037

3138
## [3.0.0] - 2024-07-16
3239

3340
### BREAKING CHANGE
41+
3442
- Use rippled API v2 as default in requests
3543

3644
### Added
45+
3746
- Support for the DeliverMax field in Payment transactions
3847
- Support for the `feature` RPC
3948

4049
### Fixed
50+
4151
- Allow empty strings for the purpose of removing fields in DIDSet transaction
4252
- Use `NetworkID` in faucet processing to produce a non-ambiguous URL for faucet hosts.
4353

4454
### Removed
55+
4556
- Remove deprecated `full`, `accounts`, and `type` parameters from ledger request model
4657

4758
## [2.6.0] - 2024-06-03
4859

4960
### Added
61+
5062
- Support for the Price Oracles amendment (XLS-47).
5163
- Add `nfts_by_issuer` clio-only API definition
5264
- Included `ctid` field in the `tx` request.
5365
- `from_xrpl` method accepts input dictionary keys exclusively in the proper XRPL format.
5466
- Support for DynamicNFT amendment (XLS-46)
5567

5668
### Fixed
69+
5770
- Added support for `XChainModifyBridge` flag maps (fixing an issue with `NFTokenCreateOffer` flag names)
5871
- Fixed `XChainModifyBridge` validation to allow just clearing of `MinAccountCreateAmount`
5972
- 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
6376
- Add the missing `AMMDeposit` Flag `TF_TWO_ASSET_IF_EMPTY`
6477

6578
### Removed:
79+
6680
- Remove Hooks faucet since it's now on the Xahau testnet.
6781

6882
## [2.5.0] - 2023-11-30
6983

7084
### Added
85+
7186
- Support for the DID amendment (XLS-40).
7287
- Support for `server_definitions` RPC
7388

7489
### Fixed
90+
7591
- Exported `get_nftoken_id` and `parse_nftoken_id` at the `xrpl.utils` level
7692
- Fixed issue in `get_nftoken_id` where error is opaque when there are no `NFTokenPage`s
7793

7894
### Changed
95+
7996
- Removed sidechain-net1 Devnet faucet support as it has been decommissioned. Users should instead use the bridge between Devnet and sidechain-net2 for testing.
8097
- Removed amm-devnet faucet support as is will soon be decommissioned
8198

8299
## [2.4.0] - 2023-09-27
100+
83101
### Added
102+
84103
- Added new syntax for `SetFee` pseudo transaction sent after the [XRPFees](https://xrpl.org/known-amendments.html#xrpfees) amendment. (Backwards compatible)
85104
- Support for [XLS-38d (XChainBridge)](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-38d-XChainBridge)
86105

87106
### Fixed
107+
88108
- Update request models related to AMM
89109
- Better error handling for when a `Wallet` is passed into an account or destination field
90110
- Fixed AMMBid fields (BidMin, BidMax) with correct type IssuedCurrencyAmount
91111

92112
## [2.3.0] - 2023-08-24
113+
93114
### Added
115+
94116
- Add AMM support [XLS-30](https://github.com/XRPLF/XRPL-Standards/discussions/78)
95117

96118
## [2.2.0] - 2023-08-07
119+
97120
### Added
121+
98122
- Added new `Clawback` transaction as per [XLS-39](https://github.com/XRPLF/XRPL-Standards/discussions/94)
99123

100124
## [2.1.0] - 2023-07-24
125+
101126
### Fixed
127+
102128
- Replaced alias for `classic_address` with separate property to work around this mypy issue:
103129
https://github.com/python/mypy/issues/6700
104130

105131
## [2.0.0] - 2023-07-05
132+
106133
### BREAKING CHANGE
134+
107135
- The default signing algorithm in the `Wallet` was changed from secp256k1 to ed25519
108136

109137
### Added:
138+
110139
- Wallet support for regular key compatibility
111140
- Added new ways of wallet generation: `from_seed`, `from_secret`, `from_entropy`, `from_secret_numbers`
112141
- Added `address` alias to `Wallet.classic_address`
113142
- 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`)
114143
- Added `network_id` to clients in order to use the `Client` with networks beyond mainnet
115144

116145
### Changed:
146+
117147
- Updated params for `Wallet` class constructor
118148
- `Wallet.address` is now readonly
119149
- Removed `sequence` from `Wallet` class
@@ -126,11 +156,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
126156
- `XRP.to_amount` now converts from XRP to drops, instead of expecting a drops amount
127157

128158
### Fixed:
159+
129160
- Added a sort of the account IDs in `multisign`, so that the `multisign` always works.
130161
- Add `ledger_hash` and `ledger_index` to `account_nfts`, `nft_buy_offers`, and `nft_sell_offers` requests.
131162
- Add `nft_page` to `ledger_entry` request.
132163

133164
### Removed:
165+
134166
- `send_reliable_submission` has been replaced by `submit_and_wait`
135167
- Longer aliases for signing/submitting functions have been removed. Specifically
136168
- `submit_transaction` is now `submit`
@@ -146,26 +178,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
146178
- `get_transaction_from_hash`
147179

148180
## [1.9.0] - 2023-06-13
181+
149182
### Added:
183+
150184
- Added `submit_and_wait` to sign (if needed), autofill, submit a transaction and wait for its final outcome
151185
- `submit` and `send_reliable_submission` now accept an optional boolean param `fail_hard` (if `True` halt the submission if it's not immediately validated)
152186
- Added sidechain devnet support to faucet generation
153187
- Added `user_agent` and `usage_context` to `generate_faucet_wallet`
154188

155189
### Changed:
190+
156191
- Allowed keypairs.sign to take a hex string in addition to bytes
157192

158193
### Fixed:
194+
159195
- Refactored `does_account_exist` and `get_balance` to avoid deprecated methods and use `ledger_index` parameter
160196
- Fixed crashes in the `SignerListSet` validation
161197
- Improved error messages in `send_reliable_submission`
162198
- Better error handling in reliable submission
163199

164200
### Removed:
201+
165202
- RPCs and utils related to the old sidechain design
166203

167204
## [1.8.0] - 2023-04-10
205+
168206
### Added:
207+
169208
- Created function alias to `safe_sign_transaction` called `sign` - safe originally used to indicate local offline signing (keys aren't exposed)
170209
- Created function alias to `safe_sign_and_autofill_transaction` called `autofill_and_sign` to reflect order of operations
171210
- 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
176215
- Added the algorithm used to encode a wallet's seed to the wallet.
177216

178217
### Changed:
218+
179219
- `check_fee` now has a higher limit that is less likely to be hit
180220
- When connected hooks v2 testnet generate_faucet_wallet now defaults to using the faucet instead of requiring specification
181221
- Deprecated `get_account_info`, `get_transaction_from_hash`, `get_account_payment_transactions` for direct requests
182222
- Private function `request_impl` has been renamed to `_request_impl`. Users should always use `request` over `request_impl`.
183223
- Removed nft-devnet faucet support as it has been decommissioned ([Blog Post](https://xrpl.org/blog/2023/nft-devnet-decommission.html))
184224

185225
### Fixed:
226+
186227
- Properly type the instance functions of NestedModel
187228
- Add additional check to `txnNotFound` error from `reliable_submission` due to race condition
188229
- Add `nft_offer` type in `AccountObjects`
189230
- Handle errors better in `send_reliable_submission`
190231
- Made `send_reliable_submission` wait the full duration until `LastLedgerSequence` passes by
191232

192233
## [1.7.0] - 2022-10-12
234+
193235
### Added:
236+
194237
- Support for ExpandedSignerList amendment that expands the maximum signer list to 32 entries
195238
- Function to parse the final account balances from a transaction's metadata
196239
- 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
200243
- Common field `ticket_sequence` to Transaction class
201244

202245
### Fixed:
246+
203247
- Typing for factory classmethods on models
204248
- Use properly encoded transactions in `Sign`, `SignFor`, and `SignAndSubmit`
205249
- Fix Sphinx build errors due to incompatible version bumps
206250

207251
## [1.6.0] - 2022-06-02
252+
208253
### Added:
254+
209255
- Support for dynamic fee calculation
210256
- Function to parse account balances from a transaction's metadata
211257
- Better error handling for invalid client URL
212258
- Exported SubscribeBook
213259

214260
### Fixed
261+
215262
- Resolve `txnNotFound` error with `send_reliable_submission` when waiting for a submitted malformed transaction
216263
- Small typing mistake in GenericRequest
217264
- Fix bug in GenericRequest.to_dict()
218265

219266
## [1.5.0] - 2022-04-25
267+
220268
### Added
269+
221270
- Support setting flags with booleans. For each transaction type supporting flags there is a `FlagInterface` to set the flags with booleans.
222271
- `federator_info` RPC support
223272
- Helper method for creating a cross-chain payment to/from a sidechain
224273
- Helper method for parsing an NFTokenID
225274

226275
### Fixed
276+
227277
- Updated NFT names to match new 1.9.0 rippled names
228278
- `xrpl.asyncio.clients` exports (now includes `request_to_websocket`, `websocket_to_response`)
229279
- Adds optional `owner` field to NFTokenBurn
230280
- Allows lower-case currency codes
231281

232282
## [1.4.0] - 2022-02-24
283+
233284
### Added
285+
234286
- Sync and async `generate_faucet_wallet` functions now support a custom
235287
faucet host
236288

237289
## [1.3.0] - 2021-12-17
290+
238291
### Added
292+
239293
- Support for the [XLS-20 NFT proposal](https://github.com/XRPLF/XRPL-Standards/discussions/46)
240294
- `xrpl.models.amounts.get_amount_value` helper function
241295
- `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
249303
- Exports `Transaction`, `Response`, pseudo-transactions at the `xrpl.models` level
250304

251305
### Fixed
306+
252307
- Improves typing of `Response.result`
253308
- Makes the default ledger version for `get_next_valid_seq_number` `current` instead of `validated`
254309
- 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
262317
- Fixes bug where autofilling using an `xAddress` with `None` in the Destination Tag threw a KeyError
263318

264319
## [1.2.0] - 2021-11-09
320+
265321
### Added
322+
266323
- Support for Python 3.10
267324

268325
### Fixed
326+
269327
- Improves documentation on using websocket clients.
270328
- Fixes an issue sending NoRippleCheck requests
271329
- Allows projects that use xrpl-py as a dependency to use typing
272330

273331
## [1.1.1] - 2021-07-02
332+
274333
### Fixed
334+
275335
- Fixes an issue encoding some non-standard currency values
276336
- Corrects installation instructions in documentation
277337

278338
## [1.1.0] - 2021-06-16
339+
279340
### Added
341+
280342
- Option for `Transaction.flags` to be a `List` of `int`s instead of just an `int`
281343
- Instance method in `Transaction` objects to calculate their hashes locally
282344
- 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
292354
- A general `from_dict` method for `Request` models, analogous to `Transaction.from_dict`
293355

294356
### Fixed
357+
295358
- Typos in docs/tests
296359
- Improved readability of the README/documentation
297360
- 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
302365
- Better error message reporting
303366

304367
## [1.0.0] - 2021-03-31
368+
305369
### Added
370+
306371
- Initial release! Please open up an issue in our repo if you have any
307372
feedback or issues to report.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "xrpl-py"
3-
version = "4.0.0"
3+
version = "4.1.0"
44
description = "A complete Python library for interacting with the XRP ledger"
55
readme = "README.md"
66
repository = "https://github.com/XRPLF/xrpl-py"

0 commit comments

Comments
 (0)