From c4952c7e6d5e2c0eb9391b64d43c7fd1fac10616 Mon Sep 17 00:00:00 2001
From: Mark Tyneway <mark.tyneway@gmail.com>
Date: Thu, 2 Jun 2022 14:00:48 -0700
Subject: [PATCH] contracts-bedrock: prepare for release

---
 packages/contracts-bedrock/foundry.toml                  | 3 +--
 packages/contracts-bedrock/package.json                  | 9 ++++-----
 packages/contracts-bedrock/{helpers => src}/constants.ts | 0
 .../contracts-bedrock/{helpers => src}/generateProofs.ts | 0
 packages/contracts-bedrock/src/index.ts                  | 3 +++
 .../{helpers => src}/trie-test-generator.ts              | 0
 packages/contracts-bedrock/{helpers => src}/utils.ts     | 0
 packages/contracts-bedrock/tasks/deposits.ts             | 2 +-
 packages/contracts-bedrock/test/helpers.spec.ts          | 2 +-
 packages/contracts-bedrock/tsconfig.json                 | 9 ++++++---
 10 files changed, 16 insertions(+), 12 deletions(-)
 rename packages/contracts-bedrock/{helpers => src}/constants.ts (100%)
 rename packages/contracts-bedrock/{helpers => src}/generateProofs.ts (100%)
 create mode 100644 packages/contracts-bedrock/src/index.ts
 rename packages/contracts-bedrock/{helpers => src}/trie-test-generator.ts (100%)
 rename packages/contracts-bedrock/{helpers => src}/utils.ts (100%)

diff --git a/packages/contracts-bedrock/foundry.toml b/packages/contracts-bedrock/foundry.toml
index bc4dc7b1f7692..700a32a448bb1 100644
--- a/packages/contracts-bedrock/foundry.toml
+++ b/packages/contracts-bedrock/foundry.toml
@@ -1,7 +1,5 @@
 [default]
 src = 'contracts'
- # We need to build seperate artifacts for forge and hh, because they each expect a different
- # structure for the artifacts directory.
 out = 'forge-artifacts'
 optimizer = true
 optimizer_runs = 999999
@@ -14,4 +12,5 @@ remappings = [
   'forge-std/=node_modules/forge-std/src',
   'ds-test/=node_modules/ds-test/src'
 ]
+extra_output = ['devdoc', 'userdoc', 'metadata', 'storageLayout']
 bytecode_hash = "none"
diff --git a/packages/contracts-bedrock/package.json b/packages/contracts-bedrock/package.json
index 1e60a04cd1d21..5625b168afbb2 100644
--- a/packages/contracts-bedrock/package.json
+++ b/packages/contracts-bedrock/package.json
@@ -25,13 +25,12 @@
   },
   "scripts": {
     "build:forge": "forge build",
-    "build": "yarn hardhat compile",
-    "test:hh": "yarn hardhat test",
-    "test": "yarn test:forge",
-    "test:forge": "forge test",
+    "build": "hardhat compile && tsc && hardhat typechain",
+    "build:ts": "tsc",
+    "test": "forge test",
     "gas-snapshot": "forge snapshot",
     "slither": "slither .",
-    "clean": "rm -rf ./artifacts ./forge-artifacts ./cache ./coverage ./tsconfig.tsbuildinfo",
+    "clean": "rm -rf ./dist ./artifacts ./forge-artifacts ./cache ./coverage ./tsconfig.tsbuildinfo",
     "lint:ts:check": "eslint .",
     "lint:contracts:check": "yarn solhint -f table 'contracts/**/*.sol'",
     "lint:check": "yarn lint:contracts:check && yarn lint:ts:check",
diff --git a/packages/contracts-bedrock/helpers/constants.ts b/packages/contracts-bedrock/src/constants.ts
similarity index 100%
rename from packages/contracts-bedrock/helpers/constants.ts
rename to packages/contracts-bedrock/src/constants.ts
diff --git a/packages/contracts-bedrock/helpers/generateProofs.ts b/packages/contracts-bedrock/src/generateProofs.ts
similarity index 100%
rename from packages/contracts-bedrock/helpers/generateProofs.ts
rename to packages/contracts-bedrock/src/generateProofs.ts
diff --git a/packages/contracts-bedrock/src/index.ts b/packages/contracts-bedrock/src/index.ts
new file mode 100644
index 0000000000000..4ea5798fa7724
--- /dev/null
+++ b/packages/contracts-bedrock/src/index.ts
@@ -0,0 +1,3 @@
+export * from './utils'
+export * from './generateProofs'
+export * from './constants'
diff --git a/packages/contracts-bedrock/helpers/trie-test-generator.ts b/packages/contracts-bedrock/src/trie-test-generator.ts
similarity index 100%
rename from packages/contracts-bedrock/helpers/trie-test-generator.ts
rename to packages/contracts-bedrock/src/trie-test-generator.ts
diff --git a/packages/contracts-bedrock/helpers/utils.ts b/packages/contracts-bedrock/src/utils.ts
similarity index 100%
rename from packages/contracts-bedrock/helpers/utils.ts
rename to packages/contracts-bedrock/src/utils.ts
diff --git a/packages/contracts-bedrock/tasks/deposits.ts b/packages/contracts-bedrock/tasks/deposits.ts
index 9c7b77bc6ba3b..8e6f0d45719d9 100644
--- a/packages/contracts-bedrock/tasks/deposits.ts
+++ b/packages/contracts-bedrock/tasks/deposits.ts
@@ -2,7 +2,7 @@ import { task, types } from 'hardhat/config'
 import { Contract, providers, utils, Wallet, Event } from 'ethers'
 import dotenv from 'dotenv'
 
-import { DepositTx } from '../helpers/index'
+import { DepositTx } from '../src'
 
 dotenv.config()
 
diff --git a/packages/contracts-bedrock/test/helpers.spec.ts b/packages/contracts-bedrock/test/helpers.spec.ts
index f4a67a6d6039b..066422f1a732f 100644
--- a/packages/contracts-bedrock/test/helpers.spec.ts
+++ b/packages/contracts-bedrock/test/helpers.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from 'chai'
 import { BigNumber } from 'ethers'
 
-import { DepositTx, SourceHashDomain } from '../helpers'
+import { DepositTx, SourceHashDomain } from '../src'
 
 describe('Helpers', () => {
   describe('DepositTx', () => {
diff --git a/packages/contracts-bedrock/tsconfig.json b/packages/contracts-bedrock/tsconfig.json
index a375bd3c46ce7..52b34d98fadbe 100644
--- a/packages/contracts-bedrock/tsconfig.json
+++ b/packages/contracts-bedrock/tsconfig.json
@@ -1,8 +1,11 @@
 {
   "extends": "../../tsconfig.json",
-  "include": ["./scripts/", "./helpers/"],
   "compilerOptions": {
-    "rootDir": ".",
+    "rootDir": "./src",
     "outDir": "./dist"
-  }
+  },
+  "exclude": ["hardhat.config.ts", "deploy", "tasks", "test"],
+  "include": [
+    "src/**/*"
+  ]
 }