Add value forwarder

Author: ScreamingHawk

README.md

@@ -163,6 +163,7 @@ The following is a list of contracts that are deployed by this script.
 | ClawbackMetadata               | 0x335411eAA9D63251f8c0867600Be4d0C190a3b1f |
 | PaymentCombiner                | 0xfe0a269E288051B0815E05Fe192FC888118CB8a2 |
 | PaymentsFactory                | 0xdC8dC7d7F0AAfbc5901DA779Ed5aab779F3E7c14 |
+| ValueForwarder                 | 0xABAAd93EeE2a569cF0632f39B10A9f5D734777ca |
 | SequencePaymentsSigner-dev     | 0x498399DD85CAa29A42Af499f82b271f1629ba0D7 |
 | SequencePayments-dev           | 0xDE280948Af8A9762B6984995C8c3c7F5AEB921Bf |
 | SequencePaymentsSigner-next    | 0x51805F2d8719a833C28EAc68aE881B2Eb70c0330 |

scripts/deploy-contracts.ts

@@ -27,6 +27,7 @@ import { ERC1155OperatorEnforcedFactory } from './factories/token_library/immuta
 import { ERC721OperatorEnforcedFactory } from './factories/token_library/immutable/ERC721OperatorEnforcedFactory'
 import { PaymentCombiner } from './factories/token_library/PaymentCombiner'
 import { PaymentsFactory } from './factories/token_library/PaymentsFactory'
+import { ValueForwarder } from './factories/token_library/ValueForwarder'
 import {
   FactoryV1,
   GuestModuleV1,
@@ -314,6 +315,8 @@ export const deployContracts = async (config: Config): Promise<string | null> =>
 
     prompt.start('Deploying Sequence Payments contracts\n')
 
+    const valueForwarder = await singletonDeployer.deploy('ValueForwarder', ValueForwarder, 0, txParams)
+
     const paymentCombiner = await singletonDeployer.deploy('PaymentCombiner', PaymentCombiner, 0, txParams)
 
     type PaymentsDeployment = {
@@ -507,6 +510,7 @@ export const deployContracts = async (config: Config): Promise<string | null> =>
       ClawbackMetadata: clawbackMetadata.address,
       PaymentCombiner: paymentCombiner.address,
       PaymentsFactory: paymentsFactory.address,
+      ValueForwarder: valueForwarder.address,
       ERC1155PackFactory: erc1155PackFactory.address
     }
     for (const { env, signerAddr, paymentsAddr } of paymentsDeployments) {

scripts/factories/token_library/ValueForwarder.ts

@@ -0,0 +1,67 @@
+import { ContractFactory, type ethers } from 'ethers'
+import type { VerificationRequest } from 'scripts/types'
+
+const abi = [
+  {
+    type: 'function',
+    name: 'forwardValue',
+    inputs: [
+      { name: 'to', type: 'address', internalType: 'address' },
+      { name: 'value', type: 'uint256', internalType: 'uint256' }
+    ],
+    outputs: [],
+    stateMutability: 'payable'
+  }
+]
+
+export class ValueForwarder extends ContractFactory {
+  constructor(signer?: ethers.Signer) {
+    super(
+      abi,
+      '6080806040523460155761014f908161001b8239f35b600080fdfe6080604052600436101561001257600080fd5b60003560e01c6398f850f11461002757600080fd5b6040366003190112610114576004356001600160a01b038116810361011457600080808093602435905af13d1561010f573d67ffffffffffffffff81116100f95760405190601f8101601f19908116603f0116820167ffffffffffffffff8111838210176100f9576040528152600060203d92013e5b156100a457005b60405162461bcd60e51b815260206004820152602760248201527f56616c7565466f727761726465723a204661696c656420746f20666f72776172604482015266642076616c756560c81b6064820152608490fd5b634e487b7160e01b600052604160045260246000fd5b61009d565b600080fdfea26469706673582212202706a11f313e042ccf1cd42b40b5f01308364a2290592fe4e14dce33175da1bf64736f6c634300081c0033',
+      signer
+    )
+  }
+}
+
+export const VALUEFORWARDER_VERIFICATION: Omit<VerificationRequest, 'waitForSuccess'> = {
+  contractToVerify: 'test/mocks/ValueForwarder.sol:ValueForwarder',
+  version: 'v0.8.28+commit.7893614a',
+  licenceType: 'Apache-2.0',
+  compilerInput: {
+    language: 'Solidity',
+    sources: {
+      'test/mocks/ValueForwarder.sol': {
+        content:
+          "// SPDX-License-Identifier: Apache-2.0\npragma solidity ^0.8.27;\n\n/// @title ValueForwarder\n/// @author Michael Standen\n/// @notice Forwarder for value\ncontract ValueForwarder {\n  function forwardValue(address to, uint256 value) external payable {\n    (bool success, ) = to.call{value: value}('');\n    require(success, 'ValueForwarder: Failed to forward value');\n  }\n}\n"
+      }
+    },
+    settings: {
+      remappings: [
+        '@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/',
+        'erc2470-libs/=lib/erc2470-libs/',
+        'erc4626-tests/=lib/openzeppelin-contracts/lib/erc4626-tests/',
+        'forge-std/=lib/forge-std/src/',
+        'halmos-cheatcodes/=lib/openzeppelin-contracts/lib/halmos-cheatcodes/src/',
+        'openzeppelin-contracts/=lib/openzeppelin-contracts/'
+      ],
+      optimizer: {
+        enabled: true,
+        runs: 200
+      },
+      metadata: {
+        useLiteralContent: false,
+        bytecodeHash: 'ipfs',
+        appendCBOR: true
+      },
+      outputSelection: {
+        '*': {
+          '*': ['evm.bytecode', 'evm.deployedBytecode', 'devdoc', 'userdoc', 'metadata', 'abi']
+        }
+      },
+      evmVersion: 'paris',
+      viaIR: true,
+      libraries: {}
+    }
+  }
+}

scripts/types.ts

@@ -43,6 +43,7 @@ export type ContractName =
   | 'ClawbackMetadata'
   | 'PaymentCombiner'
   | 'PaymentsFactory'
+  | 'ValueForwarder'
   | `SequencePaymentsSigner-${SequenceEnvironment}`
   | `SequencePayments-${SequenceEnvironment}`
 

scripts/verify-contracts.ts

@@ -35,6 +35,7 @@ import { UpgradeableBeacon } from './factories/token_library/UpgradeableBeacon'
 //   ERC721OperatorEnforcedFactory,
 //   ERC721OPERATORENFORCEDFACTORY_VERIFICATION
 // } from './factories/token_library/immutable/ERC721OperatorEnforcedFactory'
+import { VALUEFORWARDER_VERIFICATION } from './factories/token_library/ValueForwarder'
 import { FACTORY_V1_VERIFICATION } from './factories/v1/FactoryV1'
 import { GUEST_MODULE_V1_VERIFICATION } from './factories/v1/GuestModuleV1'
 import { MAIN_MODULE_UPGRADABLE_V1_VERIFICATION } from './factories/v1/MainModuleUpgradableV1'
@@ -185,6 +186,8 @@ export const verifyContracts = async (config: Config, walletContextAddrs: Contra
 
     prompt.start('Verifying Payments contracts\n')
 
+    await verifyContract(walletContextAddrs.ValueForwarder, { ...VALUEFORWARDER_VERIFICATION, waitForSuccess })
+
     await verifyContract(walletContextAddrs.PaymentCombiner, { ...PAYMENTCOMBINER_VERIFICATION, waitForSuccess })
     // Verify the implementation
     if (provider && walletContextAddrs.PaymentCombiner) {