Skip to content

Latest commit

 

History

History
154 lines (85 loc) · 12.2 KB

README.md

File metadata and controls

154 lines (85 loc) · 12.2 KB

Blockchain Commons giveBTC: A simple donation app.

_by Nicholas Ochiel and Namcios _

giveBTC is a research project into a simple, low maintenance way to receive donations in satoshis.

  • This project also serves as a repository of new implementations of or links to existing bitcoin donation apps/tools.

Additional Information

  • Reviews: contains a review of existing challenges, opportunities, and applications for receiving bitcoin donations.
  • Use Cases: contains a list and description of use cases for a bitcoin donation app.

Gordian Principles

giveBTC is a research project (and potential reference implementation of a donation app or tools to install and use a viable donation app) meant to display the Gordian Principles, which are philosophical and technical underpinnings to Blockchain Commons' Gordian technology. This includes:

  • Independence. how does it demonstrate independence
  • Privacy. how does it demonstrate privacy
  • Resilience. how does it demonstrate resilience
  • Openness. how does it demonstrate openness

Blockchain Commons apps do not phone home and do not run ads. Some are available through various app stores; all are available in our code repositories for your usage.

Status - Prototype

giveBTC is currently under active development and in the prototyping phase. It should not be used in production.

Roadmap

Prerequisites

Installation Instructions

Usage Instructions

Origin, Authors, Copyright & Licenses

Unless otherwise noted (either in this /README.md or in the file's header comments) the contents of this repository are Copyright © 2020 by Blockchain Commons, LLC, and are licensed under the spdx:BSD-2-Clause Plus Patent License.

In most cases, the authors, copyright, and license for each file reside in header comments in the source code. When it does not, we have attempted to attribute it accurately in the table below.

This table below also establishes provenance (repository of origin, permalink, and commit id) for files included from repositories that are outside of this repo. Contributors to these files are listed in the commit history for each repository, first with changes found in the commit history of this repo, then in changes in the commit history of their repo of their origin.

File From Commit Authors & Copyright (c) License
exception-to-the-rule.c or exception-folder https://github.com/community/repo-name/PERMALINK https://github.com/community/repo-name/commit/COMMITHASH 2020 Exception Author MIT

Dependencies

To build giveBTC you'll need to use the following tools:

  • A standard Debian Linux instalation.

Libraries

The following external libraries are used with giveBTC:

Libraries may be marked as use (the current version of the library is used), fork (a specific version has been forked to the BCC repos for usage), or include (files from a specific version have been included).

Derived from ...

This giveBTC project is either derived from or was inspired by:

Subsequent Usage

Adapted by ...

These are adaptations, conversions, and wrappers that make giveBTC available for other languages:

Used by ...

These are other projects that directly use giveBTC:

Libraries may be marked as use (the current version of our repo is used), fork (a specific version of our repo has been forked for usage), or include (files from a specific version of our repo have been included).

Used with ...

These are other projects that work with or leverage giveBTC:

Financial Support

giveBTC is a project of Blockchain Commons. We are proudly a "not-for-profit" social benefit corporation committed to open source & open development. Our work is funded entirely by donations and collaborative partnerships with people like you. Every contribution will be spent on building open tools, technologies, and techniques that sustain and advance blockchain and internet security infrastructure and promote an open web.

To financially support further development of giveBTC and other projects, please consider becoming a Patron of Blockchain Commons through ongoing monthly patronage as a GitHub Sponsor. You can also support Blockchain Commons with bitcoins at our BTCPay Server.

Project Sponsors

Thanks to our project sponsors for their support of giveBTC:

$sponsor-logo-with-link

$sponsor-description

Contributing

We encourage public contributions through issues and pull requests! Please review CONTRIBUTING.md for details on our development process. All contributions to this repository require a GPG signed Contributor License Agreement.

Discussions

The best place to talk about Blockchain Commons and its projects is in our GitHub Discussions areas.

Gordian System Discussions. For users and developers of the Gordian system, including the Gordian Server, Bitcoin Standup technology, QuickConnect, and the Gordian Wallet. If you want to talk about our linked full-node and wallet technology, suggest new additions to our Bitcoin Standup standards, or discuss the implementation our standalone wallet, the Discussions area of the main Gordian repo is the place.

Wallet Standard Discussions. For standards and open-source developers who want to talk about wallet standards, please use the Discussions area of the Airgapped Signing repo. This is where you can talk about projects like our LetheKit and command line tools such as seedtool, both of which are intended to testbed wallet technologies, plus the libraries that we've built to support your own deployment of wallet technology such as bc-bip39, bc-slip39, bc-shamir, Sharded Secret Key Reconstruction, bc-ur, and the bc-crypto-base. If it's a wallet-focused technology or a more general discussion of wallet standards,discuss it here.

Blockchain Commons Discussions. For developers, interns, and patrons of Blockchain Commons, please use the discussions area of the Community repo to talk about general Blockchain Commons issues, the intern program, or topics other than the Gordian System or the wallet standards, each of which have their own discussion areas.

Other Questions & Problems

As an open-source, open-development community, Blockchain Commons does not have the resources to provide direct support of our projects. Please consider the discussions area as a locale where you might get answers to questions. Alternatively, please use this repository's issues feature. Unfortunately, we can not make any promises on response time.

If your company requires support to use our projects, please feel free to contact us directly about options. We may be able to offer you a contract for support from one of our contributors, or we might be able to point you to another entity who can offer the contractual support that you need.

Credits

The following people directly contributed to this repository. You can add your name here by getting involved. The first step is learning how to contribute from our CONTRIBUTING.md documentation.

Name Role Github Email GPG Fingerprint
Christopher Allen Principal Architect @ChristopherA <ChristopherA@LifeWithAlacrity.com> FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED
Nicholas Ochiel Project lead. @nochiel <nochiel@users.noreply.github.com> 45EA 5C81 9B7E E915 C2A2 7C64 4444 1190 7BE8 83D9
Namcios Contributor @namcios <namcios@protonmail.com> 55A2 4BE0 AEE5 DB41 52C6 A410 8E3A 3683 1726 9AB4

Responsible Disclosure

We want to keep all of our software safe for everyone. If you have discovered a security vulnerability, we appreciate your help in disclosing it to us in a responsible manner. We are unfortunately not able to offer bug bounties at this time.

We do ask that you offer us good faith and use best efforts not to leak information or harm any user, their data, or our developer community. Please give us a reasonable amount of time to fix the issue before you publish it. Do not defraud our users or us in the process of discovery. We promise not to bring legal action against researchers who point out a problem provided they do their best to follow the these guidelines.

Reporting a Vulnerability

Please report suspected security vulnerabilities in private via email to ChristopherA@BlockchainCommons.com (do not use this email for support). Please do NOT create publicly viewable issues for suspected security vulnerabilities.

The following keys may be used to communicate sensitive information to developers:

Name Fingerprint
Christopher Allen FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED
Nicholas Ochiel 45EA 5C81 9B7E E915 C2A2 7C64 4444 1190 7BE8 83D9
Namcios 55A2 4BE0 AEE5 DB41 52C6 A410 8E3A 3683 1726 9AB4

You can import a key by running the following command with that individual’s fingerprint: gpg --recv-keys "<fingerprint>" Ensure that you put quotes around fingerprints that contain spaces.