Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(types): Export most of the types #2360

Merged
merged 7 commits into from
Jul 3, 2023
Merged

Conversation

ckniffen
Copy link
Collaborator

@ckniffen ckniffen commented Jun 30, 2023

High Level Overview of Change

Expose most of the types in the xrpl package.

BREAKING CHANGE: Renames of deep importable types:

  • methods/accountLines: Trustline -> AccountLinesTrustline
  • methods/bookOffers: TakerAmount -> BookOfferCurrency
  • methods/ledgerData: BinaryLedgerEntry -> LedgerDataBinaryLedgerEntry

Type of Change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • New feature (non-breaking change which adds functionality)
  • Documentation Updates

Expose most of the types in the `xrpl` package. Some renames will only
affect you if you were deep importing these types previously.

Renames of deep importable types:
- `methods/bookOffers`: `TakerAmount` -> `BookOfferCurrency`
- `methods/accountLines`: `Trustline` -> `AccountLinesTrustline`
}

export interface NFTokenPage extends BaseLedgerEntry {
LedgerEntryType: 'NFTokenPage'
NextPageMin?: string
NFTokens: NFTokenWrapper[]
NFTokens: NFToken[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this changed from NFTokenWrapper?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To keep it inline with the other nested STObjects in STArrays. After looking at more definitions i decided to change it. NFTokenWrapper was never in a released version of xrpl.js so figured now would be a good time to change it.

@ckniffen ckniffen merged commit dbd5852 into main Jul 3, 2023
17 checks passed
@ckniffen ckniffen deleted the feature/export-all-the-things branch July 3, 2023 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants