Merge pull request #8 from spherity/feature/replace-ganache

Replace Ganache with Hardhat
spherity · Nov 1, 2024 · 77b76d2 · 77b76d2
2 parents d623134 + 332c98c
commit 77b76d2
Show file tree

Hide file tree

Showing 7 changed files with 10,433 additions and 6,655 deletions.
diff --git a/__tests__/localAgent.test.ts b/__tests__/localAgent.test.ts
@@ -59,15 +59,15 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       }),
       new DIDManager({
         store: didStore,
-        defaultProvider: 'did:ethr:ganache',
+        defaultProvider: 'did:ethr:hardhat',
         providers: {
           'did:ethr': new EthrDIDProvider({
             defaultKms: 'local',
             ttl: 60 * 60 * 24 * 30 * 12 + 1,
             networks: [
               {
                 chainId: BigInt(1337),
-                name: 'ganache',
+                name: 'hardhat',
                 provider,
                 registry,
               },
@@ -81,7 +81,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
         networks: [
           {
             chainId: BigInt(1337),
-            name: 'ganache',
+            name: 'hardhat',
             provider,
             registry,
           },
@@ -92,7 +92,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
           infuraProjectId,
           networks: [
             {
-              name: 'ganache',
+              name: 'hardhat',
               chainId: BigInt(1337),
               provider,
               registry,

diff --git a/__tests__/restAgent.test.ts b/__tests__/restAgent.test.ts
@@ -80,15 +80,15 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       }),
       new DIDManager({
         store: didStore,
-        defaultProvider: 'did:ethr:ganache',
+        defaultProvider: 'did:ethr:hardhat',
         providers: {
-          'did:ethr': new EthrDIDProvider({
+          'did:ethr:hardhat': new EthrDIDProvider({
             defaultKms: 'local',
             ttl: 60 * 60 * 24 * 30 * 12 + 1,
             networks: [
               {
                 chainId: 1337,
-                name: 'ganache',
+                name: 'hardhat',
                 provider,
                 registry,
               },
@@ -102,7 +102,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
         networks: [
           {
             chainId: BigInt(1337),
-            name: 'ganache',
+            name: 'hardhat',
             provider,
             registry,
           },
@@ -113,7 +113,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
           infuraProjectId,
           networks: [
             {
-              name: 'ganache',
+              name: 'hardhat',
               chainId: BigInt(1337),
               provider,
               registry,

diff --git a/__tests__/shared/didExtensionEthrLogic.ts b/__tests__/shared/didExtensionEthrLogic.ts
@@ -22,8 +22,8 @@ export default (testContext: {
 
       alice = await agent.didManagerImport({
         controllerKeyId: 'alice-controller-key',
-        did: 'did:ethr:ganache:0x0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798',
-        provider: 'did:ethr:ganache',
+        did: 'did:ethr:hardhat:0x0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798',
+        provider: 'did:ethr:hardhat',
         alias: 'alice-did-ethr',
         keys: [
           {
@@ -36,8 +36,8 @@ export default (testContext: {
       })
       bob = await agent.didManagerImport({
         controllerKeyId: 'bob-controller-key',
-        did: 'did:ethr:ganache:0x02c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5',
-        provider: 'did:ethr:ganache',
+        did: 'did:ethr:hardhat:0x02c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5',
+        provider: 'did:ethr:hardhat',
         alias: 'bob-did-ethr',
         keys: [
           {
@@ -50,8 +50,8 @@ export default (testContext: {
       })
       erika = await agent.didManagerImport({
         controllerKeyId: 'erika-controller-key',
-        did: 'did:ethr:ganache:0x02f9308a019258c31049344f85f89d5229b531c845836f99b08601f113bce036f9',
-        provider: 'did:ethr:ganache',
+        did: 'did:ethr:hardhat:0x02f9308a019258c31049344f85f89d5229b531c845836f99b08601f113bce036f9',
+        provider: 'did:ethr:hardhat',
         alias: 'erika-did-ethr',
         keys: [
           {
@@ -64,8 +64,8 @@ export default (testContext: {
       })
       klaus = await agent.didManagerImport({
         controllerKeyId: 'klaus-controller-key',
-        did: 'did:ethr:ganache:0x02e493dbf1c10d80f3581e4904930b1404cc6c13900ee0758474fa94abe8c4cd13',
-        provider: 'did:ethr:ganache',
+        did: 'did:ethr:hardhat:0x02e493dbf1c10d80f3581e4904930b1404cc6c13900ee0758474fa94abe8c4cd13',
+        provider: 'did:ethr:hardhat',
         alias: 'klaus-did-ethr',
         keys: [
           {
@@ -100,7 +100,7 @@ export default (testContext: {
 
       expect(updatedBobDidDoc.didDocument!.verificationMethod![1].id).toContain("delegate-1")
       expect(updatedBobDidDoc.didDocument!.verificationMethod![1].type).toEqual("EcdsaSecp256k1VerificationKey2019")
-    })
+    }, 10000)
 
     it('should throw an error if key is not Secp256k1', async () => {
       const newKey = await agent.keyManagerCreate({ kms: 'local', type: 'Ed25519' })

diff --git a/__tests__/utils/ganache-provider.ts b/__tests__/utils/ganache-provider.ts
@@ -1,102 +1,17 @@
-import type { JsonRpcError, JsonRpcPayload, JsonRpcResult } from 'ethers'
-import { assertArgument, Contract, ContractFactory, JsonRpcApiProvider, Network } from 'ethers'
+import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider'
+import { BrowserProvider } from 'ethers';
+import { Contract, ContractFactory } from 'ethers'
 import { EthereumDIDRegistry } from 'ethr-did-resolver'
-import type { EthereumProvider } from 'ganache'
-import ganache from 'ganache'
-
-export type GanacheConfig = Parameters<typeof ganache.provider>[0]
-
-/**
- * A JsonRpcApiProvider that connects to a local ganache instance.
- *
- * Code mostly copied from ethersjs test tooling
- * (https://github.com/ethers-io/ext-provider-ganache/blob/335566b563b0a48844e2427ff9e3cd809e37d2b8/src.ts/provider-ganache.ts#L30)
- */
-export class GanacheProvider extends JsonRpcApiProvider {
-  readonly ganache: EthereumProvider
-
-  constructor(providerOrOptions?: EthereumProvider | GanacheConfig) {
-    let provider: EthereumProvider
-    if (providerOrOptions == null || typeof (<any>providerOrOptions).getOptions !== 'function') {
-      provider = ganache.provider(<any>providerOrOptions)
-    } else {
-      provider = <EthereumProvider>providerOrOptions
-    }
-
-    const network = new Network('testnet', provider.getOptions().chain.chainId)
-    super(network, {
-      staticNetwork: network,
-      batchMaxCount: 1,
-      batchStallTime: 0,
-      cacheTimeout: -1,
-    })
-
-    this.ganache = provider
-  }
-
-  async _send(payload: JsonRpcPayload | Array<JsonRpcPayload>): Promise<Array<JsonRpcResult | JsonRpcError>> {
-    assertArgument(!Array.isArray(payload), 'batch requests unsupported', 'UNSUPPORTED_OPERATION', {
-      operation: '_send',
-      info: { payload },
-    })
-
-    const result = await this.ganache.request(<any>payload)
-    return [{ id: payload.id, result }]
-  }
-}
+import hardhat from 'hardhat'
 
 /**
  * Creates a Web3Provider that connects to a local ganache instance with a bunch of known keys and an ERC1056 contract.
  *
  * This provider can only be used in a single test suite, because of some concurrency issues with ganache.
  */
-export async function createGanacheProvider(): Promise<{ provider: JsonRpcApiProvider; registry: string }> {
-  const provider = new GanacheProvider({
-    logging: { quiet: true },
-    accounts: [
-      {
-        secretKey: '0x278a5de700e29faae8e40e366ec5012b5ec63d36ec77e8a2417154cc1d25383f',
-        //  address: '0xf3beac30c498d9e26865f34fcaa57dbb935b0d74',
-        //  publicKey: '03fdd57adec3d438ea237fe46b33ee1e016eda6b585c3e27ea66686c2ea5358479'
-        balance: '0x1000000000000000000000',
-      },
-      {
-        secretKey: '0x0000000000000000000000000000000000000000000000000000000000000001',
-        //  address: '0x7e5f4552091a69125d5dfcb7b8c2659029395bdf',
-        //  publicKey: '0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798'
-        balance: '0x1000000000000000000000',
-      },
-      {
-        secretKey: '0x0000000000000000000000000000000000000000000000000000000000000002',
-        //  address: '0x2b5ad5c4795c026514f8317c7a215e218dccd6cf',
-        //  publicKey: '02c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5'
-        balance: '0x1000000000000000000000',
-      },
-      {
-        secretKey: '0x0000000000000000000000000000000000000000000000000000000000000003',
-        //  address: '0x6813eb9362372eef6200f3b1dbc3f819671cba69',
-        //  publicKey: '02f9308a019258c31049344f85f89d5229b531c845836f99b08601f113bce036f9'
-        balance: '0x1000000000000000000000',
-      },
-      {
-        secretKey: '0x0000000000000000000000000000000000000000000000000000000000000004',
-        //  address: '0x1eff47bc3a10a45d4b230b5d10e37751fe6aa718',
-        //  publicKey: '02e493dbf1c10d80f3581e4904930b1404cc6c13900ee0758474fa94abe8c4cd13'
-        balance: '0x1000000000000000000000',
-      },
-      {
-        secretKey: '0x0000000000000000000000000000000000000000000000000000000000000005',
-        //  address: '0xe1ab8145f7e55dc933d51a18c793f901a3a0b276'
-        //  publicKey: '022f8bde4d1a07209355b4a7250a5c5128e88b84bddc619ab7cba8d569b240efe4'
-        balance: '0x1000000000000000000000',
-      },
-      {
-        secretKey: '0x0000000000000000000000000000000000000000000000000000000000000006',
-        balance: `0x1000000000000000000000`,
-      },
-    ],
-  })
-  await provider.ready
+export async function createGanacheProvider(): Promise<{ provider: BrowserProvider; registry: string }> {
+
+  const provider = new BrowserProvider(hardhat.network.provider);
   const factory = ContractFactory.fromSolidity(EthereumDIDRegistry).connect(await provider.getSigner(0))
 
   let registryContract: Contract = await factory.deploy()

diff --git a/hardhat.config.cjs b/hardhat.config.cjs
@@ -0,0 +1,54 @@
+require('@nomicfoundation/hardhat-toolbox')
+require('@nomicfoundation/hardhat-ethers')
+
+/** @type import('hardhat/config').HardhatUserConfig */
+module.exports = {
+  solidity: '0.8.27',
+  networks: {
+    hardhat: {
+      chainId: 1337,
+      accounts: [
+        {
+          privateKey: '0x278a5de700e29faae8e40e366ec5012b5ec63d36ec77e8a2417154cc1d25383f',
+          //  address: '0xf3beac30c498d9e26865f34fcaa57dbb935b0d74',
+          //  publicKey: '03fdd57adec3d438ea237fe46b33ee1e016eda6b585c3e27ea66686c2ea5358479'
+          balance: '1000000000000000000000',
+        },
+        {
+          privateKey: '0x0000000000000000000000000000000000000000000000000000000000000001',
+          //  address: '0x7e5f4552091a69125d5dfcb7b8c2659029395bdf',
+          //  publicKey: '0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798'
+          balance: '1000000000000000000000',
+        },
+        {
+          privateKey: '0x0000000000000000000000000000000000000000000000000000000000000002',
+          //  address: '0x2b5ad5c4795c026514f8317c7a215e218dccd6cf',
+          //  publicKey: '02c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5'
+          balance: '1000000000000000000000',
+        },
+        {
+          privateKey: '0x0000000000000000000000000000000000000000000000000000000000000003',
+          //  address: '0x6813eb9362372eef6200f3b1dbc3f819671cba69',
+          //  publicKey: '02f9308a019258c31049344f85f89d5229b531c845836f99b08601f113bce036f9'
+          balance: '1000000000000000000000',
+        },
+        {
+          privateKey: '0x0000000000000000000000000000000000000000000000000000000000000004',
+          //  address: '0x1eff47bc3a10a45d4b230b5d10e37751fe6aa718',
+          //  publicKey: '02e493dbf1c10d80f3581e4904930b1404cc6c13900ee0758474fa94abe8c4cd13'
+          balance: '1000000000000000000000',
+        },
+        {
+          privateKey: '0x0000000000000000000000000000000000000000000000000000000000000005',
+          //  address: '0xe1ab8145f7e55dc933d51a18c793f901a3a0b276'
+          //  publicKey: '022f8bde4d1a07209355b4a7250a5c5128e88b84bddc619ab7cba8d569b240efe4'
+          balance: '1000000000000000000000',
+        },
+        {
+          privateKey: '0x0000000000000000000000000000000000000000000000000000000000000006',
+          balance: '1000000000000000000000',
+        },
+      ],
+    },
+  },
+}