mirror of https://github.com/bitcoinj/bitcoinj.git synced 2024-11-19 18:00:39 +01:00

Sean Gilligan d5aeaacc44 modular-architecture.md: improve diagrams, show 4 releases

This updates the document to have 4 diagrams, one for each of the
following releases:

1. 0.16.x (current stable release)
2. 0.17 (according to current plans)
3. 0.18 (according to current plans)
4. 0.19 (this more of a proposal than a plan at this point)

The diagrams have also been enhanced to differentiate between packages
and modules (aka JARs) and to distinguish between "api" and "implementation"
dependencies.

Hopefully this makes things much more clear. We can make further changes
as our plans and implementations change.

2023-03-03 20:24:00 +01:00

4.1 KiB

Raw Blame History

Overview of our migration plans to a more modular bitcoinj architecture

Note: Packages that are not significant or are not changing are not shown (and are generally expected to remain in the core module/JAR).

Legend: Dashed lines represent Gradle "implementation" dependencies. Solid lines represent Gradle "api" dependencies (or internal package dependencies.)

bitcoinj 0.16.x (current stable release)

flowchart TD
    E[examples] --> CORE
    T[tools] --> CORE
    FX[wallettemplate] --> CORE
    subgraph CORE [bitcoinj-core]
        W[o.b.wallet] --> CO
        W --> CR
        CO[o.b.core] --> CR
        CO --> W
        CR[o.b.crypto] --> CO
        CR --> W
    end
    CORE --> G[Guava]
    CORE --> BC[Bouncy Castle]
    CORE --> P[ProtoBuf]
    CORE .-> S[slf4j]
    CORE .-> A[jcip-annotations]

classDef external fill:#999;
class G,S,A,BC,P external;

bitcoinj 0.17 (current plan)

In release 0.17 (currently in progress) there has been a large amount of refactoring to prepare the o.b.base and o.b.crypto packages to become independent modules/JARs in the following release. Those packages will still contain some deprecated methods that depend on other internal packages and external modules. Those deprecated methods will be removed in release 0.18 when o.b.base and o.b.crypto are moved to their own modules.

flowchart TD
    E[examples] --> CORE
    IT[integration-test] --> CORE
    T[tools] --> CORE
    FX[wallettemplate] --> CORE
    WT[wallettool] --> CORE
    subgraph CORE [bitcoinj-core]
        W[o.b.wallet] --> CO[o.b.core]
        CO --> W
        W --> CR
        CO --> CR
        CO --> B[o.b.base]
        CR[o.b.crypto] --> B
    end
    CORE --> G[Guava]
    CORE --> P[ProtoBuf]
    CORE --> BC[Bouncy Castle]
    CORE .-> S[slf4j]
    CORE .-> A[jcip-annotations]

classDef external fill:#999;
class G,S,A,BC,P external;

bitcoinj 0.18 (current plan)

In this release it will be possible to use the bitcoinj-base module as a standalone module with no external dependencies. bitcoinj-crypto will be able to be used with a single dependency on the Bouncy Castle* library.

flowchart TD
    E[examples] --> CORE
    IT[integration-test] --> CORE
    T[tools] --> CORE
    FX[wallettemplate] --> CORE
    WT[wallettool] --> CORE
    subgraph CORE [bitcoinj-core]
        W[o.b.wallet] --> CO[o.b.core]
        CO --> W
    end
    CORE --> CRYPTO
    subgraph CRYPTO [bitcoinj-crypto]
        CR[o.b.crypto]
    end
    CRYPTO --> BASE
    CRYPTO --> BC[Bouncy Castle]
    subgraph BASE [bitcoinj-base]
        B[o.b.base]
    end
    CORE --> G[Guava]
    CORE --> P[ProtoBuf]
    CORE .-> S[slf4j]
    CORE .-> A[jcip-annotations]

classDef external fill:#999;
class G,S,A,BC,P external;

bitcoinj 0.19 (proposed)

In a proposed 0.19 release, we hope to do the following:

enhance bitcoin-crypto to contain a "provider" API so that core crypto functions that it needs can be provided by either Bouncy Castle or libsecp256k1. We also hope to completely eliminate dependencies on Guava for all modules.
Separate the current ProtoBuf-based wallet implementation into it's own module. This will require creating a Wallet interface in core.
Eliminate dependencies on Guava for all modules.

Stretch goal:

Alternate wallet implementation, perhaps using SQLite.

flowchart TD
    E[examples] --> WALLET
    IT[integration-test] --> WALLET
    T[tools] --> WALLET
    FX[wallettemplate] --> WALLET
    WT[wallettool] --> WALLET
    subgraph WALLET [bitcoinj-wallet-protobuf]
        W[o.b.wallet]
    end
    WALLET --> CORE
    WALLET .-> S[slf4j]
    WALLET --> P[ProtoBuf]
    subgraph CORE [bitcoinj-core]
        CO[o.b.core]
    end
    CORE --> CRYPTO
    CORE .-> S[slf4j]
    subgraph CRYPTO [bitcoinj-crypto]
        CR[o.b.crypto] --> CRPR[o.b.crypto.provider]
    end
    CRYPTO --> BASE
    CRPR .-> CRIMPL
    CRIMPL((impl))
    CRIMPL .-> BC[Bouncy Castle]
    CRIMPL .-> LP[libsecp256k1]
    subgraph BASE [bitcoinj-base]
        B[o.b.base]
    end

classDef external fill:#999;
class G,S,A,BC,LP,P external;

4.1 KiB Raw Blame History