Merge pull request #85 from smartcontractkit/small-refactors

address some smaller feedback on styling

Author: FelixFan1992

README.md

@@ -38,7 +38,7 @@ 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.
+For version 0.3.2 and above of this functions-toolkit package, [Anvil](https://book.getfoundry.sh/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.
@@ -638,6 +638,7 @@ export const maxQueryResponseBytes = 2097152 // Maximum size of incoming HTTP re
   functionsRouterContract: Contract // Mock FunctionsRouter contract
 }
 ```
+where Anvil instance is defined as [such](https://github.com/wevm/anvil.js/blob/main/packages/anvil.js/src/anvil/createAnvil.ts#L10)
 
 Now you can connect to the local Functions testnet RPC node with your preferred blockchain tooling, deploy a FunctionsConsumer contract, instantiate and initialize the`SubscriptionManager`, create, add the consumer contract and fund the subscription, send requests, and use the `ResponseListener` to listen for responses all on your machine.
 

src/localFunctionsTestnet.ts

@@ -33,6 +33,9 @@ import type {
   RequestEventData,
 } from './types'
 
+// this chain id is defined here as a default: https://github.com/wevm/viem/blob/main/src/chains/definitions/localhost.ts#L4
+const chainId = 1337
+
 export const startLocalFunctionsTestnet = async (
   simulationConfigPath?: string,
   port = 8545,
@@ -41,28 +44,26 @@ export const startLocalFunctionsTestnet = async (
   try {
     anvil = createAnvil({
       port,
-      chainId: 1337,
+      chainId: chainId,
     })
   } catch (error) {
     console.error('Error creating Anvil instance: ', error)
     console.error(
-      'Please refer to README about how to properly set up the environment, including anvil.',
+      'Please refer to README about how to properly set up the environment, including anvil.\n',
     )
     throw error
   }
 
   await anvil.start()
-  console.log(`Anvil started on port ${port} with chain ID 1337`)
+  console.log(`Anvil started on port ${port} with chain ID 1337\n`)
 
   anvil.on('message', message => {
     console.log('Anvil message:', message)
   })
 
-  let privateKey = process.env.PRIVATE_KEY
-  if (!privateKey) {
-    // this is a hardcoded private key provided by anvil
-    privateKey = 'ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80'
-  }
+  // this is a hardcoded private key provided by anvil, defined here: https://book.getfoundry.sh/anvil/#getting-started
+  const privateKey =
+    process.env.PRIVATE_KEY || 'ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80'
 
   const admin = new Wallet(privateKey, new providers.JsonRpcProvider(`http://127.0.0.1:${port}`))
 

test/integration/fetchRequestCommitment.test.ts

@@ -3,6 +3,8 @@ import { setupLocalTestnetFixture } from '../utils'
 
 import { Contract, Wallet, utils, providers } from 'ethers'
 
+const localhost = 'http://127.0.0.1:8004/'
+
 jest.retryTimes(2, { logErrorsBeforeRetry: true })
 
 describe('fetchRequestCommitment', () => {
@@ -62,7 +64,7 @@ describe('fetchRequestCommitment', () => {
 
     const commitment = await fetchRequestCommitment({
       requestId: reqId,
-      provider: new providers.JsonRpcProvider('http://127.0.0.1:8004/'),
+      provider: new providers.JsonRpcProvider(`${localhost}`),
       functionsRouterAddress,
       donId,
     })
@@ -105,7 +107,7 @@ describe('fetchRequestCommitment', () => {
 
     const commitment = await fetchRequestCommitment({
       requestId: reqId,
-      provider: new providers.JsonRpcProvider('http://127.0.0.1:8004/'),
+      provider: new providers.JsonRpcProvider(`${localhost}`),
       functionsRouterAddress,
       donId,
       toBlock: 1000,
@@ -119,7 +121,7 @@ describe('fetchRequestCommitment', () => {
     await expect(async () => {
       await fetchRequestCommitment({
         requestId: '0xDummyRequestId',
-        provider: new providers.JsonRpcProvider('http://127.0.0.1:8004/'),
+        provider: new providers.JsonRpcProvider(`${localhost}`),
         functionsRouterAddress,
         donId: 'invalid donId',
       })
@@ -132,7 +134,7 @@ describe('fetchRequestCommitment', () => {
     await expect(async () => {
       await fetchRequestCommitment({
         requestId: '0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
-        provider: new providers.JsonRpcProvider('http://127.0.0.1:8004/'),
+        provider: new providers.JsonRpcProvider(`${localhost}`),
         functionsRouterAddress,
         donId,
       })

test/utils/index.ts

@@ -76,6 +76,7 @@ const createTestWallets = (port = 8545): Wallet[] => {
 
   // these are hardcoded private keys provided by anvil. you can see these private keys in the console output if you simply run `anvil`
   // using these makes sure that these wallets are properly connected to Anvil local node
+  // check https://book.getfoundry.sh/anvil/#getting-started for more details
   const privateKeys = [
     '59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d',
     '5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a',