aquachain

package module
v1.7.15 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 30, 2022 License: GPL-3.0 Imports: 5 Imported by: 0

README

Aquachain

Latest Source: https://gitlab.com/aquachain/aquachain

Mirrored: https://github.com/aquachain/aquachain

Old: https://github.com/aquanetwork/aquachain

Improve the Wiki! https://gitlab.com/aquachain/aquachain/-/wikis/Basics

** Found a bug in this software? Documentation lacking? See https://gitlab.com/aquachain/aquachain/wikis/bugs **

See bottom of this document for more useful links. Your contributions are welcome.

General Purpose Distributed Computing

Aquachain: peer-to-peer programmable money, distributed code contract platform.

Target Block Time: 240 second blocks (4 minute)
Block Reward: 1 AQUA
Max Supply: 42 million
Algorithm: argon2id (CPU mined)
ChainID/NetworkID: 61717561
Known Explorers:
Known GUI Wallets:

GET AQUACHAIN

The aquachain command (full node, RPC server, and wallet) is a portable program that doesn't really need an 'installer', you can run it from anywhere. When you first start aquachain you will connect to the peer-to-peer network and start downloading the chain. To change the way aquachain runs, for example testnet, or rpc, use command line flags. (see Usage section)

You should keep backups your keystore files, and regularly check unlocking them. If not using keys, for example an RPC server, use the -nokeys flag.

List all command line flags using the -h flag, or aquachain help [subcommand]

GUI Wallets connect to RPC nodes and offer an easy-to-use interface. Hosting your own RPC server helps you stay more secure and has zero downtime.

COMPILING

Requires Go.

Linux, BSD, Mac OS

If you are reading this from the source tree, you can simply use make, or make all for all tools.

Programs are built to the ./bin/ directory.

Windows

On windows, double-click make.bat to compile aquachain.exe onto your Desktop.

** Patches can be submitted at Github or Gitlab or Mailing List **

To build latest with go, simply use 'go get' and look in $GOPATH/bin:

CGO_ENABLED=0 go get -v -u gitlab.com/aquachain/aquachain/cmd/aquachain

or all tools:

GOBIN=$PWD CGO_ENABLED=0 go get -v gitlab.com/aquachain/aquachain/cmd/...

To see latest release, check git log or:

SYNCHRONIZING

"Imported new chain segment" means you received new blocks from the network. When a single block is imported, the address of the successful miner is printed. When you start seeing one every 4 minutes or so, you know that you are fully synchronized with the network.

USAGE

Create account from the command line: aquachain.exe account new

List accounts from the command line: aquachain.exe account list

Enter AQUA javascript console: aquachain.exe

Start Daemon (geth default): aquachain.exe daemon

See more commands: Wiki

Type help at the AQUA> prompt for common AQUA console commands.

Run aquachain.exe help for command line flags and options.

RPC SERVER

See "RPC" section in ./Documentation folder and online at: https://gitlab.com/aquachain/aquachain/wikis/RPC

Start HTTP JSON/RPC server for local (127.0.0.1) connections only: aquachain -rpc

Start HTTP JSON/RPC server for remote connections, listening on 192.168.1.5:8543, able to be accessed only by 192.168.1.6:

aquachain -rpc -rpchost 192.168.1.5 -allowip 192.168.1.6/32

With no other RPC flags, the -rpc flag alone is safe for local usage (from the same machine).

Security Note about RPC: Please be aware that hosting a public RPC server (0.0.0.0) will allow strangers access to your system. Do not use the -rpcaddr flag unless you absolutely know what you are doing. Consider using a random RPC port, instead of the default 8543.

For hosting public RPC servers, please consider using -nokeys (new!) and implementing rate limiting on http (and, if using, websockets) , either via reverse proxy such as caddyserver or nginx, or firewall.

Recent builds of aquachain include support for the -allowip flag. It is by default, set to 127.0.0.1, which doesn't allow any LAN or WAN addresses access to your RPC methods.

To add IPs, use aquachain -rpc -rpchost 192.168.1.4 -allowip 192.168.1.5/32,192.168.2.30/32

The CIDR networks are comma separated, no spaces. (the /32 after an IP means 'one IP')

RPC Clients

The JSON/RPC server is able to be used with "Web3" libraries for languages such as Python or Javascript.

For compatibility with existing tools, all calls to eth_ methods are translated to aqua_, behind-the-scenes.

Go packages for creating applications that use Aquachain can be found in this repository, under the opt/aquaclient and rpc/rpcclient namespaces. See each package's documentation (godoc) for more information on usage.

Resources

About - https://telegra.ph/Aquachain-AQUA---Decentralized-Processing-07-20

Mining - https://telegra.ph/Mining-AQUA-05-27

Wiki - https://gitlab.com/aquachain/aquachain/wikis

Website - https://aquachain.github.io

ANN - https://bitcointalk.org/index.php?topic=3138231.0

Explorer - https://aquachain.github.io/explorer/

Gitlab - http://gitlab.com/aquachain/aquachain

Github - http://github.com/aquachain

Telegram News: https://t.me/Aquachain

Godoc - https://godoc.org/gitlab.com/aquachain/aquachain#pkg-subdirectories

Report bugs - https://github.com/aquachain/aquachain/issues

Telegram Chat: https://t.me/AquaCrypto

Discord: https://discordapp.com/invite/J7jBhZf

IRC: #aquachain on freenode

Bugs: https://gitlab.com/aquachain/aquachain/wikis/bugs

Contributing

Aquachain is free open source software and your contributions are welcome.

Some tips and tricks for hacking on Aquachain core:
  • Always gofmt -w -l -s before commiting. If you forget, adding a simple 'gofmt -w -l -s' commit works.
  • Before making a merge request, try make test to run all tests. If any tests pass, the PR can not be merged into the master branch.
  • Rebase: Don't git pull to update your branch. instead, from your branch, type git rebase -i master and resolve any conflicts (do this often and there wont be any!)
  • Prefix commit message with package name, such as "core: fix blockchain"

Documentation

Overview

Package aquachain defines interfaces for interacting with Aquachain.

Index

Constants

View Source 
  __ _  __ _ _   _  __ _  ___| |__   __ _(_)_ __
 / _ '|/ _' | | | |/ _' |/ __| '_ \ / _' | | '_ \
| (_| | (_| | |_| | (_| | (__| | | | (_| | | | | |
 \__,_|\__, |\__,_|\__,_|\___|_| |_|\__,_|_|_| |_|
          |_|` + "Update Often! https://gitlab.com/aquachain/aquachain\n\n"

Variables

View Source 
var NotFound = errors.New("not found")

NotFound is returned by API methods if the requested item does not exist.

Functions

This section is empty.

Types

type CallMsg 

type CallMsg struct {
	From     common.Address  // the sender of the 'transaction'
	To       *common.Address // the destination contract (nil for contract creation)
	Gas      uint64          // if 0, the call executes with near-infinite gas
	GasPrice *big.Int        // wei <-> gas exchange ratio
	Value    *big.Int        // amount of wei sent along with the call
	Data     []byte          // input data, usually an ABI-encoded contract method invocation
}

CallMsg contains parameters for contract calls.

type ChainReader 

type ChainReader interface {
	BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
	BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
	HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
	HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
	TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error)
	TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error)

	// This method subscribes to notifications about changes of the head block of
	// the canonical chain.
	SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (Subscription, error)
}

ChainReader provides access to the blockchain. The methods in this interface access raw data from either the canonical chain (when requesting by block number) or any blockchain fork that was previously downloaded and processed by the node. The block number argument can be nil to select the latest canonical block. Reading block headers should be preferred over full blocks whenever possible.

The returned error is NotFound if the requested item does not exist.

type ChainStateReader 

type ChainStateReader interface {
	BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error)
	StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error)
	CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error)
	NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
}

ChainStateReader wraps access to the state trie of the canonical blockchain. Note that implementations of the interface may be unable to return state values for old blocks. In many cases, using CallContract can be preferable to reading raw contract storage.

type ChainSyncReader 

type ChainSyncReader interface {
	SyncProgress(ctx context.Context) (*SyncProgress, error)
}

ChainSyncReader wraps access to the node's current sync status. If there's no sync currently running, it returns nil.

type ContractCaller 

type ContractCaller interface {
	CallContract(ctx context.Context, call CallMsg, blockNumber *big.Int) ([]byte, error)
}

A ContractCaller provides contract calls, essentially transactions that are executed by the EVM but not mined into the blockchain. ContractCall is a low-level method to execute such calls. For applications which are structured around specific contracts, the abigen tool provides a nicer, properly typed way to perform calls.

type FilterQuery 

type FilterQuery struct {
	FromBlock *big.Int         // beginning of the queried range, nil means genesis block
	ToBlock   *big.Int         // end of the range, nil means latest block
	Addresses []common.Address // restricts matches to events created by specific contracts

	// The Topic list restricts matches to particular event topics. Each event has a list
	// of topics. Topics matches a prefix of that list. An empty element slice matches any
	// topic. Non-empty elements represent an alternative that matches any of the
	// contained topics.
	//
	// Examples:
	// {} or nil          matches any topic list
	// {{A}}              matches topic A in first position
	// {{}, {B}}          matches any topic in first position, B in second position
	// {{A}}, {B}}        matches topic A in first position, B in second position
	// {{A, B}}, {C, D}}  matches topic (A OR B) in first position, (C OR D) in second position
	Topics [][]common.Hash
}

FilterQuery contains options for contract log filtering.

type GasEstimator 

type GasEstimator interface {
	EstimateGas(ctx context.Context, call CallMsg) (uint64, error)
}

GasEstimator wraps EstimateGas, which tries to estimate the gas needed to execute a specific transaction based on the pending state. There is no guarantee that this is the true gas limit requirement as other transactions may be added or removed by miners, but it should provide a basis for setting a reasonable default.

type GasPricer 

type GasPricer interface {
	SuggestGasPrice(ctx context.Context) (*big.Int, error)
}

GasPricer wraps the gas price oracle, which monitors the blockchain to determine the optimal gas price given current fee market conditions.

type LogFilterer 

type LogFilterer interface {
	FilterLogs(ctx context.Context, q FilterQuery) ([]types.Log, error)
	SubscribeFilterLogs(ctx context.Context, q FilterQuery, ch chan<- types.Log) (Subscription, error)
}

LogFilterer provides access to contract log events using a one-off query or continuous event subscription.

Logs received through a streaming query subscription may have Removed set to true, indicating that the log was reverted due to a chain reorganisation.

type PendingContractCaller 

type PendingContractCaller interface {
	PendingCallContract(ctx context.Context, call CallMsg) ([]byte, error)
}

PendingContractCaller can be used to perform calls against the pending state.

type PendingStateEventer 

type PendingStateEventer interface {
	SubscribePendingTransactions(ctx context.Context, ch chan<- *types.Transaction) (Subscription, error)
}

A PendingStateEventer provides access to real time notifications about changes to the pending state.

type PendingStateReader 

type PendingStateReader interface {
	PendingBalance(ctx context.Context, account common.Address) (*big.Int, error)
	PendingStorage(ctx context.Context, account common.Address, key common.Hash) ([]byte, error)
	PendingCode(ctx context.Context, account common.Address) ([]byte, error)
	PendingNonce(ctx context.Context, account common.Address) (uint64, error)
	PendingTransactionCount(ctx context.Context) (uint, error)
}

A PendingStateReader provides access to the pending state, which is the result of all known executable transactions which have not yet been included in the blockchain. It is commonly used to display the result of ’unconfirmed’ actions (e.g. wallet value transfers) initiated by the user. The PendingNonceAt operation is a good way to retrieve the next available transaction nonce for a specific account.

type Subscription 

type Subscription interface {
	// Unsubscribe cancels the sending of events to the data channel
	// and closes the error channel.
	Unsubscribe()
	// Err returns the subscription error channel. The error channel receives
	// a value if there is an issue with the subscription (e.g. the network connection
	// delivering the events has been closed). Only one value will ever be sent.
	// The error channel is closed by Unsubscribe.
	Err() <-chan error
}

Subscription represents an event subscription where events are delivered on a data channel.

type SyncProgress 

type SyncProgress struct {
	StartingBlock uint64 // Block number where sync began
	CurrentBlock  uint64 // Current block number where sync is at
	HighestBlock  uint64 // Highest alleged block number in the chain
	PulledStates  uint64 // Number of state trie entries already downloaded
	KnownStates   uint64 // Total number of state trie entries known about
}

SyncProgress gives progress indications when the node is synchronising with the Aquachain network.

type TransactionReader 

type TransactionReader interface {
	// TransactionByHash checks the pool of pending transactions in addition to the
	// blockchain. The isPending return value indicates whether the transaction has been
	// mined yet. Note that the transaction may not be part of the canonical chain even if
	// it's not pending.
	TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, isPending bool, err error)
	// TransactionReceipt returns the receipt of a mined transaction. Note that the
	// transaction may not be included in the current canonical chain even if a receipt
	// exists.
	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
}

TransactionReader provides access to past transactions and their receipts. Implementations may impose arbitrary restrictions on the transactions and receipts that can be retrieved. Historic transactions may not be available.

Avoid relying on this interface if possible. Contract logs (through the LogFilterer interface) are more reliable and usually safer in the presence of chain reorganisations.

The returned error is NotFound if the requested item does not exist.

type TransactionSender 

type TransactionSender interface {
	SendTransaction(ctx context.Context, tx *types.Transaction) error
}

TransactionSender wraps transaction sending. The SendTransaction method injects a signed transaction into the pending transaction pool for execution. If the transaction was a contract creation, the TransactionReceipt method can be used to retrieve the contract address after the transaction has been mined.

The transaction must be signed and have a valid nonce to be included. Consumers of the API can use package accounts to maintain local private keys and need can retrieve the next available nonce using PendingNonceAt.

Source Files

View all Source files

Directories

Path Synopsis
Package aqua implements the Aquachain protocol.
 Package aqua implements the Aquachain protocol.
accounts
Package accounts implements high level Aquachain account management.
 Package accounts implements high level Aquachain account management.
accounts/abi
Package abi implements the Aquachain ABI (Application Binary Interface).
 Package abi implements the Aquachain ABI (Application Binary Interface).
accounts/abi/bind
Package bind generates Aquachain contract Go bindings.
 Package bind generates Aquachain contract Go bindings.
accounts/abi/bind/backends
accounts/keystore
Package keystore implements encrypted storage of secp256k1 private keys.
 Package keystore implements encrypted storage of secp256k1 private keys.
accounts/usbwallet
accounts/usbwallet/internal/trezor
Package trezor contains the wire protocol wrapper in Go.
 Package trezor contains the wire protocol wrapper in Go.
downloader
Package downloader contains the manual full chain synchronisation.
 Package downloader contains the manual full chain synchronisation.
event
Package event deals with subscriptions to real-time events.
 Package event deals with subscriptions to real-time events.
event/filter
Package filter implements event filters.
 Package filter implements event filters.
fetcher
Package fetcher contains the block announcement based synchronisation.
 Package fetcher contains the block announcement based synchronisation.
filters
Package filters implements an aquachain filtering system for block, transactions and log events.
 Package filters implements an aquachain filtering system for block, transactions and log events.
gasprice
tracers
Package tracers is a collection of JavaScript transaction tracers.
 Package tracers is a collection of JavaScript transaction tracers.
tracers/internal/tracers
Package tracers contains the actual JavaScript tracer assets.
 Package tracers contains the actual JavaScript tracer assets.
cmd
aquabootnode
bootnode runs a bootstrap node for the Aquachain Discovery Protocol.
 bootnode runs a bootstrap node for the Aquachain Discovery Protocol.
aquachain
aquachain is the official command-line client for Aquachain.
 aquachain is the official command-line client for Aquachain.
aquaminer
aquaminer command is a aquachain reference miner
 aquaminer command is a aquachain reference miner
aquapaper
paper command is meant to be easily auditable and can safely generate offline wallets
 paper command is meant to be easily auditable and can safely generate offline wallets
aquastrat
attacher
aquachain is the official command-line client for Aquachain.
 aquachain is the official command-line client for Aquachain.
internal/browser
Package browser provides utilities for interacting with users' browsers.
 Package browser provides utilities for interacting with users' browsers.
utils
Package utils contains internal helper functions for aquachain commands.
 Package utils contains internal helper functions for aquachain commands.
Package common contains various helper functions.
 Package common contains various helper functions.
bitutil
Package bitutil implements fast bitwise operations.
 Package bitutil implements fast bitwise operations.
compiler
Package compiler wraps the Solidity compiler executable (solc).
 Package compiler wraps the Solidity compiler executable (solc).
fdlimit
hexutil
Package hexutil implements hex encoding with 0x prefix.
 Package hexutil implements hex encoding with 0x prefix.
log
Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
 Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
log/term
math
Package math provides integer math utilities.
 Package math provides integer math utilities.
mclock
package mclock is a wrapper for a monotonic clock source
 package mclock is a wrapper for a monotonic clock source
mclock/internal/monotime
Package monotime provides a fast monotonic clock source.
 Package monotime provides a fast monotonic clock source.
metrics
metrics/exp
metrics/librato
number
prque
Package consensus implements different Aquachain consensus engines.
 Package consensus implements different Aquachain consensus engines.
aquahash
Package aquahash implements the aquahash proof-of-work consensus engine.
 Package aquahash implements the aquahash proof-of-work consensus engine.
lightvalid
The lightvalid package is a lightweight version of aquahash meant only for testing a nonce on a *trusted* block.
 The lightvalid package is a lightweight version of aquahash meant only for testing a nonce on a *trusted* block.
misc
Package core implements the Aquachain consensus protocol.
 Package core implements the Aquachain consensus protocol.
asm
Provides support for dealing with EVM assembly instructions (e.g., disassembling them).
 Provides support for dealing with EVM assembly instructions (e.g., disassembling them).
bloombits
Package bloombits implements bloom filtering on batches of data.
 Package bloombits implements bloom filtering on batches of data.
state
Package state provides a caching layer atop the Aquachain state trie.
 Package state provides a caching layer atop the Aquachain state trie.
types
Package types contains data types related to Aquachain consensus.
 Package types contains data types related to Aquachain consensus.
vm
Package vm implements the Aquachain Virtual Machine.
 Package vm implements the Aquachain Virtual Machine.
vm/runtime
Package runtime provides a basic execution model for executing EVM code.
 Package runtime provides a basic execution model for executing EVM code.
bn256
Package bn256 implements the Optimal Ate pairing over a 256-bit Barreto-Naehrig curve.
 Package bn256 implements the Optimal Ate pairing over a 256-bit Barreto-Naehrig curve.
bn256/cloudflare
Package bn256 implements a particular bilinear group at the 128-bit security level.
 Package bn256 implements a particular bilinear group at the 128-bit security level.
bn256/google
Package bn256 implements a particular bilinear group.
 Package bn256 implements a particular bilinear group.
ecies
mnemonics
randentropy
sha3
Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length hash functions defined by FIPS-202.
 Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length hash functions defined by FIPS-202.
internal
aquaapi
Package aquaapi implements the general Aquachain API functions.
 Package aquaapi implements the general Aquachain API functions.
build
cmdtest
debug
Package debug interfaces Go runtime debugging facilities.
 Package debug interfaces Go runtime debugging facilities.
flock
Package flock provides portable file locking.
 Package flock provides portable file locking.
guide
Package guide is a small test suite to ensure snippets in the dev guide work.
 Package guide is a small test suite to ensure snippets in the dev guide work.
jsre
Package jsre provides execution environment for JavaScript.
 Package jsre provides execution environment for JavaScript.
jsre/deps
Package deps contains the console JavaScript dependencies Go embedded.
 Package deps contains the console JavaScript dependencies Go embedded.
web3ext
package web3ext contains aquachain specific web3.js extensions.
 package web3ext contains aquachain specific web3.js extensions.
Package node sets up multi-protocol Aquachain nodes.
 Package node sets up multi-protocol Aquachain nodes.
opt
aquaclient
Package aquaclient provides a client for the Aquachain RPC API.
 Package aquaclient provides a client for the Aquachain RPC API.
aquastats
Package aquastats implements the network stats reporting service.
 Package aquastats implements the network stats reporting service.
bmt
Package bmt provides a binary merkle tree implementation
 Package bmt provides a binary merkle tree implementation
compression/rle
Package rle implements the run-length encoding used for Aquachain data.
 Package rle implements the run-length encoding used for Aquachain data.
console
contracts/chequebook
Package chequebook package wraps the 'chequebook' Ethereum smart contract.
 Package chequebook package wraps the 'chequebook' Ethereum smart contract.
contracts/chequebook/contract
contracts/ens
contracts/ens/contract
miner
Package miner implements Aquachain block creation and mining.
 Package miner implements Aquachain block creation and mining.
reexec
swap
swap/swap
tests
Package tests implements execution of Aquachain JSON tests.
 Package tests implements execution of Aquachain JSON tests.
p2p
Package p2p implements the Aquachain p2p network protocols.
 Package p2p implements the Aquachain p2p network protocols.
discover
Package discover implements the Node Discovery Protocol.
 Package discover implements the Node Discovery Protocol.
enr
Package enr implements Aquachain Node Records as defined in EIP-778.
 Package enr implements Aquachain Node Records as defined in EIP-778.
nat
Package nat provides access to common network port mapping protocols.
 Package nat provides access to common network port mapping protocols.
netutil
Package netutil contains extensions to the net package.
 Package netutil contains extensions to the net package.
protocols
Package protocols is an extension to p2p.
 Package protocols is an extension to p2p.
simulations
Package simulations simulates p2p networks.
 Package simulations simulates p2p networks.
simulations/adapters
simulations/examples
testing
Package rlp implements the RLP serialization format.
 Package rlp implements the RLP serialization format.
rpc
Package rpc provides access to the exported methods of an object across a network or other I/O connection.
 Package rpc provides access to the exported methods of an object across a network or other I/O connection.
rpcclient
Package trie implements Merkle Patricia Tries.
 Package trie implements Merkle Patricia Tries.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.