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
+7-3Lines changed: 7 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,26 +8,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8
8
## [[Unreleased]]
9
9
10
10
### Fixed
11
+
11
12
- Removed snippets files from the xrpl-py code repository. Updated the README file to point to the correct location on XRPL.org.
12
13
13
14
## [[4.3.0]] - 2025-07-29
14
15
15
16
### Added
17
+
16
18
- Support for `Token Escrow` (XLS-85d)
17
19
- Support for `NFTokenMintOffer` (XLS-52)
18
20
- Support for `Permissioned DEX` (XLS-81)
19
21
- Add warning messages to `MPTokenIssuanceCreate` and `VaultCreate` transaction as per [XLS-89d](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0089d-multi-purpose-token-metadata-schema).
20
22
21
-
22
23
## [4.2.0] - 2025-6-09
23
24
24
25
### Added
26
+
25
27
- Improved validation for models to also check param types
26
28
- Support for `Single Asset Vault` (XLS-65d)
27
29
- Support for `Account Permission` and `Account Permission Delegation` (XLS-74d, XLS-75d)
28
30
- Support for the `Batch` amendment (XLS-56d)
29
31
30
32
### Fixed
33
+
31
34
- Add `MPTCurrency` support in `Issue` (rippled internal type)
32
35
- Fix the implementation error in get_latest_open_ledger_sequence method. The change uses the "current" ledger for extracting sequence number
33
36
- Increase default maximum payload size for websocket client
@@ -45,11 +48,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
45
48
### Added
46
49
47
50
- Support for `Deep Freeze` (XLS-77d)
48
-
- Support for `PermissionedDomains` (XLS-80)
51
+
- Support for `PermissionedDomains` (XLS-80)
49
52
- Support `AMMClawback` amendment (XLS-73d)
50
53
- Support for the `simulate` RPC ([XLS-69](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0069d-simulate))
51
54
52
55
### Fixed
56
+
53
57
-`Sign`, `SignFor`, and `SignAndSubmit` methods now properly handle WebSocket clients
54
58
55
59
## [4.0.0] - 2024-12-23
@@ -96,7 +100,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
96
100
- Add `nfts_by_issuer` clio-only API definition
97
101
- Included `ctid` field in the `tx` request.
98
102
-`from_xrpl` method accepts input dictionary keys exclusively in the proper XRPL format.
*`docker run -p 5005:5005 -p 6006:6006` starts a Docker container with an open port for admin JsonRPC and WebSocket requests.
98
-
*`-it` allows you to interact with the container.
99
-
*`-d` runs the docker container in detached mode. The container will run in the background and developer gets back control of the terminal
100
-
*`-t` starts a terminal in the container for you to send commands to.
101
-
*`--volume $PWD/.ci-config:/etc/opt/ripple/` mounts the directories as indicated. It must be an absolute path, so we use `$PWD` instead of `./`. `rippled` software searches the location `/etc/opt/ripple/` (default behavior) for the config files. Hence there is no need to explicitly specify the config-file path.
102
-
*`rippleci/rippled:develop` is an image that is regularly updated with the latest build of the `develop` branch of `rippled`.
103
-
*`-a` starts `rippled` in standalone mode
97
+
98
+
-`docker run -p 5005:5005 -p 6006:6006` starts a Docker container with an open port for admin JsonRPC and WebSocket requests.
99
+
-`-it` allows you to interact with the container.
100
+
-`-d` runs the docker container in detached mode. The container will run in the background and developer gets back control of the terminal
101
+
-`-t` starts a terminal in the container for you to send commands to.
102
+
-`--volume $PWD/.ci-config:/etc/opt/ripple/` mounts the directories as indicated. It must be an absolute path, so we use `$PWD` instead of `./`. `rippled` software searches the location `/etc/opt/ripple/` (default behavior) for the config files. Hence there is no need to explicitly specify the config-file path.
103
+
-`rippleci/rippled:develop` is an image that is regularly updated with the latest build of the `develop` branch of `rippled`.
104
+
-`-a` starts `rippled` in standalone mode
104
105
105
106
Then to actually run the tests, run the command:
106
107
@@ -166,6 +167,7 @@ open index.html
166
167
You can view docs builds for xrpl-py versions on the ReadTheDocs website here: https://readthedocs.org/projects/xrpl-py/builds/
167
168
168
169
In order to test how a change in docs configuration looks like on ReadTheDocs before merging:
170
+
169
171
1. Publish a branch with your docs configuration changes
170
172
2. Active and hide the branch by scrolling down on this page: https://readthedocs.org/projects/xrpl-py/versions/
171
173
3. View the page / build results here: https://readthedocs.org/projects/xrpl-py/builds/
@@ -188,13 +190,15 @@ Examples can be found in subfolders of [tests/integrations](https://github.com/X
188
190
## Updating `definitions.json` and models
189
191
190
192
To update just the `definitions.json` file:
193
+
191
194
```bash
192
195
poetry run poe definitions https://github.com/XRPLF/rippled/tree/develop
193
196
```
194
197
195
198
Any Github branch link or local path to rippled will work here.
196
199
197
200
To update the models as well:
201
+
198
202
```bash
199
203
poetry run poe generate https://github.com/XRPLF/rippled/tree/develop
200
204
```
@@ -213,18 +217,19 @@ Verify that the changes make sense by inspection before submitting, as there may
213
217
- Merge your changes.
214
218
215
219
### Release
220
+
216
221
1. Please increment the version in `pyproject.toml` and update the `CHANGELOG.md` file appropriately. We follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
217
222
2. Please select a commit that is suitable for release and create a tag. The following commands can be helpful:
218
-
`git tag -s -a <tag-title> -m "Optional Message describing the tag"`
219
-
`git tag` -- This command displays all the tags in the repository.
220
-
`git push <remote_name, e.g. upstream> tag <tag_title>`
223
+
`git tag -s -a <tag-title> -m "Optional Message describing the tag"`
224
+
`git tag` -- This command displays all the tags in the repository.
225
+
`git push <remote_name, e.g. upstream> tag <tag_title>`
221
226
3. A [Github Workflow](.github/workflows/publish_to_pypi.yml) completes the rest of the Release steps (building the project, generating a .whl and tarball, publishing on the PyPI platform). The workflow uses OpenID Connect's temporary keys to obtain the necessary PyPI authorization.
222
-
As a prerequisite, the PyPI `xrpl-py` project needs to authorize Github Actions as a "Trusted Publisher". This page contains helpful resources: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#configuring-trusted-publishing
227
+
As a prerequisite, the PyPI `xrpl-py` project needs to authorize Github Actions as a "Trusted Publisher". This page contains helpful resources: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#configuring-trusted-publishing
223
228
4. Send an email to [xrpl-announce](https://groups.google.com/g/xrpl-announce).
224
229
5. Post an announcement in the [XRPL Discord #python channel](https://discord.com/channels/886050993802985492/886053080913821717) with a link to the changes and highlighting key changes.
225
230
226
-
227
231
**Note: If maintainers prefer to manually release the xrpl-py software distribution, the below steps are relevant.**
232
+
228
233
1. Create a branch off main that properly increments the version in `pyproject.toml` and updates the `CHANGELOG` appropriately. We follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
0 commit comments