Fork of plugeth with any needed changes for statediff plugin
Go to file
Roy Crihfield d730849b7e Use external main module
* renames main package so it's importable
* adds wrapmain sub-module as main module
2023-08-08 20:58:22 +08:00
.circleci Pin specific version of go build container 2022-12-30 11:36:01 -06:00
.github Initial commit of merge geth v1.11.5 2023-04-21 13:24:40 -07:00
accounts accounts/abi/bind: handle UnpackLog with zero topics (#26920) 2023-03-31 02:35:29 -04:00
beacon/engine beacon/engine: don't omit empty withdrawals in ExecutionPayloadBodies (#26698) 2023-03-07 16:30:04 +01:00
build build: upgrade -dlgo version to Go 1.20.3 2023-04-04 22:24:30 +02:00
cmd Use external main module 2023-08-08 20:58:22 +08:00
common common: delete MakeName (#27023) 2023-04-03 03:51:31 -04:00
consensus consensus/ethash: use atomic type (#27068) 2023-04-18 14:54:06 +02:00
console cmd, eth, node: deprecate personal namespace (#26390) 2023-02-02 13:52:19 +02:00
contracts/checkpointoracle contracs/checkpointoracle: fix directives (#24944) 2022-05-30 14:45:27 +02:00
core These files were changed by hand to support the merge 2023-04-26 14:32:55 -07:00
crypto all: remove deprecated uses of math.rand (#26710) 2023-02-16 14:36:58 -05:00
docs docs/postmortems: remove wrong parentheses (#26066) 2022-11-01 14:50:03 +01:00
eth Initial commit of stand alone consensus engine work. 2023-06-12 09:52:46 -07:00
ethclient ethclient: ensure returned subscription is nil on error (#26976) 2023-03-25 22:38:43 +01:00
ethdb ethdb/pebble: use atomic type (#27014) 2023-03-30 15:02:14 -04:00
ethstats ethstats: set readlimit on ethstats server connection (#26207) 2022-11-17 15:33:03 +01:00
event README, go.mod, event, internal/version: bump min Go to 1.19 (#26803) 2023-03-03 12:24:09 +02:00
graphql graphql: revert storage access regression (#27007) 2023-03-30 06:57:49 -04:00
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 log: add special casing of uint256 into the logger (#26936) 2023-03-21 12:01:43 +02:00
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 metrics/librato: ensure resp.body closed (#26969) 2023-03-27 07:44:41 -04:00
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 Add --pluginsdir flag. (#1) 2023-08-04 23:03:08 +08:00
rlp rlp/rlpgen: print want/expect output string if mismatch (#26932) 2023-03-24 14:17:39 +01:00
rpc fix plugin subscription method registration 2023-06-10 01:51:39 +08:00
signer signer/core: rename testdata files (#27063) 2023-04-17 10:36:47 -04:00
swarm swarm: fix outdated link (#26501) 2023-01-16 11:00:55 +01:00
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
wrapmain Use external main module 2023-08-08 20:58:22 +08:00
.dockerignore cmd, internal/build, docker: advertise commit date in unstable build versions (#19522) 2019-05-08 16:44:28 +03:00
.gitattributes .gitattributes: enable solidity highlighting on github (#16425) 2018-04-03 15:21:24 +02:00
.gitignore cmd/geth: enable log rotation (#26843) 2023-04-03 05:05:36 -04:00
.gitmodules tests: external evm benchmarks (#24050) 2022-01-28 08:47:19 +01:00
.golangci.yml build: upgrade to go 1.19 (#25726) 2022-09-10 13:25:40 +02:00
.mailmap AUTHORS: remove one more duplicate entry (#24950) 2022-05-24 21:04:21 +02:00
.travis.yml .travis.yml: reenable PPA build on tag push (#26873) 2023-03-13 14:10:19 +01:00
appveyor.yml ci: disable coverage reporting in appveyor and travis 2023-02-17 15:34:30 +01:00
AUTHORS AUTHORS: remove one more duplicate entry (#24950) 2022-05-24 21:04:21 +02:00
circle.yml circleci: enable docker based hive testing 2016-07-15 16:07:34 +03:00
COPYING COYPING: restore the full text text of GPL (#21568) 2020-09-15 08:27:17 +02:00
COPYING.LESSER all: update license information 2015-07-07 14:12:44 +02:00
Dockerfile Use external main module 2023-08-08 20:58:22 +08:00
Dockerfile.alltools travis, build: update Go to 1.20.1 (#26653) 2023-02-16 09:00:45 +02:00
go.mod Use external main module 2023-08-08 20:58:22 +08:00
go.sum Use external main module 2023-08-08 20:58:22 +08:00
interfaces.go all: fix some typos (#25551) 2022-08-19 09:00:21 +03:00
Makefile accounts, build, mobile: remove Andriod and iOS support 2023-02-03 12:29:07 +02:00
oss-fuzz.sh core/vm: use golang native big.Int (#26834) 2023-03-08 13:12:53 -05:00
README.md A resurrected and sligtly altered version of the project README 2023-04-07 16:47:09 -07:00
SECURITY.md Issue template corrections 2022-03-30 15:06:50 -07:00
slack-post.sh Push binaries to S3 2022-01-11 14:40:43 -06:00

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.