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

Rename non-public inner struct fields as "inner" #366

Closed
notmandatory opened this issue Jun 7, 2023 · 1 comment · Fixed by #393
Closed

Rename non-public inner struct fields as "inner" #366

notmandatory opened this issue Jun 7, 2023 · 1 comment · Fixed by #393
Assignees
Labels
good first issue Good for newcomers

Comments

@notmandatory
Copy link
Member

Describe the enhancement

In a few places we need to "wrap" a bdk or rust-bitcoin struct in a bkd-ffi struct and make the original type a non-public "inner" field. We've used different names for these inner fields but should standardize on the name "inner" for consistency and readability. Examples of stucts that need to be changed:

Transaction.internal
Address.address
Script.script
Blockchain.blockchain_mutex
Mnemonic.internal
DerivationPath.derivation_path_mutex
DescriptorPublicKey.descriptor_public_key_mutex
DescriptorSecretKey.descriptor_secret_key_mutex
Input._inner
PartiallySignedTransaction.internal
Wallet.wallet_mutex

Use case

Users won't see this change.

Additional context

The name "inner" is common in other libraries like rust-bitcoin.

@notmandatory notmandatory added enhancement New feature or request good first issue Good for newcomers and removed enhancement New feature or request labels Jun 7, 2023
@SamantaTarun
Copy link

I'd like to look into this.

@reez reez linked a pull request Aug 16, 2023 that will close this issue
19 tasks
@notmandatory notmandatory added this to the Release 0.30.0 milestone Aug 18, 2023
@notmandatory notmandatory moved this to Done in BDK-Bindings Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants