televerse-dao-typechain-types 1.0.0 → 1.0.1

package/README.md

@@ -1,152 +1,16 @@
-# Hardhat Televerse DAO
+# Televerse DAO Typechain Types
 
-This Hardhat repository contains the Contracts, Unit Tests, and Scripts for the Televerse Dao
+## Purpose
 
-```sh
-git clone https://github.com/MeshDevs/televerse-dao.git
-cd hardhat
-pnpm install
-pnpx hardhat compile # builds the contracts
-pnpm prepare         # NOTE: this adds a post-checkout hook for the purpose of generating typechain types (equivalent of pnpm typechain:generate)
-```
-
-Once installed, let's create our .env file based on the .env.sample, fill in its missing fields:
-
-```sh
-touch .env
-```
-
-Note: the COINMARKETCAP_API_KEY field is necessary to return usd value of transactions during eth gas estimation
-
-We can compile and clean (only if compilation or test results are not as expected) the contracts within this project with the following commands:
-
-```sh
-npx hardhat compile
-npx hardhat clean
-```
-
-## Development
-
-For local development run the following command:
-
-```sh
-pnpm dev
-```
-
-This will start:
+These types allow us to access the smart contract factories for creating
+interfaces to the Telverse DAO contracts. It also exports via the factories the
+abi references needed by Viem.
 
-1. a local hardhat node listening here: `http://127.0.0.1:8545`
-2. a local http server listening here: `http://127.0.0.1:6061`
+## Example Use
 
-## Run & Deploy
-
-In order to run and deploy the hardhat development node:
-
-1. Start the hardhat development node (defaults to: 'http://127.0.0.1:8545')
-
-```sh
-pnpm hardhat node
-```
-
-2. Obtain the `PRIVATE_KEY_MASTER` from any account and update the `.env` file accordingly.
-
-3. Deploy the contracts with the following command (`deploy:all` knows the correct order for deployment):
-
-```sh
-pnpm hardhat deploy:all
+```ts
+import {
+  type Governance,
+  Governance__factory,
+} from 'typechain-types';
 ```
-
-For additional information relating to integrating with the TSPN, refer to the README.md in the TSPN repo [here](https://github.com/DCConnect-Global/tspn)
-
-4. the `zkEvm` and its deployed contracts are now available the local url (or, if deployed to the televerse staging server, at `https://m8kkp6.televersedao.com/rpc`)
-
-## Deployment: Staging
-
-There is a `.github/workflows/deploy-staging.yml` for deployment to staging. Note that the target (host) requires the following nginx configuration for the deployment to work:
-
-```nginx
-server {
-    server_name m8kkp6.televersedao.com;
-
-    root /var/www/html;
-    index index.html;
-
-    # Serve index.html for /
-    location = / {
-        try_files $uri $uri/ =404;
-    }
-
-    location = /contract_addresses {
-        root /var/www;
-        try_files /contracts.staging.json =404;
-        default_type application/json;
-    }
-
-    location /rpc {
-        proxy_pass http://127.0.0.1:8545/;
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection 'upgrade';
-        proxy_set_header Host $host;
-        proxy_cache_bypass $http_upgrade;
-    }
-
-    listen 443 ssl; # managed by Certbot
-    ssl_certificate /etc/letsencrypt/live/m8kkp6.televersedao.com/fullchain.pem; # managed by Certbot
-    ssl_certificate_key /etc/letsencrypt/live/m8kkp6.televersedao.com/privkey.pem; # managed by Certbot
-    include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
-    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
-}
-
-```
-
-This is served at `https://m8kkp6.televersedao.com/` (staging).
-
-## Environment
-
-Depending on the target environment (set in the `.env` file as `ZKEVM_ENV={local,staging,production}`) a corresponding `zkevmNetwork` file will be loaded. These are located
-in the `./settings/zkevmNetwork.<ZKEMV_ENV>.json`. The format for which is:
-
-```json
-{
-  "network_rpc": "http://127.0.0.1:8545"
-}
-```
-
-## Testing
-
-We can run our coverage and gas estimation tests with the following commands:
-
-```bash
-$ npx hardhat coverage --solcoverjs ./.solcover.js
-$ npx hardhat test
-```
-
-## E2E Testing
-
-A new version of the end-to-end contract test suite has been made to run on a local hardhat instance.
-Those tests can be found in the e2e folder within this hardhat project. In order to make those
-tests run properly one must do the following in addition to unit test suite setup:
-
-1. Finally change the test path location in the hardhat config file from ./test to ./e2e
-2. Run the npx hardhat test command listed above in the Testing section
-
-## Additional Support
-
-If running into any errors we suggest checking that all .env variables in use are populated correctly
-Following the stack trace to the exact line should quickly reveal if the problem is an .env variable
-Please post and error and its stack trace in the discord chat for further help
-
-## Additional Instruction
-
-You can find detailed instructions on using this repository and many tips in [its documentation](https://hardhat.org/tutorial).
-
-- [Writing and compiling contracts](https://hardhat.org/tutorial/writing-and-compiling-contracts/)
-- [Setting up the environment](https://hardhat.org/tutorial/setting-up-the-environment/)
-- [Testing Contracts](https://hardhat.org/tutorial/testing-contracts/)
-- [Setting up Metamask](https://hardhat.org/tutorial/boilerplate-project#how-to-use-it)
-- [Hardhat's full documentation](https://hardhat.org/docs/)
-
-For a complete introduction to Hardhat, refer to [this guide](https://hardhat.org/getting-started/#overview).
-
-**Happy _building_!**

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "televerse-dao-typechain-types",
   "sourceType": "commonjs",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "The typechain types for the Televerse DAO smart contracts.",
   "license": "MIT",
   "files": [
-    "typechain-types",
-    "README"
+    "typechain-types"
   ],
   "exports": {
     ".": {

package/README

@@ -1,16 +0,0 @@
-# Televerse DAO Typechain Types
-
-## Purpose
-
-These types allow us to access the smart contract factories for creating
-interfaces to the Telverse DAO contracts. It also exports via the factories the
-abi references needed by Viem.
-
-## Example Use
-
-```ts
-import {
-  type Governance,
-  Governance__factory,
-} from 'typechain-types';
-```