diff --git a/doc/JSON-RPC-interface.md b/doc/JSON-RPC-interface.md index 65dea7c5c..21bd5e765 100644 --- a/doc/JSON-RPC-interface.md +++ b/doc/JSON-RPC-interface.md @@ -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. @@ -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//` endpoint for ALL requests when multiple wallets are in use. @@ -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 @@ -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 diff --git a/doc/README.md b/doc/README.md index 0959c6c7f..39e58b05f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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 --------------------- @@ -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) @@ -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) @@ -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) diff --git a/doc/REST-interface.md b/doc/REST-interface.md index f10b8e990..f7d23b4ae 100644 --- a/doc/REST-interface.md +++ b/doc/REST-interface.md @@ -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 `