added viem subscription tests

Author: shunjizhan

e2e-tests/e2e-viem/contracts/Echo.sol

@@ -4,7 +4,10 @@ contract Echo{
     string public echo;
     uint echoCount;
 
-    event NewEcho(string message, uint count);
+    event NewEcho(
+        string indexed message,
+        uint256 count
+    );
 
     constructor() {
         echo = "Deployed successfully!";

e2e-tests/e2e-viem/docker-compose.yml

@@ -0,0 +1,67 @@
+export const ECHO_JSON = {
+  _format: 'hh-sol-artifact-1',
+  contractName: 'Echo',
+  sourceName: 'contracts/Echo.sol',
+  abi: [
+    {
+      inputs: [],
+      stateMutability: 'nonpayable',
+      type: 'constructor',
+    },
+    {
+      anonymous: false,
+      inputs: [
+        {
+          indexed: true,
+          internalType: 'string',
+          name: 'message',
+          type: 'string',
+        },
+        {
+          indexed: false,
+          internalType: 'uint256',
+          name: 'count',
+          type: 'uint256',
+        },
+      ],
+      name: 'NewEcho',
+      type: 'event',
+    },
+    {
+      inputs: [],
+      name: 'echo',
+      outputs: [
+        {
+          internalType: 'string',
+          name: '',
+          type: 'string',
+        },
+      ],
+      stateMutability: 'view',
+      type: 'function',
+    },
+    {
+      inputs: [
+        {
+          internalType: 'string',
+          name: 'message',
+          type: 'string',
+        },
+      ],
+      name: 'scream',
+      outputs: [
+        {
+          internalType: 'string',
+          name: '',
+          type: 'string',
+        },
+      ],
+      stateMutability: 'nonpayable',
+      type: 'function',
+    },
+  ],
+  bytecode: '0x608060405234801561001057600080fd5b506040518060400160405280601681526020017f4465706c6f796564207375636365737366756c6c7921000000000000000000008152506000908051906020019061005c929190610062565b50610166565b82805461006e90610134565b90600052602060002090601f01602090048101928261009057600085556100d7565b82601f106100a957805160ff19168380011785556100d7565b828001600101855582156100d7579182015b828111156100d65782518255916020019190600101906100bb565b5b5090506100e491906100e8565b5090565b5b808211156101015760008160009055506001016100e9565b5090565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b6000600282049050600182168061014c57607f821691505b602082108114156101605761015f610105565b5b50919050565b610633806101756000396000f3fe608060405234801561001057600080fd5b50600436106100365760003560e01c806329f4acb01461003b578063a773179714610059575b600080fd5b610043610089565b60405161005091906102dc565b60405180910390f35b610073600480360381019061006e9190610447565b610117565b60405161008091906102dc565b60405180910390f35b60008054610096906104bf565b80601f01602080910402602001604051908101604052809291908181526020018280546100c2906104bf565b801561010f5780601f106100e45761010080835404028352916020019161010f565b820191906000526020600020905b8154815290600101906020018083116100f257829003601f168201915b505050505081565b6060816000908051906020019061012f9291906101a0565b506001806000828254610142919061052a565b925050819055508160405161015791906105bc565b60405180910390207f8b4855b98ea931f3580ec353f7cf98d66f7424b654cfc00e50d87d6b53d9e4ee60015460405161019091906105e2565b60405180910390a2819050919050565b8280546101ac906104bf565b90600052602060002090601f0160209004810192826101ce5760008555610215565b82601f106101e757805160ff1916838001178555610215565b82800160010185558215610215579182015b828111156102145782518255916020019190600101906101f9565b5b5090506102229190610226565b5090565b5b8082111561023f576000816000905550600101610227565b5090565b600081519050919050565b600082825260208201905092915050565b60005b8381101561027d578082015181840152602081019050610262565b8381111561028c576000848401525b50505050565b6000601f19601f8301169050919050565b60006102ae82610243565b6102b8818561024e565b93506102c881856020860161025f565b6102d181610292565b840191505092915050565b600060208201905081810360008301526102f681846102a3565b905092915050565b6000604051905090565b600080fd5b600080fd5b600080fd5b600080fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b61035482610292565b810181811067ffffffffffffffff821117156103735761037261031c565b5b80604052505050565b60006103866102fe565b9050610392828261034b565b919050565b600067ffffffffffffffff8211156103b2576103b161031c565b5b6103bb82610292565b9050602081019050919050565b82818337600083830152505050565b60006103ea6103e584610397565b61037c565b90508281526020810184848401111561040657610405610317565b5b6104118482856103c8565b509392505050565b600082601f83011261042e5761042d610312565b5b813561043e8482602086016103d7565b91505092915050565b60006020828403121561045d5761045c610308565b5b600082013567ffffffffffffffff81111561047b5761047a61030d565b5b61048784828501610419565b91505092915050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b600060028204905060018216806104d757607f821691505b602082108114156104eb576104ea610490565b5b50919050565b6000819050919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b6000610535826104f1565b9150610540836104f1565b9250827fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff03821115610575576105746104fb565b5b828201905092915050565b600081905092915050565b600061059682610243565b6105a08185610580565b93506105b081856020860161025f565b80840191505092915050565b60006105c8828461058b565b915081905092915050565b6105dc816104f1565b82525050565b60006020820190506105f760008301846105d3565b9291505056fea2646970667358221220fb4c282160abfe97dd28d56ae49c82129f613a915136a56d953f458dcec4c08a64736f6c63430008090033',
+  deployedBytecode: '0x608060405234801561001057600080fd5b50600436106100365760003560e01c806329f4acb01461003b578063a773179714610059575b600080fd5b610043610089565b60405161005091906102dc565b60405180910390f35b610073600480360381019061006e9190610447565b610117565b60405161008091906102dc565b60405180910390f35b60008054610096906104bf565b80601f01602080910402602001604051908101604052809291908181526020018280546100c2906104bf565b801561010f5780601f106100e45761010080835404028352916020019161010f565b820191906000526020600020905b8154815290600101906020018083116100f257829003601f168201915b505050505081565b6060816000908051906020019061012f9291906101a0565b506001806000828254610142919061052a565b925050819055508160405161015791906105bc565b60405180910390207f8b4855b98ea931f3580ec353f7cf98d66f7424b654cfc00e50d87d6b53d9e4ee60015460405161019091906105e2565b60405180910390a2819050919050565b8280546101ac906104bf565b90600052602060002090601f0160209004810192826101ce5760008555610215565b82601f106101e757805160ff1916838001178555610215565b82800160010185558215610215579182015b828111156102145782518255916020019190600101906101f9565b5b5090506102229190610226565b5090565b5b8082111561023f576000816000905550600101610227565b5090565b600081519050919050565b600082825260208201905092915050565b60005b8381101561027d578082015181840152602081019050610262565b8381111561028c576000848401525b50505050565b6000601f19601f8301169050919050565b60006102ae82610243565b6102b8818561024e565b93506102c881856020860161025f565b6102d181610292565b840191505092915050565b600060208201905081810360008301526102f681846102a3565b905092915050565b6000604051905090565b600080fd5b600080fd5b600080fd5b600080fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b61035482610292565b810181811067ffffffffffffffff821117156103735761037261031c565b5b80604052505050565b60006103866102fe565b9050610392828261034b565b919050565b600067ffffffffffffffff8211156103b2576103b161031c565b5b6103bb82610292565b9050602081019050919050565b82818337600083830152505050565b60006103ea6103e584610397565b61037c565b90508281526020810184848401111561040657610405610317565b5b6104118482856103c8565b509392505050565b600082601f83011261042e5761042d610312565b5b813561043e8482602086016103d7565b91505092915050565b60006020828403121561045d5761045c610308565b5b600082013567ffffffffffffffff81111561047b5761047a61030d565b5b61048784828501610419565b91505092915050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052602260045260246000fd5b600060028204905060018216806104d757607f821691505b602082108114156104eb576104ea610490565b5b50919050565b6000819050919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b6000610535826104f1565b9150610540836104f1565b9250827fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff03821115610575576105746104fb565b5b828201905092915050565b600081905092915050565b600061059682610243565b6105a08185610580565b93506105b081856020860161025f565b80840191505092915050565b60006105c8828461058b565b915081905092915050565b6105dc816104f1565b82525050565b60006020820190506105f760008301846105d3565b9291505056fea2646970667358221220fb4c282160abfe97dd28d56ae49c82129f613a915136a56d953f458dcec4c08a64736f6c63430008090033',
+  linkReferences: {},
+  deployedLinkReferences: {},
+} as const;

e2e-tests/e2e-viem/test/consts.ts

@@ -1,50 +1,28 @@
-import { acala, karura, mandala } from 'viem/chains';
-import { createWalletClient, getContractAddress, http, publicActions } from 'viem';
-import { expect } from 'chai';
-import { mnemonicToAccount } from 'viem/accounts';
+import { assert, expect } from 'chai';
+import { getContractAddress } from 'viem';
 
-import { acalaForkConfig } from './utils';
-import EchoJson from '../artifacts/contracts/Echo.sol/Echo.json';
-
-const TEST_MNEMONIC = 'fox sight canyon orphan hotel grow hedgehog build bless august weather swarm';
-const account = mnemonicToAccount(TEST_MNEMONIC);
-
-const targetChain = process.env.CHAIN ?? 'acalaFork';
-const chainConfig = ({
-  acalaFork: acalaForkConfig,
-  mandala,
-  karura,
-  acala,
-})[targetChain];
-
-if (!chainConfig) {
-  throw new Error('Invalid CHAIN env variable. Must be one { local, mandala, karura, acala }');
-}
-
-console.log(`creating client for ${chainConfig.name}`);
-const client = createWalletClient({
-  account,
-  chain: chainConfig,
-  transport: http(),
-}).extend(publicActions);
+import { ECHO_JSON as EchoJson } from './consts';
+import { client } from './utils';
 
 describe('Echo contract', function () {
-  it('can deploy, read, and write contract', async () => {
-    /* ----------------- deploy ----------------- */
+  let contractAddr: `0x${string}`;
+
+  it('deploy contract', async () => {
     const deployHash = await client.deployContract({
       abi: EchoJson.abi,
-      args: [],
       bytecode: EchoJson.bytecode as `0x${string}`,
     });
 
     await client.waitForTransactionReceipt({ hash: deployHash });
     const tx = await client.getTransaction({ hash: deployHash });
 
-    const contractAddr = getContractAddress({
+    contractAddr = getContractAddress({
       from: tx.from,
       nonce: BigInt(tx.nonce),
     });
+  });
 
+  it('read and write contract', async () => {
     /* ----------------- read ----------------- */
     let echoValue = await client.readContract({
       address: contractAddr,
@@ -70,4 +48,64 @@ describe('Echo contract', function () {
     });
     expect(echoValue).to.equal('Hello World!');
   });
+
+  it('subscription', async () => {
+    const msg = 'some mysterious msg';
+    const msgHash = '0x9287dad622cb0d1809a6b37d936ec5ca8dd09645219887d4793fd63669f08715';
+    let notified0 = false;
+    let notified1 = false;
+
+    // general subscription
+    const unwatch0 = client.watchContractEvent({
+      address: contractAddr,
+      abi: EchoJson.abi,
+      eventName: 'NewEcho',
+      onLogs: logs => {
+        expect(logs.length).to.equal(1);
+        expect(logs[0].args.message).to.equal(msgHash);
+        notified0 = true;
+      },
+    });
+
+    // subscription with args
+    const unwatch1 = client.watchContractEvent({
+      address: contractAddr,
+      abi: EchoJson.abi,
+      eventName: 'NewEcho',
+      args: { message: msg },
+      onLogs: logs => {
+        expect(logs.length).to.equal(1);
+        expect(logs[0].args.message).to.equal(msgHash);
+        notified1 = true;
+      },
+    });
+
+    // subscription that should not trigger
+    const unwatch2 = client.watchContractEvent({
+      address: contractAddr,
+      abi: EchoJson.abi,
+      eventName: 'NewEcho',
+      args: { message: 'rand msg' },
+      onLogs: _logs => {
+        expect.fail('should not trigger');
+      },
+    });
+
+    const { request } = await client.simulateContract({
+      address: contractAddr,
+      abi: EchoJson.abi,
+      functionName: 'scream',
+      args: [msg],
+    });
+    const callHash = await client.writeContract(request);
+    await client.waitForTransactionReceipt({ hash: callHash });
+
+    await new Promise(resolve => setTimeout(resolve, 5000));    // wait for the notification
+    expect(notified0).to.be.true;
+    expect(notified1).to.be.true;
+
+    unwatch0();
+    unwatch1();
+    unwatch2();
+  });
 });

e2e-tests/e2e-viem/test/echo.test.ts

@@ -1,3 +1,7 @@
+import { acala, karura, mandala } from 'viem/chains';
+import { createWalletClient, http, publicActions } from 'viem';
+import { mnemonicToAccount } from 'viem/accounts';
+
 export const acalaForkConfig = {
   name: 'acala fork',
   id: 787,
@@ -12,3 +16,25 @@ export const acalaForkConfig = {
   },
   network: 'local',
 };
+
+const TEST_MNEMONIC = 'fox sight canyon orphan hotel grow hedgehog build bless august weather swarm';
+const account = mnemonicToAccount(TEST_MNEMONIC);
+
+const targetChain = process.env.CHAIN ?? 'acalaFork';
+const chainConfig = ({
+  acalaFork: acalaForkConfig,
+  mandala,
+  karura,
+  acala,
+})[targetChain];
+
+if (!chainConfig) {
+  throw new Error('Invalid CHAIN env variable. Must be one { local, mandala, karura, acala }');
+}
+
+console.log(`creating client for ${chainConfig.name}`);
+export const client = createWalletClient({
+  account,
+  chain: chainConfig,
+  transport: http(),
+}).extend(publicActions);