Merge pull request #81 from smartcontractkit/only-webpack-and-anvil

DEVSVCS-1213: replace Ganache with Anvil and upgrade webpack and remove esmify

Author: FelixFan1992

.github/workflows/test-package.yaml

@@ -18,6 +18,9 @@ jobs:
         with:
           node-version: 18
 
+      - name: setup-foundry
+        uses: foundry-rs/foundry-toolchain@de808b1eea699e761c404bda44ba8f21aba30b2c # v1.3.1
+
       - name: Install dependencies
         run: npm install # npm install instead of npm ci is used to prevent unsupported platform errors due to the fsevents sub-dependency --no-optional
 

.github/workflows/test.yaml

@@ -21,6 +21,9 @@ jobs:
         with:
           node-version: 18
 
+      - name: setup-foundry
+        uses: foundry-rs/foundry-toolchain@de808b1eea699e761c404bda44ba8f21aba30b2c # v1.3.1
+
       - name: Install dependencies
         run: npm install # npm install instead of npm ci is used to prevent unsupported platform errors due to the fsevents sub-dependency
 

Makefile

@@ -0,0 +1,20 @@
+# Makefile
+
+# Define the default target
+.PHONY: all
+all: install
+
+# Install Foundry and npm packages
+.PHONY: install
+install:
+	@echo "Installing Foundry..."
+	curl -L https://foundry.paradigm.xyz | bash
+	@echo "Installing npm packages..."
+	npm install
+
+# Clean up the project
+.PHONY: clean
+clean:
+	@echo "Cleaning up..."
+	rm -rf node_modules
+	rm -rf dist

README.md

@@ -38,6 +38,9 @@ Up-to-date documentation on Chainlink Functions can be found [here](https://docs
 
 Install Node.js version `18.18.0` or higher _and_ Deno version `1.36.0` or higher.
 
+For version 0.3.2 and above of this functions-toolkit package, Anvil is required to run local tests. A `Makefile` is included to automate the installation and build process. Simply run `make install` to install Anvil and all npm packages.
+If you already have anvil and/or foundry (the Foundry toolchain) installed, you would not need to run this. But you may want to run `foundryup` to update your version and `npm install` to install packages.
+
 Chainlink Functions requires signing a terms of service agreement before creating a billing subscription. See this [getting started](https://docs.chain.link/chainlink-functions/getting-started) section in the docs.
 
 ## Functions Billing Subscription Management
@@ -593,14 +596,16 @@ return Functions.encodeString(escape("$hello*world?"));
 
 ### Local Functions Testnet
 
+> **Note**
+> For version 0.3.2 and above of this functions-toolkit package, Anvil is REQUIRED to use `localFunctionsTestnet`. Please run `make install` to install Anvil and all the necessary dependencies. If you already have anvil and/or foundry (the Foundry toolchain) installed, you would not need to run this. But you may want to run `foundryup` to update your version and `npm install` to install packages.
+
 For debugging smart contracts and the end-to-end request flow on your local machine, you can use the `localFunctionsTestnet` function. This creates a local testnet RPC node with a mock Chainlink Functions contracts. You can then deploy your own Functions consumer contract to this local network, create and manage subscriptions, and send requests. Request processing will simulate the behavior of an actual DON where the request is executed 4 times and the discrete median response is transmitted back to the consumer contract. (Note that Chainlink Functions uses the following calculation to select the discrete median response: `const medianResponse = responses[responses.length - 1) / 2]`).
 
 The `localFunctionsTestnet` function takes the following values as arguments.
 
 ```
 const localFunctionsTestnet = await startLocalFunctionsTestnet(
   simulationConfigPath?: string // Absolute path to config file which exports simulation config parameters
-  options?: ServerOptions, // Ganache server options
   port?: number, // Defaults to 8545
 )
 ```
@@ -623,10 +628,10 @@ export const maxQueryResponseBytes = 2097152 // Maximum size of incoming HTTP re
 
 ```
 {
-  server: Server // Ganache server
+  anvil: Anvil // Anvil instance
   adminWallet: { address: string, privateKey: string } // Funded admin wallet
   getFunds: (address: string, { weiAmount, juelsAmount }: { weiAmount?: BigInt | string; juelsAmount?: BigInt | string }) => Promise<void> // Method which can be called to send funds to any address
-  close: () => Promise<void> // Method to close the server
+  close: () => Promise<void> // Method to stop the Anvil instance
   donId: string // DON ID for simulated DON
   // The following values are all Ethers.js contract types: https://docs.ethers.org/v5/api/contract/contract/
   linkTokenContract: Contract // Mock LINK token contract