Code Monkey home page Code Monkey logo

rot13maxi / bitkey Goto Github PK

View Code? Open in Web Editor NEW

This project forked from proto-at-block/bitkey

0.0 0.0 0.0 155.9 MB

Bitkey is a self-custody bitcoin wallet with an app, hardware, and recovery tools.

Home Page: https://bitkey.world

License: Other

Shell 0.51% JavaScript 0.17% Ruby 0.04% C++ 0.30% Python 1.54% C 49.31% Rust 9.38% Kotlin 33.39% TypeScript 0.42% Swift 3.22% Makefile 0.02% HCL 1.22% Dockerfile 0.03% Meson 0.30% Open Policy Agent 0.01% Procfile 0.01% Just 0.13%

bitkey's Introduction

Bitkey

Bitkey is the safe, easy way to own and manage your bitcoin. Learn more at bitkey.world, or on our development blog

For more information about our release of Bitkey's code, read our blog post on the topic.

Repository Structure

Each directory in our repository is a seperate project— each with its own build and often in its own language(s) / platform(s).

Directory Description
app/android Android mobile app
app/core Key and wallet management (shared)
app/ios iOS mobile app
app/shared Kotlin Multiplatform code shared between Android and iOS
app/style Style Dictionary (shared)
app Our mobile application's project root
firmware Code that powers the Bitkey hardware device
nodes Nodes (bitcoind / electrum) and service
server API Server and Wallet Security Module (WSM)
terraform Our Infrastructure as Code

Building

Bitkey source is available here for auditing purposes, but we're not ready to support external parties in building all Bitkey components. See individual project README information for more detail.

Contributing

At this time, we are not accepting external contributions to Bitkey code. We're prioritizing building a smooth, safe self-custody experience through the Bitkey app and hardware through contirbutions from our internal team. For now, if you want to contribute to Bitkey, consider joining our team.

Security Reporting Program

To report potential security issues to us, please email us at [email protected].

To protect our customers, we ask that you report vulnerabilities to us as soon as you can, and that you coordinate disclosure with us first, so that we can understand and mitigate reported vulnerabilities before they are disclosed to anyone other than the Bitkey team or to the public. To accomplish this, we ask you to follow a 90-day disclosure policy. That is, we ask that you do not disclose the existence, discovery, and technical details of the vulnerability until the 90th day after you file a report with reasonable technical detail with the Bitkey team, and that you notify us prior to disclosure.

Verifying Bitkey Mobile Applications

We want to enable anyone with sufficient technical skills, to match the application built using the code in this repository to the application distributed to customer on the app stores.

We currently have the Android verification process available. Stay tuned for iOS verification, coming soon.

Head to app/verifiable-build/android/README.md to learn more about the verification process and how to do do it yourself.

Notes

  • This document (including Software and schematics) is current as of 2024-02-22. Our goal is to make sure the code we publish is up to date with what is available in the App Store. We may publish other items on a less real time basis (e.g. server code and schematics) and so what is published may not always map to what is in production or design.

  • Ownership of this document and all design elements of the Bitkey remain with Block, Inc.

  • This document is released to provide transparency into the Bitkey product and service.

  • Software is licensed by Block, Inc. under the MIT License (the “License”) with the Commons Clause modifier, and with no warranties or guarantees.

bitkey's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.