Add a chainalysis vanchor contract (#206)

Author: drewstone

package.json

@@ -66,17 +66,17 @@
     "@types/chai": "^4.3.0",
     "@types/mocha": "^9.0.0",
     "@webb-tools/sdk-core": "0.1.4-113",
-    "@webb-tools/test-utils": "0.1.4-113",
     "@webb-tools/semaphore": "0.0.1-4",
     "@webb-tools/semaphore-group": "0.0.1-4",
     "@webb-tools/semaphore-identity": "0.0.1-3",
     "@webb-tools/semaphore-proof": "0.0.1-3",
+    "@webb-tools/test-utils": "0.1.4-113",
     "babel-plugin-styled-components": "^2.0.7",
     "bn.js": "4.11.6",
     "chai": "^4.3.5",
     "circomlib": "^2.0.5",
     "circomlibjs": "0.0.8",
-    "dotenv": "^8.2.0",
+    "dotenv": "^16.0.3",
     "elliptic": "^6.5.3",
     "ethereum-waffle": "^3.4.4",
     "hardhat-artifactor": "^0.2.0",

packages/anchors/src/ChainalysisVAnchor.ts

@@ -0,0 +1,39 @@
+import { ZkComponents } from '@webb-tools/utils';
+import { BigNumberish, ethers, BigNumber } from 'ethers';
+import { VAnchorEncodeInputs__factory, ChainalysisVAnchor__factory } from '@webb-tools/contracts';
+import VAnchor from './VAnchor';
+
+export class ChainalysisVAnchor extends VAnchor {
+  public static async createVAnchor(
+    verifier: string,
+    levels: BigNumberish,
+    hasher: string,
+    handler: string,
+    token: string,
+    maxEdges: number,
+    smallCircuitZkComponents: ZkComponents,
+    largeCircuitZkComponents: ZkComponents,
+    signer: ethers.Signer
+  ) {
+    const encodeLibraryFactory = new VAnchorEncodeInputs__factory(signer);
+    const encodeLibrary = await encodeLibraryFactory.deploy();
+    await encodeLibrary.deployed();
+    const factory = new ChainalysisVAnchor__factory(
+      { ['contracts/libs/VAnchorEncodeInputs.sol:VAnchorEncodeInputs']: encodeLibrary.address },
+      signer
+    );
+    const vAnchor = await factory.deploy(verifier, levels, hasher, handler, token, maxEdges, {});
+    await vAnchor.deployed();
+    const createdVAnchor = new ChainalysisVAnchor(
+      vAnchor,
+      signer,
+      BigNumber.from(levels).toNumber(),
+      maxEdges,
+      smallCircuitZkComponents,
+      largeCircuitZkComponents
+    );
+    createdVAnchor.latestSyncedBlock = vAnchor.deployTransaction.blockNumber!;
+    createdVAnchor.token = token;
+    return createdVAnchor;
+  }
+}

packages/anchors/src/VAnchor.ts

@@ -2,6 +2,7 @@ import { BigNumber, BigNumberish, ContractTransaction, ethers } from 'ethers';
 import {
   VAnchor as VAnchorContract,
   VAnchor__factory,
+  ChainalysisVAnchor as ChainalysisVAnchorContract,
   VAnchorEncodeInputs__factory,
   TokenWrapper__factory,
 } from '@webb-tools/contracts';
@@ -18,8 +19,6 @@ import {
   randomBN,
   CircomProvingManager,
   ProvingManagerSetupInput,
-  Note,
-  NoteGenInput,
   MerkleProof,
   UtxoGenInput,
   CircomUtxo,
@@ -32,7 +31,6 @@ import {
   IVariableAnchorPublicInputs,
 } from '@webb-tools/interfaces';
 import { hexToU8a, u8aToHex, getChainIdType, ZkComponents } from '@webb-tools/utils';
-import { solidityPack } from 'ethers/lib/utils';
 
 const zeroAddress = '0x0000000000000000000000000000000000000000';
 function checkNativeAddress(tokenAddress: string): boolean {
@@ -50,7 +48,7 @@ export var proofTimeBenchmark = [];
 // Functionality relevant to a particular anchor deployment (deposit, withdraw) is implemented in instance methods
 export class VAnchor implements IAnchor {
   signer: ethers.Signer;
-  contract: VAnchorContract;
+  contract: VAnchorContract | ChainalysisVAnchorContract;
   tree: MerkleTree;
   // hex string of the connected root
   maxEdges: number;
@@ -65,7 +63,7 @@ export class VAnchor implements IAnchor {
   provingManager: CircomProvingManager;
 
   constructor(
-    contract: VAnchorContract,
+    contract: VAnchorContract | ChainalysisVAnchorContract,
     signer: ethers.Signer,
     treeHeight: number,
     maxEdges: number,

packages/anchors/src/index.ts

@@ -1,5 +1,6 @@
 export { AnchorHandler } from './AnchorHandler';
 export { VAnchor } from './VAnchor';
+export { ChainalysisVAnchor } from './ChainalysisVAnchor';
 export { IdentityVAnchor } from './IdentityVAnchor';
 export { OpenVAnchor } from './OpenVAnchor';
 export { PoseidonHasher } from './PoseidonHasher';

packages/contracts/contracts/handlers/TokenWrapperHandler.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Webb Technologies
+ * Copyright 2021-2022 Webb Technologies
  * SPDX-License-Identifier: GPL-3.0-or-later-only
  */
 

packages/contracts/contracts/interfaces/external/aave/IAaveLendingPool.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Webb Technologies
+ * Copyright 2021-2022 Webb Technologies
  * SPDX-License-Identifier: GPL-3.0-or-later-only
  */
 

packages/contracts/contracts/interfaces/external/chainalysis/ISanctionsList.sol

@@ -0,0 +1,10 @@
+/**
+ * Copyright 2021-2022 Webb Technologies
+ * SPDX-License-Identifier: GPL-3.0-or-later-only
+ */
+
+pragma solidity ^0.8.0;
+
+interface ISanctionsList {
+    function isSanctioned(address addr) external view returns (bool);
+}

packages/contracts/contracts/interfaces/tokens/IAaveTokenWrapper.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Webb Technologies
+ * Copyright 2021-2022 Webb Technologies
  * SPDX-License-Identifier: GPL-3.0-or-later-only
  */
 

packages/contracts/contracts/tokens/AaveTokenWrapper.sol

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 Webb Technologies
+ * Copyright 2021-2022 Webb Technologies
  * SPDX-License-Identifier: GPL-3.0-or-later-only
  */
 

packages/contracts/contracts/utils/SanctionFilter.sol

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2021-2022 Webb Technologies
+ * SPDX-License-Identifier: GPL-3.0-or-later-only
+ */
+
+import "../interfaces/external/chainalysis/ISanctionsList.sol";
+
+pragma solidity ^0.8.0;
+
+contract SanctionFilter {
+    address constant SANCTIONS_CONTRACT = 0x40C57923924B5c5c5455c48D93317139ADDaC8fb;
+
+    modifier isNotSanctioned(address addr) {
+        ISanctionsList sanctionsList = ISanctionsList(SANCTIONS_CONTRACT);
+        require(!sanctionsList.isSanctioned(addr), "SanctionFilter: Sanctioned address");
+        _;
+    }
+}