Skip to content

Business process for Bitcoin withdrawals from Custodial platforms (such as Square and Cash App)

License

Notifications You must be signed in to change notification settings

block/bitty-city

Bitty-City

Brrr Cat Bitcoin

This project prescribes the custodial product experience for bitcoin on-chain operations. It is used currently by Block for Square Bitcoin withdrawals.

Building

Bitty City uses CashApp's Hermit. Hermit ensures that your team, your contributors, and your CI have the same consistent tooling. Here are the installation instructions.

Activate Hermit either by enabling the shell hooks (one-time only, recommended) or manually sourcing the env with . ./bin/activate-hermit.

Use gradle to run all tests:

bin/gradle build

Project Structure

  • common/ - Shared models and utilities
  • outie/ - Withdrawals module
  • innie/ - Deposits module (WIP)

Modules

Common

Shared models and utilities used across modules.

Innie

Handles bitcoin deposit operations and related custodial product experience.

Outie

Handles bitcoin withdrawal operations and related custodial product experience. See the state machine diagram for details on the withdrawal flow.

About

Business process for Bitcoin withdrawals from Custodial platforms (such as Square and Cash App)

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 6

Languages