Refactor by johnwhitton · Pull Request #38 · harmony-one/horizon

johnwhitton · 2022-05-25T22:18:58Z

Refactor to improve solidity tooling using hardhat including testing, deployment, documentation and gas estimation. As well as consolidate all tools, scripts and cli into a src folder.

Migration Strategy

Smart Contract use Hardhat with Typescript and ethers(instead of web3)
- Replace all web3 with ethers
- replace all solidity deployments and test js files with typescript
- remove all truffleConfig use hardhat instead
- write tests
docs: new folder for documentation
docs/assets => migrated from assets
docs/solidity: contains generated solidity documentation
deploy: new folder for deployment scripts (using hardhat-deploy and logic from scripts)
src: new folder for typescript source files
src/lib: (migrated from scripts)
src/cli: (migrated from cli)
src/(elc, eprover, eth2hmy-relay): migrated from tools(elc, eprover, eth2hmy-relay)

Action Items

Resolve gas issue with Kovan Deployment
Resolve upgrade Process
Generate DAGs for Local Ethereum (Hardhat) node

Logs and Analysis

johnlaptop horizon (refactor) $ npx hardhat deploy --network hardhat --tags HarmonyLightClient
Nothing to compile
No need to generate any newer typings.
✅ Generated documentation for 46 contracts
(node:62043) UnhandledPromiseRejectionWarning: Error: processing response error (body="{\"jsonrpc\":\"2.0\",\"id\":42,\"error\":{\"code\":-32600,\"message\":\"invalid request\"}}\n", error={"code":-32600}, requestBody="{\"method\":{\"jsonrpc\":\"2.0\",\"method\":\"hmyv2_getFullHeader\",\"params\":[\"0xe\"],\"id\":1654537992451},\"id\":42,\"jsonrpc\":\"2.0\"}", requestMethod="POST", url="http://localhost:9500", code=SERVER_ERROR, version=web/5.6.0)
    at Logger.makeError (/Users/john/one-wallet/horizon/node_modules/@ethersproject/logger/src.ts/index.ts:261:28)
    at Logger.throwError (/Users/john/one-wallet/horizon/node_modules/@ethersproject/logger/src.ts/index.ts:273:20)
    at /Users/john/one-wallet/horizon/node_modules/@ethersproject/web/src.ts/index.ts:329:28
    at step (/Users/john/one-wallet/horizon/node_modules/@ethersproject/web/lib/index.js:33:23)
    at Object.next (/Users/john/one-wallet/horizon/node_modules/@ethersproject/web/lib/index.js:14:53)
    at fulfilled (/Users/john/one-wallet/horizon/node_modules/@ethersproject/web/lib/index.js:5:58)
    at processTicksAndRejections (internal/process/task_queues.js:95:5)
(Use `node --trace-warnings ...` to show where the warning was created)
(node:62043) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:62043) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

…ools-> elc)

polymorpher · 2022-05-26T07:25:02Z

.gitignore

+Thumbs.db
+
+# Ignore built ts files
+dist/**/*


This will ignore eth2hmy-relay/ethash/dist/**

polymorpher · 2022-05-26T07:31:57Z

package.json.orig

@@ -0,0 +1,71 @@
+{


we can just remove this

polymorpher · 2022-05-26T07:34:12Z

docs/README.md

@@ -1,2 +1,294 @@
 # Horizon Bridge Documentation and API reference

+# Overview


Was this updated after the other PR (#37)?

polymorpher · 2022-05-26T07:35:16Z

docs/SOLIDITY.md

@@ -0,0 +1,133 @@
+# Advanced Sample Hardhat Project


Remove template file? Doesn't seem to be very relevant

If some commands are helpful - we can keep them in a short cheatsheet

polymorpher · 2022-05-26T07:37:26Z

yarn-error.log should be ignored

polymorpher · 2022-05-26T07:38:08Z

Can the auto-generated d.ts files be removed? They are more distracting than helpful

polymorpher · 2022-05-26T07:41:13Z

Can all auto-generated .md files be removed until we manually review and polish them (e.g. by extensively commenting on original .sol file, or adding extra to .md)? The reason is they don't contain useful information, and may discourage a new developer into thinking all our documentations are just boilerplates

polymorpher · 2022-05-26T07:41:50Z

Can data/abi/* be removed as well? They don't look like abi and they are not referenced elsewhere

polymorpher · 2022-05-26T07:47:17Z

Lastly, can some template files be removed as well? (e.g. the docs/SOLIDITY.md mentioned in in-line comments). Let's focus on information that is strongly relevant to helping other developers understand and onboard the project

…t api issues

…ve redundant deploy scripts

…network, deployment, testing and coverage information

….md to include reference to the developer guide

johnwhitton · 2022-06-08T03:21:32Z

Merged latest upstream/main still have some action items for testing and deployment which can be progressed separately.

confirm linting has an indentation of 4 spaces
Fix test EthLightClient.js
Fix deploy script 004_deploy_ethereumLightClient.ts (Fixed by removing deplyments/localnet folder and redeploying)
Remove scripts directory (util.js -> src/lib and newtest.js -> test)

…lnet

…Developer.md

johnwhitton added 21 commits May 18, 2022 17:28

Update hardhat.config.js to use .env for Infura Project Id

d1de57f

Update testing README.md with beginning of initial setup information

8409435

Update testing README.md with beginning of initial setup information

73ee8f9

Update testing README.md including info from ethereum light client (t…

8a5c5be

…ools-> elc)

Update README.md

72e2343

Include Overview of Project Status in docs => README.md

aa2439f

include notes on permissionless validator rollout

f464aa4

Include notes on Testing

fcf52cd

Update README with more instructions

eea86ea

Additional deployment info

18bb47e

Include information for blockchain dependencies

9b90df5

Initial refactor to use hardhat and typescript and generate docs

f7343ca

Include typechain definitions

8b25003

update scripts in package.json and include type definitions

b97a8ef

Begin migration to hardhat, ethers, typescript

44984ac

Fix typos in README.md

16fa99b

Refactor of codebase folder structures

83e6deb

Some deploy functionality

16a7f13

Update tsConfig to improve compilation issues

41e2580

Update tsConfig to improve compilation issues

1bda6f6

Update docs/README.md with Developer Setup and Testing guide

62e9c24

polymorpher reviewed May 26, 2022

View reviewed changes

.gitignore

Thumbs.db

# Ignore built ts files

dist/**/*

Copy link

Collaborator

polymorpher May 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will ignore eth2hmy-relay/ethash/dist/**

polymorpher reviewed May 26, 2022

View reviewed changes

package.json.orig Outdated

@@ -0,0 +1,71 @@

{

Copy link

Collaborator

polymorpher May 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can just remove this

polymorpher reviewed May 26, 2022

View reviewed changes

johnwhitton added 17 commits May 26, 2022 18:21

Refactor deployment and remove redundant documentation

b482383

Update Deploy scripts for LightClients and TokenLockers

1f4f51e

Include Harmony Node fork to use

c5970fb

Include latest launch information in docs

d58fd51

Create DEVELOPER.md and start work on refactored cli

15ac3a1

Add linting commands to package.json

4c7dafd

Fix lint to just lint deploy src and test directories

d46b9dd

Run yarn lint

88b5076

Working Local Deployments (no proxies), update linting, fix deploymen…

5845f7f

…t api issues

Include a cheatsheet in DEVELOPER.md

40f4b8b

Update Developer.md with smart contract and network information, remo…

3d52be0

…ve redundant deploy scripts

DEVELOPER.md add in smart contract testing strategy and sample coverage

215d812

Add CLI to DEVELOPER.md

11fe633

Include smart contract testing scaffolding, update DEVELOPER.md with …

c2ab222

…network, deployment, testing and coverage information

Remove old obsolete documentation from DEVELOPER.md and update README…

e5bcea3

….md to include reference to the developer guide

Update DEVELOPER.md to include coverage in quick start

ab0a1be

Merge latest upstream/main into refactor and resolve conflicts

1838ff2

johnwhitton added 7 commits June 8, 2022 10:22

harhat compile generation of typechain factories and redeploy to loca…

c619f49

…lnet

Pull in latest eprover/everifier and Harmony prover fixes

75c6499

remove old cli folder as it is now under src directory

94d9ea3

add in latest changes to Receipt.js and MPT.test.js

60f72c1

Ignore typechain folder, update eslint, begin work on cli testing in …

7fe5671

…Developer.md

Update HarmonyProverTest to use latest solidity compiler

be2221b

Add in additional CLI deploy steps

d208cd4

gupadhyaya approved these changes Jun 9, 2022

View reviewed changes

gupadhyaya merged commit 560c96f into harmony-one:main Jun 9, 2022

johnwhitton mentioned this pull request Jun 20, 2022

Refactor v2 #48

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor#38

Refactor#38
gupadhyaya merged 45 commits intoharmony-one:mainfrom
johnwhitton:refactor

johnwhitton commented May 25, 2022 •

edited

Loading

Uh oh!

polymorpher May 26, 2022

Uh oh!

polymorpher May 26, 2022

Uh oh!

polymorpher May 26, 2022

Uh oh!

polymorpher May 26, 2022

Uh oh!

polymorpher May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

johnwhitton commented Jun 8, 2022 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -1,2 +1,294 @@
		# Horizon Bridge Documentation and API reference

		# Overview

Conversation

johnwhitton commented May 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Migration Strategy

Action Items

Logs and Analysis

Uh oh!

polymorpher May 26, 2022

Choose a reason for hiding this comment

Uh oh!

polymorpher May 26, 2022

Choose a reason for hiding this comment

Uh oh!

polymorpher May 26, 2022

Choose a reason for hiding this comment

Uh oh!

polymorpher May 26, 2022

Choose a reason for hiding this comment

Uh oh!

polymorpher May 26, 2022

Choose a reason for hiding this comment

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

polymorpher commented May 26, 2022

Uh oh!

johnwhitton commented Jun 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

johnwhitton commented May 25, 2022 •

edited

Loading

johnwhitton commented Jun 8, 2022 •

edited

Loading