Welcome to the Ark monorepo, a comprehensive solution for off-chain Bitcoin and Liquid transactions.
โ ๏ธ IMPORTANT DISCLAIMER: ALPHA SOFTWARE Ark is currently in alpha stage. This software is experimental and under active development. DO NOT ATTEMPT TO USE IN PRODUCTION. Use at your own risk.
Covenant-less | Covenant | |
---|---|---|
Network | Bitcoin signet, Bitcoin regtest | Liquid, Liquid testnet, Liquid regtest |
Wallet | Embedded lnwallet | Ocean wallet |
For a comprehensive guide on how to set up and use Ark, please visit our Developer Portal. For a quick-start with Docker, head over to our Quick Start guide where you can setup an Ark Server and Clients in a local Bitcoin regtest network.
api-spec
: Ark Protocol Buffer API specificationclient
:ark
Single-key wallet CLI for interacting with the ASPcommon
: Shared code between the server and clientpkg/client-sdk
: Go SDK for interacting with ASPs running the Ark protocol. It offers WASM bindings to interact with the SDK from the browser and other environments.server
:arkd
Ark Service Provider (ASP) - the always-on daemon
For detailed development instructions, including running tests, and contributing to the implementations, please refer to the README files in the server
and client
directories.
To compile Ark binaries from source, you can use the following Make commands from the root of the monorepo:
make build-server
: Builds thearkd
binary (Ark Service Provider)make build-client
: Builds theark
binary (Single-key wallet CLI)make build-wasm
: Builds the WebAssembly bindingsmake build
: Builds all components for the current architecture (server, client, and WebAssembly SDK)make build-all
: Cross-compile all components for all supported architectures
For example, to build both the server and client binaries, run:
make build
This will compile the arkd
and ark
binaries for your current architecture. For more detailed build instructions and options, please refer to the README files in the server
and client
directories.
- No force pushing in PRs: Always use
git push --force-with-lease
to avoid overwriting others' work. - Sign your commits: Use GPG to sign your commits for verification.
- Squash and merge: When merging PRs, use the "Squash and merge" option to maintain a clean commit history.
- Testing: Add tests for each new major feature or bug fix.
- Keep master green: The master branch should always be in a passing state. All tests must pass before merging.
-
Install Go (version 1.18 or later)
-
Install Nigiri for local Bitcoin and Liquid networks
-
Clone this repository:
git clone https://github.com/ark-network/ark.git cd ark
-
Install dependencies:
go mod download
-
Build the project:
cd server make build cd ../client make build
Note: You need to run make build
in both the server
and client
directories separately.
If you encounter any issues or have questions, please file an issue on our GitHub Issues page.
We take the security of Ark seriously. If you discover a security vulnerability, we appreciate your responsible disclosure.
Currently, we do not have an official bug bounty program. However, we value the efforts of security researchers and will consider offering appropriate compensation for significant, responsibly disclosed vulnerabilities.
This project is licensed under the MIT License - see the LICENSE file for details.