Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions docs/changelog/v0.1.x/988_v0_1_11.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: v0.1.11
---

### BREAKING CHANGES

#### xrpl

- Moved `Signers` type from `github.com/Peersyst/xrpl-go/xrpl/transaction` package to `github.com/Peersyst/xrpl-go/xrpl/transaction/types`.

### Added

#### binary-codec

- Added `MPToken` definitions.
- Added `Hash192` type.
- Added functions to serialize and deserialize `MPTCurrencyAmount`.
- Added `GranularPermissions` and `DelegatablePermissions` entries to definitions.
- Added `PermissionValue` serialized type with custom serializer routing.
- Added`EncodeForSigningBatch` function.

#### xrpl

- Added `AMMClawback` transaction type.
- Added `MPTokenAuthorize`, `MPTokenIssuanceCreate`, `MPTokenIssuanceDestroy`, `MPTokenIssuanceSet` transactions. It also adds the `types.Holder`, `types.AssetScale`, `types.MPTokenMetadata` and `types.TransferFee` types to represent the holder of the token, the asset scale, the metadata and the transfer fee of the token respectively.
- Added `NFTokenMintOffer` support by adding `Amount`, `Expiration`, and `Destination` fields to `NFTokenMint` transaction. Also add `NFTokenMintMetadata` struct to handle transaction metadata with `nftoken_id` and `offer_id` fields.
- Added `MPTCurrencyAmount` for currency kinds.
- Added unit tests for `MPTCurrencyAmount`.
- Added `NFTokenModify` transaction type.

##### Account Permission Delegation (XLS-74d, XLS-75d)

- Added `DelegateSet` transaction type (XLS-74d) with validation and error support.
- Added `Delegate` ledger entry type (XLS-74d).
- Added `PermissionValue` and `Permission` types for delegated permissions.
- Added integration tests for `DelegateSet` submission and delegated `Payment` execution (XLS-75d).

##### Batch (XLS-56d)

- Added `Batch` transaction type.
- Added `CombineBatchSigners` function to combine the batch signers of a set of transactions into a single transaction.
- Added `SignMultiBatch` function to sign a multi-account Batch transaction.
- Added `TfInnerBatchTxn` flag.

## Changed

### binary-codec

- Refactored `Issue` codec type to support `Currency` and `Issuer` fields.

### Dependencies

- Bumped Go version to 1.23.0.

## Fixed

### xrpl

- Fixed some flatten fields with the `Flatten` function for `NFTokenMint`, `NFTokenCancel`, `NFTokenCreate`, `NFTokenBurn`
37 changes: 37 additions & 0 deletions docs/changelog/v0.1.x/989_v0_1_10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: v0.1.10
---

### BREAKING CHANGES

#### xrpl

- `Submit` client method is renamed to `SubmitTxBlob` in both clients.
- `SubmitAndWait` client method is renamed to `SubmitTxBlobAndWait` in both clients.

### Added

#### xrpl

- Added `SubmitTx` and `SubmitTxAndWait` client methods to both clients.
- Added support for the Credential fields in the following transaction types:
- Payment
- DepositPreauth
- AccountDelete
- PaymentChannelClaim
- EscrowFinish
- Added the `credential` ledger entry for the `account_objects` request.
- Added tec/tef/tel/tem/ter TxResult codes.
- Added `XLS-80d` support with `PermissionedDomain` transaction types:
- `PermissionedDomainSet`
- `PermissionedDomainDelete`

### Fixed

#### binary-codec

- Added native `uint8` type support for `Uint8` type.

#### big-decimal

- Fixed `BigDecimal` precision.
18 changes: 18 additions & 0 deletions docs/changelog/v0.1.x/990_v0_1_9.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: v0.1.9
---

### Added

#### xrpl

- Added support for all the Credential transaction types:
- CredentialCreate
- CredentialAccept
- CredentialDelete

### Fixed

#### big-decimal

- Amounts transcoding fix for large values.
16 changes: 16 additions & 0 deletions docs/changelog/v0.1.x/991_v0_1_8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: v0.1.8
---

### Added

#### xrpl

- Added `BalanceChanges` to the `Transaction` type.

### Changed

#### xrpl

- Updated `AffectedNode` type fields to be a pointer to allow nil values.
- Fixed `BaseLedger` field in `ledger` response (v1 and v2). BaseLedger.Transactions is now an array of interfaces instead of a slice of `FlatTransaction` due to `Expand` field in the request.
9 changes: 9 additions & 0 deletions docs/changelog/v0.1.x/992_v0_1_7.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: v0.1.7
---

### Added

#### xrpl

- Added support for websocket client subscriptions. Now you can subscribe to streams like `ledgerClosed`, `transaction`, `consensus`, `peerStatusChange`, `validationReceived`, etc.
26 changes: 26 additions & 0 deletions docs/changelog/v0.1.x/993_v0_1_6.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: v0.1.6
---

### Added

#### xrpl

- Configurable timeout for the RPC client. New default timeout of 5 seconds instead of 1 second.

### Fixed

#### xrpl

- Updates some fields in AccountSet and Payment related transactions to a pointer to allow 0 or "" values. For example:

- `DestinationTag`
- `TickSize`
- `Domain`
- `WalletLocator`
- `WalletSize`
- `TransferRate`

- Adds more tests for setting some `asf` flags in `AccountSet`.
- Fixed `Transaction` field in `account_tx` response.
- Fixed `Ledger` field in `ledger` response. LedgerIndex is now an uint32 instead of a string.
9 changes: 9 additions & 0 deletions docs/changelog/v0.1.x/994_v0_1_5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: v0.1.5
---

### Added

#### xrpl

Support for the XLS-77d (deep freeze)
18 changes: 18 additions & 0 deletions docs/changelog/v0.1.x/995_v0_1_4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: v0.1.4
---

### Added

#### xrpl

- Added `GatewayBalances` and `GetAggregatePrice` queries.

### Fixed

#### xrpl

- Updated SignerQuorum in SignerListSet to be an interface{} with uint32 type assertion instead of a value (uint32).
- This allows distinguishing between an unset (nil) and an explicitly set value, including 0 to delete a signer list.
- Ensures SignerQuorum is only included in the Flatten() output when explicitly defined.
- Updates the `Validate` method to make sure `SignerEntries` is not set when `SignerQuorum` is set to 0
14 changes: 14 additions & 0 deletions docs/changelog/v0.1.x/996_v0_1_3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: v0.1.3
---

### Added

- Added `APIVersion` field to the `Client` struct.
- Added `RippledAPIV1` and `RippledAPIV2` constants.
- Added missing `ctid` field on `TxRequest` v1 query.
- Added missing `NoRippleCheck` query (v1 & v2 support).

### Changed

- RippledAPIV2 is set as default API version. Queries and transactions are now compatible with Rippled v2 by default. V1 is still supported. In order to use v1, you need to use the `v1` package of each query type.
10 changes: 10 additions & 0 deletions docs/changelog/v0.1.x/997_v0_1_2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: v0.1.2
---

### Fixed

#### xrpl

- The `InfoRequest` for the `account_info` method had an incorrect field `signer_list` (an `s` was missing). The correct field is now `signer_lists`.
Link to the documentation [here](https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info#request-format).
42 changes: 42 additions & 0 deletions docs/changelog/v0.1.x/998_v0_1_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: v0.1.1
---

### Added

#### address-codec

- New `ErrInvalidAddressFormat` error.

### Fixed

#### binary-codec

- Fixed `AccountID` X-Address decoding/encoding support.

#### xrpl

- Replace `IsValidClassicAddress` with `IsValidAddress` on transactions `Validate` methods:
- `AccountDelete`
- `AMMBid`
- `DepositPreauth`
- `EscrowCancel`
- `EscrowFinish`
- `EscrowCancel`
- `NFTokenBurn`
- `NFTokenCreateOffer`
- `NFTokenMint`
- `NFTokenOffer`
- `Payment`
- `PaymentChannelCreate`
- `SetRegularKey`
- `SignerListSet`
- `BaseTx`
- `XChainBridge`
- `XChainAccountCreateCommit`
- `XChainAddAccountCreateAttestation`
- `XChainAddClaimAttestation`
- `XChainClaim`
- `XChainCreateClaimID`
- Master address derivation on wallet `FromSeed` function.
- `NetworkID` field on `BaseTx` type.
80 changes: 80 additions & 0 deletions docs/changelog/v0.1.x/999_v0_1_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: v0.1.0
---

### Added

#### binary-codec

- Updated `definitions`.
- New `DecodeLedgerData` function.
- `Quality` encoding/decoding functions.
- New `XChainBridge` and `Issue` types.

#### address-codec

- Address validation with `IsValidAddress`, `IsValidClassicAddress` and `IsValidXAddress`.
- Address conversion with `XAddressToClassicAddress` and `ClassicAddressToXAddress`.
- X-Address encoding/decoding with `EncodeXAddress` and `DecodeXAddress`.

#### keypairs

- New `DeriveNodeAddress` function.

#### xrpl

- New `AccountRoot`, `Amendments`, `Bridge`, `DID`, `DirectoryNode`, `Oracle`, `RippleState`, `XChainOwnedClaimID`, `XChainOwnedCreateAccountClaimID` ledger entry types.
- New `Multisign` utility function.
- New `NftHistory`, `NftsByIssuer`, `LedgerData`, `Check`, `BookOffers`, `PathFind`, `FeatureOne`, `FeatureAll` queries.
- New `SubmitMultisigned` request.
- New `AMMBid`, `AMMCreate`, `AMMDelete`, `AMMDeposit`, `AMMVote`, `AMMWithdraw` amm transactions.
- New `CheckCancel`, `CheckCash`, `CheckCreate` check transactions.
- New `DepositPreauth` transaction.
- New `DIDSet` and `DIDDelete` transactions.
- New `EscrowCreate`, `EscrowFinish`, `EscrowCancel` escrow transactions.
- New `OracleSet` and `OracleDelete` oracle transactions.
- New `XChainAccountCreateCommitment`, `XChainAddAccountCreateAttestation`, `XChainAddClaimAttestation`, `XChainClaim`, `XChainCommit`, `XChainCreateBridge`, `XChainCreateClaimID` and `XChainModifyBridge` cross-chain transactions.
- New `Multisign` wallet method.
- Ripple time conversion utility functions.
- Added query methods for websocket and rpc clients.
- New `SubmitMultisigned`, `AutofillMultisigned` and `SubmitTxBlobAndWait` methods for both clients.
- Added `Autofill` method for rpc client.
- New `MaxRetries` and `RetryDelay` config options for both clients.

#### Other

- Implemented `secp256k1` algorithm.

### Changed

#### binary-codec

- Exported `FieldInstance` type.
- Updated `NewBinaryParser` constructor to accept `definitions.Definitions` as a parameter.
- Updated `NewSerializer` to `NewBinarySerializer` constructor.
- Refactored `FieldIDCodec` to be a struct with `Encode` and `Decode` methods.
- `FromJson` methods to `FromJSON`.
- `ToJson` methods to `ToJSON`.

#### address-codec

No changes were made.

#### keypairs

- Decoupled `ed25519` and `secp256k1` algorithms from `keypairs` package.
- Decoupled `der` parsing from `keypairs` package.

#### xrpl

- Renamed `CurrencyStringToHex` to `ConvertStringToHex` and `CurrencyHexToString` to `ConvertHexToString`.
- Renamed `HashSignedTx` to `TxBlob`.
- Wallet API methods have been renamed for better usability.
- Renamed `SendRequest` to `Request` methods for websocket and rpc clients.

### Fixed

#### xrpl

- Some queries did not have proper fields. All queries have been updated with the fields that are required by the XRP Ledger.
- Some transaction types did not have proper fields. All transaction types have been updated with the fields that are required by the XRP Ledger.
10 changes: 10 additions & 0 deletions docs/changelog/v0.1.x/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
sidebar_position: 0
---

# Changelog

This section provides a concise record of all notable changes made to the project, organized by release version.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Loading