From 2e7254e737fa1e0d640da4ae4096c679c09acaa9 Mon Sep 17 00:00:00 2001 From: Austin Roberts Date: Tue, 20 Jul 2021 10:18:29 -0500 Subject: [PATCH] Update documentation --- README.md | 13 +++++++++++++ plugins/packages/blockupdates/main.go | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 25215ce84..c4bfa3cc8 100644 --- a/README.md +++ b/README.md @@ -361,6 +361,19 @@ supported by the current plugin system, we're happy to help. Reach out to us on [Discord](https://discord.gg/Epf7b7Gr) and we'll help you figure out how to make it work. +# 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. # Existing Plugins diff --git a/plugins/packages/blockupdates/main.go b/plugins/packages/blockupdates/main.go index 5dbc36469..c568cf59f 100644 --- a/plugins/packages/blockupdates/main.go +++ b/plugins/packages/blockupdates/main.go @@ -251,7 +251,7 @@ func (b *BlockUpdates) BlockUpdatesByNumber(ctx context.Context, number rpc.Bloc return blockUpdates(ctx, block) } -// BlockUPdatesByHash retrieves a block by hash, gets receipts and state +// BlockUpdatesByHash retrieves a block by hash, gets receipts and state // updates, and serializes the response. func (b *BlockUpdates) BlockUpdatesByHash(ctx context.Context, hash common.Hash) (map[string]interface{}, error) { block, err := b.backend.BlockByHash(ctx, hash)