Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions doc/JSON-RPC-interface.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# JSON-RPC Interface

The headless daemon `bitcoind` has the JSON-RPC API enabled by default, the GUI
`bitcoin-qt` has it disabled by default. This can be changed with the `-server`
The headless daemon `aviand` has the JSON-RPC API enabled by default, the GUI
`avian-qt` has it disabled by default. This can be changed with the `-server`
option. In the GUI it is possible to execute RPC methods in the Debug Console
Dialog.

Expand All @@ -24,7 +24,7 @@ This endpoint is only activated when the wallet component has been compiled in.
It can service both wallet and non-wallet requests.
It MUST be used for wallet requests when two or more wallets are loaded.

This is the endpoint used by bitcoin-cli when a `-rpcwallet=` parameter is passed in.
This is the endpoint used by avian-cli when a `-rpcwallet=` parameter is passed in.

Best practice would dictate using the `/wallet/<walletname>/` endpoint for ALL
requests when multiple wallets are in use.
Expand Down Expand Up @@ -53,16 +53,16 @@ Examples:

```sh
# "params": ["mywallet", false, false, "", false, false, true]
bitcoin-cli createwallet mywallet false false "" false false true
avian-cli createwallet mywallet false false "" false false true

# "params": {"wallet_name": "mywallet", "load_on_startup": true}
bitcoin-cli -named createwallet wallet_name=mywallet load_on_startup=true
avian-cli -named createwallet wallet_name=mywallet load_on_startup=true

# "params": {"args": ["mywallet"], "load_on_startup": true}
bitcoin-cli -named createwallet mywallet load_on_startup=true
avian-cli -named createwallet mywallet load_on_startup=true
```

`bitcoin rpc` can also be substituted for `bitcoin-cli -named`, and is a newer alternative.
`avian rpc` can also be substituted for `avian-cli -named`, and is a newer alternative.

## Versioning

Expand Down Expand Up @@ -137,7 +137,7 @@ RPC interface will be abused.
withstand arbitrary Internet traffic, so changing the above settings
to expose it to the Internet (even using something like a Tor onion
service) could expose you to unconsidered vulnerabilities. See
`bitcoind -help` for more information about these settings and other
`aviand -help` for more information about these settings and other
settings described in this document.

Related, if you use Bitcoin Core inside a Docker container, you may
Expand Down
37 changes: 17 additions & 20 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Bitcoin Core
Avian Core
=============

Setup
---------------------
Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires several hundred gigabytes or more of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to several days or more.
Avian Core is the Avian Network client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Avian transactions, which requires several hundred gigabytes or more of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to several days or more.

To download Bitcoin Core, visit [bitcoincore.org](https://bitcoincore.org/en/download/).
To download Avian Core, visit [github.com/AvianNetwork/Avian](https://github.com/AvianNetwork/Avian/releases).

Running
---------------------
Expand All @@ -15,31 +15,28 @@ The following are some helpful notes on how to run Bitcoin Core on your native p

Unpack the files into a directory and run:

- `bin/bitcoin-qt` (GUI) or
- `bin/bitcoind` (headless)
- `bin/bitcoin` (wrapper command)
- `bin/avian-qt` (GUI) or
- `bin/aviand` (headless)
- `bin/avian` (wrapper command)

The `bitcoin` command supports subcommands like `bitcoin gui`, `bitcoin node`, and `bitcoin rpc` exposing different functionality. Subcommands can be listed with `bitcoin help`.
The `avian` command supports subcommands like `avian gui`, `avian node`, and `avian rpc` exposing different functionality. Subcommands can be listed with `avian help`.

### Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.
Unpack the files into a directory, and then run avian-qt.exe.

### macOS

Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.
Drag Avian Core to your applications folder, and then run Avian Core.

### Need Help?

* See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
for help and more information.
* Ask for help on [Bitcoin StackExchange](https://bitcoin.stackexchange.com).
* Ask for help on #bitcoin on Libera Chat. If you don't have an IRC client, you can use [web.libera.chat](https://web.libera.chat/#bitcoin).
* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0).
* See the documentation on [GitHub](https://github.com/AvianNetwork/Avian) for help and more information.
* Ask for help on the [Avian Network Discord](https://discord.gg/aviannetwork).

Building
---------------------
The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
The following are developer notes on how to build Avian Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

- [Dependencies](dependencies.md)
- [macOS Build Notes](build-osx.md)
Expand All @@ -51,12 +48,12 @@ The following are developer notes on how to build Bitcoin Core on your native pl

Development
---------------------
The Bitcoin repo's [root README](/README.md) contains relevant information on the development process and automated testing.
The Avian repo's [root README](/README.md) contains relevant information on the development process and automated testing.

- [Developer Notes](developer-notes.md)
- [Productivity Notes](productivity.md)
- [Release Process](release-process.md)
- [Source Code Documentation (External Link)](https://doxygen.bitcoincore.org/)
- [Source Code Documentation (External Link)](https://doxygen.bitcoincore.org/) (upstream Bitcoin Core)
- [Translation Process](translation_process.md)
- [Translation Strings Policy](translation_strings_policy.md)
- [JSON-RPC Interface](JSON-RPC-interface.md)
Expand All @@ -67,12 +64,12 @@ The Bitcoin repo's [root README](/README.md) contains relevant information on th
- [Internal Design Docs](design/)

### Resources
* Discuss on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Development & Technical Discussion board](https://bitcointalk.org/index.php?board=6.0).
* Discuss project-specific development on #bitcoin-core-dev on Libera Chat. If you don't have an IRC client, you can use [web.libera.chat](https://web.libera.chat/#bitcoin-core-dev).
* Discuss on the [Avian Network Discord](https://discord.gg/aviannetwork).
* Open issues on [GitHub](https://github.com/AvianNetwork/Avian/issues).

### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [bitcoin.conf Configuration File](bitcoin-conf.md)
- [avian.conf Configuration File](bitcoin-conf.md)
- [CJDNS Support](cjdns.md)
- [Files](files.md)
- [Fuzz-testing](fuzzing.md)
Expand Down
2 changes: 1 addition & 1 deletion doc/REST-interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,4 +153,4 @@ Refer to the `getrawmempool` RPC help for details. Defaults to setting

Risks
-------------
Running a web browser on the same node with a REST enabled bitcoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:7896/rest/tx/1234567890.json">` which might break the nodes privacy.
Running a web browser on the same node with a REST enabled aviand can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:7896/rest/tx/1234567890.json">` which might break the nodes privacy.
6 changes: 3 additions & 3 deletions doc/assumeutxo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Assumeutxo Usage

Assumeutxo is a feature that allows fast bootstrapping of a validating bitcoind
Assumeutxo is a feature that allows fast bootstrapping of a validating aviand
instance.

For notes on the design of Assumeutxo, please refer to [the design doc](/doc/design/assumeutxo.md).
Expand All @@ -17,7 +17,7 @@ Once you've obtained the snapshot, you can use the RPC command `loadtxoutset` to
load it.

```
$ bitcoin-cli -rpcclienttimeout=0 loadtxoutset /path/to/input
$ avian-cli -rpcclienttimeout=0 loadtxoutset /path/to/input
```

After the snapshot has loaded, the syncing process of both the snapshot chain
Expand Down Expand Up @@ -69,7 +69,7 @@ comparing the hash.
Example usage:

```
$ bitcoin-cli -rpcclienttimeout=0 dumptxoutset /path/to/output rollback
$ avian-cli -rpcclienttimeout=0 dumptxoutset /path/to/output rollback
```

For most of the duration of `dumptxoutset` running the node is in a temporary
Expand Down
26 changes: 13 additions & 13 deletions doc/bitcoin-conf.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# `bitcoin.conf` Configuration File
# `avian.conf` Configuration File

The configuration file is used by `bitcoind`, `bitcoin-qt` and `bitcoin-cli`.
The configuration file is used by `aviand`, `avian-qt` and `avian-cli`.

All command-line options (except for `-?`, `-help`, `-version` and `-conf`) may be specified in a configuration file, and all configuration file options (except for `includeconf`) may also be specified on the command line. Command-line options override values set in the configuration file and configuration file options override values set in the GUI.

Changes to the configuration file while `bitcoind` or `bitcoin-qt` is running only take effect after restarting.
Changes to the configuration file while `aviand` or `avian-qt` is running only take effect after restarting.

Users should never make any configuration changes which they do not understand. Furthermore, users should always be wary of accepting any configuration changes provided to them by another source (even if they believe that they do understand them).

## Configuration File Precedence

Options specified in the configuration file can be overridden by options in the [`settings.json` file](files.md) and by options specified on the command line.

The `settings.json` file contains dynamic settings that are set by the Bitcoin Core GUI and RPCs at runtime, and augment or replace the static settings specified in the `bitcoin.conf` file.
The `settings.json` file contains dynamic settings that are set by the Avian Core GUI and RPCs at runtime, and augment or replace the static settings specified in the `avian.conf` file.

Command line options also augment or replace `bitcoin.conf` options, and can be useful for scripting and debugging.
Command line options also augment or replace `avian.conf` options, and can be useful for scripting and debugging.

It is possible to see which setting values are in use by checking `debug.log` output. Any unrecognized options that are found in `bitcoin.conf` also show up as warnings in `debug.log` output.
It is possible to see which setting values are in use by checking `debug.log` output. Any unrecognized options that are found in `avian.conf` also show up as warnings in `debug.log` output.

## Configuration File Format

Expand Down Expand Up @@ -69,24 +69,24 @@ However, there are exceptions to this general rule. For example, it is an error

## Configuration File Path

The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `bitcoin.conf` and it is located in the Bitcoin data directory, but both the Bitcoin data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.
The configuration file is not automatically created; you can create it using your favorite text editor. By default, the configuration file name is `avian.conf` and it is located in the Avian data directory, but both the Avian data directory and the configuration file path may be changed using the `-datadir` and `-conf` command-line options.

The `includeconf=<file>` option in the `bitcoin.conf` file can be used to include additional configuration files.
The `includeconf=<file>` option in the `avian.conf` file can be used to include additional configuration files.

### Default configuration file locations

Operating System | Data Directory | Example Path
-- | -- | --
Windows | `%LOCALAPPDATA%\Bitcoin\` | `C:\Users\username\AppData\Local\Bitcoin\bitcoin.conf`
Linux | `$HOME/.bitcoin/` | `/home/username/.bitcoin/bitcoin.conf`
macOS | `$HOME/Library/Application Support/Bitcoin/` | `/Users/username/Library/Application Support/Bitcoin/bitcoin.conf`
Windows | `%LOCALAPPDATA%\AvianV5\` | `C:\Users\username\AppData\Local\AvianV5\avian.conf`
Linux | `$HOME/.avianv5/` | `/home/username/.avianv5/avian.conf`
macOS | `$HOME/Library/Application Support/AvianV5/` | `/Users/username/Library/Application Support/AvianV5/avian.conf`

An example configuration file can be generated by [contrib/devtools/gen-avian-conf.sh](../contrib/devtools/gen-avian-conf.sh).
Run this script after compiling to generate an up-to-date configuration file.
The output is placed under `share/examples/bitcoin.conf`.
The output is placed under `share/examples/avian.conf`.
To use the generated configuration file, copy the example file into your data directory and edit it there, like so:

```
# example copy command for linux user
cp share/examples/bitcoin.conf ~/.bitcoin
cp share/examples/avian.conf ~/.avianv5
```
2 changes: 1 addition & 1 deletion doc/build-freebsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Updated for FreeBSD [14.3](https://www.freebsd.org/releases/14.3R/announce/)**

This guide describes how to build bitcoind, command-line utilities, and GUI on FreeBSD.
This guide describes how to build aviand, command-line utilities, and GUI on FreeBSD.

## Preparation

Expand Down
2 changes: 1 addition & 1 deletion doc/build-netbsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Updated for NetBSD [10.1](https://netbsd.org/releases/formal-10/NetBSD-10.1.html)**

This guide describes how to build bitcoind, command-line utilities, and GUI on NetBSD.
This guide describes how to build aviand, command-line utilities, and GUI on NetBSD.

## Preparation

Expand Down
2 changes: 1 addition & 1 deletion doc/build-openbsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Updated for OpenBSD [7.8](https://www.openbsd.org/78.html)**

This guide describes how to build bitcoind, command-line utilities, and GUI on OpenBSD.
This guide describes how to build aviand, command-line utilities, and GUI on OpenBSD.

## Preparation

Expand Down
34 changes: 17 additions & 17 deletions doc/build-osx.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Updated for MacOS [15](https://www.apple.com/macos/macos-sequoia/)**

This guide describes how to build bitcoind, command-line utilities, and GUI on macOS.
This guide describes how to build aviand, command-line utilities, and GUI on macOS.

## Preparation

Expand Down Expand Up @@ -181,45 +181,45 @@ You can also create a `.zip` containing the `.app` bundle by running the follow
cmake --build build --target deploy
```

## Running Bitcoin Core
## Running Avian Core

Bitcoin Core should now be available at `./build/bin/bitcoind`.
If you compiled support for the GUI, it should be available at `./build/bin/bitcoin-qt`.
Avian Core should now be available at `./build/bin/aviand`.
If you compiled support for the GUI, it should be available at `./build/bin/avian-qt`.

There is also a multifunction command line interface at `./build/bin/bitcoin`
supporting subcommands like `bitcoin node`, `bitcoin gui`, `bitcoin rpc`, and
others that can be listed with `bitcoin help`.
There is also a multifunction command line interface at `./build/bin/avian`
supporting subcommands like `avian node`, `avian gui`, `avian rpc`, and
others that can be listed with `avian help`.

The first time you run `bitcoind` or `bitcoin-qt`, it will start downloading the blockchain.
The first time you run `aviand` or `avian-qt`, it will start downloading the blockchain.
This process could take many hours, or even days on slower than average systems.

By default, blockchain and wallet data files will be stored in:

``` bash
/Users/${USER}/Library/Application Support/Bitcoin/
/Users/${USER}/Library/Application Support/AvianV5/
```

Before running, you may create an empty configuration file:

```shell
mkdir -p "/Users/${USER}/Library/Application Support/Bitcoin"
mkdir -p "/Users/${USER}/Library/Application Support/AvianV5"

touch "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
touch "/Users/${USER}/Library/Application Support/AvianV5/avian.conf"

chmod 600 "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
chmod 600 "/Users/${USER}/Library/Application Support/AvianV5/avian.conf"
```

You can monitor the download process by looking at the debug.log file:

```shell
tail -f $HOME/Library/Application\ Support/Bitcoin/debug.log
tail -f $HOME/Library/Application\ Support/AvianV5/debug.log
```

## Other commands:

```shell
./build/bin/bitcoind -daemon # Starts the bitcoin daemon.
./build/bin/bitcoin-cli --help # Outputs a list of command-line options.
./build/bin/bitcoin-cli help # Outputs a list of RPC commands when the daemon is running.
./build/bin/bitcoin-qt -server # Starts the bitcoin-qt server mode, allows bitcoin-cli control
./build/bin/aviand -daemon # Starts the Avian daemon.
./build/bin/avian-cli --help # Outputs a list of command-line options.
./build/bin/avian-cli help # Outputs a list of RPC commands when the daemon is running.
./build/bin/avian-qt -server # Starts the avian-qt server mode, allows avian-cli control
```
8 changes: 4 additions & 4 deletions doc/build-unix.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,11 +218,11 @@ Setup and Build Example: Arch Linux
This example lists the steps necessary to setup and build a command line only distribution of the latest changes on Arch Linux:

pacman --sync --needed capnproto cmake boost gcc git libevent make python sqlite
git clone https://github.com/bitcoin/bitcoin.git
cd bitcoin/
git clone https://github.com/AvianNetwork/Avian.git
cd Avian/
cmake -B build
cmake --build build
ctest --test-dir build
./build/bin/bitcoind
./build/bin/bitcoin help
./build/bin/aviand
./build/bin/avian help

2 changes: 1 addition & 1 deletion doc/build-windows-msvc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Windows / MSVC Build Guide

This guide describes how to build bitcoind, command-line utilities, and GUI on Windows using Microsoft Visual Studio.
This guide describes how to build aviand, command-line utilities, and GUI on Windows using Microsoft Visual Studio.

For cross-compiling options, please see [`build-windows.md`](./build-windows.md).

Expand Down
10 changes: 5 additions & 5 deletions doc/cjdns.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ connections are not affected by this option. It can be specified multiple times
to allow multiple networks, e.g. onlynet=cjdns, onlynet=i2p, onlynet=onion.

CJDNS support was added to Bitcoin Core in version 23.0 and there may be fewer
CJDNS peers than Tor or IP ones. You can use `bitcoin-cli -addrinfo` to see the
CJDNS peers than Tor or IP ones. You can use `avian-cli -addrinfo` to see the
number of CJDNS addresses known to your node.

In general, a node can be run with both an onion service and CJDNS (or any/all
Expand All @@ -109,9 +109,9 @@ There are several ways to see your CJDNS address in Bitcoin Core:
- in the "Local addresses" output of CLI `-netinfo`
- in the "localaddresses" output of RPC `getnetworkinfo`

To see which CJDNS peers your node is connected to, use `bitcoin-cli -netinfo 4`
or the `getpeerinfo` RPC (i.e. `bitcoin-cli getpeerinfo`).
To see which CJDNS peers your node is connected to, use `avian-cli -netinfo 4`
or the `getpeerinfo` RPC (i.e. `avian-cli getpeerinfo`).

You can use the `getnodeaddresses` RPC to fetch a number of CJDNS peers known to your node; run `bitcoin-cli help getnodeaddresses` for details.
You can use the `getnodeaddresses` RPC to fetch a number of CJDNS peers known to your node; run `avian-cli help getnodeaddresses` for details.

`bitcoin rpc` can also be substituted for `bitcoin-cli`.
`avian rpc` can also be substituted for `avian-cli`.
Loading
Loading