Merge pull request #18 from niftykit-inc/listeners

adds mint events

Author: jcurbelo

README.md

@@ -97,6 +97,24 @@ const web3ModalProviders = {
 const drop = await DropKit.create('sdk-api-key-here', isDev, web3ModalProviders, provider);
 ```
 
+## Events
+
+```typescript
+// Minted to the connected wallet
+drop.onMintedToWallet((...args) => {
+  console.log(
+      `[onMintedToWallet] TokenId: ${args[2]}, From ${args[0]}, To ${args[1]}`
+  );
+});
+
+// Minted from any wallet
+drop.onMinted((...args) => {
+  console.log(
+      `[onMinted] TokenId: ${args[2]}, From ${args[0]}, To ${args[1]}`
+  );
+});
+```
+
 ## API
 
 ```typescript
@@ -117,5 +135,10 @@ class DropKit {
     auctionStartedAt(): Promise<number>;
     generateProof(): Promise<ProofApiResponse & ErrorApiResponse>;
     mint(quantity: number): Promise<ContractReceipt | null>;
+    onMinted(listener: Listener): Contract;
+    onMintedToWallet(listener: Listener): Contract;
+    mintedToWalletListeners(): Listener[];
+    mintedListeners(): Listener[];
+    removeAllListeners(): Contract;
 }
 ```

src/DropKit.ts

@@ -1,14 +1,24 @@
+import {
+  JsonRpcProvider,
+  JsonRpcSigner,
+  Listener,
+  Provider,
+  Web3Provider,
+} from '@ethersproject/providers'
 import axios from 'axios'
 import { EthereumRpcError } from 'eth-rpc-errors'
 import {
-  ethers,
-  Contract,
   BigNumber,
-  ContractTransaction,
+  Contract,
   ContractReceipt,
+  ContractTransaction,
+  ethers,
   Signer,
 } from 'ethers'
+import Web3Modal, { IProviderOptions } from 'web3modal'
 import { API_ENDPOINT, API_ENDPOINT_DEV } from './config/endpoint'
+import { NETWORKS, ZERO_ADDRESS } from './config/networks'
+import { PROVIDER_OPTIONS } from './config/providers'
 import DropKitCollectionABI from './contracts/DropKitCollection.json'
 import DropKitCollectionV2ABI from './contracts/DropKitCollectionV2.json'
 import DropKitCollectionV3ABI from './contracts/DropKitCollectionV3.json'
@@ -18,15 +28,6 @@ import {
   ErrorApiResponse,
   ProofApiResponse,
 } from './types/api-responses'
-import Web3Modal, { IProviderOptions } from 'web3modal'
-import { PROVIDER_OPTIONS } from './config/providers'
-import {
-  JsonRpcProvider,
-  JsonRpcSigner,
-  Provider,
-  Web3Provider,
-} from '@ethersproject/providers'
-import { NETWORKS } from './config/networks'
 
 const abis: Record<number, any> = {
   2: DropKitCollectionABI.abi,
@@ -325,6 +326,36 @@ export default class DropKit {
     }
   }
 
+  onMinted(listener: Listener): Contract {
+    const filter = this.contract.filters.Transfer(ZERO_ADDRESS)
+    return this.contract.on(filter, listener)
+  }
+
+  onMintedToWallet(listener: Listener): Contract {
+    const filter = this.contract.filters.Transfer(
+      ZERO_ADDRESS,
+      this.walletAddress
+    )
+    return this.contract.on(filter, listener)
+  }
+
+  mintedToWalletListeners(): Listener[] {
+    const filter = this.contract.filters.Transfer(
+      ZERO_ADDRESS,
+      this.walletAddress
+    )
+    return this.contract.listeners(filter)
+  }
+
+  mintedListeners(): Listener[] {
+    const filter = this.contract.filters.Transfer(ZERO_ADDRESS)
+    return this.contract.listeners(filter)
+  }
+
+  removeAllListeners(): Contract {
+    return this.contract.removeAllListeners()
+  }
+
   private async _mint(
     quantity: number,
     amount: BigNumber

src/config/networks.ts

@@ -16,3 +16,5 @@ export const NETWORKS: Record<number, Network> = {
     blockExplorerUrls: ['https://mumbai.polygonscan.com/'],
   },
 }
+
+export const ZERO_ADDRESS = '0x0000000000000000000000000000000000000000'