README
¶
Aurora Filesystem
DISCLAIMER
This software is provided to you "as is", use at your own risk and without warranties of any kind. It is your responsibility to read and understand how Aurora works and the implications of running this software. The usage of Aurorafs involves various risks, including, but not limited to: damage to hardware or loss of funds associated with the Ethereum account connected to your node. No developers or entity involved will be liable for any claims and damages associated with your use, inability to use, or your interaction with other nodes or the software.
Our documentation is hosted at https://docs.aufs.io .
Contributing
Please read the coding guidelines.
Installing
Get in touch
License
This library is distributed under the BSD-style license found in the LICENSE file.
Documentation
¶
Overview ¶
Package aurorafs is the root package of Ethereum Aurora node implementation.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( Version = func() string { if commitHash != "" { return version + "-" + commitHash } return version + "-dev" }() // CommitTime returns the time of the commit from which this code was derived. // If it's not set (in the case of running the code directly without compilation) // then the current time will be returned. CommitTime = func() string { if commitTime == "" { commitTime = strconv.Itoa(int(time.Now().Unix())) } return commitTime } )
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
accounting
Package accounting provides functionalities needed to do per-peer accounting.
|
Package accounting provides functionalities needed to do per-peer accounting. |
|
accounting/mock
Package mock provides a mock implementation for the accounting interface.
|
Package mock provides a mock implementation for the accounting interface. |
|
addressbook
Package addressbook provides persisted mapping between overlay (topology) address and aurora.Address address, which contains underlay (physical) address.
|
Package addressbook provides persisted mapping between overlay (topology) address and aurora.Address address, which contains underlay (physical) address. |
|
api
Package api provides the functionality of the aurora client-facing HTTP API.
|
Package api provides the functionality of the aurora client-facing HTTP API. |
|
aurora
Package aurora exposes the data structure and operations necessary on the aurora.Address type which used in the handshake protocol, address-book and hive protocol.
|
Package aurora exposes the data structure and operations necessary on the aurora.Address type which used in the handshake protocol, address-book and hive protocol. |
|
bitvector
Package bitvector provides functionality of a simple bit vector implementation.
|
Package bitvector provides functionality of a simple bit vector implementation. |
|
bmt
Package bmt implements Binary Merkle Tree hash.
|
Package bmt implements Binary Merkle Tree hash. |
|
bmt/reference
Package reference is a simple nonconcurrent reference implementation for hashsize segment based Binary Merkle tree hash on arbitrary but fixed maximum chunksize n where 0 <= n <= 4096 This implementation does not take advantage of any paralellisms and uses far more memory than necessary, but it is easy to see that it is correct.
|
Package reference is a simple nonconcurrent reference implementation for hashsize segment based Binary Merkle tree hash on arbitrary but fixed maximum chunksize n where 0 <= n <= 4096 This implementation does not take advantage of any paralellisms and uses far more memory than necessary, but it is easy to see that it is correct. |
|
bmtpool
Package bmtpool provides easy access to binary merkle tree hashers managed in as a resource pool.
|
Package bmtpool provides easy access to binary merkle tree hashers managed in as a resource pool. |
|
boson
Package boson contains most basic and general Aurora concepts.
|
Package boson contains most basic and general Aurora concepts. |
|
chunkinfo/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
debugapi
Package debugapi exposes the debug API used to control and analyze low-level and runtime features and functionalities of Aurora.
|
Package debugapi exposes the debug API used to control and analyze low-level and runtime features and functionalities of Aurora. |
|
discovery
Package discovery exposes the discovery driver interface which is implemented by discovery protocols.
|
Package discovery exposes the discovery driver interface which is implemented by discovery protocols. |
|
encryption
Package encryption exposes functionalities needed for encryption and decryption operations in Aurora.
|
Package encryption exposes functionalities needed for encryption and decryption operations in Aurora. |
|
file
Package file provides interfaces for file-oriented operations.
|
Package file provides interfaces for file-oriented operations. |
|
file/joiner
Package joiner provides implementations of the file.Joiner interface
|
Package joiner provides implementations of the file.Joiner interface |
|
file/pipeline
Package pipeline provides functionality for hashing pipelines needed to create different flavors of merkelised representations of arbitrary data.
|
Package pipeline provides functionality for hashing pipelines needed to create different flavors of merkelised representations of arbitrary data. |
|
file/splitter
Package splitter provides implementations of the file.Splitter interface
|
Package splitter provides implementations of the file.Splitter interface |
|
hive
Package hive exposes the hive protocol implementation which is the discovery protocol used to inform and be informed about other peers in the network.
|
Package hive exposes the hive protocol implementation which is the discovery protocol used to inform and be informed about other peers in the network. |
|
hive/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
hive2/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
jsonhttp
Package jsonhttp contains utility functions that make it easier to create JSON-based HTTP APIs.
|
Package jsonhttp contains utility functions that make it easier to create JSON-based HTTP APIs. |
|
jsonhttp/jsonhttptest
Package jsonhttptest helps with end-to-end testing of JSON-based HTTP APIs.
|
Package jsonhttptest helps with end-to-end testing of JSON-based HTTP APIs. |
|
localstore
Package localstore provides disk storage layer for Aurora Chunk persistence.
|
Package localstore provides disk storage layer for Aurora Chunk persistence. |
|
logging
Package logging provides the logger interface abstraction and implementation for Aurora.
|
Package logging provides the logger interface abstraction and implementation for Aurora. |
|
manifest
Package manifest contains the abstractions needed for collection representation in Aurora.
|
Package manifest contains the abstractions needed for collection representation in Aurora. |
|
multicast/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
netstore
Package netstore provides an abstraction layer over the Aurora local storage layer that leverages connectivity with other peers in order to retrieve chunks from the network that cannot be found locally.
|
Package netstore provides an abstraction layer over the Aurora local storage layer that leverages connectivity with other peers in order to retrieve chunks from the network that cannot be found locally. |
|
node
Package node defines the concept of a Aurora node by bootstrapping and injecting all necessary dependencies.
|
Package node defines the concept of a Aurora node by bootstrapping and injecting all necessary dependencies. |
|
p2p
Package p2p provides the peer-to-peer abstractions used across different protocols in Aurora.
|
Package p2p provides the peer-to-peer abstractions used across different protocols in Aurora. |
|
p2p/libp2p/internal/handshake/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
p2p/libp2p/internal/headers/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
p2p/libp2p/internal/reacher
Package reacher runs a background worker that will ping peers from an internal queue and report back the reachability to the notifier.
|
Package reacher runs a background worker that will ping peers from an internal queue and report back the reachability to the notifier. |
|
p2p/protobuf/internal/pb
Package pb holds only Protocol Buffer definitions and generated code for testing purposes.
|
Package pb holds only Protocol Buffer definitions and generated code for testing purposes. |
|
pingpong
Package pingpong exposes the simple ping-pong protocol which measures round-trip-time with other peers.
|
Package pingpong exposes the simple ping-pong protocol which measures round-trip-time with other peers. |
|
pingpong/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
pinning
Package pinning provides a simple set of operations for tracking pinned references.
|
Package pinning provides a simple set of operations for tracking pinned references. |
|
ratelimit
Package ratelimit provides a mechanism to rate limit requests based on a string key, refill rate and burst amount.
|
Package ratelimit provides a mechanism to rate limit requests based on a string key, refill rate and burst amount. |
|
resolver
Package resolver handles name resolution for the Aurora aurorafs.
|
Package resolver handles name resolution for the Aurora aurorafs. |
|
routetab/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
rpc
Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports.
|
Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports. |
|
sctx
Package sctx provides convenience methods for context value injection and extraction.
|
Package sctx provides convenience methods for context value injection and extraction. |
|
settlement/traffic/trafficprotocol/pb
Package pb holds only Protocol Buffer definitions and generated code.
|
Package pb holds only Protocol Buffer definitions and generated code. |
|
shed
Package shed provides a simple abstraction components to compose more complex operations on storage data organized in fields and indexes.
|
Package shed provides a simple abstraction components to compose more complex operations on storage data organized in fields and indexes. |
|
soc
Package soc provides the single-owner chunk implementation and validator.
|
Package soc provides the single-owner chunk implementation and validator. |
|
statestore
Package statestore provides statestore implementation and mock.
|
Package statestore provides statestore implementation and mock. |
|
storage
Package storage provides implementation contracts and notions used across storage-aware components in aurora.
|
Package storage provides implementation contracts and notions used across storage-aware components in aurora. |
|
topology
Package topology exposes abstractions needed in topology-aware components.
|
Package topology exposes abstractions needed in topology-aware components. |
|
topology/kademlia
Package kademlia provides an implementation of the topology.Driver interface in a way that a kademlia connectivity is actively maintained by the node.
|
Package kademlia provides an implementation of the topology.Driver interface in a way that a kademlia connectivity is actively maintained by the node. |
|
topology/kademlia/internal/metrics
Package metrics provides service for collecting various metrics about peers.
|
Package metrics provides service for collecting various metrics about peers. |
|
topology/kademlia/internal/waitnext
Package waitnext Package metrics provides service for collecting various metrics about peers.
|
Package waitnext Package metrics provides service for collecting various metrics about peers. |
|
tracing
Package tracing helps with the propagation of the tracing span through context in the system.
|
Package tracing helps with the propagation of the tracing span through context in the system. |
|
traversal
Package traversal provides abstraction and implementation needed to traverse all chunks below a given root hash.
|
Package traversal provides abstraction and implementation needed to traverse all chunks below a given root hash. |
Click to show internal directories.
Click to hide internal directories.