Fork of plugeth with any needed changes for statediff plugin
Go to file
2023-05-05 14:29:36 -07:00
.circleci
.github Initial commit of merge geth v1.11.5 2023-04-21 13:24:40 -07:00
accounts
beacon/engine
build build: upgrade -dlgo version to Go 1.20.3 2023-04-04 22:24:30 +02:00
cmd Initial commit of merge geth v1.11.5 2023-04-21 13:24:40 -07:00
common
consensus consensus/ethash: use atomic type (#27068) 2023-04-18 14:54:06 +02:00
console
contracts/checkpointoracle
core These files were changed by hand to support the merge 2023-04-26 14:32:55 -07:00
crypto
docs
eth Initial commit of merge geth v1.11.5 2023-04-21 13:24:40 -07:00
ethclient
ethdb
ethstats
event
graphql
internal cmd/geth: rename --vmodule to --log.vmodule (#27071) 2023-04-19 07:18:02 -04:00
les all: refactor trie API (#26995) 2023-04-20 06:57:24 -04:00
light all: refactor trie API (#26995) 2023-04-20 06:57:24 -04:00
log
metrics metrics: use atomic type (#27121) 2023-04-20 03:36:54 -04:00
miner params: remove EIP150Hash from chainconfig (#27087) 2023-04-18 03:49:09 -04:00
node
p2p p2p: access embedded fields of Server directly (#27078) 2023-04-18 11:57:08 +02:00
params params: go-ethereum v1.11.6 stable 2023-04-20 20:14:51 +02:00
plugins Expose state trie to plugins 2023-05-05 14:14:15 -07:00
rlp
rpc Initial commit of merge geth v1.11.5 2023-04-21 13:24:40 -07:00
signer signer/core: rename testdata files (#27063) 2023-04-17 10:36:47 -04:00
swarm
tests all: refactor trie API (#26995) 2023-04-20 06:57:24 -04:00
trie Initial commit of merge geth v1.11.5 2023-04-21 13:24:40 -07:00
.dockerignore
.gitattributes
.gitignore
.gitmodules
.golangci.yml
.mailmap
.travis.yml
appveyor.yml
AUTHORS
circle.yml
COPYING
COPYING.LESSER
Dockerfile
Dockerfile.alltools
go.mod Expose state trie to plugins 2023-05-05 14:14:15 -07:00
go.sum Expose state trie to plugins 2023-05-05 14:14:15 -07:00
interfaces.go
Makefile
oss-fuzz.sh
README.md A resurrected and sligtly altered version of the project README 2023-04-07 16:47:09 -07:00
SECURITY.md
slack-post.sh

PluGeth

PluGeth is a fork of the Go Ethereum Client (Geth) that implements a plugin architecture, allowing developers to extend Geth's capabilities in a number of different ways using plugins, rather than having to create additional, new forks of Geth.

Documentation can be found here.

Design Goals

The upstream Geth client exists primarily to serve as a client for the Ethereum mainnet, though it also supports a number of popular testnets. Supporting the Ethereum mainnet is a big enough challenge in its own right that the Geth team generally avoids changes to support other networks, or to provide features only a small handful of users would be interested in.

The result is that many projects have forked Geth. Some implement their own consensus protocols or alter the behavior of the EVM to support other networks. Others are designed to extract information from the Ethereum mainnet in ways the standard Geth client does not support.

PluGeth aims to provide a single Geth fork that developers can choose to extend rather than forking the Geth project. Out of the box, PluGeth behaves exactly like upstream Geth, but by installing plugins written in Golang, developers can extend its functionality in a wide variety of way.

Contact Us

If you're trying to do something that isn't supported by the current plugin system, Reach out to us on Discord and we'll help you figure out how to make it work.

System Requirements

System requirements will vary depending on which network you are connecting to. On the Ethereum mainnet, you should have at least 8 GB RAM, 2 CPUs, and 350 GB of SSD disks.

PluGeth relies on Golang's Plugin implementation, which is only supported on Linux, FreeBSD, and macOS. Windows support is unlikely to be added in the foreseeable future.

Licensing Considerations

The Geth codebase is licensed under the LGPL. By linking with Geth, you have an obligation to enable anyone you provide your plugin binaries to run against their own modified versions of Geth. Because of how Golang plugins work running against updated versions of Geth may require recompiling the plugin.

If you plan to license your plugin under the LGPL or a more permissive license, you should be able to meet these requirements. If you plan to use your plugin privately without distributing it, you should be fine. If you plan to release your plugin without making the source available, you may find yourself in violation of Geth's license unless you can provide a way to relink it against more recent versions of Geth.