Add template #1

ceyonur · 2023-02-23T14:15:28Z

Adds template repository

Example branch and PR based on this template can be found at: #2

richardpringle · 2023-05-19T14:35:30Z

.github/dependabot.yml

+  - package-ecosystem: "gomod" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"


I know there's a precedent already here, but in my experience, weekly PRs from dependabot are actually merged quicker.

My main aim was to put a specific daily check for subnet-evm repo. But I feel like this is not possible.

changed to weekly, if you know anything regarding how we can differentiate this for per-repo, LMK so we can put a specific rule for subnet-evm

richardpringle · 2023-05-19T14:44:18Z

README.md

+
+## How to use
+
+There is an example branch [hello-world-example](https://github.com/ava-labs/precompilevm/tree/hello-world-example) in this repository. You can check the example branch to see how to register precompiles and test them.


Can we get CI to automatically keep the hello-world-example branch up to date?

It certainly possible to keep it up-to-date with precompilevm/master but we also need to keep it up-to-date with subnet-evm + precompile generate tool. So it is mostly a manual process to regenerate those files and fix any conflicts. I will add an action with https://github.com/marketplace/actions/sync-branches to create PRs, but since the branch will be mentioned in docs, we have to keep this a manual process. but we can use CI as a reminder.

@ceyonur, you want to create an issue and reference it here, then resolve this conversation?

README.md

richardpringle · 2023-05-19T15:02:29Z

contract-examples/hardhat.config.ts

@@ -0,0 +1,50 @@
+import "@nomiclabs/hardhat-waffle"


Do we even use waffle in the tests?

I think this was generated from hardhat by default. Probably to be used for task.

contract-examples/hardhat.config.ts

contract-examples/package.json

contract-examples/tasks.ts

plugin/main.go

Co-authored-by: Richard Pringle <rpring9@gmail.com> Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>

aaronbuchwald · 2023-05-25T17:06:23Z

tests/precompile/precompile_test.go

+func TestE2E(t *testing.T) {
+	gomega.RegisterFailHandler(ginkgo.Fail)
+	ginkgo.RunSpecs(t, "subnet-evm precompile ginkgo test suite")
+}
+
+// BeforeSuite starts an AvalancheGo process to use for the e2e tests
+var _ = ginkgo.BeforeSuite(func() {
+	ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
+	defer cancel()
+
+	wd, err := os.Getwd()
+	gomega.Expect(err).Should(gomega.BeNil())
+	log.Info("Starting AvalancheGo node", "wd", wd)
+	startCmd, err = utils.RunCommand("./scripts/run.sh")
+	gomega.Expect(err).Should(gomega.BeNil())
+
+	// Assumes that startCmd will launch a node with HTTP Port at [utils.DefaultLocalNodeURI]
+	healthClient := health.NewClient(utils.DefaultLocalNodeURI)
+	healthy, err := health.AwaitReady(ctx, healthClient, 5*time.Second, nil)
+	gomega.Expect(err).Should(gomega.BeNil())
+	gomega.Expect(healthy).Should(gomega.BeTrue())
+	log.Info("AvalancheGo node is healthy")
+})
+
+var _ = ginkgo.AfterSuite(func() {
+	gomega.Expect(startCmd).ShouldNot(gomega.BeNil())
+	gomega.Expect(startCmd.Stop()).Should(gomega.BeNil())
+})


Can we reduce further code duplication by exporting this from Subnet-EVM and importing it here?

Should make our lives easier if we change this in the future

Since we currently run the same process for every js/ts test file paired with a genesis file, we could also create a utility in Subnet-EVM that automatically collects all of the tests that need to be run and runs all of them, which we could then simply import and run here as well to get rid of a lot of the template code. Just spitballing, don't mean to feature creep for this PR

imported

I think we have a issue for the second part right? ava-labs/subnet-evm#458

aaronbuchwald · 2023-05-25T17:09:19Z

contract-examples/tasks.ts

+  2: "Admin",
+}
+
+const getRole = async (allowList, address) => {


do we need these here?

not currently, removed

aaronbuchwald · 2023-05-25T17:09:45Z

contract-examples/contracts/IAllowList.sol

+//SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+interface IAllowList {


Should we import this from Subnet-EVM instead of copy pasting it here?

Actually, seems like we could get rid of this completely if we did not need AllowList functionality in the next PR. Can we just make it so that HelloWorld does not extend AllowList ?

I'd like to keep HelloWorld same as the one in https://docs.avax.network/subnets/hello-world-precompile-tutorial#tutorial
I will try to import it from subnet-evm

aaronbuchwald · 2023-05-25T17:36:32Z

I think the primary goal for this repo should be to create the simplest and smallest possible example of how to create a Subnet-EVM with custom precompiles.

It seems like there are a few easy ways we can make this repo a bit smaller:

Remove the allow list from HelloWorld so that we don't need to copy paste it (could we also import it?)
Refactor the ginkgo tests in Subnet-EVM to automatically scrape a given genesis/test directory for the tests that it should run and import that here to run the relevant e2e tests

aaronbuchwald · 2023-05-25T17:37:59Z

contract-examples/README.md

@@ -0,0 +1,167 @@
+# Subnet EVM Contracts


Do we need to have a README both here and at the root of the repo? Since the only thing in the repo is a precompile, it seems like one README should be all we need

Could we consolidate these into one README and either include explicit step by step instructions how to use this repo and create your own precompile or create a separate md file that includes instructions, which we can link in the README?

…add-template

ceyonur added 17 commits February 23, 2023 17:09

add repo template

a281ab6

add workflow

3ea6e6d

remove geth import check

e4acefa

add linter

33eebb1

remove coverage

20f643e

add golangci

5071646

more ignore files

95f595c

remove ds store

16102c5

remove pull request template

f02681c

bump subnet-evm version

b94e4a8

remove todos

390df27

bump versions

d7b8bd9

add dependabot

a35f5ce

update golint

8e79f35

bump go version

2ba46a3

run specific version of precompilegen

f18f567

fix license headers

584364e

richardpringle reviewed May 19, 2023

View reviewed changes

ceyonur and others added 2 commits May 19, 2023 23:03

review fixes

2ad6f03

Apply suggestions from code review

9ec30b0

Co-authored-by: Richard Pringle <rpring9@gmail.com> Signed-off-by: Ceyhun Onur <ceyhunonur54@gmail.com>

aaronbuchwald reviewed May 25, 2023

View reviewed changes

ceyonur added 5 commits May 29, 2023 15:34

reviews

db00631

Merge branch 'add-template' of github.com:ava-labs/precompilevm into …

2e2d88b

…add-template

bump go mod to export ginkgo suites branch

ff16ee2

remove yarn

a0926b2

bump node version

9620c78

ceyonur added 4 commits June 8, 2023 20:38

remove yarn lock

c1d8ff0

replace local subnet-evm with registry

3938535

fix package json & suites

33712fa

add local package tgz

ae03784

richardpringle previously approved these changes Jun 15, 2023

View reviewed changes

add package from npm

f5921d8

ceyonur dismissed richardpringle’s stale review via f5921d8 June 16, 2023 13:23

ceyonur added 3 commits June 16, 2023 16:30

Add typescript dep

aa70d80

add interface & test folders

e9ce7b4

rename repo

3fd97c3

richardpringle previously approved these changes Jun 26, 2023

View reviewed changes

bump subnet-evm to v0.5.2-rc.0

0afef4a

ceyonur dismissed richardpringle’s stale review via 0afef4a June 27, 2023 17:05

ceyonur added 2 commits June 27, 2023 20:07

add version to generate_precompile script

ce5e2d2

bump subnet-evm version to v0.5.2

5870e3e

ceyonur mentioned this pull request Jun 29, 2023

add precompile-evm docs ava-labs/avalanche-docs#1418

Merged

aaronbuchwald approved these changes Jun 29, 2023

View reviewed changes

anusha-ctrl approved these changes Jun 29, 2023

View reviewed changes

ceyonur merged commit 6255416 into main Jun 29, 2023

ceyonur deleted the add-template branch June 29, 2023 21:11

ceyonur linked an issue Jun 29, 2023 that may be closed by this pull request

Initialize template repo and guide #3

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add template #1

Add template #1

ceyonur commented Feb 23, 2023 •

edited

Loading

richardpringle May 19, 2023

ceyonur May 29, 2023

ceyonur May 29, 2023

richardpringle May 19, 2023

aaronbuchwald May 25, 2023

ceyonur May 29, 2023

richardpringle Jun 20, 2023

richardpringle May 19, 2023

ceyonur May 19, 2023

aaronbuchwald May 25, 2023

aaronbuchwald May 25, 2023

ceyonur May 29, 2023

aaronbuchwald May 25, 2023

ceyonur May 29, 2023

aaronbuchwald May 25, 2023

aaronbuchwald May 25, 2023

ceyonur May 29, 2023

aaronbuchwald commented May 25, 2023

aaronbuchwald May 25, 2023

aaronbuchwald May 25, 2023


		## How to use

		There is an example branch [hello-world-example](https://github.com/ava-labs/precompilevm/tree/hello-world-example) in this repository. You can check the example branch to see how to register precompiles and test them.

Add template #1

Add template #1

Conversation

ceyonur commented Feb 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronbuchwald commented May 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ceyonur commented Feb 23, 2023 •

edited

Loading