XRPLF / xrpl-py

A Python library to interact with the XRP Ledger (XRPL) blockchain
ISC License
144 stars 83 forks source link

refactor(wallet): Rename `Wallet.classic_address` to `Wallet.address` #601

Closed JST5000 closed 1 year ago

JST5000 commented 1 year ago

High Level Overview of Change

classic_address is jargon for most people - we should instead name it address

Context of Change

We already were planning on adding a new alias, but in the spirit of having a clear API, this PR is instead planning to just set address to the new name.

classic_address is only named that to differentiate itself from x-address which is a newer standard which is not supported at the ledger level. (You have to decode x-addresses back to classic_addresses before submitting a transaction to the ledger) - For a concept as basic as what an account on the XRPL is, we don't want to require understanding that nuance.

Type of Change

Test Plan

CI Passes

Note: Originally this was a breaking change, but after discussion we've changed it to just affect the defaults we use - while keeping classic_address as an alias.