76a6d94bbe
* WIP New APIs for dealing with custodians/exchanges * Simplified things * More API refinements + index.html file for quick viewing * Finishing touches on spec * Switched cryptoCode to paymentMethod as this allows us to differentiate between onchain and lightning * Moved draft API docs to "/docs-draft" * WIP baby steps * Added DB migration for CustodianAccountData * Rough but working POST /v1/api/custodian-account + GET /v1/api/custodian * WIP + early Kraken API client * Moved service registration to proper location * Working create + list custodian accounts + permissions + WIP Kraken client * Kraken API Balances call is working * Added asset balances to response * List Custodian Accounts call does not load assetBalances by default, because it can fail. Can be requested when needed. * Call to get the details of 1 specific custodian account * Added permissions to swagger * Added "tradableAssetPairs" to Kraken custodian response + cache the tradable pairs in memory for 24 hours * Removed unused file * WIP + Moved files to better locations * Updated docs * Working API endpoint to get info on a trade (same response as creating a new trade) * Working API endpoints for Deposit + Trade + untested Withdraw * Delete custodian account * Trading works, better error handling, cleanup * Working withdrawals + New endpoint for getting bid/ask prices * Completed withdrawals + new endpoint for getting info on a past withdrawal to simplify testing, Enums are output as strings, * Better error handling when withdrawing to a wrong destination * WithdrawalAddressName in config is now a string per currency (dictionary) * Added TODOs * Only show the custodian account "config" to users who are allowed * Added the new permissions to the API Keys UI * Renamed KrakenClient to KrakenExchange * WIP Kraken Config Form * Removed files for UI again, will make separate PR later * Fixed docs + Refactored to use PaymentMethod more + Added "name" to custodian account + Using cancelationToken everywhere * Updated withdrawal info docs * First unit test * Complete tests for /api/v1/custodians and /api/v1/custodian-accounts endpoints + Various improvements and fixes * Mock custodian and more exceptions * Many more tests + cleanup, moved files to better locations * More tests * WIP more tests * Greenfield API tests complete * Added missing "Name" column * Cleanup, TODOs and beginning of Kraken Tests * Added Kraken tests using public endpoints + handling of "SATS" currency * Added 1st mocked Kraken API call: GetAssetBalancesAsync * Added assert for bad config * Mocked more Kraken API responses + added CreationDate to withdrawal response * pr review club changes * Make Kraken Custodian a plugin * Re-added User-Agent header as it is required * Fixed bug in market trade on Kraken using a percentage as qty * A short delay so Kraken has the time to execute the market order and we don't fetch the details too quickly. * Merged the draft swagger into the main swagger since it didn't work anymore * Fixed API permissions test * Removed 2 TODOs * Fixed unit test * Remove Kraken Api as it should be separate opt-in plugin * Flatten namespace hierarchy and use InnerExeption instead of OriginalException * Remove useless line * Make sure account is from a specific store * Proper error if custodian code not found * Remove various warnings * Remove various warnings * Handle CustodianApiException through an exception filter * Store custodian-account blob directly * Remove duplications, transform methods into property * Improve docs tags * Make sure the custodianCode saved is canonical * Fix test Co-authored-by: Wouter Samaey <wouter.samaey@storefront.be> Co-authored-by: nicolas.dorier <nicolas.dorier@gmail.com>
BTCPay Server
Accept Bitcoin payments ₿
BTCPay Server is a free and open-source Bitcoin payment processor which allows you to accept bitcoin without fees or intermediaries.
Website | Documentation | API | Contribute | YouTube | Chat
View Demo · Report a bug · Request a feature · FAQ
💼 Table of Contents
🎨 Features
- Direct, peer-to-peer Bitcoin payments
- No transaction fees (other than the network fee)
- No fees, middleman or KYC
- Non-custodial (complete control over the private key)
- Enhanced privacy & security
- Self-hosted
- SegWit support
- Lightning Network support (LND, c-lightning, Eclair, and Ptarmigan)
- Tor support
- Share your instance with friends (multi-tenant)
- Invoice management and Payment requests
- Apps: Point of sale, crowdfunding, donation button
- Full-node reliant wallet with hardware wallet integration and SegWit support
- Bitcoin-only build, separate community-maintained altcoin build (supported altcoins)
🚀 Getting Started
Firstly, decide if you want to host an instance yourself or use a third-party host. If you've chosen to self-host, there are plenty of documented ways to deploy BTCPay Server.
After successful deployment, make sure to check our getting started and walkthrough guides. In case you would like to use Lightning Network, see Lightning guide.
📗 Documentation
Please check out our official website, complete documentation and FAQ for more details.
If you have trouble using BTCPay Server, consider joining communities listed on the official website to get help from other contributors. Only create a GitHub issue for technical issues you can't resolve through other channels or feature requests you've validated with other members of the community.
🤝 Contributing
BTCPay Server is built and maintained entirely by volunteer contributors around the internet. We welcome and appreciate new contributions.
If you're a developer looking to help, but you're not sure where to begin, check the good first issue label, which contains small pieces of work that have been specifically flagged as being friendly to new contributors.
Contributors looking to do something a bit more challenging, before opening a pull request, please join our community chat or start a GitHub discussion to get early feedback, discuss best ways to tackle the problem and ensure there is no work duplication.
There are many other ways to get involved with the project. Check our contribution guidelines. To get the big-picture of the project development, visit our evolving roadmap. We organize different types of community calls several times a month. Subscribe to our calendar and feel free to join our calls to discuss development, design, documentation and more.
🧑💻 Developing
To begin developing locally, visit our local development guide. There are also several video-tutorials:
- Setting up development environment on Windows
- Setting up development environment Linux (Ubuntu)
- Setting up development environment MacOS
How to build
While the documentation advises using docker-compose, you may want to build BTCPay Server yourself.
First, install .NET Core SDK v6.0 as specified by the Microsoft website.
On Powershell:
.\build.ps1
On linux:
./build.sh
How to run
Use the run scripts to run BTCPay Server, this example shows how to print the available command-line arguments of BTCPay Server.
On Powershell:
.\run.ps1 --help
On linux:
./run.sh --help
How to debug
If you want to debug, use Visual Studio Code or Visual Studio 2019.
You need to run the development time docker-compose as described in the test guide.
You can then run the debugger by using the Launch Profile Docker-Regtest on either Visual Studio Code or Visual Studio 2017.
If you need to debug ledger wallet interaction, install the development time certificate with:
# Install development time certificate in the trust store
dotnet dev-certs https --trust
Then use the Docker-Regtest-https debug profile.
Other dependencies
For more information, see the documentation: How to deploy a BTCPay Server instance.
🧪 API
BTCPay Server has two APIs:
- Greenfield API (New)
- Legacy API
The Greenfield API is our brand-new API which is still in development. Once complete, it will allow you to run BTCPay Server headlessly. The Legacy API, is fully compatible with BitPay's API. It has limited features, but allows instant migration from BitPay.
💚 Community
Our community is the ❤️ of the project. To chat with other community members in real-time, join our Mattermost chat. We're also on GitHub discussions.
📝 License
BTCPay Server software, logo and designs are provided under MIT License.
🙏 Supporters
The BTCPay Server Project is proudly supported by these entities through the BTCPay Server Foundation.
Spiral |
Baillie Gifford |
PNXBET |
LunaNode |
Wallet of Satoshi |
Nomics |
Coincards |
IVPN |
If you'd like to support the project, please visit the donation page.