Update readme and change forRoot props

.npmignore

@@ -1,9 +1,13 @@
 __tests__/
 .github/
 coverage/
-dist/*.tsbuildinfo
-dist/*.js.map
+*.tsbuildinfo
+*.js.map
 src/
+.eslintrc.js
+.gitignore
+.prettierrc
 .travis.yml
-CONTRIBUTING.md
-README.md
+nest-cli.json
+tsconfig.build.json
+tsconfig.json

CHANGELOG.md

@@ -1 +1,5 @@
-RELEASE 0.1.1
+# Changelog
+
+## 0.1.0
+Published by **[jarcodallo](https://github.com/jarcodallo)** on **TODO**
+- TODO

README.md

@@ -1,29 +1,279 @@
-<h1 align="center">NestJS-Ethers</h1>
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/nestjs-ethers">
-    <img alt="npm" src="https://img.shields.io/npm/v/nestjs-ethers" />
-  </a>
-  <a href="https://travis-ci.com/github/jarcodallo/nestjs-ethers">
-    <img alt="Travis" src="https://api.travis-ci.com/jarcodallo/nestjs-ethers.svg?branch=main" />
-  </a>
-  <a href='https://coveralls.io/github/jarcodallo/nestjs-ethers?branch=main'>
-    <img src='https://coveralls.io/repos/github/jarcodallo/nestjs-ethers/badge.svg?branch=main' alt='Coverage Status' />
-  </a>
-  <a href="https://snyk.io/test/github/jarcodallo/nestjs-ethers">
-    <img alt="Snyk Vulnerabilities for npm package" src="https://img.shields.io/snyk/vulnerabilities/npm/nestjs-ethers" />
-  </a>
-  <img alt="David" src="https://img.shields.io/david/jarcodallo/nestjs-ethers">
-  <img alt="Dependabot" src="https://badgen.net/dependabot/jarcodallo/nestjs-ethers/?icon=dependabot">
-  <img alt="Supported platforms: Express & Fastify" src="https://img.shields.io/badge/platforms-Express%20%26%20Fastify-green" />
-</p>
+NestJS-Ethers
+=============
+
+[![npm](https://img.shields.io/npm/v/nestjs-ethers)](https://www.npmjs.com/package/nestjs-ethers)
+[![travis](https://api.travis-ci.com/jarcodallo/nestjs-ethers.svg?branch=main)](https://travis-ci.com/github/jarcodallo/nestjs-ethers)
+[![coverage](https://coveralls.io/repos/github/jarcodallo/nestjs-ethers/badge.svg?branch=main)](https://coveralls.io/github/jarcodallo/nestjs-ethers?branch=main)
+[![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/nestjs-ethers)](https://snyk.io/test/github/jarcodallo/nestjs-ethers)
+[![dependencies](https://img.shields.io/david/jarcodallo/nestjs-ethers)](https://img.shields.io/david/jarcodallo/nestjs-ethers)
+[![dependabot](https://badgen.net/dependabot/jarcodallo/nestjs-ethers/?icon=dependabot)](https://badgen.net/dependabot/jarcodallo/nestjs-ethers/?icon=dependabot)
+[![supported platforms](https://img.shields.io/badge/platforms-Express%20%26%20Fastify-green)](https://img.shields.io/badge/platforms-Express%20%26%20Fastify-green)
+
+
+Ethereum wallet implementation and utilities for NestJS based on [Ethers.js](https://github.com/ethers-io/ethers.js/)
 
 ## Install
 
 ```sh
 npm i nestjs-ethers
 ```
 
+## Register module
+
+### Zero configuration
+
+Just import `EthersModule` to your module:
+
+```ts
+import { EthersModule } from 'nestjs-ethers';
+
+@Module({
+  imports: [EthersModule.forRoot()],
+  ...
+})
+class MyModule {}
+```
+
+**NOTE:** *By default `EthersModule` will try to connect using [getDefaultProvider](https://docs.ethers.io/v5/api/providers/#providers-getDefaultProvider). It's the safest, easiest way to begin developing on Ethereum. It creates a [FallbackProvider](https://docs.ethers.io/v5/api/providers/other/#FallbackProvider) connected to as many backend services as possible.* 
+
+### Configuration params
+
+`nestjs-ethers` can be configured with this options:
+
+```ts
+interface EthersModuleOptions {
+  /**
+   * Optional parameter for connection, can be a Network object
+   * or the name of a common network as a string (e.g. "homestead")
+   * If no network is provided, homestead (i.e. mainnet) is used.
+   * The network may also be a URL to connect to,
+   * such as http://localhost:8545 or wss://example.com.
+   * @see {@link https://docs.ethers.io/v5/api/providers/types/#providers-Networkish}
+   */
+  network?: Network | string;
+
+  /**
+   * Optional parameter to name the module context,
+   */
+  providerName?: string;
+
+  /**
+   * Optional parameter for Alchemy API Token
+   * @see {@link https://alchemyapi.io}
+   */
+  alchemy?: string;
+
+  /**
+   * Optional parameter for Etherscan API Token
+   * @see {@link https://etherscan.io}
+   */
+  etherscan?: string;
+
+  /**
+   * Optional parameter for use Cloudflare Provider
+   * @see {@link https://cloudflare-eth.com}
+   */
+  cloudflare?: boolean;
+
+  /**
+   * Optional parameter for Infura Project ID
+   * or InfuraProviderOptions(applicationId, applicationSecretKey)
+   * @see {@link https://infura.io}
+   */
+  infura?: InfuraProviderOptions | string;
+
+  /**
+   * Optional parameter for Pocket Network Application ID
+   * or PocketProviderOptions(projectId, projectSecret)
+   * @see {@link https://pokt.network}
+   */
+  pocket?: PocketProviderOptions | string;
+
+  /**
+   * Optional parameter the number of backends that must agree
+   * (default: 2 for mainnet, 1 for testnets)
+   */
+  quorum?: number;
+
+  /**
+   * Optional parameter if this option is false, EthersModule will try to connect
+   * with the credentials provided in options. If you define more than one provider,
+   * EthersModule will use the FallbackProvider to send multiple requests simultaneously.
+   */
+  useDefaultProvider?: boolean;
+}
+```
+
+### Synchronous configuration
+
+Use `EthersModule.forRoot` method with [Options interface](#configuration-params):
+
+```ts
+import { EthersModule } from 'nestjs-ethers';
+
+@Module({
+  imports: [
+    EthersModule.forRoot({
+      network: 'rinkeby',
+      providerName: 'MyModule',
+      alchemy: '845ce4ed0120d68eb5740c9160f08f98',
+      etherscan: 'e8cce313c1cfbd085f68be509451f1bab8',
+      cloudflare: true,
+      infura: {
+        projectId: 'd71b3d93c2fcfa7cab4924e63298575a',
+        projectSecret: 'ed6baa9f7a09877998a24394a12bf3dc',
+      },
+      pocket: {
+        applicationId: '9b0afc55221c429104d04ef9',
+        applicationSecretKey: 'b5e6d6a55426712a42a93f39555973fc',
+      },
+      quorum: 1,
+      useDefaultProvider: true,
+    })
+  ],
+  ...
+})
+class MyModule {}
+```
+
+### Asynchronous configuration
+
+With `EthersModule.forRootAsync` you can, for example, import your `ConfigModule` and inject `ConfigService` to use it in `useFactory` method.
+
+`useFactory` should return object with [Options interface](#configuration-params) or undefined
+
+Here's an example:
+
+```ts
+import { EthersModule } from 'nestjs-ethers';
+
+@Injectable()
+class ConfigService {
+  public readonly infura = {
+    projectId: 'd71b3d93c2fcfa7cab4924e63298575a',
+    projectSecret: 'ed6baa9f7a09877998a24394a12bf3dc',
+  };
+}
+
+@Module({
+  providers: [ConfigService],
+  exports: [ConfigService]
+})
+class ConfigModule {}
+
+@Module({
+  imports: [
+    EthersModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: async (config: ConfigService) => {
+        await somePromise();
+        return {
+          network: 'rinkeby',
+          infura: config.infura,
+          useDefaultProvider: false,
+        };
+      }
+    })
+  ],
+  ...
+})
+class TestModule {}
+```
+
+Or you can just pass `ConfigService` to `providers`, if you don't have any `ConfigModule`:
+
+```ts
+import { EthersModule } from 'nestjs-ethers';
+
+@Injectable()
+class ConfigService {
+  public readonly pocket: {
+    applicationId: '9b0afc55221c429104d04ef9',
+    applicationSecretKey: 'b5e6d6a55426712a42a93f39555973fc',
+  };
+}
+
+@Module({
+  imports: [
+    EthersModule.forRootAsync({
+      providers: [ConfigService],
+      inject: [ConfigService],
+      useFactory: (config: ConfigService) => {
+        return {
+          network: 'rinkeby',
+          pocket: config.pocket,
+          useDefaultProvider: false,
+        };
+      }
+    })
+  ],
+  controllers: [TestController]
+})
+class TestModule {}
+```
+
+You can also pass multiple `ethersjs` configs, if you want to use the `FallbackProvider` to send multiple requests simultaneously:
+
+```ts
+import { EthersModule } from 'nestjs-ethers';
+
+@Injectable()
+class ConfigService {
+  public readonly infura = {
+    projectId: 'd71b3d93c2fcfa7cab4924e63298575a',
+    projectSecret: 'ed6baa9f7a09877998a24394a12bf3dc',
+  };
+  public readonly pocket: {
+    applicationId: '9b0afc55221c429104d04ef9',
+    applicationSecretKey: 'b5e6d6a55426712a42a93f39555973fc',
+  };
+}
+
+@Module({
+  providers: [ConfigService],
+  exports: [ConfigService]
+})
+class ConfigModule {}
+
+@Module({
+  imports: [
+    EthersModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: async (config: ConfigService) => {
+        await somePromise();
+        return {
+          network: 'rinkeby',
+          infura: config.infura,
+          pocket: config.pocket,
+          useDefaultProvider: false,
+        };
+      }
+    })
+  ],
+  ...
+})
+class TestModule {}
+```
+
+#### Testing a class that uses @InjectEthersProvider
+
+This package exposes a getEthersToken() function that returns a prepared injection token based on the provided context. 
+Using this token, you can easily provide a mock implementation of the `EthersBaseProvider` using any of the standard custom provider techniques, including useClass, useValue, and useFactory.
+
+```ts
+  const module: TestingModule = await Test.createTestingModule({
+    providers: [
+      MyService,
+      {
+        provide: getEthersToken(MyService.name),
+        useValue: mockProvider,
+      },
+    ],
+  }).compile();
+```
+
 ## Change Log
 
 See [Changelog](CHANGELOG.md) for more information.
@@ -38,4 +288,4 @@ Contributions welcome! See [Contributing](CONTRIBUTING.md).
 
 ## License
 
-Licensed under the Apache 2.0 - see the [LICENSE](LICENSE) file for details.
+Licensed under the Apache 2.0 - see the [LICENSE](LICENSE) file for details.

__tests__/ethers.decorators.spec.ts

@@ -1,16 +1,33 @@
 import { NestFactory } from '@nestjs/core';
 import { Module, Controller, Get, Injectable } from '@nestjs/common';
 import * as request from 'supertest';
+import * as nock from 'nock';
 import {
   EthersModule,
   InjectEthersProvider,
   EthersBaseProvider,
   Network,
+  ETHERS_MAINNET_NAME,
 } from '../src';
 import { platforms } from './utils/platforms';
 import { extraWait } from './utils/extraWait';
 
 describe('InjectEthersProvider', () => {
+  beforeEach(() => nock.cleanAll());
+
+  beforeAll(() => {
+    if (!nock.isActive()) {
+      nock.activate();
+    }
+
+    nock.disableNetConnect();
+    nock.enableNetConnect('127.0.0.1');
+  });
+
+  afterAll(() => {
+    nock.restore();
+  });
+
   for (const PlatformAdapter of platforms) {
     describe(PlatformAdapter.name, () => {
       it('should inject ethers provider in a service successfully', async () => {
@@ -57,7 +74,10 @@ describe('InjectEthersProvider', () => {
           .expect(200)
           .expect((res) => {
             expect(res.body.network).toBeDefined();
-            expect(res.body.network).toHaveProperty('name', 'homestead');
+            expect(res.body.network).toHaveProperty(
+              'name',
+              ETHERS_MAINNET_NAME,
+            );
             expect(res.body.network).toHaveProperty('chainId', 1);
             expect(res.body.network).toHaveProperty('ensAddress');
           });
@@ -100,7 +120,10 @@ describe('InjectEthersProvider', () => {
           .expect(200)
           .expect((res) => {
             expect(res.body.network).toBeDefined();
-            expect(res.body.network).toHaveProperty('name', 'homestead');
+            expect(res.body.network).toHaveProperty(
+              'name',
+              ETHERS_MAINNET_NAME,
+            );
             expect(res.body.network).toHaveProperty('chainId', 1);
             expect(res.body.network).toHaveProperty('ensAddress');
           });