Add minimal viable Anchor #602

chrismaree · 2024-09-10T10:47:56Z

This PR re-works this repo to work alongside Solana Anchor. To achieve this, it adds a number of dependencies and re-works a lot of the repo layout, such as moving where some tests are located (hence the large file diff). In broad strokes this PR does:

Updates the repo to work with node 20. to achieve this two deprecated & redundant packages were removed arb-bridge-eth and arb-bridge-peripherals. both of these are not supported by Arbitrum anymore. We only used these packages to fetch the interfaces in some tests when creating a fake. to supplement this, the ArbutrumMocks.sol was updated to store the same interface (see here).
Added required MVP anchor files, including Anchor.toml, Cargo.lock, Cargo.toml, Programs/x, test/svm/x. sample program has the simplest posible SVM contract and test to show the tooling working.
Moved existing EVM tests from /test/x to /test/evm/hardhat & /test/evm/foundry to better separate test directories and not mix and match the way things were before. This required editing all ts files within the test directory, hence the large change in the PR (done with an automated tool).
Updates the GitHub work flow. This change was pretty extensive. I did the following:
- Updated to node 20. Added the setup and build for Anchor + solana local key gen + rust compilation steps.
- Removed the Solhint job and rather placed this within the Lint job. Solhint is just a lint flow. now, we have a Lint job that does: a) lint-js, b) lint-solidity, c) lint-rust.
- Re-work the Test job to now have: a) test evm-hardhat, b test svm. The test evm-forge is left as a separate job (under the title Forge) to keep the speed of CI up.

Signed-off-by: chrismaree <[email protected]>

socket-security · 2024-09-10T10:48:28Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@babel/[email protected]	None	`0`	248 kB	nicolo-ribaudo
npm/@coral-xyz/[email protected]	None	`0`	37.1 kB	acheroncrypto
npm/@coral-xyz/[email protected]	environment, filesystem, network	`0`	1.8 MB	acheroncrypto
npm/@coral-xyz/[email protected]	None	`0`	22.2 kB	acheroncrypto
npm/@noble/[email protected]	None	`0`	1.6 MB	paulmillr
npm/@noble/[email protected]	None	`0`	837 kB	paulmillr
npm/@solana/[email protected]	None	`0`	197 kB	steveluscher
npm/@solana/[email protected]	network	`0`	10.9 MB	lorisleiva
npm/@swc/[email protected]	None	`0`	231 kB	kdy1, kwonoj
npm/@types/[email protected]	None	`0`	5.91 kB	types
npm/@types/[email protected]	None	`0`	6.67 kB	types
npm/@types/[email protected]	None	`0`	21.2 kB	types
npm/[email protected]	network	`0`	43.7 kB	fengmk2
npm/[email protected]	None	`0`	55.7 kB	no2chem
npm/[email protected]	None	`0`	99 kB	fanatid
npm/[email protected]	None	`0`	34.6 kB	volovyk-s
npm/[email protected]	None	`0`	213 kB	pabigot
npm/[email protected]	None	`0`	11.7 kB	sindresorhus
npm/[email protected]	network	`0`	75.1 kB	lquixada
npm/[email protected]	None	`0`	9.42 kB	sindresorhus
npm/[email protected]	None	`0`	11.2 kB	sindresorhus
npm/[email protected]	None	`0`	10.5 kB	blakeembrey
npm/[email protected]	None	`0`	7.76 kB	digitaldesignlabs
npm/[email protected]	None	`0`	38 kB	lpinca
npm/[email protected]	None	`0`	14 kB	indexzero
npm/[email protected]	None	`0`	125 kB	nickyout
npm/[email protected]	None	`0`	3.66 kB	dead_horse
npm/[email protected]	None	`0`	3.89 kB	heineiuo
npm/[email protected]	None	`0`	162 kB	tedeh
npm/[email protected]	None	`0`	36.8 kB	creationix
npm/[email protected]	None	`0`	0 B
npm/[email protected]	None	`0`	17.7 kB	blakeembrey
npm/[email protected]	environment, eval, filesystem	`0`	3.91 MB	juergba
npm/[email protected]	None	`0`	6.72 kB	styfle
npm/[email protected]	None	`0`	25.1 kB	blakeembrey
npm/[email protected]	network	`0`	162 kB	node-fetch-bot
npm/[email protected]	None	`0`	1.64 MB	vitaly
npm/[email protected]	None	`0`	27.9 kB	benjamn
npm/[email protected]	None	`0`	332 kB	mkozjak
npm/[email protected]	None	`0`	10.4 kB	blakeembrey
npm/[email protected]	None	`0`	182 kB	artmllr
npm/[email protected]	None	`0`	79.4 kB	arv
npm/[email protected]	None	`0`	12.5 kB	dominictarr
npm/[email protected]	None	`0`	144 kB	binarymuse
npm/[email protected]	None	`0`	86.2 kB	typescript-bot
npm/[email protected]	None	`0`	116 kB	ctavan
npm/[email protected]	environment, network	`0`	147 kB	lpinca

View full report↗︎

Signed-off-by: chrismaree <[email protected]>

chrismaree · 2024-09-10T14:30:03Z

contracts/test/ArbitrumMocks.sol

@@ -29,3 +29,27 @@ contract ArbitrumMockErc20GatewayRouter {
        return address(this);
    }
 }
+
+contract Inbox {


interfaces added to replace the need for arb-bridge-eth and arb-bridge-peripherals

utils/utils.ts

Signed-off-by: chrismaree <[email protected]>

chrismaree · 2024-09-11T09:27:42Z

package.json

@@ -66,8 +71,8 @@
    "@types/node": "^12.0.0",
    "@typescript-eslint/eslint-plugin": "^4.29.1",
    "@typescript-eslint/parser": "^4.29.1",
-    "arb-bridge-eth": "^0.7.4",


packages removed to get node 20 support.

chrismaree · 2024-09-11T09:42:02Z

package.json

@@ -19,20 +19,25 @@
  "main": "dist/index.js",
  "scripts": {


note some of the extra split up scripts that I added so we can have seperate parts executed from CI job. We might want to further split up the build command.

Signed-off-by: chrismaree <[email protected]>

nicholaspai · 2024-09-11T12:06:50Z

.github/workflows/pr.yml

-          cache: "yarn"
+          node-version: "${{ matrix.node }}"
+          cache: yarn
+      - name: Setup Anchor & Build


Aside: is github CI smart enough to only run certain tasks if certain files are changed? For example, we should only run anchor tasks if solana files are touched right?

not easily. right now it will do all parts of the work flow on each run. we can improve this later. it's not too slow by comparison to how it was before.

Conditional runs are pretty hard, but I think there are easier ways to make it less imapctful.

Two things on this if it becomes a pain point:

We can use a docker image with rust tools and/or solana tools preinstalled.

We can run this setup in parallel while we're doing EVM build, tests, etc, which I suspect will take longer.

.gitignore

Signed-off-by: chrismaree <[email protected]>

mrice32

LGTM just a few small questions around ci.

I also ran the install and svm-test locally. All worked great.

mrice32 · 2024-09-12T22:25:06Z

.github/workflows/pr.yml

-          cache: "yarn"
+          node-version: "${{ matrix.node }}"
+          cache: yarn
+      - name: Setup Anchor & Build


Conditional runs are pretty hard, but I think there are easier ways to make it less imapctful.

Two things on this if it becomes a pain point:

We can use a docker image with rust tools and/or solana tools preinstalled.

We can run this setup in parallel while we're doing EVM build, tests, etc, which I suspect will take longer.

mrice32 · 2024-09-12T22:28:51Z

.github/workflows/pr.yml

+        run: solana-keygen new --no-bip39-passphrase
+        shell: bash
+      - name: Make Anchor.toml compatible with runner
+        run: "sed -i 's:/user/:/runner/:' Anchor.toml"


I don't see the string user in the Anchor.toml?

I might actually be able to delete this. it was trying to get anchor to detect the solana-keygen new command from above. the util can in some environments place the key in a location anchor cant find it, hence this command. but it looks like we don't need that after all and the tests run without it.

mrice32 · 2024-09-12T22:32:34Z

.github/workflows/publish.yml

@@ -24,6 +24,13 @@ jobs:
        uses: manovotny/[email protected]

      # Setup .npmrc file to publish to npm
+      - name: Setup Anchor & Build


Maybe move the comment above down to above npm?

yup, sorry. I messed that up. have fixed it.

mrice32 · 2024-09-12T22:33:48Z

.github/workflows/pr.yml

+        with:
+          anchor-version: 0.30.1
+          solana-cli-version: 1.18.21
+          node-version: 20.17.0


Will this break if the node version varies (i.e. 20 resolves to 20.17.1)?

Can we just specify 20 here or does it have to be specific?

I think it will work just fine? the version specified above in the config has 20 set, with no sub versions. I'll try changing this here and see if the workflow still runs.

test worked just fine with the node version simply being "20"

mrice32 · 2024-09-12T22:36:10Z

hardhat.config.ts

@@ -468,6 +468,9 @@ const config: HardhatUserConfig = {
    outDir: "./typechain",
    target: "ethers-v5",
  },
+  paths: {
+    tests: "./test/evm/hardhat",


You've double checked that this still runs all the tests, right? Just want to double check that a change like this doesn't accidentally disable all the evm tests because of a minor typo or config issue causes it to point at an empty dir.

Signed-off-by: chrismaree <[email protected]>

mrice32

LGTM!

Added happy ever after

a71917b

Signed-off-by: chrismaree <[email protected]>

chrismaree marked this pull request as draft September 10, 2024 10:52

chrismaree added 6 commits September 10, 2024 13:13

Added happy ever after

8d93d13

Signed-off-by: chrismaree <[email protected]>

Added happy ever after

c4fdb03

Signed-off-by: chrismaree <[email protected]>

Added happy ever after

24ac9f1

Signed-off-by: chrismaree <[email protected]>

Added happy ever after

87deab3

Signed-off-by: chrismaree <[email protected]>

Added happy ever after

2336c5c

Signed-off-by: chrismaree <[email protected]>

Added happy ever after

96fe436

Signed-off-by: chrismaree <[email protected]>

chrismaree commented Sep 10, 2024

View reviewed changes

nicholaspai reviewed Sep 10, 2024

View reviewed changes

utils/utils.ts Outdated Show resolved Hide resolved

chrismaree added 16 commits September 10, 2024 16:40

Added happy ever after

56a75ea

Signed-off-by: chrismaree <[email protected]>

Added happy ever after

99bd393

Signed-off-by: chrismaree <[email protected]>

Added happy ever after

1922aa2

Signed-off-by: chrismaree <[email protected]>

WIP

8888d86

Signed-off-by: chrismaree <[email protected]>

WIP

106eff2

Signed-off-by: chrismaree <[email protected]>

WIP

2a6a9b0

Signed-off-by: chrismaree <[email protected]>

WIP

c9c3876

Signed-off-by: chrismaree <[email protected]>

WIP

c24b3ae

Signed-off-by: chrismaree <[email protected]>

WIP

a99d549

Signed-off-by: chrismaree <[email protected]>

WIP

780fa55

Signed-off-by: chrismaree <[email protected]>

WIP

e4fbcf5

Signed-off-by: chrismaree <[email protected]>

WIP

16fcfe7

Signed-off-by: chrismaree <[email protected]>

WIP

a9213eb

Signed-off-by: chrismaree <[email protected]>

WIP

83d610c

Signed-off-by: chrismaree <[email protected]>

WIP

39733d6

Signed-off-by: chrismaree <[email protected]>

WIP

57f74a7

Signed-off-by: chrismaree <[email protected]>

chrismaree commented Sep 11, 2024

View reviewed changes

chrismaree changed the title ~~Add minimal viable svm~~ Add minimal viable Anchor Sep 11, 2024

chrismaree marked this pull request as ready for review September 11, 2024 09:38

chrismaree commented Sep 11, 2024

View reviewed changes

WIP

4a958fd

Signed-off-by: chrismaree <[email protected]>

nicholaspai reviewed Sep 11, 2024

View reviewed changes

.gitignore Show resolved Hide resolved

nicholaspai approved these changes Sep 11, 2024

View reviewed changes

chrismaree added 2 commits September 11, 2024 16:06

Merge branch 'master' into chrismaree/add-anchor-minimum

4ed9598

WIP

b13eaef

Signed-off-by: chrismaree <[email protected]>

mrice32 approved these changes Sep 12, 2024

View reviewed changes

chrismaree added 3 commits September 15, 2024 19:21

WIP

84689ff

Signed-off-by: chrismaree <[email protected]>

WIP

27c3201

Signed-off-by: chrismaree <[email protected]>

Merge branch 'master' into chrismaree/add-anchor-minimum

393e9bb

mrice32 approved these changes Sep 17, 2024

View reviewed changes

chrismaree merged commit 5c779a9 into master Sep 17, 2024
9 checks passed

chrismaree deleted the chrismaree/add-anchor-minimum branch September 17, 2024 15:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add minimal viable Anchor #602

Add minimal viable Anchor #602

chrismaree commented Sep 10, 2024 •

edited

Loading

socket-security bot commented Sep 10, 2024 •

edited

Loading

chrismaree Sep 10, 2024 •

edited

Loading

chrismaree Sep 11, 2024

chrismaree Sep 11, 2024

nicholaspai Sep 11, 2024

chrismaree Sep 12, 2024

mrice32 Sep 12, 2024

mrice32 left a comment •

edited

Loading

mrice32 Sep 12, 2024

mrice32 Sep 12, 2024

chrismaree Sep 15, 2024

mrice32 Sep 12, 2024

chrismaree Sep 15, 2024

mrice32 Sep 12, 2024

chrismaree Sep 15, 2024

chrismaree Sep 15, 2024

mrice32 Sep 17, 2024

mrice32 Sep 12, 2024

chrismaree Sep 15, 2024

chrismaree Sep 15, 2024

mrice32 Sep 17, 2024

mrice32 left a comment

Add minimal viable Anchor #602

Add minimal viable Anchor #602

Conversation

chrismaree commented Sep 10, 2024 • edited Loading

socket-security bot commented Sep 10, 2024 • edited Loading

chrismaree Sep 10, 2024 • 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

mrice32 left a comment • 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

mrice32 left a comment

Choose a reason for hiding this comment

chrismaree commented Sep 10, 2024 •

edited

Loading

socket-security bot commented Sep 10, 2024 •

edited

Loading

chrismaree Sep 10, 2024 •

edited

Loading

mrice32 left a comment •

edited

Loading