carbon vortex - add minor comment

bancorprotocol · Sep 25, 2024 · a63f8c1 · a63f8c1
1 parent 0b0560c
commit a63f8c1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/contracts/vortex/CarbonVortex.sol b/contracts/vortex/CarbonVortex.sol
@@ -31,6 +31,7 @@ import { PPM_RESOLUTION, MAX_GAP } from "../utility/Constants.sol";
  * - this parameter can be configured so that tokens reach the market rate faster or slower
  * target token is the token to which all other tokens are traded to (can be native token for example)
  * final target token is an additional token to which the target token is traded to (optional)
+ * transferAddress is the address to which all target / final target tokens are sent to
  */
 contract CarbonVortex is ICarbonVortex, Upgradeable, ReentrancyGuardUpgradeable, Utils {
     using Address for address payable;

diff --git a/deploy/scripts/network/0004-CarbonVortex.ts b/deploy/scripts/network/0004-CarbonVortex.ts
@@ -10,6 +10,7 @@ import { HardhatRuntimeEnvironment } from 'hardhat/types';
  * 1. target token is *targetToken* - set address in named-accounts VortexNamedAccounts for the chain
  * 2. final target token is *finalTargetToken* - set address in named-accounts VortexNamedAccounts for the chain (can be zero address)
  * 3. transferAddress is *transferAddress* - set address in named-accounts VortexNamedAccounts for the chain
+ *    --- this is the address that will receive the target / final target tokens after trade
  * 4. CarbonController is set as withdraw address (on execute, tokens will be withdrawn from it
  * 5. For licensed deployments, vault should be address 0 (already configured)
  */