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
This commit is contained in:
Arran Schlosberg 2024-10-30 13:51:41 +00:00 committed by GitHub
parent dc8fc0308d
commit 41a2592b8c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 23 additions and 9 deletions

View file

@ -10,8 +10,8 @@ on:
jobs: jobs:
diffs: diffs:
env: env:
# Last commit on `renamed-go-module` branch to be merged into `main` # Last commit from rename-module workflow job to be included in `main`
LIBEVM_BASE: a7f08d0e757d5a69d3e269c69dcea7e45bab97e3 LIBEVM_BASE: 0b56af5a01b8a0c6fc9d60247bb79ffd03d1bcfd
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4

View file

@ -1,14 +1,23 @@
# libevm
[![API Reference](
https://pkg.go.dev/badge/github.com/ava-labs/libevm
)](https://pkg.go.dev/github.com/ava-labs/libevm?tab=doc)
[![Go Report Card](https://goreportcard.com/badge/github.com/ava-labs/libevm)](https://goreportcard.com/report/github.com/ava-labs/libevm)
[![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)
The Ethereum Virtual Machine (EVM) as a library, `libevm` is a fork of [`geth`](https://github.com/ethereum/go-ethereum) with
injectable configuration directives. Although designed to support the Avalanche [C-Chain](https://github.com/ava-labs/coreth) and
[EVM-L1s](https://github.com/ava-labs/subnet-evm) (formerly _subnets_), configuration is general-purpose and backwards-compatible
with `geth`.
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!
## Go Ethereum ## Go Ethereum
Golang execution layer implementation of the Ethereum protocol. Golang execution layer implementation of the Ethereum protocol.
[![API Reference](
https://pkg.go.dev/badge/github.com/ethereum/go-ethereum
)](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc)
[![Go Report Card](https://goreportcard.com/badge/github.com/ethereum/go-ethereum)](https://goreportcard.com/report/github.com/ethereum/go-ethereum)
[![Travis](https://app.travis-ci.com/ethereum/go-ethereum.svg?branch=master)](https://app.travis-ci.com/github/ethereum/go-ethereum)
[![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/nthXNEv)
Automated builds are available for stable releases and the unstable master branch. Binary Automated builds are available for stable releases and the unstable master branch. Binary
archives are published at https://geth.ethereum.org/downloads/. archives are published at https://geth.ethereum.org/downloads/.

View file

@ -13,6 +13,7 @@
// You should have received a copy of the GNU Lesser General Public License // You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see // along with the go-ethereum library. If not, see
// <http://www.gnu.org/licenses/>. // <http://www.gnu.org/licenses/>.
package core package core
// canExecuteTransaction is a convenience wrapper for calling the // canExecuteTransaction is a convenience wrapper for calling the

View file

@ -13,6 +13,7 @@
// You should have received a copy of the GNU Lesser General Public License // You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see // along with the go-ethereum library. If not, see
// <http://www.gnu.org/licenses/>. // <http://www.gnu.org/licenses/>.
package libevm package libevm
import ( import (

View file

@ -13,6 +13,7 @@
// You should have received a copy of the GNU Lesser General Public License // You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see // along with the go-ethereum library. If not, see
// <http://www.gnu.org/licenses/>. // <http://www.gnu.org/licenses/>.
package params package params
import ( import (

View file

@ -13,6 +13,7 @@
// You should have received a copy of the GNU Lesser General Public License // You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see // along with the go-ethereum library. If not, see
// <http://www.gnu.org/licenses/>. // <http://www.gnu.org/licenses/>.
package params package params
import ( import (

View file

@ -13,6 +13,7 @@
// You should have received a copy of the GNU Lesser General Public License // You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see // along with the go-ethereum library. If not, see
// <http://www.gnu.org/licenses/>. // <http://www.gnu.org/licenses/>.
package params package params
import ( import (