Add initial code & readme

.gitignore

@@ -23,3 +23,9 @@ go.work.sum
 
 # env file
 .env
+
+# Development related file
+.vscode/
+build/
+cover.html
+testdir*

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

Makefile

@@ -0,0 +1,14 @@
+BUILD := `git rev-parse --short HEAD`
+
+.PHONY: build itest
+
+build:
+	go build -o ./build/teler \
+		-ldflags "-X github.com/wcgcyx/teler/version.Version=$(BUILD)" \
+		cmd/teler/main.go
+
+utest:
+	go test -v --count=1 ./...
+
+clean:
+	rm -rf ./build/*

README.md

@@ -1,2 +1,60 @@
-# teler
-A Trust-based Essential-data Lightweight Ethereum RPC Node written in Golang
+# Teler
+
+Teler Node is a ***T***rust-based ***E***ssential-data ***L***ightweight ***E***thereum ***R***PC Node written in Golang.
+
+# Introduction
+It is expensive to run a Ethereum RPC Node locally. As of today, an Ethereum Full Node on Mainnet typically takes over 1 TB of disk space to run. 
+
+Therefore, developers would need to rely on node providers to query on-chain data or perform transaction simulation such as [Alchemy](https://www.alchemy.com/), [QuickNode](https://www.quicknode.com/), [Infura](https://www.infura.io/) and so on. 
+
+Teler node significantly reduces the disk usage by only keeping chain state for the past hour and by getting latest block from a trusted source. Once sync up, a teler node will be able to stay in sync by querying the latest block from a node provider, which can be easily achieved with a free tier subscription.
+
+Meanwhile, it is able to serve RPCs that are targeting chain state < an hour. This includes `eth_call`, `eth_estimateGas` and even tracing APIs (_WIP_).
+
+Teler node can also be used as a way to scale web3 provider. Instead of spining up new Ethereum Nodes to scale, much cheaper teler nodes can be spinned up and connecting to an existing Ethereum Node to stay in sync.
+
+_Note: This documentation and teler is still WIP, feel free to reach out for any question._
+
+# Usage
+## Build
+Building `teler` requires Go >= 1.22.5. To obtain Go, visit [here](https://go.dev/doc/install).
+```
+git clone https://github.com/wcgcyx/teler.git
+cd teler
+make
+./build/teler --help
+```
+## Quickstart (Holesky)
+To sync a `teler` node on holesky from scratch, it is recommended to do initial sync from a local Ethereum node first before switching to a node provider. [Erigon](https://github.com/erigontech/erigon) is used below as an example.
+
+(If you wish to sync from a snapshot directly to save time, reach out to me).
+
+1. Spin up an Erigon node for initial sync
+```
+mkdir erigondir
+erigon --internalcl --prune=hrtc --datadir ./erigondir --chain=holesky
+```
+
+2. Start teler node
+```
+mkdir telerdir
+teler start --path ./telerdir --chain holesky --blksrc http://localhost:8545
+```
+
+3. Switch to node provider and start serving RPCs
+
+Once teler syncs to the local erigon. You can stop both processes and remove everything erigon related to save disk space.
+
+Then you will be able to sync from a node provider (a free tier subscription will be more than sufficient).
+
+```
+teler start --path ./telerdir --blksrc ${HOLESKY_PROVIDER_URL} --rpc-port 9424
+```
+
+This also serves RPC on `localhost:9424`.
+
+# Contributor
+Zhenyang Shi - [email protected]
+
+# License
+Licensed under LGPL-3.0.

backend/backend.go

@@ -0,0 +1,56 @@
+package backend
+
+/*
+ * Licensed under LGPL-3.0.
+ *
+ * You can get a copy of the LGPL-3.0 License at
+ *
+ * https://www.gnu.org/licenses/lgpl-3.0.en.html
+ *
+ * @wcgcyx - https://github.com/wcgcyx
+ */
+
+import (
+	"context"
+
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
+	"github.com/ethereum/go-ethereum/params"
+	"github.com/wcgcyx/teler/blockchain"
+	"github.com/wcgcyx/teler/processor"
+	"github.com/wcgcyx/teler/worldstate"
+)
+
+type Backend interface {
+	// Processor gets the current block processor.
+	Processor() *processor.BlockProcessor
+
+	// ChainConfig gets the current chain config.
+	ChainConfig() *params.ChainConfig
+
+	// Blockchain gets the blockchain instance.
+	Blockchain() blockchain.Blockchain
+
+	// StateArchive gets the state archive instance.
+	StateArchive() worldstate.LayeredWorldStateArchive
+
+	// ImportBlock process and import a block.
+	ImportBlock(ctx context.Context, blk *types.Block, prvBlk *types.Block) error
+
+	// ImportBlocks import a list of blocks.
+	ImportBlocks(ctx context.Context, blks []*types.Block) error
+
+	// SetSafeTag sets the safe tag.
+	SetSafeTag(ctx context.Context, safe common.Hash)
+
+	// SetFinalizedTag sets the finalized tag.
+	SetFinalizedTag(ctx context.Context, finalized common.Hash)
+
+	// DebugDestructStateChild is used to destruct a state child.
+	// Note: This should ONLY be called for debug purpose.
+	DebugDestructStateChild(height uint64, root common.Hash, child common.Hash) error
+
+	// DebugForceProcessBlock is used to force process a block.
+	// Note: This should ONLY be called for debug purpose.
+	DebugForceProcessBlock(ctx context.Context, blk *types.Block) error
+}