You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuweni.apache.org by to...@apache.org on 2021/01/05 08:10:20 UTC

[incubator-tuweni-website] branch master updated: Add eth-faucet and scraper

This is an automated email from the ASF dual-hosted git repository.

toulmean pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-tuweni-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 4735742  Add eth-faucet and scraper
4735742 is described below

commit 473574221f694aad97cfafdd021f3c660c99e790
Author: Antoine Toulme <an...@lunar-ocean.com>
AuthorDate: Tue Jan 5 00:10:05 2021 -0800

    Add eth-faucet and scraper
---
 tutorials/apps/eth-faucet.md | 67 ++++++++++++++++++++++++++++++++++++++++++++
 tutorials/apps/index.md      | 18 ++++++++++--
 tutorials/apps/scraper.md    | 24 ++++++++++++++++
 3 files changed, 107 insertions(+), 2 deletions(-)

diff --git a/tutorials/apps/eth-faucet.md b/tutorials/apps/eth-faucet.md
new file mode 100644
index 0000000..d7eceb6
--- /dev/null
+++ b/tutorials/apps/eth-faucet.md
@@ -0,0 +1,67 @@
+---
+layout: tutorial
+title: Ethereum Faucet
+description: Ethereum Faucet
+group: nav-right
+previous: index.md
+categories: [applications]
+---
+
+The `eth-faucet` application is an Ethereum faucet that runs alongside an Ethereum client. The faucet allows to distribute funds.
+
+The faucet works with a configuration file, `application.yml`. Here is a template of the file:
+
+{%highlight yaml%}
+server:
+  use-forward-headers: true
+  forward-headers-strategy: native
+spring:
+  main:
+    banner-mode: "off"
+  security:
+    oauth2:
+      client:
+        registration:
+          github:
+            clientId: <your github client ID>
+            clientSecret: <your github client secret>
+html:
+  title: Faucet
+  request_message: Welcome to our faucet. You can ask for up to 1 ETH on this faucet.
+
+security:
+  oauth2:
+    client:
+      preEstablishedRedirectUri: <registered github redirect URI>
+      registeredRedirectUri: <registered github redirect URI>
+      useCurrentUri: false
+
+faucet:
+  maxETH: <the maximum amount of eth, in ETH, that you>
+  chainId: <chain id of your network>
+  rpcPort: <Ethereum client RPC port>
+  rpcHost: <Ethereum client RPC host>
+
+wallet:
+  path: wallet.key
+banner: >
+  Apache Tuweni Faucet example.
+
+           `:oyhdhhhhhhyo-`
+         :yds/.        ./sdy:
+       :mh:                :hm:
+     `ym:                    :my`
+     hm`                      `mh
+    +N.                        .N+
+    my :ydh/              /hdy- ym
+    Mo`MMMMM`            .MMMMN oM
+    my /hdh/              +hdh: ym
+    +N.                        .N+
+     hm`              `m:     `mh
+     `ym:    `sssssssssN:    :my`
+       :dh:   ``````````   :hd:
+         :yds/.        ./sdy:
+           `-oyhdhhhhdhyo-`
+{%endhighlight%}
+
+You should register a Github OAuth application to go along and fill the template.
\ No newline at end of file
diff --git a/tutorials/apps/index.md b/tutorials/apps/index.md
index d7e93bb..42b210f 100644
--- a/tutorials/apps/index.md
+++ b/tutorials/apps/index.md
@@ -15,12 +15,26 @@ The `gossip` application is an example showing how the Plumtree gossip implement
 
 # hobbits-relayer
 
+The `hobbits-relayer` application showcases how to use the Hobbits protocol to pass messages between different networks.
+
 [More](/tutorials/apps/hobbits-relayer)
 
 # tuweni
 
 [More](/tutorials/apps/tuweni)
 
+# scraper
+
+The `scraper` application discovers nodes running on discv5, reporting them to stdout as it goes.
+
+[More](/tutorials/apps/scraper)
+
+# v4scraper
+
+TODO
+
+# eth-faucet
+
+The `eth-faucet` application is an Ethereum faucet that runs alongside an Ethereum client. The faucet allows to distribute funds.
 
-devp2p
-eth-faucet
\ No newline at end of file
+[More](/tutorials/apps/eth-faucet)
\ No newline at end of file
diff --git a/tutorials/apps/scraper.md b/tutorials/apps/scraper.md
new file mode 100644
index 0000000..0ada778
--- /dev/null
+++ b/tutorials/apps/scraper.md
@@ -0,0 +1,24 @@
+---
+layout: tutorial
+title: Scraper
+description: Scraper
+group: nav-right
+previous: index.md
+categories: [applications]
+---
+
+Scraper 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.
+
+Whenever a new peer is detected, its information is printed out to stdout with the following format:
+
+<host address>,<udp port>,<attnets attribute>,<base-64 RLP encoding of the ENR>
+
+The attnets attribute is an ENR attribute used by Ethereum 2.0.
+
+Usage:
+
+{%highlight bash%}
+./scraper -LK4QC3FCb7-JTNRiWAezECk_QUJc9c2IkJA1-EAmqAA5wmdbPWsAeRpnMXKRJqOYG0TE99ycB1nOb9y26mjb_UoHS4Bh2F0dG5ldHOIAAAAAAAAAACEZXRoMpDnp11aAAAAAf__________gmlkgnY0gmlwhDMPYfCJc2VjcDI1NmsxoQOmDQryZJApMwIT-dQAbxjvxLbPzyKn9GFk5dqam4MDTYN0Y3CCIyiDdWRwgiMo
+{%endhighlight%}
\ No newline at end of file


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@tuweni.apache.org
For additional commands, e-mail: commits-help@tuweni.apache.org