This is an automated email from the ASF dual-hosted git repository.
toulmean pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-tuweni.git
The following commit(s) were added to refs/heads/main by this push:
new dbc8f59c2 more READMEs
new 69b0da6e3 Merge pull request #505 from atoulme/add_readmes
dbc8f59c2 is described below
commit dbc8f59c2e9f59935d1d59e9a92c758114040418
Author: Antoine Toulme <[email protected]>
AuthorDate: Sun Jan 29 20:49:54 2023 -0800
more READMEs
---
{eth-crawler => app-commons}/README.md | 10 ++--
bytes/README.md | 8 +++
{eth-crawler => concurrent-coroutines}/README.md | 10 ++--
{eth-crawler => concurrent}/README.md | 10 ++--
{eth-crawler => config}/README.md | 10 ++--
{eth-crawler => crypto}/README.md | 10 ++--
{eth-crawler => devp2p-eth}/README.md | 10 ++--
{eth-crawler => devp2p-proxy}/README.md | 10 ++--
{eth-crawler => devp2p}/README.md | 10 ++--
{eth-crawler => dns-discovery}/README.md | 10 ++--
docs/index.md | 66 +++++++++++++++++++++++
{eth-crawler => eth-blockprocessor}/README.md | 15 ++++--
{eth-client => eth-client-app}/README.md | 12 ++++-
{eth-crawler => eth-client-ui}/README.md | 15 ++++--
eth-client/README.md | 51 +++---------------
eth-crawler/README.md | 8 +++
eth-faucet/README.md | 8 +++
{eth-crawler => eth-precompiles}/README.md | 10 ++--
{eth-crawler => eth-repository}/README.md | 10 ++--
{eth-crawler => eth}/README.md | 14 +++--
{eth-crawler => ethstats}/README.md | 10 ++--
{eth-crawler => evm-dsl}/README.md | 10 ++--
{eth-crawler => evm}/README.md | 10 ++--
{eth-crawler => genesis}/README.md | 10 ++--
gossip/README.md | 11 +++-
hobbits-relayer/README.md | 14 ++++-
{eth-crawler => hobbits}/README.md | 10 ++--
{eth-crawler => io}/README.md | 10 ++--
jsonrpc-app/README.md | 12 ++++-
{eth-crawler => jsonrpc}/README.md | 10 ++--
{eth-crawler => junit}/README.md | 10 ++--
{eth-crawler => kademlia}/README.md | 10 ++--
{eth-crawler => kv}/README.md | 10 ++--
{eth-crawler => les}/README.md | 10 ++--
{eth-crawler => merkle-trie}/README.md | 10 ++--
{eth-crawler => metrics}/README.md | 10 ++--
net/README.md | 10 +++-
{eth-crawler => peer-repository}/README.md | 10 ++--
{eth-crawler => plumtree-servlet}/README.md | 10 ++--
{eth-crawler => plumtree-vertx}/README.md | 10 ++--
{eth-crawler => plumtree}/README.md | 10 ++--
{eth-crawler => pow}/README.md | 10 ++--
{eth-crawler => rlp}/README.md | 10 ++--
{eth-crawler => rlpx}/README.md | 10 ++--
{eth-crawler => scuttlebutt-client-lib}/README.md | 10 ++--
{eth-crawler => scuttlebutt-discovery}/README.md | 10 ++--
{eth-crawler => scuttlebutt-handshake}/README.md | 10 ++--
{eth-crawler => scuttlebutt-rpc}/README.md | 10 ++--
{eth-crawler => scuttlebutt}/README.md | 10 ++--
{eth-crawler => ssz}/README.md | 10 ++--
stratum/client/src/main/resources/logback.xml | 27 ----------
{eth-crawler => stratum/proxy}/README.md | 10 ++--
{eth-crawler => stratum/server}/README.md | 10 ++--
toml/README.md | 35 +++++++-----
units/README.md | 10 +++-
{eth-crawler => wallet}/README.md | 10 ++--
wallet/build.gradle | 2 +-
57 files changed, 496 insertions(+), 222 deletions(-)
diff --git a/eth-crawler/README.md b/app-commons/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to app-commons/README.md
index 16ebab3e4..d08825ac1 100644
--- a/eth-crawler/README.md
+++ b/app-commons/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Application Commons
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/bytes/README.md b/bytes/README.md
index 14ef32eb6..5a445cff0 100644
--- a/bytes/README.md
+++ b/bytes/README.md
@@ -12,6 +12,11 @@ specific language governing permissions and limitations
under the License.
--->
# Bytes
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
+
# Getting started
Apache Tuweni provides support for manipulating bytes.
@@ -317,3 +322,6 @@ You will need to implement the following functions:
* [`mutableCopy(offset,
size)`](https://tuweni.apache.org/docs/org.apache.tuweni.bytes/-bytes/mutable-copy.html)
You can choose to simplify greatly by extending the [`DelegatingBytes`
class](https://tuweni.apache.org/docs/org.apache.tuweni.bytes/-delegating-bytes/index.html)
instead.
+
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/concurrent-coroutines/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to concurrent-coroutines/README.md
index 16ebab3e4..9576af1b3 100644
--- a/eth-crawler/README.md
+++ b/concurrent-coroutines/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Concurrent coroutines
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/concurrent/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to concurrent/README.md
index 16ebab3e4..b263932b7 100644
--- a/eth-crawler/README.md
+++ b/concurrent/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Concurrent
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/config/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to config/README.md
index 16ebab3e4..cd00c5145 100644
--- a/eth-crawler/README.md
+++ b/config/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Configuration
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/crypto/README.md
similarity index 73%
copy from eth-crawler/README.md
copy to crypto/README.md
index 16ebab3e4..1949f4a70 100644
--- a/eth-crawler/README.md
+++ b/crypto/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Crypto
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/devp2p-eth/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to devp2p-eth/README.md
index 16ebab3e4..411de3229 100644
--- a/eth-crawler/README.md
+++ b/devp2p-eth/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# DevP2P Eth Subprotocol
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/devp2p-proxy/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to devp2p-proxy/README.md
index 16ebab3e4..5c0303960 100644
--- a/eth-crawler/README.md
+++ b/devp2p-proxy/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# DevP2P Proxy Subprotocol
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/devp2p/README.md
similarity index 73%
copy from eth-crawler/README.md
copy to devp2p/README.md
index 16ebab3e4..83de26e99 100644
--- a/eth-crawler/README.md
+++ b/devp2p/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# DevP2P
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/dns-discovery/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to dns-discovery/README.md
index 16ebab3e4..9f93e5084 100644
--- a/eth-crawler/README.md
+++ b/dns-discovery/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# DNS discovery
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 000000000..7c6bb96e6
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,66 @@
+<!---
+Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE
+file distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
+to You under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the
+License. You may obtain a copy of the License at
+ *
+http://www.apache.org/licenses/LICENSE-2.0
+ *
+Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
+specific language governing permissions and limitations under the License.
+ --->
+
+# Stability levels
+
+### Prototype
+
+This component is still in development. It is likely that the component owners
might not give attention to bugs or performance issues.
+Configuration options might break often depending on how things evolve. The
component should not be used in production.
+
+### Alpha
+
+The component is ready to be used for limited non-critical workloads and the
authors of this component would welcome your feedback.
+Bugs and performance problems should be reported, but component owners might
not work on them right away.
+The configuration options might change often without backwards compatibility
guarantees.
+
+### Beta
+
+Same as Alpha, but the configuration options are deemed stable.
+While there might be breaking changes between releases, component owners
should try to minimize them.
+A component at this stage is expected to have had exposure to non-critical
production workloads already during its **Alpha** phase, making it suitable for
broader usage.
+
+### Stable
+
+The component is ready for general availability.
+Bugs and performance problems should be reported and there's an expectation
that the component owners will work on them.
+Breaking changes, including configuration options and the component's output
are not expected to happen without prior notice, unless under special
circumstances.
+
+### Deprecated
+
+The component is planned to be removed in a future version and no further
support will be provided.
+Note that new issues will likely not be worked on.
+When a component enters "deprecated" mode, it is expected to exist for at
least two minor releases.
+See the component's readme file for more details on when a component will
cease to exist.
+
+### Unmaintained
+
+A component identified as unmaintained does not have an active code owner.
+Such component may have never been assigned a code owner or a previously
active code owner has not responded to requests for feedback within 6 weeks of
being contacted.
+Issues and pull requests for unmaintained components will be labelled as such.
+After 6 months of being unmaintained, these components will be removed from
official distribution.
+Components that are unmaintained are actively seeking contributors to become
code owners.
+
+# Component Type
+
+### Library
+
+The component is meant to be consumed as a library, and to be embedded into
other applications. It should be consumed through its API.
+
+### Example
+
+The component is an example of usage of libraries or applications, and can be
used as a tutorial or integration test.
+
+### Application
+
+The component is an application that can be consumed as an executable, and
offers configuration through file and command line arguments.
diff --git a/eth-crawler/README.md b/eth-blockprocessor/README.md
similarity index 62%
copy from eth-crawler/README.md
copy to eth-blockprocessor/README.md
index 16ebab3e4..de768ce22 100644
--- a/eth-crawler/README.md
+++ b/eth-blockprocessor/README.md
@@ -10,8 +10,17 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Ethereum Block Processor
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-------------|
+| Stability | [prototype] |
+| Component Type | [library] |
+
+This library implements a block processor for the Ethereum blockchain.
+
+A block processor applies the transformation of a block to the blockchain.
+
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
diff --git a/eth-client/README.md b/eth-client-app/README.md
similarity index 83%
copy from eth-client/README.md
copy to eth-client-app/README.md
index 1bea31757..487287973 100644
--- a/eth-client/README.md
+++ b/eth-client-app/README.md
@@ -10,7 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum client
+# Ethereum client application
+
+| Status | |
+|----------------|---------------|
+| Stability | [prototype] |
+| Component Type | [application] |
The `tuweni` application is an Ethereum client that can run multiple chains
and multiple discovery mechanisms.
@@ -58,4 +63,7 @@ path="data"
genesis="bar"
[genesis.bar]
path=other.json
-```
\ No newline at end of file
+```
+
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[application]:https://github.com/apache/incubator-tuweni/tree/main/docs#application
\ No newline at end of file
diff --git a/eth-crawler/README.md b/eth-client-ui/README.md
similarity index 60%
copy from eth-crawler/README.md
copy to eth-client-ui/README.md
index 16ebab3e4..e0bdcab21 100644
--- a/eth-crawler/README.md
+++ b/eth-client-ui/README.md
@@ -10,8 +10,17 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Ethereum client UI
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-------------|
+| Stability | [prototype] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+The Ethereum client UI is a set of REST services and web pages associated with
the Ethereum client.
+
+It exposes data from the client, such as its configuration and state, over web
pages.
+
+
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-client/README.md b/eth-client/README.md
index 1bea31757..b3c3cf17a 100644
--- a/eth-client/README.md
+++ b/eth-client/README.md
@@ -12,50 +12,13 @@ specific language governing permissions and limitations
under the License.
--->
# Ethereum client
-The `tuweni` application is an Ethereum client that can run multiple chains
and multiple discovery mechanisms.
+| Status | |
+|----------------|-------------|
+| Stability | [prototype] |
+| Component Type | [library] |
-`tuweni` can sync multiple chains at once. It also has a web UI.
+The Ethereum client library defines the domain objects and their coordination
to form an Ethereum client.
-NOTE: everything at this point is at best a prototype. This may change at any
time.
-Usage:
-
-```bash
-Apache Tuweni client loading
-Usage: <main class> [-h] [-c=<configPath>] [-w=<web>]
--c, --config=<configPath>
-Configuration file.
--h, --help Prints usage prompt
--w, --web=<web> Web console host:port
-```
-
-Most of the action happens in the configuration file, written with TOML.
-
-Example with one chain:
-
-```toml
-[storage.default]
-path="data"
-genesis="default"
-[genesis.default]
-path=default.json
-```
-
-The `default.json` file is your usual genesis configuration file.
-
-Example with two chains:
-
-Example with one chain:
-
-```toml
-[storage.foo]
-path="data"
-genesis="foo"
-[genesis.foo]
-path=default.json
-[storage.bar]
-path="data"
-genesis="bar"
-[genesis.bar]
-path=other.json
-```
\ No newline at end of file
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/eth-crawler/README.md
index 16ebab3e4..8e7a5f278 100644
--- a/eth-crawler/README.md
+++ b/eth-crawler/README.md
@@ -12,6 +12,14 @@ specific language governing permissions and limitations
under the License.
--->
# Ethereum crawler
+| Status | |
+|----------------|---------------|
+| Stability | [alpha] |
+| Component Type | [application] |
+
The crawler is a discv5 server that constantly looks for new peers.
Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[application]:https://github.com/apache/incubator-tuweni/tree/main/docs#application
\ No newline at end of file
diff --git a/eth-faucet/README.md b/eth-faucet/README.md
index 6752705a8..bbc02dfde 100644
--- a/eth-faucet/README.md
+++ b/eth-faucet/README.md
@@ -12,6 +12,11 @@ specific language governing permissions and limitations
under the License.
--->
# Ethereum Faucet
+| Status | |
+|----------------|---------------|
+| Stability | [alpha] |
+| Component Type | [application] |
+
This example allows you to set up a faucet with Github authentication.
The application is written in Kotlin with Spring Boot, with Spring Web, Spring
Security and Thymeleaf templates.
@@ -109,3 +114,6 @@ In the web page, note the faucet account address. Make sure
to send money to tha
Now you can send money using the faucet. Enter any valid address and press OK.
The second time you ask for money, the faucet will detect the balance of the
account matches the max the faucet with top up.
+
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[application]:https://github.com/apache/incubator-tuweni/tree/main/docs#application
\ No newline at end of file
diff --git a/eth-crawler/README.md b/eth-precompiles/README.md
similarity index 71%
copy from eth-crawler/README.md
copy to eth-precompiles/README.md
index 16ebab3e4..9e188d120 100644
--- a/eth-crawler/README.md
+++ b/eth-precompiles/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Ethereum Precompiles
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-------------|
+| Stability | [prototype] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/eth-repository/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to eth-repository/README.md
index 16ebab3e4..94baa5146 100644
--- a/eth-crawler/README.md
+++ b/eth-repository/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Ethereum Repository
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/eth/README.md
similarity index 68%
copy from eth-crawler/README.md
copy to eth/README.md
index 16ebab3e4..97de0fcac 100644
--- a/eth-crawler/README.md
+++ b/eth/README.md
@@ -10,8 +10,16 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Ethereum
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
+
+This library represents domain objects related to the Ethereum blockchain.
+
+
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
diff --git a/eth-crawler/README.md b/ethstats/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to ethstats/README.md
index 16ebab3e4..827a37fe1 100644
--- a/eth-crawler/README.md
+++ b/ethstats/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# EthStats server
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/evm-dsl/README.md
similarity index 70%
copy from eth-crawler/README.md
copy to evm-dsl/README.md
index 16ebab3e4..fc2dd64a5 100644
--- a/eth-crawler/README.md
+++ b/evm-dsl/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Ethereum Virtual Machine DSL
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-------------|
+| Stability | [prototype] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/evm/README.md
similarity index 70%
copy from eth-crawler/README.md
copy to evm/README.md
index 16ebab3e4..1ff7bb486 100644
--- a/eth-crawler/README.md
+++ b/evm/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Ethereum Virtual Machine
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-------------|
+| Stability | [prototype] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/genesis/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to genesis/README.md
index 16ebab3e4..1c1402a44 100644
--- a/eth-crawler/README.md
+++ b/genesis/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Genesis Library
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/gossip/README.md b/gossip/README.md
index c653d63a0..c8621e7b3 100644
--- a/gossip/README.md
+++ b/gossip/README.md
@@ -12,6 +12,12 @@ specific language governing permissions and limitations
under the License.
--->
# Gossip
+| Status | |
+|----------------|---------------|
+| Stability | [beta] |
+| Component Type | [application] |
+
+
The `gossip` application is an example showing how the Plumtree gossip
implementation functions.
`gossip` is distributed as part of the binary distribution of Apache Tuweni,
which you can download from this [page](/download)
@@ -57,4 +63,7 @@ In a separate shell, you can send messages to the listener
with:
This will send 10 messages, of 32 random bytes each. Open the file `/tmp/log`
to see them.
-You can create more complex scenarios with multiple gossip listeners, showing
the path by which gossip circulates across peers.
\ No newline at end of file
+You can create more complex scenarios with multiple gossip listeners, showing
the path by which gossip circulates across peers.
+
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[application]:https://github.com/apache/incubator-tuweni/tree/main/docs#application
\ No newline at end of file
diff --git a/hobbits-relayer/README.md b/hobbits-relayer/README.md
index fd33c2d56..b5a91fab5 100644
--- a/hobbits-relayer/README.md
+++ b/hobbits-relayer/README.md
@@ -10,6 +10,15 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
+
+# Hobbits Relayer
+
+
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [example] |
+
The `hobbits-relayer` application showcases how to use the Hobbits protocol to
pass messages between different networks.
```bash
@@ -35,4 +44,7 @@ hobbits-relayer -b udp://localhost:2222 -t
udp://localhost:4444
Relay messages from a Web Socket port 2222 to a TCP server on 4444:
```bash
hobbits-relayer -b ws://localhost:2222 -t tcp://localhost:4444
-```
\ No newline at end of file
+```
+
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[example]:https://github.com/apache/incubator-tuweni/tree/main/docs#example
\ No newline at end of file
diff --git a/eth-crawler/README.md b/hobbits/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to hobbits/README.md
index 16ebab3e4..b3c0acb7d 100644
--- a/eth-crawler/README.md
+++ b/hobbits/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Hobbits
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-------------|
+| Stability | [prototype] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/io/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to io/README.md
index 16ebab3e4..98a74b34c 100644
--- a/eth-crawler/README.md
+++ b/io/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Input/Output
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/jsonrpc-app/README.md b/jsonrpc-app/README.md
index 5036a0aa6..60edbb5eb 100644
--- a/jsonrpc-app/README.md
+++ b/jsonrpc-app/README.md
@@ -10,7 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# JSONRPC
+# JSONRPC application
+
+| Status | |
+|----------------|---------------|
+| Stability | [beta] |
+| Component Type | [application] |
The `jsonrpc` application is a JSON-RPC proxy that can cache, filter,
throttle, meter and authenticate requests to a JSON-RPC endpoint.
@@ -40,4 +45,7 @@ cacheEnabled=true
cachedMethods=[""] # All methods are cached
cacheStoragePath="/var/jsonrpccache" # Cache location
allowedMethods=[""] # All methods are enabled
-```
\ No newline at end of file
+```
+
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[application]:https://github.com/apache/incubator-tuweni/tree/main/docs#application
\ No newline at end of file
diff --git a/eth-crawler/README.md b/jsonrpc/README.md
similarity index 73%
copy from eth-crawler/README.md
copy to jsonrpc/README.md
index 16ebab3e4..6cb7886b3 100644
--- a/eth-crawler/README.md
+++ b/jsonrpc/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# JSON-RPC
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/junit/README.md
similarity index 73%
copy from eth-crawler/README.md
copy to junit/README.md
index 16ebab3e4..44f43d278 100644
--- a/eth-crawler/README.md
+++ b/junit/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Junit
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/kademlia/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to kademlia/README.md
index 16ebab3e4..4f03abad8 100644
--- a/eth-crawler/README.md
+++ b/kademlia/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Kademlia routing table
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/kv/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to kv/README.md
index 16ebab3e4..2b24d97dc 100644
--- a/eth-crawler/README.md
+++ b/kv/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Key/Value Store
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/les/README.md
similarity index 71%
copy from eth-crawler/README.md
copy to les/README.md
index 16ebab3e4..6bc7af61c 100644
--- a/eth-crawler/README.md
+++ b/les/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# DevP2P LES subprotocol
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-------------|
+| Stability | [prototype] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[prototype]:https://github.com/apache/incubator-tuweni/tree/main/docs#prototype
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/merkle-trie/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to merkle-trie/README.md
index 16ebab3e4..34d53f48d 100644
--- a/eth-crawler/README.md
+++ b/merkle-trie/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Patricia Merkle Trie
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/metrics/README.md
similarity index 73%
copy from eth-crawler/README.md
copy to metrics/README.md
index 16ebab3e4..afeea631a 100644
--- a/eth-crawler/README.md
+++ b/metrics/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Metrics
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/net/README.md b/net/README.md
index 209d19215..d8d60d2e3 100644
--- a/net/README.md
+++ b/net/README.md
@@ -12,6 +12,11 @@ specific language governing permissions and limitations
under the License.
--->
# Net
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
+
# Getting started
To get started, install the `net` library.
@@ -99,4 +104,7 @@ options.setSsl(true)
.setReuseAddress(true)
.setReusePort(true);
client = vertx.createHttpClient(options);
-```
\ No newline at end of file
+```
+
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/peer-repository/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to peer-repository/README.md
index 16ebab3e4..9f7c42b68 100644
--- a/eth-crawler/README.md
+++ b/peer-repository/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Peer Repository
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/plumtree-servlet/README.md
similarity index 69%
copy from eth-crawler/README.md
copy to plumtree-servlet/README.md
index 16ebab3e4..b6932c88e 100644
--- a/eth-crawler/README.md
+++ b/plumtree-servlet/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Plumtree ( Push-Lazy-pUsh Multicast TREE) Servlet example
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [example] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[example]:https://github.com/apache/incubator-tuweni/tree/main/docs#example
\ No newline at end of file
diff --git a/eth-crawler/README.md b/plumtree-vertx/README.md
similarity index 69%
copy from eth-crawler/README.md
copy to plumtree-vertx/README.md
index 16ebab3e4..d3dd4b2da 100644
--- a/eth-crawler/README.md
+++ b/plumtree-vertx/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Plumtree ( Push-Lazy-pUsh Multicast TREE) Vert.x example
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [example] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[example]:https://github.com/apache/incubator-tuweni/tree/main/docs#example
\ No newline at end of file
diff --git a/eth-crawler/README.md b/plumtree/README.md
similarity index 70%
copy from eth-crawler/README.md
copy to plumtree/README.md
index 16ebab3e4..e290918c2 100644
--- a/eth-crawler/README.md
+++ b/plumtree/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Plumtree ( Push-Lazy-pUsh Multicast TREE)
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/pow/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to pow/README.md
index 16ebab3e4..9e5259727 100644
--- a/eth-crawler/README.md
+++ b/pow/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Proof-Of-Work
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/rlp/README.md
similarity index 71%
copy from eth-crawler/README.md
copy to rlp/README.md
index 16ebab3e4..4ec8d1d0b 100644
--- a/eth-crawler/README.md
+++ b/rlp/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# RLP (Recursive Length Prefix) codec
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/rlpx/README.md
similarity index 71%
copy from eth-crawler/README.md
copy to rlpx/README.md
index 16ebab3e4..c6d871e7b 100644
--- a/eth-crawler/README.md
+++ b/rlpx/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# RLPx Peer-to-Peer Service
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/scuttlebutt-client-lib/README.md
similarity index 71%
copy from eth-crawler/README.md
copy to scuttlebutt-client-lib/README.md
index 16ebab3e4..f6abd4b59 100644
--- a/eth-crawler/README.md
+++ b/scuttlebutt-client-lib/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Scuttlebutt Client Library
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/scuttlebutt-discovery/README.md
similarity index 71%
copy from eth-crawler/README.md
copy to scuttlebutt-discovery/README.md
index 16ebab3e4..86fb88bd8 100644
--- a/eth-crawler/README.md
+++ b/scuttlebutt-discovery/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Scuttlebutt Discovery Library
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/scuttlebutt-handshake/README.md
similarity index 71%
copy from eth-crawler/README.md
copy to scuttlebutt-handshake/README.md
index 16ebab3e4..b788c5bae 100644
--- a/eth-crawler/README.md
+++ b/scuttlebutt-handshake/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Scuttlebutt Handshake Library
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/scuttlebutt-rpc/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to scuttlebutt-rpc/README.md
index 16ebab3e4..4aabeb3d1 100644
--- a/eth-crawler/README.md
+++ b/scuttlebutt-rpc/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Scuttlebutt RPC
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/scuttlebutt/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to scuttlebutt/README.md
index 16ebab3e4..fe3288c98 100644
--- a/eth-crawler/README.md
+++ b/scuttlebutt/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Scuttlebutt Library
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/ssz/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to ssz/README.md
index 16ebab3e4..b3e44994b 100644
--- a/eth-crawler/README.md
+++ b/ssz/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# SSZ (Simple SerialiZe)
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/stratum/client/src/main/resources/logback.xml
b/stratum/client/src/main/resources/logback.xml
deleted file mode 100644
index 6c9cb319e..000000000
--- a/stratum/client/src/main/resources/logback.xml
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE
- file distributed with this work for additional information regarding
copyright ownership. The ASF licenses this file
- to You under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the
- License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on
- an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the
- specific language governing permissions and limitations under the License.
--->
-<configuration scan="true">
-
- <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
- <!-- encoders are assigned the type
- ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
- <encoder>
- <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} -
%msg%n</pattern>
- </encoder>
- </appender>
-
- <root level="debug">
- <appender-ref ref="STDOUT" />
- </root>
-</configuration>
\ No newline at end of file
diff --git a/eth-crawler/README.md b/stratum/proxy/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to stratum/proxy/README.md
index 16ebab3e4..737c281ea 100644
--- a/eth-crawler/README.md
+++ b/stratum/proxy/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Stratum Proxy
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/stratum/server/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to stratum/server/README.md
index 16ebab3e4..11783dc5f 100644
--- a/eth-crawler/README.md
+++ b/stratum/server/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Stratum Server
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [beta] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[beta]:https://github.com/apache/incubator-tuweni/tree/main/docs#beta
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/toml/README.md b/toml/README.md
index 9d58981af..4608276d4 100644
--- a/toml/README.md
+++ b/toml/README.md
@@ -1,8 +1,27 @@
+<!---
+Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE
+file distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
+to You under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the
+License. You may obtain a copy of the License at
+ *
+http://www.apache.org/licenses/LICENSE-2.0
+ *
+Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
+specific language governing permissions and limitations under the License.
+ --->
+
# Tuweni-Toml: TOML parser for Java/Kotlin
+
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
+
Tuweni-Toml is a complete TOML parser with the following attributes:
-* Supports the latest TOML specification version (0.5.0).
+* Supports TOML specification version 0.5.0.
* Provides detailed error reporting, including error position.
* Performs error recovery, allowing parsing to continue after an error.
@@ -19,15 +38,5 @@ result.errors().forEach(error ->
System.err.println(error.toString()));
String value = result.getString("a. dotted . key");
```
-# License
-
-Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE
-file distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file
-to You under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the
-License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on
-an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
-specific language governing permissions and limitations under the License.
\ No newline at end of file
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/units/README.md b/units/README.md
index 0be400832..db3bdb0f0 100644
--- a/units/README.md
+++ b/units/README.md
@@ -12,6 +12,11 @@ specific language governing permissions and limitations
under the License.
--->
# Units
+| Status | |
+|----------------|-----------|
+| Stability | [stable] |
+| Component Type | [library] |
+
# Getting started
Apache Tuweni provides support for manipulating unsigned integers and base
Ethereum currencies.
@@ -138,4 +143,7 @@ public final class Wei extends BaseUInt256Value<Wei> {
super(bytes, Wei::new);
}
}
-```
\ No newline at end of file
+```
+
+[stable]:https://github.com/apache/incubator-tuweni/tree/main/docs#stable
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/eth-crawler/README.md b/wallet/README.md
similarity index 72%
copy from eth-crawler/README.md
copy to wallet/README.md
index 16ebab3e4..610a95b7a 100644
--- a/eth-crawler/README.md
+++ b/wallet/README.md
@@ -10,8 +10,12 @@ Unless required by applicable law or agreed to in writing,
software distributed
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the
specific language governing permissions and limitations under the License.
--->
-# Ethereum crawler
+# Ethereum wallet
-The crawler is a discv5 server that constantly looks for new peers.
+| Status | |
+|----------------|-----------|
+| Stability | [alpha] |
+| Component Type | [library] |
-Whenever it connects to peers, it asks for all their known peers, and keeps
going until it has exhausted all peers it could discover, then starts all over
again.
+[alpha]:https://github.com/apache/incubator-tuweni/tree/main/docs#alpha
+[library]:https://github.com/apache/incubator-tuweni/tree/main/docs#library
\ No newline at end of file
diff --git a/wallet/build.gradle b/wallet/build.gradle
index 11ff8baef..20886f52e 100644
--- a/wallet/build.gradle
+++ b/wallet/build.gradle
@@ -10,7 +10,7 @@
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
-description = 'Wallet holding '
+description = 'Ethereum wallet'
dependencies {
implementation project(':bytes')
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
