Skip to content

Commit 41a2592

Browse files
authored
chore: post-rename cleanup + libevm intro (#68)
## Why this should be merged Cleans up loose ends after renaming the Go module. Also adds an introduction to the README to explain the purpose of libevm. ## How this works The changed hash in the workflow is just a fix (although a no-op). The spaces after the copyright headers are to stop them from [showing up in documentation](https://pkg.go.dev/github.com/ava-labs/libevm@v1.13.14-0.1.0-rc.1/params). ## How this was tested n/a
1 parent dc8fc03 commit 41a2592

File tree

7 files changed

+23
-9
lines changed

7 files changed

+23
-9
lines changed

.github/workflows/libevm-delta.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ on:
1010
jobs:
1111
diffs:
1212
env:
13-
# Last commit on `renamed-go-module` branch to be merged into `main`
14-
LIBEVM_BASE: a7f08d0e757d5a69d3e269c69dcea7e45bab97e3
13+
# Last commit from rename-module workflow job to be included in `main`
14+
LIBEVM_BASE: 0b56af5a01b8a0c6fc9d60247bb79ffd03d1bcfd
1515
runs-on: ubuntu-latest
1616
steps:
1717
- uses: actions/checkout@v4

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
1+
# libevm
2+
3+
[![API Reference](
4+
https://pkg.go.dev/badge/github.com/ava-labs/libevm
5+
)](https://pkg.go.dev/github.com/ava-labs/libevm?tab=doc)
6+
[![Go Report Card](https://goreportcard.com/badge/github.com/ava-labs/libevm)](https://goreportcard.com/report/github.com/ava-labs/libevm)
7+
[![Go Build & Test](https://github.com/ava-labs/libevm/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/ava-labs/libevm/actions/workflows/go.yml)
8+
9+
The Ethereum Virtual Machine (EVM) as a library, `libevm` is a fork of [`geth`](https://github.com/ethereum/go-ethereum) with
10+
injectable configuration directives. Although designed to support the Avalanche [C-Chain](https://github.com/ava-labs/coreth) and
11+
[EVM-L1s](https://github.com/ava-labs/subnet-evm) (formerly _subnets_), configuration is general-purpose and backwards-compatible
12+
with `geth`.
13+
14+
15+
We are immensely grateful for the hard work of the `geth` authors, and hope that our contribution can be of value to others too. Thank you!
16+
117
## Go Ethereum
218

319
Golang execution layer implementation of the Ethereum protocol.
420

5-
[![API Reference](
6-
https://pkg.go.dev/badge/github.com/ethereum/go-ethereum
7-
)](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc)
8-
[![Go Report Card](https://goreportcard.com/badge/github.com/ethereum/go-ethereum)](https://goreportcard.com/report/github.com/ethereum/go-ethereum)
9-
[![Travis](https://app.travis-ci.com/ethereum/go-ethereum.svg?branch=master)](https://app.travis-ci.com/github/ethereum/go-ethereum)
10-
[![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/nthXNEv)
11-
1221
Automated builds are available for stable releases and the unstable master branch. Binary
1322
archives are published at https://geth.ethereum.org/downloads/.
1423

core/state_transition.libevm.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// You should have received a copy of the GNU Lesser General Public License
1414
// along with the go-ethereum library. If not, see
1515
// <http://www.gnu.org/licenses/>.
16+
1617
package core
1718

1819
// canExecuteTransaction is a convenience wrapper for calling the

libevm/libevm.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// You should have received a copy of the GNU Lesser General Public License
1414
// along with the go-ethereum library. If not, see
1515
// <http://www.gnu.org/licenses/>.
16+
1617
package libevm
1718

1819
import (

params/config.libevm.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// You should have received a copy of the GNU Lesser General Public License
1414
// along with the go-ethereum library. If not, see
1515
// <http://www.gnu.org/licenses/>.
16+
1617
package params
1718

1819
import (

params/hooks.libevm.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// You should have received a copy of the GNU Lesser General Public License
1414
// along with the go-ethereum library. If not, see
1515
// <http://www.gnu.org/licenses/>.
16+
1617
package params
1718

1819
import (

params/json.libevm.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// You should have received a copy of the GNU Lesser General Public License
1414
// along with the go-ethereum library. If not, see
1515
// <http://www.gnu.org/licenses/>.
16+
1617
package params
1718

1819
import (

0 commit comments

Comments
 (0)