ETH Price: $2,582.11 (+1.05%)

Transaction Decoder

Block:
17974238 at Aug-23-2023 01:49:59 AM +UTC
Transaction Fee:
0.00379699038200218 ETH $9.80
Gas Used:
207,190 Gas / 18.326127622 Gwei

Account State Difference:

  Address   Before After State Difference Code
(beaverbuild)
13.357521915143386871 Eth13.357702012649969151 Eth0.00018009750658228
0xb14875d5...9333715F8
0.022978596435259089 Eth
Nonce: 2
0.019181606053256909 Eth
Nonce: 3
0.00379699038200218

Execution Trace

ETH 0.001605442415609962 WooCrossChainRouterV2.crossSwap( refId=716571692755356138, to=0xb14875d599A7B95D51009836980bcC19333715F8, srcInfos=[{name:fromToken, type:address, order:1, indexed:false, value:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE, valueString:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE}, {name:bridgeToken, type:address, order:2, indexed:false, value:0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2, valueString:0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2}, {name:fromAmount, type:uint256, order:3, indexed:false, value:700000000000000, valueString:700000000000000}, {name:minBridgeAmount, type:uint256, order:4, indexed:false, value:700000000000000, valueString:700000000000000}], dstInfos=[{name:chainId, type:uint16, order:1, indexed:false, value:111, valueString:111}, {name:toToken, type:address, order:2, indexed:false, value:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE, valueString:0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE}, {name:bridgeToken, type:address, order:3, indexed:false, value:0x4200000000000000000000000000000000000006, valueString:0x4200000000000000000000000000000000000006}, {name:minToAmount, type:uint256, order:4, indexed:false, value:692010000000000, valueString:692010000000000}, {name:airdropNativeAmount, type:uint256, order:5, indexed:false, value:0, valueString:0}] )
  • ETH 0.0007 WETH9.CALL( )
  • WETH9.balanceOf( 0x9D1A92e601db0901e69bd810029F2C14bCCA3128 ) => ( 700000000000000 )
  • WETH9.withdraw( wad=700000000000000 )
    • ETH 0.0007 WooCrossChainRouterV2.CALL( )
    • ETH 0.0007 StargateEthVault.CALL( )
    • StargateEthVault.approve( guy=0x8731d54E9D02c286767d56ac03e8037C07e01e98, wad=700000000000000 ) => ( True )
    • ETH 0.000905442415609962 Router.swap( _dstChainId=111, _srcPoolId=13, _dstPoolId=13, _refundAddress=0xb14875d599A7B95D51009836980bcC19333715F8, _amountLD=700000000000000, _minAmountLD=693000000000000, _lzTxParams=[{name:dstGasForCall, type:uint256, order:1, indexed:false, value:360000, valueString:360000}, {name:dstNativeAmount, type:uint256, order:2, indexed:false, value:0, valueString:0}, {name:dstNativeAddr, type:bytes, order:3, indexed:false, value:0xB14875D599A7B95D51009836980BCC19333715F8, valueString:0xB14875D599A7B95D51009836980BCC19333715F8}], _to=0xBEAE1B06949D033DA628BA3E5AF267C3E740494B, _payload=0x00000000000000000000000000000000000000000000000009F1C62872C889EA000000000000000000000000B14875D599A7B95D51009836980BCC19333715F8000000000000000000000000EEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEE00000000000000000000000000000000000000000000000000027561223B2400 )
      • Factory.getPool( 13 ) => ( 0x101816545F6bd2b1076434B54383a1E633390A2E )
      • Pool.STATICCALL( )
      • Pool.swap( _dstChainId=111, _dstPoolId=13, _from=0x9D1A92e601db0901e69bd810029F2C14bCCA3128, _amountLD=700000000000000, _minAmountLD=693000000000000, newLiquidity=True )
        crossSwap[WooCrossChainRouterV2 (ln:56)]
        File 1 of 6: WooCrossChainRouterV2
        // SPDX-License-Identifier: MIT
        pragma solidity =0.8.14;
        // OpenZeppelin Contracts
        import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
        import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
        import {ReentrancyGuard} from "@openzeppelin/contracts/security/ReentrancyGuard.sol";
        import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
        import {ICommonOFT, IOFTWithFee} from "@layerzerolabs/solidity-examples/contracts/token/oft/v2/fee/IOFTWithFee.sol";
        // Local Contracts
        import {IWETH} from "./interfaces/IWETH.sol";
        import {IWooCrossChainRouterV2} from "./interfaces/IWooCrossChainRouterV2.sol";
        import {IWooRouterV2} from "./interfaces/IWooRouterV2.sol";
        import {IStargateEthVault} from "./interfaces/Stargate/IStargateEthVault.sol";
        import {IStargateRouter} from "./interfaces/Stargate/IStargateRouter.sol";
        import {ILzApp} from "./interfaces/LayerZero/ILzApp.sol";
        import {TransferHelper} from "./libraries/TransferHelper.sol";
        /// @title WOOFi cross chain router implementation.
        /// @notice Router for stateless execution of cross chain swap against WOOFi private pool.
        /// @custom:stargate-contracts https://stargateprotocol.gitbook.io/stargate/developers/contract-addresses/mainnet
        contract WooCrossChainRouterV2 is IWooCrossChainRouterV2, Ownable, ReentrancyGuard {
            using EnumerableSet for EnumerableSet.AddressSet;
            /* ----- Constants ----- */
            address public constant ETH_PLACEHOLDER_ADDR = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;
            /* ----- Variables ----- */
            IWooRouterV2 public wooRouter;
            IStargateRouter public stargateRouter;
            address public immutable weth;
            uint256 public bridgeSlippage; // 1 in 10000th: default 1%
            uint256 public dstGasForSwapCall;
            uint256 public dstGasForNoSwapCall;
            uint16 public sgChainIdLocal; // Stargate chainId on local chain
            mapping(uint16 => address) public wooCrossChainRouters; // chainId => WooCrossChainRouter address
            mapping(uint16 => address) public sgETHs; // chainId => SGETH token address
            mapping(uint16 => mapping(address => uint256)) public sgPoolIds; // chainId => token address => Stargate poolId
            mapping(address => address) public tokenToOFTs; // token address(sgChainIdLocal) => OFT address
            EnumerableSet.AddressSet private directBridgeTokens;
            receive() external payable {}
            constructor(
                address _weth,
                address _wooRouter,
                address _stargateRouter,
                uint16 _sgChainIdLocal
            ) {
                wooRouter = IWooRouterV2(_wooRouter);
                stargateRouter = IStargateRouter(_stargateRouter);
                weth = _weth;
                bridgeSlippage = 100;
                dstGasForSwapCall = 360000;
                dstGasForNoSwapCall = 80000;
                sgChainIdLocal = _sgChainIdLocal;
                _initSgETHs();
                _initSgPoolIds();
                _initTokenToOFTs(_sgChainIdLocal);
            }
            /* ----- Functions ----- */
            function crossSwap(
                uint256 refId,
                address payable to,
                SrcInfos memory srcInfos,
                DstInfos memory dstInfos
            ) external payable nonReentrant {
                require(srcInfos.fromToken != address(0), "WooCrossChainRouterV2: !srcInfos.fromToken");
                require(
                    dstInfos.toToken != address(0) && dstInfos.toToken != sgETHs[dstInfos.chainId],
                    "WooCrossChainRouterV2: !dstInfos.toToken"
                );
                require(to != address(0), "WooCrossChainRouterV2: !to");
                uint256 msgValue = msg.value;
                uint256 bridgeAmount;
                {
                    // Step 1: transfer
                    if (srcInfos.fromToken == ETH_PLACEHOLDER_ADDR) {
                        require(srcInfos.fromAmount <= msgValue, "WooCrossChainRouterV2: !srcInfos.fromAmount");
                        srcInfos.fromToken = weth;
                        IWETH(weth).deposit{value: srcInfos.fromAmount}();
                        msgValue -= srcInfos.fromAmount;
                    } else {
                        TransferHelper.safeTransferFrom(srcInfos.fromToken, msg.sender, address(this), srcInfos.fromAmount);
                    }
                    // Step 2: local swap by WooRouter or not
                    // 1.WOO is directBridgeToken, path(always) WOO(Arbitrum) => WOO(BSC)
                    // 2.WOO not the directBridgeToken, path(maybe): WOO(Arbitrum) -> USDC(Arbitrum) => BUSD(BSC) -> WOO(BSC)
                    // 3.Ethereum no WOOFi liquidity, tokens(WOO, ETH, USDC) always will be bridged directly without swap
                    if (!directBridgeTokens.contains(srcInfos.fromToken) && srcInfos.fromToken != srcInfos.bridgeToken) {
                        TransferHelper.safeApprove(srcInfos.fromToken, address(wooRouter), srcInfos.fromAmount);
                        bridgeAmount = wooRouter.swap(
                            srcInfos.fromToken,
                            srcInfos.bridgeToken,
                            srcInfos.fromAmount,
                            srcInfos.minBridgeAmount,
                            payable(address(this)),
                            to
                        );
                    } else {
                        require(
                            srcInfos.fromAmount == srcInfos.minBridgeAmount,
                            "WooCrossChainRouterV2: !srcInfos.minBridgeAmount"
                        );
                        bridgeAmount = srcInfos.fromAmount;
                    }
                    require(
                        bridgeAmount <= IERC20(srcInfos.bridgeToken).balanceOf(address(this)),
                        "WooCrossChainRouterV2: !bridgeAmount"
                    );
                }
                // Step 3: cross chain swap by [OFT / StargateRouter]
                address oft = tokenToOFTs[srcInfos.bridgeToken];
                if (oft != address(0)) {
                    _bridgeByOFT(refId, to, msgValue, bridgeAmount, IOFTWithFee(oft), srcInfos, dstInfos);
                } else {
                    _bridgeByStargate(refId, to, msgValue, bridgeAmount, srcInfos, dstInfos);
                }
                emit WooCrossSwapOnSrcChain(
                    refId,
                    _msgSender(),
                    to,
                    srcInfos.fromToken,
                    srcInfos.fromAmount,
                    srcInfos.minBridgeAmount,
                    bridgeAmount
                );
            }
            function onOFTReceived(
                uint16 srcChainId,
                bytes memory, // srcAddress
                uint64, // nonce
                bytes32 from,
                uint256 amountLD,
                bytes memory payload
            ) external {
                require(_isLegitOFT(_msgSender()), "WooCrossChainRouterV2: INVALID_CALLER");
                require(
                    wooCrossChainRouters[srcChainId] == address(uint160(uint256(from))),
                    "WooCrossChainRouterV2: INVALID_FROM"
                );
                // _msgSender() should be OFT address if requires above are passed
                address bridgedToken = IOFTWithFee(_msgSender()).token();
                // make sure the same order to abi.encode when decode payload
                (uint256 refId, address to, address toToken, uint256 minToAmount) = abi.decode(
                    payload,
                    (uint256, address, address, uint256)
                );
                _handleERC20Received(refId, to, toToken, bridgedToken, amountLD, minToAmount);
            }
            function sgReceive(
                uint16, // srcChainId
                bytes memory, // srcAddress
                uint256, // nonce
                address bridgedToken,
                uint256 amountLD,
                bytes memory payload
            ) external {
                require(msg.sender == address(stargateRouter), "WooCrossChainRouterV2: INVALID_CALLER");
                // make sure the same order to abi.encode when decode payload
                (uint256 refId, address to, address toToken, uint256 minToAmount) = abi.decode(
                    payload,
                    (uint256, address, address, uint256)
                );
                // toToken won't be SGETH, and bridgedToken won't be ETH_PLACEHOLDER_ADDR
                if (bridgedToken == sgETHs[sgChainIdLocal]) {
                    // bridgedToken is SGETH, received native token
                    _handleNativeReceived(refId, to, toToken, amountLD, minToAmount);
                } else {
                    // bridgedToken is not SGETH, received ERC20 token
                    _handleERC20Received(refId, to, toToken, bridgedToken, amountLD, minToAmount);
                }
            }
            function quoteLayerZeroFee(
                uint256 refId,
                address to,
                SrcInfos memory srcInfos,
                DstInfos memory dstInfos
            ) external view returns (uint256, uint256) {
                bytes memory payload = abi.encode(refId, to, dstInfos.toToken, dstInfos.minToAmount);
                address oft = tokenToOFTs[srcInfos.bridgeToken];
                if (oft != address(0)) {
                    // bridge via OFT if it's OFT
                    uint256 dstGasForCall = _getDstGasForCall(dstInfos);
                    bytes memory adapterParams = _getAdapterParams(to, oft, dstGasForCall, dstInfos);
                    bool useZro = false;
                    bytes32 dstWooCrossChainRouter = bytes32(uint256(uint160(wooCrossChainRouters[dstInfos.chainId])));
                    return
                        IOFTWithFee(oft).estimateSendAndCallFee(
                            dstInfos.chainId,
                            dstWooCrossChainRouter,
                            srcInfos.minBridgeAmount,
                            payload,
                            uint64(dstGasForCall),
                            useZro,
                            adapterParams
                        );
                } else {
                    // otherwise bridge via Stargate
                    IStargateRouter.lzTxObj memory obj = _getLzTxObj(to, dstInfos);
                    return
                        stargateRouter.quoteLayerZeroFee(
                            dstInfos.chainId,
                            1, // https://stargateprotocol.gitbook.io/stargate/developers/function-types
                            obj.dstNativeAddr,
                            payload,
                            obj
                        );
                }
            }
            function allDirectBridgeTokens() external view returns (address[] memory) {
                uint256 length = directBridgeTokens.length();
                address[] memory tokens = new address[](length);
                unchecked {
                    for (uint256 i = 0; i < length; ++i) {
                        tokens[i] = directBridgeTokens.at(i);
                    }
                }
                return tokens;
            }
            function allDirectBridgeTokensLength() external view returns (uint256) {
                return directBridgeTokens.length();
            }
            function _initSgETHs() internal {
                // Ethereum
                sgETHs[101] = 0x72E2F4830b9E45d52F80aC08CB2bEC0FeF72eD9c;
                // Arbitrum
                sgETHs[110] = 0x82CbeCF39bEe528B5476FE6d1550af59a9dB6Fc0;
                // Optimism
                sgETHs[111] = 0xb69c8CBCD90A39D8D3d3ccf0a3E968511C3856A0;
            }
            function _initSgPoolIds() internal {
                // poolId > 0 means able to be bridge token
                // Ethereum
                sgPoolIds[101][0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48] = 1; // USDC
                sgPoolIds[101][0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2] = 13; // WETH
                sgPoolIds[101][0x4691937a7508860F876c9c0a2a617E7d9E945D4B] = 20; // WOO
                // BNB Chain
                sgPoolIds[102][0x55d398326f99059fF775485246999027B3197955] = 2; // USDT
                sgPoolIds[102][0xe9e7CEA3DedcA5984780Bafc599bD69ADd087D56] = 5; // BUSD
                sgPoolIds[102][0x4691937a7508860F876c9c0a2a617E7d9E945D4B] = 20; // WOO
                // Avalanche
                sgPoolIds[106][0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E] = 1; // USDC
                sgPoolIds[106][0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7] = 2; // USDT
                sgPoolIds[106][0xaBC9547B534519fF73921b1FBA6E672b5f58D083] = 20; // WOO
                // Polygon
                sgPoolIds[109][0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174] = 1; // USDC
                sgPoolIds[109][0xc2132D05D31c914a87C6611C10748AEb04B58e8F] = 2; // USDT
                sgPoolIds[109][0x1B815d120B3eF02039Ee11dC2d33DE7aA4a8C603] = 20; // WOO
                // Arbitrum
                sgPoolIds[110][0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8] = 1; // USDC
                sgPoolIds[110][0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9] = 2; // USDT
                sgPoolIds[110][0x82aF49447D8a07e3bd95BD0d56f35241523fBab1] = 13; // WETH
                sgPoolIds[110][0xcAFcD85D8ca7Ad1e1C6F82F651fA15E33AEfD07b] = 20; // WOO
                // Optimism
                sgPoolIds[111][0x7F5c764cBc14f9669B88837ca1490cCa17c31607] = 1; // USDC
                sgPoolIds[111][0x4200000000000000000000000000000000000006] = 13; // WETH
                sgPoolIds[111][0x871f2F2ff935FD1eD867842FF2a7bfD051A5E527] = 20; // WOO
                // Fantom
                sgPoolIds[112][0x04068DA6C83AFCFA0e13ba15A6696662335D5B75] = 1; // USDC
                sgPoolIds[112][0x6626c47c00F1D87902fc13EECfaC3ed06D5E8D8a] = 20; // WOO
            }
            function _initTokenToOFTs(uint16 _sgChainIdLocal) internal {
                address btcbOFT = 0x2297aEbD383787A160DD0d9F71508148769342E3; // BTCbOFT && BTCbProxyOFT
                if (_sgChainIdLocal == 106) {
                    // BTC.b(ERC20) on Avalanche address
                    tokenToOFTs[0x152b9d0FdC40C096757F570A51E494bd4b943E50] = btcbOFT;
                }
                tokenToOFTs[btcbOFT] = btcbOFT;
            }
            function _getDstGasForCall(DstInfos memory dstInfos) internal view returns (uint256) {
                return (dstInfos.toToken == dstInfos.bridgeToken) ? dstGasForNoSwapCall : dstGasForSwapCall;
            }
            function _getAdapterParams(
                address to,
                address oft,
                uint256 dstGasForCall,
                DstInfos memory dstInfos
            ) internal view returns (bytes memory) {
                // OFT src logic: require(providedGasLimit >= minGasLimit)
                // uint256 minGasLimit = minDstGasLookup[_dstChainId][_type] + dstGasForCall;
                // _type: 0(send), 1(send_and_call)
                uint256 providedGasLimit = ILzApp(oft).minDstGasLookup(dstInfos.chainId, 1) + dstGasForCall;
                // https://layerzero.gitbook.io/docs/evm-guides/advanced/relayer-adapter-parameters#airdrop
                return
                    abi.encodePacked(
                        uint16(2), // version: 2 is able to airdrop native token on destination but 1 is not
                        providedGasLimit, // gasAmount: destination transaction gas for LayerZero to delivers
                        dstInfos.airdropNativeAmount, // nativeForDst: airdrop native token amount
                        to // addressOnDst: address to receive airdrop native token on destination
                    );
            }
            function _getLzTxObj(address to, DstInfos memory dstInfos) internal view returns (IStargateRouter.lzTxObj memory) {
                uint256 dstGasForCall = _getDstGasForCall(dstInfos);
                return IStargateRouter.lzTxObj(dstGasForCall, dstInfos.airdropNativeAmount, abi.encodePacked(to));
            }
            function _isLegitOFT(address caller) internal view returns (bool) {
                return tokenToOFTs[caller] != address(0);
            }
            function _bridgeByOFT(
                uint256 refId,
                address payable to,
                uint256 msgValue,
                uint256 bridgeAmount,
                IOFTWithFee oft,
                SrcInfos memory srcInfos,
                DstInfos memory dstInfos
            ) internal {
                {
                    address token = oft.token();
                    require(token == srcInfos.bridgeToken, "WooCrossChainRouterV2: !token");
                    if (token != address(oft)) {
                        // oft.token() != address(oft) means is a ProxyOFT
                        // for example: BTC.b on Avalanche is ERC20, need BTCbProxyOFT to lock up BTC.b
                        TransferHelper.safeApprove(srcInfos.bridgeToken, address(oft), bridgeAmount);
                    }
                }
                // OFT src logic: require(_removeDust(bridgeAmount) >= minAmount)
                uint256 minAmount = (bridgeAmount * (10000 - bridgeSlippage)) / 10000;
                bytes memory payload = abi.encode(refId, to, dstInfos.toToken, dstInfos.minToAmount);
                uint256 dstGasForCall = _getDstGasForCall(dstInfos);
                ICommonOFT.LzCallParams memory callParams;
                {
                    bytes memory adapterParams = _getAdapterParams(to, address(oft), dstGasForCall, dstInfos);
                    callParams = ICommonOFT.LzCallParams(
                        payable(msg.sender), // refundAddress
                        address(0), // zroPaymentAddress
                        adapterParams //adapterParams
                    );
                }
                bytes32 dstWooCrossChainRouter = bytes32(uint256(uint160(wooCrossChainRouters[dstInfos.chainId])));
                oft.sendAndCall{value: msgValue}(
                    address(this),
                    dstInfos.chainId,
                    dstWooCrossChainRouter,
                    bridgeAmount,
                    minAmount,
                    payload,
                    uint64(dstGasForCall),
                    callParams
                );
            }
            function _bridgeByStargate(
                uint256 refId,
                address payable to,
                uint256 msgValue,
                uint256 bridgeAmount,
                SrcInfos memory srcInfos,
                DstInfos memory dstInfos
            ) internal {
                uint256 srcPoolId = sgPoolIds[sgChainIdLocal][srcInfos.bridgeToken];
                require(srcPoolId > 0, "WooCrossChainRouterV2: !srcInfos.bridgeToken");
                uint256 dstPoolId = sgPoolIds[dstInfos.chainId][dstInfos.bridgeToken];
                require(dstPoolId > 0, "WooCrossChainRouterV2: !dstInfos.bridgeToken");
                bytes memory payload = abi.encode(refId, to, dstInfos.toToken, dstInfos.minToAmount);
                uint256 dstMinBridgeAmount = (bridgeAmount * (10000 - bridgeSlippage)) / 10000;
                bytes memory dstWooCrossChainRouter = abi.encodePacked(wooCrossChainRouters[dstInfos.chainId]);
                IStargateRouter.lzTxObj memory obj = _getLzTxObj(to, dstInfos);
                if (srcInfos.bridgeToken == weth) {
                    IWETH(weth).withdraw(bridgeAmount);
                    address sgETH = sgETHs[sgChainIdLocal];
                    IStargateEthVault(sgETH).deposit{value: bridgeAmount}(); // logic from Stargate RouterETH.sol
                    TransferHelper.safeApprove(sgETH, address(stargateRouter), bridgeAmount);
                } else {
                    TransferHelper.safeApprove(srcInfos.bridgeToken, address(stargateRouter), bridgeAmount);
                }
                stargateRouter.swap{value: msgValue}(
                    dstInfos.chainId, // dst chain id
                    srcPoolId, // bridge token's pool id on src chain
                    dstPoolId, // bridge token's pool id on dst chain
                    payable(_msgSender()), // rebate address
                    bridgeAmount, // swap amount on src chain
                    dstMinBridgeAmount, // min received amount on dst chain
                    obj, // config: dstGasForCall, dstAirdropNativeAmount, dstReceiveAirdropNativeTokenAddr
                    dstWooCrossChainRouter, // smart contract to call on dst chain
                    payload // payload to piggyback
                );
            }
            function _handleNativeReceived(
                uint256 refId,
                address to,
                address toToken,
                uint256 bridgedAmount,
                uint256 minToAmount
            ) internal {
                address msgSender = _msgSender();
                if (toToken == ETH_PLACEHOLDER_ADDR) {
                    TransferHelper.safeTransferETH(to, bridgedAmount);
                    emit WooCrossSwapOnDstChain(
                        refId,
                        msgSender,
                        to,
                        weth,
                        bridgedAmount,
                        toToken,
                        ETH_PLACEHOLDER_ADDR,
                        minToAmount,
                        bridgedAmount
                    );
                } else {
                    try
                        wooRouter.swap{value: bridgedAmount}(
                            ETH_PLACEHOLDER_ADDR,
                            toToken,
                            bridgedAmount,
                            minToAmount,
                            payable(to),
                            to
                        )
                    returns (uint256 realToAmount) {
                        emit WooCrossSwapOnDstChain(
                            refId,
                            msgSender,
                            to,
                            weth,
                            bridgedAmount,
                            toToken,
                            toToken,
                            minToAmount,
                            realToAmount
                        );
                    } catch {
                        TransferHelper.safeTransferETH(to, bridgedAmount);
                        emit WooCrossSwapOnDstChain(
                            refId,
                            msgSender,
                            to,
                            weth,
                            bridgedAmount,
                            toToken,
                            ETH_PLACEHOLDER_ADDR,
                            minToAmount,
                            bridgedAmount
                        );
                    }
                }
            }
            function _handleERC20Received(
                uint256 refId,
                address to,
                address toToken,
                address bridgedToken,
                uint256 bridgedAmount,
                uint256 minToAmount
            ) internal {
                address msgSender = _msgSender();
                if (toToken == bridgedToken) {
                    TransferHelper.safeTransfer(bridgedToken, to, bridgedAmount);
                    emit WooCrossSwapOnDstChain(
                        refId,
                        msgSender,
                        to,
                        bridgedToken,
                        bridgedAmount,
                        toToken,
                        toToken,
                        minToAmount,
                        bridgedAmount
                    );
                } else {
                    TransferHelper.safeApprove(bridgedToken, address(wooRouter), bridgedAmount);
                    try wooRouter.swap(bridgedToken, toToken, bridgedAmount, minToAmount, payable(to), to) returns (
                        uint256 realToAmount
                    ) {
                        emit WooCrossSwapOnDstChain(
                            refId,
                            msgSender,
                            to,
                            bridgedToken,
                            bridgedAmount,
                            toToken,
                            toToken,
                            minToAmount,
                            realToAmount
                        );
                    } catch {
                        TransferHelper.safeTransfer(bridgedToken, to, bridgedAmount);
                        emit WooCrossSwapOnDstChain(
                            refId,
                            msgSender,
                            to,
                            bridgedToken,
                            bridgedAmount,
                            toToken,
                            bridgedToken,
                            minToAmount,
                            bridgedAmount
                        );
                    }
                }
            }
            /* ----- Owner & Admin Functions ----- */
            function setWooRouter(address _wooRouter) external onlyOwner {
                require(_wooRouter != address(0), "WooCrossChainRouterV2: !_wooRouter");
                wooRouter = IWooRouterV2(_wooRouter);
            }
            function setStargateRouter(address _stargateRouter) external onlyOwner {
                require(_stargateRouter != address(0), "WooCrossChainRouterV2: !_stargateRouter");
                stargateRouter = IStargateRouter(_stargateRouter);
            }
            function setBridgeSlippage(uint256 _bridgeSlippage) external onlyOwner {
                require(_bridgeSlippage <= 10000, "WooCrossChainRouterV2: !_bridgeSlippage");
                bridgeSlippage = _bridgeSlippage;
            }
            function setDstGasForSwapCall(uint256 _dstGasForSwapCall) external onlyOwner {
                dstGasForSwapCall = _dstGasForSwapCall;
            }
            function setDstGasForNoSwapCall(uint256 _dstGasForNoSwapCall) external onlyOwner {
                dstGasForNoSwapCall = _dstGasForNoSwapCall;
            }
            function setSgChainIdLocal(uint16 _sgChainIdLocal) external onlyOwner {
                sgChainIdLocal = _sgChainIdLocal;
            }
            function setWooCrossChainRouter(uint16 chainId, address wooCrossChainRouter) external onlyOwner {
                require(wooCrossChainRouter != address(0), "WooCrossChainRouterV2: !wooCrossChainRouter");
                wooCrossChainRouters[chainId] = wooCrossChainRouter;
            }
            function setSgETH(uint16 chainId, address token) external onlyOwner {
                require(token != address(0), "WooCrossChainRouterV2: !token");
                sgETHs[chainId] = token;
            }
            function setSgPoolId(
                uint16 chainId,
                address token,
                uint256 poolId
            ) external onlyOwner {
                sgPoolIds[chainId][token] = poolId;
            }
            function setTokenToOFT(address token, address oft) external onlyOwner {
                tokenToOFTs[token] = oft;
            }
            function addDirectBridgeToken(address token) external onlyOwner {
                bool success = directBridgeTokens.add(token);
                require(success, "WooCrossChainRouterV2: token exist");
            }
            function removeDirectBridgeToken(address token) external onlyOwner {
                bool success = directBridgeTokens.remove(token);
                require(success, "WooCrossChainRouterV2: token not exist");
            }
            function inCaseTokenGotStuck(address stuckToken) external onlyOwner {
                if (stuckToken == ETH_PLACEHOLDER_ADDR) {
                    TransferHelper.safeTransferETH(msg.sender, address(this).balance);
                } else {
                    uint256 amount = IERC20(stuckToken).balanceOf(address(this));
                    TransferHelper.safeTransfer(stuckToken, msg.sender, amount);
                }
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.8.0;
        /// @title Wrapped ETH.
        interface IWETH {
            /// @dev Deposit ETH into WETH
            function deposit() external payable;
            /// @dev Transfer WETH to receiver
            /// @param to address of WETH receiver
            /// @param value amount of WETH to transfer
            /// @return get true when succeed, else false
            function transfer(address to, uint256 value) external returns (bool);
            /// @dev Withdraw WETH to ETH
            function withdraw(uint256) external;
        }
        // SPDX-License-Identifier: MIT
        pragma solidity =0.8.14;
        /*
        ░██╗░░░░░░░██╗░█████╗░░█████╗░░░░░░░███████╗██╗
        ░██║░░██╗░░██║██╔══██╗██╔══██╗░░░░░░██╔════╝██║
        ░╚██╗████╗██╔╝██║░░██║██║░░██║█████╗█████╗░░██║
        ░░████╔═████║░██║░░██║██║░░██║╚════╝██╔══╝░░██║
        ░░╚██╔╝░╚██╔╝░╚█████╔╝╚█████╔╝░░░░░░██║░░░░░██║
        ░░░╚═╝░░░╚═╝░░░╚════╝░░╚════╝░░░░░░░╚═╝░░░░░╚═╝
        *
        * MIT License
        * ===========
        *
        * Copyright (c) 2020 WooTrade
        *
        * Permission is hereby granted, free of charge, to any person obtaining a copy
        * of this software and associated documentation files (the "Software"), to deal
        * in the Software without restriction, including without limitation the rights
        * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        * copies of the Software, and to permit persons to whom the Software is
        * furnished to do so, subject to the following conditions:
        *
        * The above copyright notice and this permission notice shall be included in all
        * copies or substantial portions of the Software.
        *
        * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        */
        /// @title WOOFi cross chain router interface (version 2).
        /// @notice functions to interface with WOOFi cross chain swap.
        interface IWooCrossChainRouterV2 {
            /* ----- Structs ----- */
            struct SrcInfos {
                address fromToken;
                address bridgeToken;
                uint256 fromAmount;
                uint256 minBridgeAmount;
            }
            struct DstInfos {
                uint16 chainId;
                address toToken;
                address bridgeToken;
                uint256 minToAmount;
                uint256 airdropNativeAmount;
            }
            /* ----- Events ----- */
            event WooCrossSwapOnSrcChain(
                uint256 indexed refId,
                address indexed sender,
                address indexed to,
                address fromToken,
                uint256 fromAmount,
                uint256 minBridgeAmount,
                uint256 realBridgeAmount
            );
            event WooCrossSwapOnDstChain(
                uint256 indexed refId,
                address indexed sender,
                address indexed to,
                address bridgedToken,
                uint256 bridgedAmount,
                address toToken,
                address realToToken,
                uint256 minToAmount,
                uint256 realToAmount
            );
            /* ----- State Variables ----- */
            function weth() external view returns (address);
            function bridgeSlippage() external view returns (uint256);
            function dstGasForSwapCall() external view returns (uint256);
            function dstGasForNoSwapCall() external view returns (uint256);
            function sgChainIdLocal() external view returns (uint16);
            function wooCrossChainRouters(uint16 chainId) external view returns (address wooCrossChainRouter);
            function sgETHs(uint16 chainId) external view returns (address sgETH);
            function sgPoolIds(uint16 chainId, address token) external view returns (uint256 poolId);
            /* ----- Functions ----- */
            function crossSwap(
                uint256 refId,
                address payable to,
                SrcInfos memory srcInfos,
                DstInfos memory dstInfos
            ) external payable;
            function sgReceive(
                uint16 srcChainId,
                bytes memory srcAddress,
                uint256 nonce,
                address bridgedToken,
                uint256 amountLD,
                bytes memory payload
            ) external;
            function quoteLayerZeroFee(
                uint256 refId,
                address to,
                SrcInfos memory srcInfos,
                DstInfos memory dstInfos
            ) external view returns (uint256 nativeAmount, uint256 zroAmount);
            function allDirectBridgeTokens() external view returns (address[] memory tokens);
            function allDirectBridgeTokensLength() external view returns (uint256 length);
        }
        // SPDX-License-Identifier: MIT
        pragma solidity =0.8.14;
        /*
        ░██╗░░░░░░░██╗░█████╗░░█████╗░░░░░░░███████╗██╗
        ░██║░░██╗░░██║██╔══██╗██╔══██╗░░░░░░██╔════╝██║
        ░╚██╗████╗██╔╝██║░░██║██║░░██║█████╗█████╗░░██║
        ░░████╔═████║░██║░░██║██║░░██║╚════╝██╔══╝░░██║
        ░░╚██╔╝░╚██╔╝░╚█████╔╝╚█████╔╝░░░░░░██║░░░░░██║
        ░░░╚═╝░░░╚═╝░░░╚════╝░░╚════╝░░░░░░░╚═╝░░░░░╚═╝
        *
        * MIT License
        * ===========
        *
        * Copyright (c) 2020 WooTrade
        *
        * Permission is hereby granted, free of charge, to any person obtaining a copy
        * of this software and associated documentation files (the "Software"), to deal
        * in the Software without restriction, including without limitation the rights
        * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        * copies of the Software, and to permit persons to whom the Software is
        * furnished to do so, subject to the following conditions:
        *
        * The above copyright notice and this permission notice shall be included in all
        * copies or substantial portions of the Software.
        *
        * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        */
        import "../interfaces/IWooPPV2.sol";
        /// @title Woo router interface (version 2)
        /// @notice functions to interface with WooFi swap
        interface IWooRouterV2 {
            /* ----- Type declarations ----- */
            enum SwapType {
                WooSwap,
                DodoSwap
            }
            /* ----- Events ----- */
            event WooRouterSwap(
                SwapType swapType,
                address indexed fromToken,
                address indexed toToken,
                uint256 fromAmount,
                uint256 toAmount,
                address from,
                address indexed to,
                address rebateTo
            );
            event WooPoolChanged(address newPool);
            /* ----- Router properties ----- */
            function WETH() external view returns (address);
            function wooPool() external view returns (IWooPPV2);
            /* ----- Main query & swap APIs ----- */
            /// @notice query the amount to swap fromToken -> toToken
            /// @param fromToken the from token
            /// @param toToken the to token
            /// @param fromAmount the amount of fromToken to swap
            /// @return toAmount the predicted amount to receive
            function querySwap(
                address fromToken,
                address toToken,
                uint256 fromAmount
            ) external view returns (uint256 toAmount);
            /// @notice query the amount to swap fromToken -> toToken,
            ///     WITHOUT checking the reserve balance; so it
            ///     always returns the quoted amount (for reference).
            /// @param fromToken the from token
            /// @param toToken the to token
            /// @param fromAmount the amount of fromToken to swap
            /// @return toAmount the predicted amount to receive
            function tryQuerySwap(
                address fromToken,
                address toToken,
                uint256 fromAmount
            ) external view returns (uint256 toAmount);
            /// @notice Swap `fromToken` to `toToken`.
            /// @param fromToken the from token
            /// @param toToken the to token
            /// @param fromAmount the amount of `fromToken` to swap
            /// @param minToAmount the minimum amount of `toToken` to receive
            /// @param to the destination address
            /// @param rebateTo the rebate address (optional, can be 0)
            /// @return realToAmount the amount of toToken to receive
            function swap(
                address fromToken,
                address toToken,
                uint256 fromAmount,
                uint256 minToAmount,
                address payable to,
                address rebateTo
            ) external payable returns (uint256 realToAmount);
            /* ----- 3rd party DEX swap ----- */
            /// @notice swap fromToken -> toToken via an external 3rd swap
            /// @param approveTarget the contract address for token transfer approval
            /// @param swapTarget the contract address for swap
            /// @param fromToken the from token
            /// @param toToken the to token
            /// @param fromAmount the amount of fromToken to swap
            /// @param minToAmount the min amount of swapped toToken
            /// @param to the destination address
            /// @param data call data for external call
            function externalSwap(
                address approveTarget,
                address swapTarget,
                address fromToken,
                address toToken,
                uint256 fromAmount,
                uint256 minToAmount,
                address payable to,
                bytes calldata data
            ) external payable returns (uint256 realToAmount);
        }
        // SPDX-License-Identifier: GPL-3.0-or-later
        pragma solidity ^0.8.0;
        // helper methods for interacting with ERC20 tokens and sending ETH that do not consistently return true/false
        library TransferHelper {
            function safeApprove(
                address token,
                address to,
                uint256 value
            ) internal {
                // bytes4(keccak256(bytes('approve(address,uint256)')));
                (bool success, bytes memory data) = token.call(abi.encodeWithSelector(0x095ea7b3, to, value));
                require(
                    success && (data.length == 0 || abi.decode(data, (bool))),
                    "TransferHelper::safeApprove: approve failed"
                );
            }
            function safeTransfer(
                address token,
                address to,
                uint256 value
            ) internal {
                // bytes4(keccak256(bytes('transfer(address,uint256)')));
                (bool success, bytes memory data) = token.call(abi.encodeWithSelector(0xa9059cbb, to, value));
                require(
                    success && (data.length == 0 || abi.decode(data, (bool))),
                    "TransferHelper::safeTransfer: transfer failed"
                );
            }
            function safeTransferFrom(
                address token,
                address from,
                address to,
                uint256 value
            ) internal {
                // bytes4(keccak256(bytes('transferFrom(address,address,uint256)')));
                (bool success, bytes memory data) = token.call(abi.encodeWithSelector(0x23b872dd, from, to, value));
                require(
                    success && (data.length == 0 || abi.decode(data, (bool))),
                    "TransferHelper::transferFrom: transferFrom failed"
                );
            }
            function safeTransferETH(address to, uint256 value) internal {
                (bool success, ) = to.call{value: value}(new bytes(0));
                require(success, "TransferHelper::safeTransferETH: ETH transfer failed");
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.8.0;
        interface IStargateEthVault {
            function deposit() external payable;
            function transfer(address to, uint256 value) external returns (bool);
            function withdraw(uint256) external;
            function approve(address guy, uint256 wad) external returns (bool);
            function transferFrom(
                address src,
                address dst,
                uint256 wad
            ) external returns (bool);
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.8.0;
        interface IStargateRouter {
            struct lzTxObj {
                uint256 dstGasForCall;
                uint256 dstNativeAmount;
                bytes dstNativeAddr;
            }
            function addLiquidity(
                uint256 _poolId,
                uint256 _amountLD,
                address _to
            ) external;
            function swap(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLD,
                uint256 _minAmountLD,
                lzTxObj memory _lzTxParams,
                bytes calldata _to,
                bytes calldata _payload
            ) external payable;
            function redeemRemote(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLP,
                uint256 _minAmountLD,
                bytes calldata _to,
                lzTxObj memory _lzTxParams
            ) external payable;
            function instantRedeemLocal(
                uint16 _srcPoolId,
                uint256 _amountLP,
                address _to
            ) external returns (uint256);
            function redeemLocal(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLP,
                bytes calldata _to,
                lzTxObj memory _lzTxParams
            ) external payable;
            function sendCredits(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress
            ) external payable;
            function quoteLayerZeroFee(
                uint16 _dstChainId,
                uint8 _functionType,
                bytes calldata _toAddress,
                bytes calldata _transferAndCallPayload,
                lzTxObj memory _lzTxParams
            ) external view returns (uint256, uint256);
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.8.0;
        /**
         * @dev Interface of the LzApp that functions not exist in the @layerzerolabs package
         */
        interface ILzApp {
            function minDstGasLookup(uint16 _dstChainId, uint16 _type) external view returns (uint256 _minGasLimit);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)
        pragma solidity ^0.8.0;
        import "../utils/Context.sol";
        /**
         * @dev Contract module which provides a basic access control mechanism, where
         * there is an account (an owner) that can be granted exclusive access to
         * specific functions.
         *
         * By default, the owner account will be the one that deploys the contract. This
         * can later be changed with {transferOwnership}.
         *
         * This module is used through inheritance. It will make available the modifier
         * `onlyOwner`, which can be applied to your functions to restrict their use to
         * the owner.
         */
        abstract contract Ownable is Context {
            address private _owner;
            event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
            /**
             * @dev Initializes the contract setting the deployer as the initial owner.
             */
            constructor() {
                _transferOwnership(_msgSender());
            }
            /**
             * @dev Throws if called by any account other than the owner.
             */
            modifier onlyOwner() {
                _checkOwner();
                _;
            }
            /**
             * @dev Returns the address of the current owner.
             */
            function owner() public view virtual returns (address) {
                return _owner;
            }
            /**
             * @dev Throws if the sender is not the owner.
             */
            function _checkOwner() internal view virtual {
                require(owner() == _msgSender(), "Ownable: caller is not the owner");
            }
            /**
             * @dev Leaves the contract without owner. It will not be possible to call
             * `onlyOwner` functions anymore. Can only be called by the current owner.
             *
             * NOTE: Renouncing ownership will leave the contract without an owner,
             * thereby removing any functionality that is only available to the owner.
             */
            function renounceOwnership() public virtual onlyOwner {
                _transferOwnership(address(0));
            }
            /**
             * @dev Transfers ownership of the contract to a new account (`newOwner`).
             * Can only be called by the current owner.
             */
            function transferOwnership(address newOwner) public virtual onlyOwner {
                require(newOwner != address(0), "Ownable: new owner is the zero address");
                _transferOwnership(newOwner);
            }
            /**
             * @dev Transfers ownership of the contract to a new account (`newOwner`).
             * Internal function without access restriction.
             */
            function _transferOwnership(address newOwner) internal virtual {
                address oldOwner = _owner;
                _owner = newOwner;
                emit OwnershipTransferred(oldOwner, newOwner);
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Contract module that helps prevent reentrant calls to a function.
         *
         * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
         * available, which can be applied to functions to make sure there are no nested
         * (reentrant) calls to them.
         *
         * Note that because there is a single `nonReentrant` guard, functions marked as
         * `nonReentrant` may not call one another. This can be worked around by making
         * those functions `private`, and then adding `external` `nonReentrant` entry
         * points to them.
         *
         * TIP: If you would like to learn more about reentrancy and alternative ways
         * to protect against it, check out our blog post
         * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
         */
        abstract contract ReentrancyGuard {
            // Booleans are more expensive than uint256 or any type that takes up a full
            // word because each write operation emits an extra SLOAD to first read the
            // slot's contents, replace the bits taken up by the boolean, and then write
            // back. This is the compiler's defense against contract upgrades and
            // pointer aliasing, and it cannot be disabled.
            // The values being non-zero value makes deployment a bit more expensive,
            // but in exchange the refund on every call to nonReentrant will be lower in
            // amount. Since refunds are capped to a percentage of the total
            // transaction's gas, it is best to keep them low in cases like this one, to
            // increase the likelihood of the full refund coming into effect.
            uint256 private constant _NOT_ENTERED = 1;
            uint256 private constant _ENTERED = 2;
            uint256 private _status;
            constructor() {
                _status = _NOT_ENTERED;
            }
            /**
             * @dev Prevents a contract from calling itself, directly or indirectly.
             * Calling a `nonReentrant` function from another `nonReentrant`
             * function is not supported. It is possible to prevent this from happening
             * by making the `nonReentrant` function external, and making it call a
             * `private` function that does the actual work.
             */
            modifier nonReentrant() {
                // On the first call to nonReentrant, _notEntered will be true
                require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
                // Any calls to nonReentrant after this point will fail
                _status = _ENTERED;
                _;
                // By storing the original value once again, a refund is triggered (see
                // https://eips.ethereum.org/EIPS/eip-2200)
                _status = _NOT_ENTERED;
            }
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Interface of the ERC20 standard as defined in the EIP.
         */
        interface IERC20 {
            /**
             * @dev Emitted when `value` tokens are moved from one account (`from`) to
             * another (`to`).
             *
             * Note that `value` may be zero.
             */
            event Transfer(address indexed from, address indexed to, uint256 value);
            /**
             * @dev Emitted when the allowance of a `spender` for an `owner` is set by
             * a call to {approve}. `value` is the new allowance.
             */
            event Approval(address indexed owner, address indexed spender, uint256 value);
            /**
             * @dev Returns the amount of tokens in existence.
             */
            function totalSupply() external view returns (uint256);
            /**
             * @dev Returns the amount of tokens owned by `account`.
             */
            function balanceOf(address account) external view returns (uint256);
            /**
             * @dev Moves `amount` tokens from the caller's account to `to`.
             *
             * Returns a boolean value indicating whether the operation succeeded.
             *
             * Emits a {Transfer} event.
             */
            function transfer(address to, uint256 amount) external returns (bool);
            /**
             * @dev Returns the remaining number of tokens that `spender` will be
             * allowed to spend on behalf of `owner` through {transferFrom}. This is
             * zero by default.
             *
             * This value changes when {approve} or {transferFrom} are called.
             */
            function allowance(address owner, address spender) external view returns (uint256);
            /**
             * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
             *
             * Returns a boolean value indicating whether the operation succeeded.
             *
             * IMPORTANT: Beware that changing an allowance with this method brings the risk
             * that someone may use both the old and the new allowance by unfortunate
             * transaction ordering. One possible solution to mitigate this race
             * condition is to first reduce the spender's allowance to 0 and set the
             * desired value afterwards:
             * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
             *
             * Emits an {Approval} event.
             */
            function approve(address spender, uint256 amount) external returns (bool);
            /**
             * @dev Moves `amount` tokens from `from` to `to` using the
             * allowance mechanism. `amount` is then deducted from the caller's
             * allowance.
             *
             * Returns a boolean value indicating whether the operation succeeded.
             *
             * Emits a {Transfer} event.
             */
            function transferFrom(
                address from,
                address to,
                uint256 amount
            ) external returns (bool);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts (last updated v4.7.0) (utils/structs/EnumerableSet.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Library for managing
         * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
         * types.
         *
         * Sets have the following properties:
         *
         * - Elements are added, removed, and checked for existence in constant time
         * (O(1)).
         * - Elements are enumerated in O(n). No guarantees are made on the ordering.
         *
         * ```
         * contract Example {
         *     // Add the library methods
         *     using EnumerableSet for EnumerableSet.AddressSet;
         *
         *     // Declare a set state variable
         *     EnumerableSet.AddressSet private mySet;
         * }
         * ```
         *
         * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
         * and `uint256` (`UintSet`) are supported.
         *
         * [WARNING]
         * ====
         *  Trying to delete such a structure from storage will likely result in data corruption, rendering the structure unusable.
         *  See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info.
         *
         *  In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an array of EnumerableSet.
         * ====
         */
        library EnumerableSet {
            // To implement this library for multiple types with as little code
            // repetition as possible, we write it in terms of a generic Set type with
            // bytes32 values.
            // The Set implementation uses private functions, and user-facing
            // implementations (such as AddressSet) are just wrappers around the
            // underlying Set.
            // This means that we can only create new EnumerableSets for types that fit
            // in bytes32.
            struct Set {
                // Storage of set values
                bytes32[] _values;
                // Position of the value in the `values` array, plus 1 because index 0
                // means a value is not in the set.
                mapping(bytes32 => uint256) _indexes;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function _add(Set storage set, bytes32 value) private returns (bool) {
                if (!_contains(set, value)) {
                    set._values.push(value);
                    // The value is stored at length-1, but we add 1 to all indexes
                    // and use 0 as a sentinel value
                    set._indexes[value] = set._values.length;
                    return true;
                } else {
                    return false;
                }
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function _remove(Set storage set, bytes32 value) private returns (bool) {
                // We read and store the value's index to prevent multiple reads from the same storage slot
                uint256 valueIndex = set._indexes[value];
                if (valueIndex != 0) {
                    // Equivalent to contains(set, value)
                    // To delete an element from the _values array in O(1), we swap the element to delete with the last one in
                    // the array, and then remove the last element (sometimes called as 'swap and pop').
                    // This modifies the order of the array, as noted in {at}.
                    uint256 toDeleteIndex = valueIndex - 1;
                    uint256 lastIndex = set._values.length - 1;
                    if (lastIndex != toDeleteIndex) {
                        bytes32 lastValue = set._values[lastIndex];
                        // Move the last value to the index where the value to delete is
                        set._values[toDeleteIndex] = lastValue;
                        // Update the index for the moved value
                        set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex
                    }
                    // Delete the slot where the moved value was stored
                    set._values.pop();
                    // Delete the index for the deleted slot
                    delete set._indexes[value];
                    return true;
                } else {
                    return false;
                }
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function _contains(Set storage set, bytes32 value) private view returns (bool) {
                return set._indexes[value] != 0;
            }
            /**
             * @dev Returns the number of values on the set. O(1).
             */
            function _length(Set storage set) private view returns (uint256) {
                return set._values.length;
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function _at(Set storage set, uint256 index) private view returns (bytes32) {
                return set._values[index];
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function _values(Set storage set) private view returns (bytes32[] memory) {
                return set._values;
            }
            // Bytes32Set
            struct Bytes32Set {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
                return _add(set._inner, value);
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
                return _remove(set._inner, value);
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
                return _contains(set._inner, value);
            }
            /**
             * @dev Returns the number of values in the set. O(1).
             */
            function length(Bytes32Set storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
                return _at(set._inner, index);
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
                return _values(set._inner);
            }
            // AddressSet
            struct AddressSet {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(AddressSet storage set, address value) internal returns (bool) {
                return _add(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(AddressSet storage set, address value) internal returns (bool) {
                return _remove(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(AddressSet storage set, address value) internal view returns (bool) {
                return _contains(set._inner, bytes32(uint256(uint160(value))));
            }
            /**
             * @dev Returns the number of values in the set. O(1).
             */
            function length(AddressSet storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(AddressSet storage set, uint256 index) internal view returns (address) {
                return address(uint160(uint256(_at(set._inner, index))));
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(AddressSet storage set) internal view returns (address[] memory) {
                bytes32[] memory store = _values(set._inner);
                address[] memory result;
                /// @solidity memory-safe-assembly
                assembly {
                    result := store
                }
                return result;
            }
            // UintSet
            struct UintSet {
                Set _inner;
            }
            /**
             * @dev Add a value to a set. O(1).
             *
             * Returns true if the value was added to the set, that is if it was not
             * already present.
             */
            function add(UintSet storage set, uint256 value) internal returns (bool) {
                return _add(set._inner, bytes32(value));
            }
            /**
             * @dev Removes a value from a set. O(1).
             *
             * Returns true if the value was removed from the set, that is if it was
             * present.
             */
            function remove(UintSet storage set, uint256 value) internal returns (bool) {
                return _remove(set._inner, bytes32(value));
            }
            /**
             * @dev Returns true if the value is in the set. O(1).
             */
            function contains(UintSet storage set, uint256 value) internal view returns (bool) {
                return _contains(set._inner, bytes32(value));
            }
            /**
             * @dev Returns the number of values on the set. O(1).
             */
            function length(UintSet storage set) internal view returns (uint256) {
                return _length(set._inner);
            }
            /**
             * @dev Returns the value stored at position `index` in the set. O(1).
             *
             * Note that there are no guarantees on the ordering of values inside the
             * array, and it may change when more values are added or removed.
             *
             * Requirements:
             *
             * - `index` must be strictly less than {length}.
             */
            function at(UintSet storage set, uint256 index) internal view returns (uint256) {
                return uint256(_at(set._inner, index));
            }
            /**
             * @dev Return the entire set in an array
             *
             * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
             * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
             * this function has an unbounded cost, and using it as part of a state-changing function may render the function
             * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
             */
            function values(UintSet storage set) internal view returns (uint256[] memory) {
                bytes32[] memory store = _values(set._inner);
                uint256[] memory result;
                /// @solidity memory-safe-assembly
                assembly {
                    result := store
                }
                return result;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity >=0.5.0;
        import "../ICommonOFT.sol";
        /**
         * @dev Interface of the IOFT core standard
         */
        interface IOFTWithFee is ICommonOFT {
            /**
             * @dev send `_amount` amount of token to (`_dstChainId`, `_toAddress`) from `_from`
             * `_from` the owner of token
             * `_dstChainId` the destination chain identifier
             * `_toAddress` can be any size depending on the `dstChainId`.
             * `_amount` the quantity of tokens in wei
             * `_minAmount` the minimum amount of tokens to receive on dstChain
             * `_refundAddress` the address LayerZero refunds if too much message fee is sent
             * `_zroPaymentAddress` set to address(0x0) if not paying in ZRO (LayerZero Token)
             * `_adapterParams` is a flexible bytes array to indicate messaging adapter services
             */
            function sendFrom(address _from, uint16 _dstChainId, bytes32 _toAddress, uint _amount, uint _minAmount, LzCallParams calldata _callParams) external payable;
            function sendAndCall(address _from, uint16 _dstChainId, bytes32 _toAddress, uint _amount, uint _minAmount, bytes calldata _payload, uint64 _dstGasForCall, LzCallParams calldata _callParams) external payable;
        }
        // SPDX-License-Identifier: MIT
        pragma solidity =0.8.14;
        /*
        ░██╗░░░░░░░██╗░█████╗░░█████╗░░░░░░░███████╗██╗
        ░██║░░██╗░░██║██╔══██╗██╔══██╗░░░░░░██╔════╝██║
        ░╚██╗████╗██╔╝██║░░██║██║░░██║█████╗█████╗░░██║
        ░░████╔═████║░██║░░██║██║░░██║╚════╝██╔══╝░░██║
        ░░╚██╔╝░╚██╔╝░╚█████╔╝╚█████╔╝░░░░░░██║░░░░░██║
        ░░░╚═╝░░░╚═╝░░░╚════╝░░╚════╝░░░░░░░╚═╝░░░░░╚═╝
        *
        * MIT License
        * ===========
        *
        * Copyright (c) 2020 WooTrade
        *
        * Permission is hereby granted, free of charge, to any person obtaining a copy
        * of this software and associated documentation files (the "Software"), to deal
        * in the Software without restriction, including without limitation the rights
        * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        * copies of the Software, and to permit persons to whom the Software is
        * furnished to do so, subject to the following conditions:
        *
        * The above copyright notice and this permission notice shall be included in all
        * copies or substantial portions of the Software.
        *
        * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        */
        /// @title Woo private pool for swap.
        /// @notice Use this contract to directly interfact with woo's synthetic proactive
        ///         marketing making pool.
        /// @author woo.network
        interface IWooPPV2 {
            /* ----- Events ----- */
            event Deposit(address indexed token, address indexed sender, uint256 amount);
            event Withdraw(address indexed token, address indexed receiver, uint256 amount);
            event Migrate(address indexed token, address indexed receiver, uint256 amount);
            event AdminUpdated(address indexed addr, bool flag);
            event FeeAddrUpdated(address indexed newFeeAddr);
            event WooracleUpdated(address indexed newWooracle);
            event WooSwap(
                address indexed fromToken,
                address indexed toToken,
                uint256 fromAmount,
                uint256 toAmount,
                address from,
                address indexed to,
                address rebateTo,
                uint256 swapVol,
                uint256 swapFee
            );
            /* ----- External Functions ----- */
            /// @notice The quote token address (immutable).
            /// @return address of quote token
            function quoteToken() external view returns (address);
            /// @notice Gets the pool size of the specified token (swap liquidity).
            /// @param token the token address
            /// @return the pool size
            function poolSize(address token) external view returns (uint256);
            /// @notice Query the amount to swap `fromToken` to `toToken`, without checking the pool reserve balance.
            /// @param fromToken the from token
            /// @param toToken the to token
            /// @param fromAmount the amount of `fromToken` to swap
            /// @return toAmount the swapped amount of `toToken`
            function tryQuery(
                address fromToken,
                address toToken,
                uint256 fromAmount
            ) external view returns (uint256 toAmount);
            /// @notice Query the amount to swap `fromToken` to `toToken`, with checking the pool reserve balance.
            /// @dev tx reverts when 'toToken' balance is insufficient.
            /// @param fromToken the from token
            /// @param toToken the to token
            /// @param fromAmount the amount of `fromToken` to swap
            /// @return toAmount the swapped amount of `toToken`
            function query(
                address fromToken,
                address toToken,
                uint256 fromAmount
            ) external view returns (uint256 toAmount);
            /// @notice Swap `fromToken` to `toToken`.
            /// @param fromToken the from token
            /// @param toToken the to token
            /// @param fromAmount the amount of `fromToken` to swap
            /// @param minToAmount the minimum amount of `toToken` to receive
            /// @param to the destination address
            /// @param rebateTo the rebate address (optional, can be address ZERO)
            /// @return realToAmount the amount of toToken to receive
            function swap(
                address fromToken,
                address toToken,
                uint256 fromAmount,
                uint256 minToAmount,
                address to,
                address rebateTo
            ) external returns (uint256 realToAmount);
            /// @notice Deposit the specified token into the liquidity pool of WooPPV2.
            /// @param token the token to deposit
            /// @param amount the deposit amount
            function deposit(address token, uint256 amount) external;
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Provides information about the current execution context, including the
         * sender of the transaction and its data. While these are generally available
         * via msg.sender and msg.data, they should not be accessed in such a direct
         * manner, since when dealing with meta-transactions the account sending and
         * paying for execution may not be the actual sender (as far as an application
         * is concerned).
         *
         * This contract is only required for intermediate, library-like contracts.
         */
        abstract contract Context {
            function _msgSender() internal view virtual returns (address) {
                return msg.sender;
            }
            function _msgData() internal view virtual returns (bytes calldata) {
                return msg.data;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity >=0.5.0;
        import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
        /**
         * @dev Interface of the IOFT core standard
         */
        interface ICommonOFT is IERC165 {
            struct LzCallParams {
                address payable refundAddress;
                address zroPaymentAddress;
                bytes adapterParams;
            }
            /**
             * @dev estimate send token `_tokenId` to (`_dstChainId`, `_toAddress`)
             * _dstChainId - L0 defined chain id to send tokens too
             * _toAddress - dynamic bytes array which contains the address to whom you are sending tokens to on the dstChain
             * _amount - amount of the tokens to transfer
             * _useZro - indicates to use zro to pay L0 fees
             * _adapterParam - flexible bytes array to indicate messaging adapter services in L0
             */
            function estimateSendFee(uint16 _dstChainId, bytes32 _toAddress, uint _amount, bool _useZro, bytes calldata _adapterParams) external view returns (uint nativeFee, uint zroFee);
            function estimateSendAndCallFee(uint16 _dstChainId, bytes32 _toAddress, uint _amount, bytes calldata _payload, uint64 _dstGasForCall, bool _useZro, bytes calldata _adapterParams) external view returns (uint nativeFee, uint zroFee);
            /**
             * @dev returns the circulating amount of tokens on current chain
             */
            function circulatingSupply() external view returns (uint);
            /**
             * @dev returns the address of the ERC20 token
             */
            function token() external view returns (address);
        }
        // SPDX-License-Identifier: MIT
        // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
        pragma solidity ^0.8.0;
        /**
         * @dev Interface of the ERC165 standard, as defined in the
         * https://eips.ethereum.org/EIPS/eip-165[EIP].
         *
         * Implementers can declare support of contract interfaces, which can then be
         * queried by others ({ERC165Checker}).
         *
         * For an implementation, see {ERC165}.
         */
        interface IERC165 {
            /**
             * @dev Returns true if this contract implements the interface defined by
             * `interfaceId`. See the corresponding
             * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
             * to learn more about how these ids are created.
             *
             * This function call must use less than 30 000 gas.
             */
            function supportsInterface(bytes4 interfaceId) external view returns (bool);
        }
        

        File 2 of 6: WETH9
        // Copyright (C) 2015, 2016, 2017 Dapphub
        
        // This program is free software: you can redistribute it and/or modify
        // it under the terms of the GNU General Public License as published by
        // the Free Software Foundation, either version 3 of the License, or
        // (at your option) any later version.
        
        // This program is distributed in the hope that it will be useful,
        // but WITHOUT ANY WARRANTY; without even the implied warranty of
        // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        // GNU General Public License for more details.
        
        // You should have received a copy of the GNU General Public License
        // along with this program.  If not, see <http://www.gnu.org/licenses/>.
        
        pragma solidity ^0.4.18;
        
        contract WETH9 {
            string public name     = "Wrapped Ether";
            string public symbol   = "WETH";
            uint8  public decimals = 18;
        
            event  Approval(address indexed src, address indexed guy, uint wad);
            event  Transfer(address indexed src, address indexed dst, uint wad);
            event  Deposit(address indexed dst, uint wad);
            event  Withdrawal(address indexed src, uint wad);
        
            mapping (address => uint)                       public  balanceOf;
            mapping (address => mapping (address => uint))  public  allowance;
        
            function() public payable {
                deposit();
            }
            function deposit() public payable {
                balanceOf[msg.sender] += msg.value;
                Deposit(msg.sender, msg.value);
            }
            function withdraw(uint wad) public {
                require(balanceOf[msg.sender] >= wad);
                balanceOf[msg.sender] -= wad;
                msg.sender.transfer(wad);
                Withdrawal(msg.sender, wad);
            }
        
            function totalSupply() public view returns (uint) {
                return this.balance;
            }
        
            function approve(address guy, uint wad) public returns (bool) {
                allowance[msg.sender][guy] = wad;
                Approval(msg.sender, guy, wad);
                return true;
            }
        
            function transfer(address dst, uint wad) public returns (bool) {
                return transferFrom(msg.sender, dst, wad);
            }
        
            function transferFrom(address src, address dst, uint wad)
                public
                returns (bool)
            {
                require(balanceOf[src] >= wad);
        
                if (src != msg.sender && allowance[src][msg.sender] != uint(-1)) {
                    require(allowance[src][msg.sender] >= wad);
                    allowance[src][msg.sender] -= wad;
                }
        
                balanceOf[src] -= wad;
                balanceOf[dst] += wad;
        
                Transfer(src, dst, wad);
        
                return true;
            }
        }
        
        
        /*
                            GNU GENERAL PUBLIC LICENSE
                               Version 3, 29 June 2007
        
         Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
         Everyone is permitted to copy and distribute verbatim copies
         of this license document, but changing it is not allowed.
        
                                    Preamble
        
          The GNU General Public License is a free, copyleft license for
        software and other kinds of works.
        
          The licenses for most software and other practical works are designed
        to take away your freedom to share and change the works.  By contrast,
        the GNU General Public License is intended to guarantee your freedom to
        share and change all versions of a program--to make sure it remains free
        software for all its users.  We, the Free Software Foundation, use the
        GNU General Public License for most of our software; it applies also to
        any other work released this way by its authors.  You can apply it to
        your programs, too.
        
          When we speak of free software, we are referring to freedom, not
        price.  Our General Public Licenses are designed to make sure that you
        have the freedom to distribute copies of free software (and charge for
        them if you wish), that you receive source code or can get it if you
        want it, that you can change the software or use pieces of it in new
        free programs, and that you know you can do these things.
        
          To protect your rights, we need to prevent others from denying you
        these rights or asking you to surrender the rights.  Therefore, you have
        certain responsibilities if you distribute copies of the software, or if
        you modify it: responsibilities to respect the freedom of others.
        
          For example, if you distribute copies of such a program, whether
        gratis or for a fee, you must pass on to the recipients the same
        freedoms that you received.  You must make sure that they, too, receive
        or can get the source code.  And you must show them these terms so they
        know their rights.
        
          Developers that use the GNU GPL protect your rights with two steps:
        (1) assert copyright on the software, and (2) offer you this License
        giving you legal permission to copy, distribute and/or modify it.
        
          For the developers' and authors' protection, the GPL clearly explains
        that there is no warranty for this free software.  For both users' and
        authors' sake, the GPL requires that modified versions be marked as
        changed, so that their problems will not be attributed erroneously to
        authors of previous versions.
        
          Some devices are designed to deny users access to install or run
        modified versions of the software inside them, although the manufacturer
        can do so.  This is fundamentally incompatible with the aim of
        protecting users' freedom to change the software.  The systematic
        pattern of such abuse occurs in the area of products for individuals to
        use, which is precisely where it is most unacceptable.  Therefore, we
        have designed this version of the GPL to prohibit the practice for those
        products.  If such problems arise substantially in other domains, we
        stand ready to extend this provision to those domains in future versions
        of the GPL, as needed to protect the freedom of users.
        
          Finally, every program is threatened constantly by software patents.
        States should not allow patents to restrict development and use of
        software on general-purpose computers, but in those that do, we wish to
        avoid the special danger that patents applied to a free program could
        make it effectively proprietary.  To prevent this, the GPL assures that
        patents cannot be used to render the program non-free.
        
          The precise terms and conditions for copying, distribution and
        modification follow.
        
                               TERMS AND CONDITIONS
        
          0. Definitions.
        
          "This License" refers to version 3 of the GNU General Public License.
        
          "Copyright" also means copyright-like laws that apply to other kinds of
        works, such as semiconductor masks.
        
          "The Program" refers to any copyrightable work licensed under this
        License.  Each licensee is addressed as "you".  "Licensees" and
        "recipients" may be individuals or organizations.
        
          To "modify" a work means to copy from or adapt all or part of the work
        in a fashion requiring copyright permission, other than the making of an
        exact copy.  The resulting work is called a "modified version" of the
        earlier work or a work "based on" the earlier work.
        
          A "covered work" means either the unmodified Program or a work based
        on the Program.
        
          To "propagate" a work means to do anything with it that, without
        permission, would make you directly or secondarily liable for
        infringement under applicable copyright law, except executing it on a
        computer or modifying a private copy.  Propagation includes copying,
        distribution (with or without modification), making available to the
        public, and in some countries other activities as well.
        
          To "convey" a work means any kind of propagation that enables other
        parties to make or receive copies.  Mere interaction with a user through
        a computer network, with no transfer of a copy, is not conveying.
        
          An interactive user interface displays "Appropriate Legal Notices"
        to the extent that it includes a convenient and prominently visible
        feature that (1) displays an appropriate copyright notice, and (2)
        tells the user that there is no warranty for the work (except to the
        extent that warranties are provided), that licensees may convey the
        work under this License, and how to view a copy of this License.  If
        the interface presents a list of user commands or options, such as a
        menu, a prominent item in the list meets this criterion.
        
          1. Source Code.
        
          The "source code" for a work means the preferred form of the work
        for making modifications to it.  "Object code" means any non-source
        form of a work.
        
          A "Standard Interface" means an interface that either is an official
        standard defined by a recognized standards body, or, in the case of
        interfaces specified for a particular programming language, one that
        is widely used among developers working in that language.
        
          The "System Libraries" of an executable work include anything, other
        than the work as a whole, that (a) is included in the normal form of
        packaging a Major Component, but which is not part of that Major
        Component, and (b) serves only to enable use of the work with that
        Major Component, or to implement a Standard Interface for which an
        implementation is available to the public in source code form.  A
        "Major Component", in this context, means a major essential component
        (kernel, window system, and so on) of the specific operating system
        (if any) on which the executable work runs, or a compiler used to
        produce the work, or an object code interpreter used to run it.
        
          The "Corresponding Source" for a work in object code form means all
        the source code needed to generate, install, and (for an executable
        work) run the object code and to modify the work, including scripts to
        control those activities.  However, it does not include the work's
        System Libraries, or general-purpose tools or generally available free
        programs which are used unmodified in performing those activities but
        which are not part of the work.  For example, Corresponding Source
        includes interface definition files associated with source files for
        the work, and the source code for shared libraries and dynamically
        linked subprograms that the work is specifically designed to require,
        such as by intimate data communication or control flow between those
        subprograms and other parts of the work.
        
          The Corresponding Source need not include anything that users
        can regenerate automatically from other parts of the Corresponding
        Source.
        
          The Corresponding Source for a work in source code form is that
        same work.
        
          2. Basic Permissions.
        
          All rights granted under this License are granted for the term of
        copyright on the Program, and are irrevocable provided the stated
        conditions are met.  This License explicitly affirms your unlimited
        permission to run the unmodified Program.  The output from running a
        covered work is covered by this License only if the output, given its
        content, constitutes a covered work.  This License acknowledges your
        rights of fair use or other equivalent, as provided by copyright law.
        
          You may make, run and propagate covered works that you do not
        convey, without conditions so long as your license otherwise remains
        in force.  You may convey covered works to others for the sole purpose
        of having them make modifications exclusively for you, or provide you
        with facilities for running those works, provided that you comply with
        the terms of this License in conveying all material for which you do
        not control copyright.  Those thus making or running the covered works
        for you must do so exclusively on your behalf, under your direction
        and control, on terms that prohibit them from making any copies of
        your copyrighted material outside their relationship with you.
        
          Conveying under any other circumstances is permitted solely under
        the conditions stated below.  Sublicensing is not allowed; section 10
        makes it unnecessary.
        
          3. Protecting Users' Legal Rights From Anti-Circumvention Law.
        
          No covered work shall be deemed part of an effective technological
        measure under any applicable law fulfilling obligations under article
        11 of the WIPO copyright treaty adopted on 20 December 1996, or
        similar laws prohibiting or restricting circumvention of such
        measures.
        
          When you convey a covered work, you waive any legal power to forbid
        circumvention of technological measures to the extent such circumvention
        is effected by exercising rights under this License with respect to
        the covered work, and you disclaim any intention to limit operation or
        modification of the work as a means of enforcing, against the work's
        users, your or third parties' legal rights to forbid circumvention of
        technological measures.
        
          4. Conveying Verbatim Copies.
        
          You may convey verbatim copies of the Program's source code as you
        receive it, in any medium, provided that you conspicuously and
        appropriately publish on each copy an appropriate copyright notice;
        keep intact all notices stating that this License and any
        non-permissive terms added in accord with section 7 apply to the code;
        keep intact all notices of the absence of any warranty; and give all
        recipients a copy of this License along with the Program.
        
          You may charge any price or no price for each copy that you convey,
        and you may offer support or warranty protection for a fee.
        
          5. Conveying Modified Source Versions.
        
          You may convey a work based on the Program, or the modifications to
        produce it from the Program, in the form of source code under the
        terms of section 4, provided that you also meet all of these conditions:
        
            a) The work must carry prominent notices stating that you modified
            it, and giving a relevant date.
        
            b) The work must carry prominent notices stating that it is
            released under this License and any conditions added under section
            7.  This requirement modifies the requirement in section 4 to
            "keep intact all notices".
        
            c) You must license the entire work, as a whole, under this
            License to anyone who comes into possession of a copy.  This
            License will therefore apply, along with any applicable section 7
            additional terms, to the whole of the work, and all its parts,
            regardless of how they are packaged.  This License gives no
            permission to license the work in any other way, but it does not
            invalidate such permission if you have separately received it.
        
            d) If the work has interactive user interfaces, each must display
            Appropriate Legal Notices; however, if the Program has interactive
            interfaces that do not display Appropriate Legal Notices, your
            work need not make them do so.
        
          A compilation of a covered work with other separate and independent
        works, which are not by their nature extensions of the covered work,
        and which are not combined with it such as to form a larger program,
        in or on a volume of a storage or distribution medium, is called an
        "aggregate" if the compilation and its resulting copyright are not
        used to limit the access or legal rights of the compilation's users
        beyond what the individual works permit.  Inclusion of a covered work
        in an aggregate does not cause this License to apply to the other
        parts of the aggregate.
        
          6. Conveying Non-Source Forms.
        
          You may convey a covered work in object code form under the terms
        of sections 4 and 5, provided that you also convey the
        machine-readable Corresponding Source under the terms of this License,
        in one of these ways:
        
            a) Convey the object code in, or embodied in, a physical product
            (including a physical distribution medium), accompanied by the
            Corresponding Source fixed on a durable physical medium
            customarily used for software interchange.
        
            b) Convey the object code in, or embodied in, a physical product
            (including a physical distribution medium), accompanied by a
            written offer, valid for at least three years and valid for as
            long as you offer spare parts or customer support for that product
            model, to give anyone who possesses the object code either (1) a
            copy of the Corresponding Source for all the software in the
            product that is covered by this License, on a durable physical
            medium customarily used for software interchange, for a price no
            more than your reasonable cost of physically performing this
            conveying of source, or (2) access to copy the
            Corresponding Source from a network server at no charge.
        
            c) Convey individual copies of the object code with a copy of the
            written offer to provide the Corresponding Source.  This
            alternative is allowed only occasionally and noncommercially, and
            only if you received the object code with such an offer, in accord
            with subsection 6b.
        
            d) Convey the object code by offering access from a designated
            place (gratis or for a charge), and offer equivalent access to the
            Corresponding Source in the same way through the same place at no
            further charge.  You need not require recipients to copy the
            Corresponding Source along with the object code.  If the place to
            copy the object code is a network server, the Corresponding Source
            may be on a different server (operated by you or a third party)
            that supports equivalent copying facilities, provided you maintain
            clear directions next to the object code saying where to find the
            Corresponding Source.  Regardless of what server hosts the
            Corresponding Source, you remain obligated to ensure that it is
            available for as long as needed to satisfy these requirements.
        
            e) Convey the object code using peer-to-peer transmission, provided
            you inform other peers where the object code and Corresponding
            Source of the work are being offered to the general public at no
            charge under subsection 6d.
        
          A separable portion of the object code, whose source code is excluded
        from the Corresponding Source as a System Library, need not be
        included in conveying the object code work.
        
          A "User Product" is either (1) a "consumer product", which means any
        tangible personal property which is normally used for personal, family,
        or household purposes, or (2) anything designed or sold for incorporation
        into a dwelling.  In determining whether a product is a consumer product,
        doubtful cases shall be resolved in favor of coverage.  For a particular
        product received by a particular user, "normally used" refers to a
        typical or common use of that class of product, regardless of the status
        of the particular user or of the way in which the particular user
        actually uses, or expects or is expected to use, the product.  A product
        is a consumer product regardless of whether the product has substantial
        commercial, industrial or non-consumer uses, unless such uses represent
        the only significant mode of use of the product.
        
          "Installation Information" for a User Product means any methods,
        procedures, authorization keys, or other information required to install
        and execute modified versions of a covered work in that User Product from
        a modified version of its Corresponding Source.  The information must
        suffice to ensure that the continued functioning of the modified object
        code is in no case prevented or interfered with solely because
        modification has been made.
        
          If you convey an object code work under this section in, or with, or
        specifically for use in, a User Product, and the conveying occurs as
        part of a transaction in which the right of possession and use of the
        User Product is transferred to the recipient in perpetuity or for a
        fixed term (regardless of how the transaction is characterized), the
        Corresponding Source conveyed under this section must be accompanied
        by the Installation Information.  But this requirement does not apply
        if neither you nor any third party retains the ability to install
        modified object code on the User Product (for example, the work has
        been installed in ROM).
        
          The requirement to provide Installation Information does not include a
        requirement to continue to provide support service, warranty, or updates
        for a work that has been modified or installed by the recipient, or for
        the User Product in which it has been modified or installed.  Access to a
        network may be denied when the modification itself materially and
        adversely affects the operation of the network or violates the rules and
        protocols for communication across the network.
        
          Corresponding Source conveyed, and Installation Information provided,
        in accord with this section must be in a format that is publicly
        documented (and with an implementation available to the public in
        source code form), and must require no special password or key for
        unpacking, reading or copying.
        
          7. Additional Terms.
        
          "Additional permissions" are terms that supplement the terms of this
        License by making exceptions from one or more of its conditions.
        Additional permissions that are applicable to the entire Program shall
        be treated as though they were included in this License, to the extent
        that they are valid under applicable law.  If additional permissions
        apply only to part of the Program, that part may be used separately
        under those permissions, but the entire Program remains governed by
        this License without regard to the additional permissions.
        
          When you convey a copy of a covered work, you may at your option
        remove any additional permissions from that copy, or from any part of
        it.  (Additional permissions may be written to require their own
        removal in certain cases when you modify the work.)  You may place
        additional permissions on material, added by you to a covered work,
        for which you have or can give appropriate copyright permission.
        
          Notwithstanding any other provision of this License, for material you
        add to a covered work, you may (if authorized by the copyright holders of
        that material) supplement the terms of this License with terms:
        
            a) Disclaiming warranty or limiting liability differently from the
            terms of sections 15 and 16 of this License; or
        
            b) Requiring preservation of specified reasonable legal notices or
            author attributions in that material or in the Appropriate Legal
            Notices displayed by works containing it; or
        
            c) Prohibiting misrepresentation of the origin of that material, or
            requiring that modified versions of such material be marked in
            reasonable ways as different from the original version; or
        
            d) Limiting the use for publicity purposes of names of licensors or
            authors of the material; or
        
            e) Declining to grant rights under trademark law for use of some
            trade names, trademarks, or service marks; or
        
            f) Requiring indemnification of licensors and authors of that
            material by anyone who conveys the material (or modified versions of
            it) with contractual assumptions of liability to the recipient, for
            any liability that these contractual assumptions directly impose on
            those licensors and authors.
        
          All other non-permissive additional terms are considered "further
        restrictions" within the meaning of section 10.  If the Program as you
        received it, or any part of it, contains a notice stating that it is
        governed by this License along with a term that is a further
        restriction, you may remove that term.  If a license document contains
        a further restriction but permits relicensing or conveying under this
        License, you may add to a covered work material governed by the terms
        of that license document, provided that the further restriction does
        not survive such relicensing or conveying.
        
          If you add terms to a covered work in accord with this section, you
        must place, in the relevant source files, a statement of the
        additional terms that apply to those files, or a notice indicating
        where to find the applicable terms.
        
          Additional terms, permissive or non-permissive, may be stated in the
        form of a separately written license, or stated as exceptions;
        the above requirements apply either way.
        
          8. Termination.
        
          You may not propagate or modify a covered work except as expressly
        provided under this License.  Any attempt otherwise to propagate or
        modify it is void, and will automatically terminate your rights under
        this License (including any patent licenses granted under the third
        paragraph of section 11).
        
          However, if you cease all violation of this License, then your
        license from a particular copyright holder is reinstated (a)
        provisionally, unless and until the copyright holder explicitly and
        finally terminates your license, and (b) permanently, if the copyright
        holder fails to notify you of the violation by some reasonable means
        prior to 60 days after the cessation.
        
          Moreover, your license from a particular copyright holder is
        reinstated permanently if the copyright holder notifies you of the
        violation by some reasonable means, this is the first time you have
        received notice of violation of this License (for any work) from that
        copyright holder, and you cure the violation prior to 30 days after
        your receipt of the notice.
        
          Termination of your rights under this section does not terminate the
        licenses of parties who have received copies or rights from you under
        this License.  If your rights have been terminated and not permanently
        reinstated, you do not qualify to receive new licenses for the same
        material under section 10.
        
          9. Acceptance Not Required for Having Copies.
        
          You are not required to accept this License in order to receive or
        run a copy of the Program.  Ancillary propagation of a covered work
        occurring solely as a consequence of using peer-to-peer transmission
        to receive a copy likewise does not require acceptance.  However,
        nothing other than this License grants you permission to propagate or
        modify any covered work.  These actions infringe copyright if you do
        not accept this License.  Therefore, by modifying or propagating a
        covered work, you indicate your acceptance of this License to do so.
        
          10. Automatic Licensing of Downstream Recipients.
        
          Each time you convey a covered work, the recipient automatically
        receives a license from the original licensors, to run, modify and
        propagate that work, subject to this License.  You are not responsible
        for enforcing compliance by third parties with this License.
        
          An "entity transaction" is a transaction transferring control of an
        organization, or substantially all assets of one, or subdividing an
        organization, or merging organizations.  If propagation of a covered
        work results from an entity transaction, each party to that
        transaction who receives a copy of the work also receives whatever
        licenses to the work the party's predecessor in interest had or could
        give under the previous paragraph, plus a right to possession of the
        Corresponding Source of the work from the predecessor in interest, if
        the predecessor has it or can get it with reasonable efforts.
        
          You may not impose any further restrictions on the exercise of the
        rights granted or affirmed under this License.  For example, you may
        not impose a license fee, royalty, or other charge for exercise of
        rights granted under this License, and you may not initiate litigation
        (including a cross-claim or counterclaim in a lawsuit) alleging that
        any patent claim is infringed by making, using, selling, offering for
        sale, or importing the Program or any portion of it.
        
          11. Patents.
        
          A "contributor" is a copyright holder who authorizes use under this
        License of the Program or a work on which the Program is based.  The
        work thus licensed is called the contributor's "contributor version".
        
          A contributor's "essential patent claims" are all patent claims
        owned or controlled by the contributor, whether already acquired or
        hereafter acquired, that would be infringed by some manner, permitted
        by this License, of making, using, or selling its contributor version,
        but do not include claims that would be infringed only as a
        consequence of further modification of the contributor version.  For
        purposes of this definition, "control" includes the right to grant
        patent sublicenses in a manner consistent with the requirements of
        this License.
        
          Each contributor grants you a non-exclusive, worldwide, royalty-free
        patent license under the contributor's essential patent claims, to
        make, use, sell, offer for sale, import and otherwise run, modify and
        propagate the contents of its contributor version.
        
          In the following three paragraphs, a "patent license" is any express
        agreement or commitment, however denominated, not to enforce a patent
        (such as an express permission to practice a patent or covenant not to
        sue for patent infringement).  To "grant" such a patent license to a
        party means to make such an agreement or commitment not to enforce a
        patent against the party.
        
          If you convey a covered work, knowingly relying on a patent license,
        and the Corresponding Source of the work is not available for anyone
        to copy, free of charge and under the terms of this License, through a
        publicly available network server or other readily accessible means,
        then you must either (1) cause the Corresponding Source to be so
        available, or (2) arrange to deprive yourself of the benefit of the
        patent license for this particular work, or (3) arrange, in a manner
        consistent with the requirements of this License, to extend the patent
        license to downstream recipients.  "Knowingly relying" means you have
        actual knowledge that, but for the patent license, your conveying the
        covered work in a country, or your recipient's use of the covered work
        in a country, would infringe one or more identifiable patents in that
        country that you have reason to believe are valid.
        
          If, pursuant to or in connection with a single transaction or
        arrangement, you convey, or propagate by procuring conveyance of, a
        covered work, and grant a patent license to some of the parties
        receiving the covered work authorizing them to use, propagate, modify
        or convey a specific copy of the covered work, then the patent license
        you grant is automatically extended to all recipients of the covered
        work and works based on it.
        
          A patent license is "discriminatory" if it does not include within
        the scope of its coverage, prohibits the exercise of, or is
        conditioned on the non-exercise of one or more of the rights that are
        specifically granted under this License.  You may not convey a covered
        work if you are a party to an arrangement with a third party that is
        in the business of distributing software, under which you make payment
        to the third party based on the extent of your activity of conveying
        the work, and under which the third party grants, to any of the
        parties who would receive the covered work from you, a discriminatory
        patent license (a) in connection with copies of the covered work
        conveyed by you (or copies made from those copies), or (b) primarily
        for and in connection with specific products or compilations that
        contain the covered work, unless you entered into that arrangement,
        or that patent license was granted, prior to 28 March 2007.
        
          Nothing in this License shall be construed as excluding or limiting
        any implied license or other defenses to infringement that may
        otherwise be available to you under applicable patent law.
        
          12. No Surrender of Others' Freedom.
        
          If conditions are imposed on you (whether by court order, agreement or
        otherwise) that contradict the conditions of this License, they do not
        excuse you from the conditions of this License.  If you cannot convey a
        covered work so as to satisfy simultaneously your obligations under this
        License and any other pertinent obligations, then as a consequence you may
        not convey it at all.  For example, if you agree to terms that obligate you
        to collect a royalty for further conveying from those to whom you convey
        the Program, the only way you could satisfy both those terms and this
        License would be to refrain entirely from conveying the Program.
        
          13. Use with the GNU Affero General Public License.
        
          Notwithstanding any other provision of this License, you have
        permission to link or combine any covered work with a work licensed
        under version 3 of the GNU Affero General Public License into a single
        combined work, and to convey the resulting work.  The terms of this
        License will continue to apply to the part which is the covered work,
        but the special requirements of the GNU Affero General Public License,
        section 13, concerning interaction through a network will apply to the
        combination as such.
        
          14. Revised Versions of this License.
        
          The Free Software Foundation may publish revised and/or new versions of
        the GNU General Public License from time to time.  Such new versions will
        be similar in spirit to the present version, but may differ in detail to
        address new problems or concerns.
        
          Each version is given a distinguishing version number.  If the
        Program specifies that a certain numbered version of the GNU General
        Public License "or any later version" applies to it, you have the
        option of following the terms and conditions either of that numbered
        version or of any later version published by the Free Software
        Foundation.  If the Program does not specify a version number of the
        GNU General Public License, you may choose any version ever published
        by the Free Software Foundation.
        
          If the Program specifies that a proxy can decide which future
        versions of the GNU General Public License can be used, that proxy's
        public statement of acceptance of a version permanently authorizes you
        to choose that version for the Program.
        
          Later license versions may give you additional or different
        permissions.  However, no additional obligations are imposed on any
        author or copyright holder as a result of your choosing to follow a
        later version.
        
          15. Disclaimer of Warranty.
        
          THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
        APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
        HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
        OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
        THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
        PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
        IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
        ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
        
          16. Limitation of Liability.
        
          IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
        WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
        THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
        GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
        USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
        DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
        PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
        EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
        SUCH DAMAGES.
        
          17. Interpretation of Sections 15 and 16.
        
          If the disclaimer of warranty and limitation of liability provided
        above cannot be given local legal effect according to their terms,
        reviewing courts shall apply local law that most closely approximates
        an absolute waiver of all civil liability in connection with the
        Program, unless a warranty or assumption of liability accompanies a
        copy of the Program in return for a fee.
        
                             END OF TERMS AND CONDITIONS
        
                    How to Apply These Terms to Your New Programs
        
          If you develop a new program, and you want it to be of the greatest
        possible use to the public, the best way to achieve this is to make it
        free software which everyone can redistribute and change under these terms.
        
          To do so, attach the following notices to the program.  It is safest
        to attach them to the start of each source file to most effectively
        state the exclusion of warranty; and each file should have at least
        the "copyright" line and a pointer to where the full notice is found.
        
            <one line to give the program's name and a brief idea of what it does.>
            Copyright (C) <year>  <name of author>
        
            This program is free software: you can redistribute it and/or modify
            it under the terms of the GNU General Public License as published by
            the Free Software Foundation, either version 3 of the License, or
            (at your option) any later version.
        
            This program is distributed in the hope that it will be useful,
            but WITHOUT ANY WARRANTY; without even the implied warranty of
            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
            GNU General Public License for more details.
        
            You should have received a copy of the GNU General Public License
            along with this program.  If not, see <http://www.gnu.org/licenses/>.
        
        Also add information on how to contact you by electronic and paper mail.
        
          If the program does terminal interaction, make it output a short
        notice like this when it starts in an interactive mode:
        
            <program>  Copyright (C) <year>  <name of author>
            This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
            This is free software, and you are welcome to redistribute it
            under certain conditions; type `show c' for details.
        
        The hypothetical commands `show w' and `show c' should show the appropriate
        parts of the General Public License.  Of course, your program's commands
        might be different; for a GUI interface, you would use an "about box".
        
          You should also get your employer (if you work as a programmer) or school,
        if any, to sign a "copyright disclaimer" for the program, if necessary.
        For more information on this, and how to apply and follow the GNU GPL, see
        <http://www.gnu.org/licenses/>.
        
          The GNU General Public License does not permit incorporating your program
        into proprietary programs.  If your program is a subroutine library, you
        may consider it more useful to permit linking proprietary applications with
        the library.  If this is what you want to do, use the GNU Lesser General
        Public License instead of this License.  But first, please read
        <http://www.gnu.org/philosophy/why-not-lgpl.html>.
        
        */

        File 3 of 6: StargateEthVault
        // Copyright (C) 2015, 2016, 2017 Dapphub
        // This program is free software: you can redistribute it and/or modify
        // it under the terms of the GNU General Public License as published by
        // the Free Software Foundation, either version 3 of the License, or
        // (at your option) any later version.
        // This program is distributed in the hope that it will be useful,
        // but WITHOUT ANY WARRANTY; without even the implied warranty of
        // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        // GNU General Public License for more details.
        // You should have received a copy of the GNU General Public License
        // along with this program.  If not, see <http://www.gnu.org/licenses/>.
        pragma solidity ^0.7.6;
        import "@openzeppelin/contracts/access/Ownable.sol";
        import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
        import "./interfaces/IStargateEthVault.sol";
        // This contract always UNWRAPS the erc20 for native gas token on transfer + transferFrom.
        // If you wish to disable the transfer auto-unwrap, you can specify _to addresses with `setNoUnwrapTo`
        contract StargateEthVault is IStargateEthVault, Ownable, ReentrancyGuard {
            string public constant name     = "Stargate Ether Vault";
            string public constant symbol   = "SGETH";
            uint8  public constant decimals = 18;
            uint256 public totalSupply;
            event Approval(address indexed src, address indexed guy, uint wad);
            event Transfer(address indexed src, address indexed dst, uint wad);
            event Deposit(address indexed dst, uint wad);
            event Withdrawal(address indexed src, uint wad);
            event TransferNative(address indexed src, address indexed dst, uint wad);
            mapping (address => uint)                       public  balanceOf;
            mapping (address => mapping (address => uint))  public  allowance;
            mapping (address => bool)                       public  noUnwrapTo;
            // if you do NOT wish to unwrap eth on transfers TO certain addresses
            function setNoUnwrapTo(address _addr) external onlyOwner {
                noUnwrapTo[_addr] = true;
            }
            function deposit() public payable override {
                balanceOf[msg.sender] += msg.value;
                totalSupply += msg.value;
                emit Deposit(msg.sender, msg.value);
            }
            function withdraw(uint wad) external override {
                require(balanceOf[msg.sender] >= wad);
                balanceOf[msg.sender] -= wad;
                msg.sender.transfer(wad);
                totalSupply -= wad;
                emit Withdrawal(msg.sender, wad);
            }
            function approve(address guy, uint wad) external override returns (bool) {
                allowance[msg.sender][guy] = wad;
                emit Approval(msg.sender, guy, wad);
                return true;
            }
            function transfer(address dst, uint wad) external override returns (bool) {
                return transferFrom(msg.sender, dst, wad);
            }
            function transferFrom(address src, address dst, uint wad) public override nonReentrant returns (bool) {
                require(balanceOf[src] >= wad);
                if (src != msg.sender && allowance[src][msg.sender] != uint(-1)) {
                    require(allowance[src][msg.sender] >= wad);
                    allowance[src][msg.sender] -= wad;
                }
                // always decrement the src (payer) address
                balanceOf[src] -= wad;
                if(noUnwrapTo[dst]){
                    // we do *not* unwrap
                    balanceOf[dst] += wad;
                    emit Transfer(src, dst, wad);
                } else {
                    // unwrap and send native gas token
                    totalSupply -= wad; // if its getting unwrapped, decrement the totalSupply
                    (bool success, ) = dst.call{value: wad}("");
                    require(success, "SGETH: failed to transfer");
                    emit TransferNative(src, dst, wad);
                }
                return true;
            }
            function renounceOwnership() public override onlyOwner {}
            receive() external payable {
                deposit();
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        import "../utils/Context.sol";
        /**
         * @dev Contract module which provides a basic access control mechanism, where
         * there is an account (an owner) that can be granted exclusive access to
         * specific functions.
         *
         * By default, the owner account will be the one that deploys the contract. This
         * can later be changed with {transferOwnership}.
         *
         * This module is used through inheritance. It will make available the modifier
         * `onlyOwner`, which can be applied to your functions to restrict their use to
         * the owner.
         */
        abstract contract Ownable is Context {
            address private _owner;
            event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
            /**
             * @dev Initializes the contract setting the deployer as the initial owner.
             */
            constructor () {
                address msgSender = _msgSender();
                _owner = msgSender;
                emit OwnershipTransferred(address(0), msgSender);
            }
            /**
             * @dev Returns the address of the current owner.
             */
            function owner() public view virtual returns (address) {
                return _owner;
            }
            /**
             * @dev Throws if called by any account other than the owner.
             */
            modifier onlyOwner() {
                require(owner() == _msgSender(), "Ownable: caller is not the owner");
                _;
            }
            /**
             * @dev Leaves the contract without owner. It will not be possible to call
             * `onlyOwner` functions anymore. Can only be called by the current owner.
             *
             * NOTE: Renouncing ownership will leave the contract without an owner,
             * thereby removing any functionality that is only available to the owner.
             */
            function renounceOwnership() public virtual onlyOwner {
                emit OwnershipTransferred(_owner, address(0));
                _owner = address(0);
            }
            /**
             * @dev Transfers ownership of the contract to a new account (`newOwner`).
             * Can only be called by the current owner.
             */
            function transferOwnership(address newOwner) public virtual onlyOwner {
                require(newOwner != address(0), "Ownable: new owner is the zero address");
                emit OwnershipTransferred(_owner, newOwner);
                _owner = newOwner;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        /**
         * @dev Contract module that helps prevent reentrant calls to a function.
         *
         * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
         * available, which can be applied to functions to make sure there are no nested
         * (reentrant) calls to them.
         *
         * Note that because there is a single `nonReentrant` guard, functions marked as
         * `nonReentrant` may not call one another. This can be worked around by making
         * those functions `private`, and then adding `external` `nonReentrant` entry
         * points to them.
         *
         * TIP: If you would like to learn more about reentrancy and alternative ways
         * to protect against it, check out our blog post
         * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
         */
        abstract contract ReentrancyGuard {
            // Booleans are more expensive than uint256 or any type that takes up a full
            // word because each write operation emits an extra SLOAD to first read the
            // slot's contents, replace the bits taken up by the boolean, and then write
            // back. This is the compiler's defense against contract upgrades and
            // pointer aliasing, and it cannot be disabled.
            // The values being non-zero value makes deployment a bit more expensive,
            // but in exchange the refund on every call to nonReentrant will be lower in
            // amount. Since refunds are capped to a percentage of the total
            // transaction's gas, it is best to keep them low in cases like this one, to
            // increase the likelihood of the full refund coming into effect.
            uint256 private constant _NOT_ENTERED = 1;
            uint256 private constant _ENTERED = 2;
            uint256 private _status;
            constructor () {
                _status = _NOT_ENTERED;
            }
            /**
             * @dev Prevents a contract from calling itself, directly or indirectly.
             * Calling a `nonReentrant` function from another `nonReentrant`
             * function is not supported. It is possible to prevent this from happening
             * by making the `nonReentrant` function external, and make it call a
             * `private` function that does the actual work.
             */
            modifier nonReentrant() {
                // On the first call to nonReentrant, _notEntered will be true
                require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
                // Any calls to nonReentrant after this point will fail
                _status = _ENTERED;
                _;
                // By storing the original value once again, a refund is triggered (see
                // https://eips.ethereum.org/EIPS/eip-2200)
                _status = _NOT_ENTERED;
            }
        }
        pragma solidity 0.7.6;
        interface IStargateEthVault {
            function deposit() external payable;
            function transfer(address to, uint value) external returns (bool);
            function withdraw(uint) external;
            function approve(address guy, uint wad) external returns (bool);
            function transferFrom(address src, address dst, uint wad) external returns (bool);
        }// SPDX-License-Identifier: MIT
        pragma solidity >=0.6.0 <0.8.0;
        /*
         * @dev Provides information about the current execution context, including the
         * sender of the transaction and its data. While these are generally available
         * via msg.sender and msg.data, they should not be accessed in such a direct
         * manner, since when dealing with GSN meta-transactions the account sending and
         * paying for execution may not be the actual sender (as far as an application
         * is concerned).
         *
         * This contract is only required for intermediate, library-like contracts.
         */
        abstract contract Context {
            function _msgSender() internal view virtual returns (address payable) {
                return msg.sender;
            }
            function _msgData() internal view virtual returns (bytes memory) {
                this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
                return msg.data;
            }
        }
        

        File 4 of 6: Router
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        pragma abicoder v2;
        // imports
        import "@openzeppelin/contracts/access/Ownable.sol";
        import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
        import "./Factory.sol";
        import "./Pool.sol";
        import "./Bridge.sol";
        // interfaces
        import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
        import "./interfaces/IStargateRouter.sol";
        import "./interfaces/IStargateReceiver.sol";
        // libraries
        import "@openzeppelin/contracts/math/SafeMath.sol";
        contract Router is IStargateRouter, Ownable, ReentrancyGuard {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // CONSTANTS
            uint8 internal constant TYPE_REDEEM_LOCAL_RESPONSE = 1;
            uint8 internal constant TYPE_REDEEM_LOCAL_CALLBACK_RETRY = 2;
            uint8 internal constant TYPE_SWAP_REMOTE_RETRY = 3;
            //---------------------------------------------------------------------------
            // STRUCTS
            struct CachedSwap {
                address token;
                uint256 amountLD;
                address to;
                bytes payload;
            }
            //---------------------------------------------------------------------------
            // VARIABLES
            Factory public factory; // used for creating pools
            address public protocolFeeOwner; // can call methods to pull Stargate fees collected in pools
            address public mintFeeOwner; // can call methods to pull mint fees collected in pools
            Bridge public bridge;
            mapping(uint16 => mapping(bytes => mapping(uint256 => bytes))) public revertLookup; //[chainId][srcAddress][nonce]
            mapping(uint16 => mapping(bytes => mapping(uint256 => CachedSwap))) public cachedSwapLookup; //[chainId][srcAddress][nonce]
            //---------------------------------------------------------------------------
            // EVENTS
            event Revert(uint8 bridgeFunctionType, uint16 chainId, bytes srcAddress, uint256 nonce);
            event CachedSwapSaved(uint16 chainId, bytes srcAddress, uint256 nonce, address token, uint256 amountLD, address to, bytes payload, bytes reason);
            event RevertRedeemLocal(uint16 srcChainId, uint256 _srcPoolId, uint256 _dstPoolId, bytes to, uint256 redeemAmountSD, uint256 mintAmountSD, uint256 indexed nonce, bytes indexed srcAddress);
            event RedeemLocalCallback(uint16 srcChainId, bytes indexed srcAddress, uint256 indexed nonce, uint256 srcPoolId, uint256 dstPoolId, address to, uint256 amountSD, uint256 mintAmountSD);
            //---------------------------------------------------------------------------
            // MODIFIERS
            modifier onlyBridge() {
                require(msg.sender == address(bridge), "Bridge: caller must be Bridge.");
                _;
            }
            constructor() {}
            function setBridgeAndFactory(Bridge _bridge, Factory _factory) external onlyOwner {
                require(address(bridge) == address(0x0) && address(factory) == address(0x0), "Stargate: bridge and factory already initialized"); // 1 time only
                require(address(_bridge) != address(0x0), "Stargate: bridge cant be 0x0");
                require(address(_factory) != address(0x0), "Stargate: factory cant be 0x0");
                bridge = _bridge;
                factory = _factory;
            }
            //---------------------------------------------------------------------------
            // VIEWS
            function _getPool(uint256 _poolId) internal view returns (Pool pool) {
                pool = factory.getPool(_poolId);
                require(address(pool) != address(0x0), "Stargate: Pool does not exist");
            }
            //---------------------------------------------------------------------------
            // INTERNAL
            function _safeTransferFrom(
                address token,
                address from,
                address to,
                uint256 value
            ) private {
                // bytes4(keccak256(bytes('transferFrom(address,address,uint256)')));
                (bool success, bytes memory data) = token.call(abi.encodeWithSelector(0x23b872dd, from, to, value));
                require(success && (data.length == 0 || abi.decode(data, (bool))), "Stargate: TRANSFER_FROM_FAILED");
            }
            //---------------------------------------------------------------------------
            // LOCAL CHAIN FUNCTIONS
            function addLiquidity(
                uint256 _poolId,
                uint256 _amountLD,
                address _to
            ) external override nonReentrant {
                Pool pool = _getPool(_poolId);
                uint256 convertRate = pool.convertRate();
                _amountLD = _amountLD.div(convertRate).mul(convertRate);
                _safeTransferFrom(pool.token(), msg.sender, address(pool), _amountLD);
                pool.mint(_to, _amountLD);
            }
            function swap(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLD,
                uint256 _minAmountLD,
                lzTxObj memory _lzTxParams,
                bytes calldata _to,
                bytes calldata _payload
            ) external payable override nonReentrant {
                require(_amountLD > 0, "Stargate: cannot swap 0");
                require(_refundAddress != address(0x0), "Stargate: _refundAddress cannot be 0x0");
                Pool.SwapObj memory s;
                Pool.CreditObj memory c;
                {
                    Pool pool = _getPool(_srcPoolId);
                    {
                        uint256 convertRate = pool.convertRate();
                        _amountLD = _amountLD.div(convertRate).mul(convertRate);
                    }
                    s = pool.swap(_dstChainId, _dstPoolId, msg.sender, _amountLD, _minAmountLD, true);
                    _safeTransferFrom(pool.token(), msg.sender, address(pool), _amountLD);
                    c = pool.sendCredits(_dstChainId, _dstPoolId);
                }
                bridge.swap{value: msg.value}(_dstChainId, _srcPoolId, _dstPoolId, _refundAddress, c, s, _lzTxParams, _to, _payload);
            }
            function redeemRemote(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLP,
                uint256 _minAmountLD,
                bytes calldata _to,
                lzTxObj memory _lzTxParams
            ) external payable override nonReentrant {
                require(_refundAddress != address(0x0), "Stargate: _refundAddress cannot be 0x0");
                require(_amountLP > 0, "Stargate: not enough lp to redeemRemote");
                Pool.SwapObj memory s;
                Pool.CreditObj memory c;
                {
                    Pool pool = _getPool(_srcPoolId);
                    uint256 amountLD = pool.amountLPtoLD(_amountLP);
                    // perform a swap with no liquidity
                    s = pool.swap(_dstChainId, _dstPoolId, msg.sender, amountLD, _minAmountLD, false);
                    pool.redeemRemote(_dstChainId, _dstPoolId, msg.sender, _amountLP);
                    c = pool.sendCredits(_dstChainId, _dstPoolId);
                }
                // equal to a swap, with no payload ("0x") no dstGasForCall 0
                bridge.swap{value: msg.value}(_dstChainId, _srcPoolId, _dstPoolId, _refundAddress, c, s, _lzTxParams, _to, "");
            }
            function instantRedeemLocal(
                uint16 _srcPoolId,
                uint256 _amountLP,
                address _to
            ) external override nonReentrant returns (uint256 amountSD) {
                require(_amountLP > 0, "Stargate: not enough lp to redeem");
                Pool pool = _getPool(_srcPoolId);
                amountSD = pool.instantRedeemLocal(msg.sender, _amountLP, _to);
            }
            function redeemLocal(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLP,
                bytes calldata _to,
                lzTxObj memory _lzTxParams
            ) external payable override nonReentrant {
                require(_refundAddress != address(0x0), "Stargate: _refundAddress cannot be 0x0");
                Pool pool = _getPool(_srcPoolId);
                require(_amountLP > 0, "Stargate: not enough lp to redeem");
                uint256 amountSD = pool.redeemLocal(msg.sender, _amountLP, _dstChainId, _dstPoolId, _to);
                require(amountSD > 0, "Stargate: not enough lp to redeem with amountSD");
                Pool.CreditObj memory c = pool.sendCredits(_dstChainId, _dstPoolId);
                bridge.redeemLocal{value: msg.value}(_dstChainId, _srcPoolId, _dstPoolId, _refundAddress, c, amountSD, _to, _lzTxParams);
            }
            function sendCredits(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress
            ) external payable override nonReentrant {
                require(_refundAddress != address(0x0), "Stargate: _refundAddress cannot be 0x0");
                Pool pool = _getPool(_srcPoolId);
                Pool.CreditObj memory c = pool.sendCredits(_dstChainId, _dstPoolId);
                bridge.sendCredits{value: msg.value}(_dstChainId, _srcPoolId, _dstPoolId, _refundAddress, c);
            }
            function quoteLayerZeroFee(
                uint16 _dstChainId,
                uint8 _functionType,
                bytes calldata _toAddress,
                bytes calldata _transferAndCallPayload,
                Router.lzTxObj memory _lzTxParams
            ) external view override returns (uint256, uint256) {
                return bridge.quoteLayerZeroFee(_dstChainId, _functionType, _toAddress, _transferAndCallPayload, _lzTxParams);
            }
            function revertRedeemLocal(
                uint16 _dstChainId,
                bytes calldata _srcAddress,
                uint256 _nonce,
                address payable _refundAddress,
                lzTxObj memory _lzTxParams
            ) external payable {
                require(_refundAddress != address(0x0), "Stargate: _refundAddress cannot be 0x0");
                bytes memory payload = revertLookup[_dstChainId][_srcAddress][_nonce];
                require(payload.length > 0, "Stargate: no retry revert");
                {
                    uint8 functionType;
                    assembly {
                        functionType := mload(add(payload, 32))
                    }
                    require(functionType == TYPE_REDEEM_LOCAL_RESPONSE, "Stargate: invalid function type");
                }
                // empty it
                revertLookup[_dstChainId][_srcAddress][_nonce] = "";
                uint256 srcPoolId;
                uint256 dstPoolId;
                assembly {
                    srcPoolId := mload(add(payload, 64))
                    dstPoolId := mload(add(payload, 96))
                }
                Pool.CreditObj memory c;
                {
                    Pool pool = _getPool(dstPoolId);
                    c = pool.sendCredits(_dstChainId, srcPoolId);
                }
                bridge.redeemLocalCallback{value: msg.value}(_dstChainId, _refundAddress, c, _lzTxParams, payload);
            }
            function retryRevert(
                uint16 _srcChainId,
                bytes calldata _srcAddress,
                uint256 _nonce
            ) external payable {
                bytes memory payload = revertLookup[_srcChainId][_srcAddress][_nonce];
                require(payload.length > 0, "Stargate: no retry revert");
                // empty it
                revertLookup[_srcChainId][_srcAddress][_nonce] = "";
                uint8 functionType;
                assembly {
                    functionType := mload(add(payload, 32))
                }
                if (functionType == TYPE_REDEEM_LOCAL_CALLBACK_RETRY) {
                    (, uint256 srcPoolId, uint256 dstPoolId, address to, uint256 amountSD, uint256 mintAmountSD) = abi.decode(
                        payload,
                        (uint8, uint256, uint256, address, uint256, uint256)
                    );
                    _redeemLocalCallback(_srcChainId, _srcAddress, _nonce, srcPoolId, dstPoolId, to, amountSD, mintAmountSD);
                }
                // for retrying the swapRemote. if it fails again, retry
                else if (functionType == TYPE_SWAP_REMOTE_RETRY) {
                    (, uint256 srcPoolId, uint256 dstPoolId, uint256 dstGasForCall, address to, Pool.SwapObj memory s, bytes memory p) = abi.decode(
                        payload,
                        (uint8, uint256, uint256, uint256, address, Pool.SwapObj, bytes)
                    );
                    _swapRemote(_srcChainId, _srcAddress, _nonce, srcPoolId, dstPoolId, dstGasForCall, to, s, p);
                } else {
                    revert("Stargate: invalid function type");
                }
            }
            function clearCachedSwap(
                uint16 _srcChainId,
                bytes calldata _srcAddress,
                uint256 _nonce
            ) external {
                CachedSwap memory cs = cachedSwapLookup[_srcChainId][_srcAddress][_nonce];
                require(cs.to != address(0x0), "Stargate: cache already cleared");
                // clear the data
                cachedSwapLookup[_srcChainId][_srcAddress][_nonce] = CachedSwap(address(0x0), 0, address(0x0), "");
                IStargateReceiver(cs.to).sgReceive(_srcChainId, _srcAddress, _nonce, cs.token, cs.amountLD, cs.payload);
            }
            function creditChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint256 _srcPoolId,
                Pool.CreditObj memory _c
            ) external onlyBridge {
                Pool pool = _getPool(_srcPoolId);
                pool.creditChainPath(_dstChainId, _dstPoolId, _c);
            }
            //---------------------------------------------------------------------------
            // REMOTE CHAIN FUNCTIONS
            function redeemLocalCheckOnRemote(
                uint16 _srcChainId,
                bytes memory _srcAddress,
                uint256 _nonce,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                uint256 _amountSD,
                bytes calldata _to
            ) external onlyBridge {
                Pool pool = _getPool(_dstPoolId);
                try pool.redeemLocalCheckOnRemote(_srcChainId, _srcPoolId, _amountSD) returns (uint256 redeemAmountSD, uint256 mintAmountSD) {
                    revertLookup[_srcChainId][_srcAddress][_nonce] = abi.encode(
                        TYPE_REDEEM_LOCAL_RESPONSE,
                        _srcPoolId,
                        _dstPoolId,
                        redeemAmountSD,
                        mintAmountSD,
                        _to
                    );
                    emit RevertRedeemLocal(_srcChainId, _srcPoolId, _dstPoolId, _to, redeemAmountSD, mintAmountSD, _nonce, _srcAddress);
                } catch {
                    // if the func fail, return [swapAmount: 0, mintAMount: _amountSD]
                    // swapAmount represents the amount of chainPath balance deducted on the remote side, which because the above tx failed, should be 0
                    // mintAmount is the full amount of tokens the user attempted to redeem on the src side, which gets converted back into the lp amount
                    revertLookup[_srcChainId][_srcAddress][_nonce] = abi.encode(TYPE_REDEEM_LOCAL_RESPONSE, _srcPoolId, _dstPoolId, 0, _amountSD, _to);
                    emit Revert(TYPE_REDEEM_LOCAL_RESPONSE, _srcChainId, _srcAddress, _nonce);
                }
            }
            function redeemLocalCallback(
                uint16 _srcChainId,
                bytes memory _srcAddress,
                uint256 _nonce,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address _to,
                uint256 _amountSD,
                uint256 _mintAmountSD
            ) external onlyBridge {
                _redeemLocalCallback(_srcChainId, _srcAddress, _nonce, _srcPoolId, _dstPoolId, _to, _amountSD, _mintAmountSD);
            }
            function _redeemLocalCallback(
                uint16 _srcChainId,
                bytes memory _srcAddress,
                uint256 _nonce,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address _to,
                uint256 _amountSD,
                uint256 _mintAmountSD
            ) internal {
                Pool pool = _getPool(_dstPoolId);
                try pool.redeemLocalCallback(_srcChainId, _srcPoolId, _to, _amountSD, _mintAmountSD) {} catch {
                    revertLookup[_srcChainId][_srcAddress][_nonce] = abi.encode(
                        TYPE_REDEEM_LOCAL_CALLBACK_RETRY,
                        _srcPoolId,
                        _dstPoolId,
                        _to,
                        _amountSD,
                        _mintAmountSD
                    );
                    emit Revert(TYPE_REDEEM_LOCAL_CALLBACK_RETRY, _srcChainId, _srcAddress, _nonce);
                }
                emit RedeemLocalCallback(_srcChainId, _srcAddress, _nonce, _srcPoolId, _dstPoolId, _to, _amountSD, _mintAmountSD);
            }
            function swapRemote(
                uint16 _srcChainId,
                bytes memory _srcAddress,
                uint256 _nonce,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                uint256 _dstGasForCall,
                address _to,
                Pool.SwapObj memory _s,
                bytes memory _payload
            ) external onlyBridge {
                _swapRemote(_srcChainId, _srcAddress, _nonce, _srcPoolId, _dstPoolId, _dstGasForCall, _to, _s, _payload);
            }
            function _swapRemote(
                uint16 _srcChainId,
                bytes memory _srcAddress,
                uint256 _nonce,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                uint256 _dstGasForCall,
                address _to,
                Pool.SwapObj memory _s,
                bytes memory _payload
            ) internal {
                Pool pool = _getPool(_dstPoolId);
                // first try catch the swap remote
                try pool.swapRemote(_srcChainId, _srcPoolId, _to, _s) returns (uint256 amountLD) {
                    if (_payload.length > 0) {
                        // then try catch the external contract call
                        try IStargateReceiver(_to).sgReceive{gas: _dstGasForCall}(_srcChainId, _srcAddress, _nonce, pool.token(), amountLD, _payload) {
                            // do nothing
                        } catch (bytes memory reason) {
                            cachedSwapLookup[_srcChainId][_srcAddress][_nonce] = CachedSwap(pool.token(), amountLD, _to, _payload);
                            emit CachedSwapSaved(_srcChainId, _srcAddress, _nonce, pool.token(), amountLD, _to, _payload, reason);
                        }
                    }
                } catch {
                    revertLookup[_srcChainId][_srcAddress][_nonce] = abi.encode(
                        TYPE_SWAP_REMOTE_RETRY,
                        _srcPoolId,
                        _dstPoolId,
                        _dstGasForCall,
                        _to,
                        _s,
                        _payload
                    );
                    emit Revert(TYPE_SWAP_REMOTE_RETRY, _srcChainId, _srcAddress, _nonce);
                }
            }
            //---------------------------------------------------------------------------
            // DAO Calls
            function createPool(
                uint256 _poolId,
                address _token,
                uint8 _sharedDecimals,
                uint8 _localDecimals,
                string memory _name,
                string memory _symbol
            ) external onlyOwner returns (address) {
                require(_token != address(0x0), "Stargate: _token cannot be 0x0");
                return factory.createPool(_poolId, _token, _sharedDecimals, _localDecimals, _name, _symbol);
            }
            function createChainPath(
                uint256 _poolId,
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint256 _weight
            ) external onlyOwner {
                Pool pool = _getPool(_poolId);
                pool.createChainPath(_dstChainId, _dstPoolId, _weight);
            }
            function activateChainPath(
                uint256 _poolId,
                uint16 _dstChainId,
                uint256 _dstPoolId
            ) external onlyOwner {
                Pool pool = _getPool(_poolId);
                pool.activateChainPath(_dstChainId, _dstPoolId);
            }
            function setWeightForChainPath(
                uint256 _poolId,
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint16 _weight
            ) external onlyOwner {
                Pool pool = _getPool(_poolId);
                pool.setWeightForChainPath(_dstChainId, _dstPoolId, _weight);
            }
            function setProtocolFeeOwner(address _owner) external onlyOwner {
                require(_owner != address(0x0), "Stargate: _owner cannot be 0x0");
                protocolFeeOwner = _owner;
            }
            function setMintFeeOwner(address _owner) external onlyOwner {
                require(_owner != address(0x0), "Stargate: _owner cannot be 0x0");
                mintFeeOwner = _owner;
            }
            function setFees(uint256 _poolId, uint256 _mintFeeBP) external onlyOwner {
                Pool pool = _getPool(_poolId);
                pool.setFee(_mintFeeBP);
            }
            function setFeeLibrary(uint256 _poolId, address _feeLibraryAddr) external onlyOwner {
                Pool pool = _getPool(_poolId);
                pool.setFeeLibrary(_feeLibraryAddr);
            }
            function setSwapStop(uint256 _poolId, bool _swapStop) external onlyOwner {
                Pool pool = _getPool(_poolId);
                pool.setSwapStop(_swapStop);
            }
            function setDeltaParam(
                uint256 _poolId,
                bool _batched,
                uint256 _swapDeltaBP,
                uint256 _lpDeltaBP,
                bool _defaultSwapMode,
                bool _defaultLPMode
            ) external onlyOwner {
                Pool pool = _getPool(_poolId);
                pool.setDeltaParam(_batched, _swapDeltaBP, _lpDeltaBP, _defaultSwapMode, _defaultLPMode);
            }
            function callDelta(uint256 _poolId, bool _fullMode) external {
                Pool pool = _getPool(_poolId);
                pool.callDelta(_fullMode);
            }
            function withdrawMintFee(uint256 _poolId, address _to) external {
                require(mintFeeOwner == msg.sender, "Stargate: only mintFeeOwner");
                Pool pool = _getPool(_poolId);
                pool.withdrawMintFeeBalance(_to);
            }
            function withdrawProtocolFee(uint256 _poolId, address _to) external {
                require(protocolFeeOwner == msg.sender, "Stargate: only protocolFeeOwner");
                Pool pool = _getPool(_poolId);
                pool.withdrawProtocolFeeBalance(_to);
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        import "../utils/Context.sol";
        /**
         * @dev Contract module which provides a basic access control mechanism, where
         * there is an account (an owner) that can be granted exclusive access to
         * specific functions.
         *
         * By default, the owner account will be the one that deploys the contract. This
         * can later be changed with {transferOwnership}.
         *
         * This module is used through inheritance. It will make available the modifier
         * `onlyOwner`, which can be applied to your functions to restrict their use to
         * the owner.
         */
        abstract contract Ownable is Context {
            address private _owner;
            event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
            /**
             * @dev Initializes the contract setting the deployer as the initial owner.
             */
            constructor () {
                address msgSender = _msgSender();
                _owner = msgSender;
                emit OwnershipTransferred(address(0), msgSender);
            }
            /**
             * @dev Returns the address of the current owner.
             */
            function owner() public view virtual returns (address) {
                return _owner;
            }
            /**
             * @dev Throws if called by any account other than the owner.
             */
            modifier onlyOwner() {
                require(owner() == _msgSender(), "Ownable: caller is not the owner");
                _;
            }
            /**
             * @dev Leaves the contract without owner. It will not be possible to call
             * `onlyOwner` functions anymore. Can only be called by the current owner.
             *
             * NOTE: Renouncing ownership will leave the contract without an owner,
             * thereby removing any functionality that is only available to the owner.
             */
            function renounceOwnership() public virtual onlyOwner {
                emit OwnershipTransferred(_owner, address(0));
                _owner = address(0);
            }
            /**
             * @dev Transfers ownership of the contract to a new account (`newOwner`).
             * Can only be called by the current owner.
             */
            function transferOwnership(address newOwner) public virtual onlyOwner {
                require(newOwner != address(0), "Ownable: new owner is the zero address");
                emit OwnershipTransferred(_owner, newOwner);
                _owner = newOwner;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        /**
         * @dev Contract module that helps prevent reentrant calls to a function.
         *
         * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
         * available, which can be applied to functions to make sure there are no nested
         * (reentrant) calls to them.
         *
         * Note that because there is a single `nonReentrant` guard, functions marked as
         * `nonReentrant` may not call one another. This can be worked around by making
         * those functions `private`, and then adding `external` `nonReentrant` entry
         * points to them.
         *
         * TIP: If you would like to learn more about reentrancy and alternative ways
         * to protect against it, check out our blog post
         * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
         */
        abstract contract ReentrancyGuard {
            // Booleans are more expensive than uint256 or any type that takes up a full
            // word because each write operation emits an extra SLOAD to first read the
            // slot's contents, replace the bits taken up by the boolean, and then write
            // back. This is the compiler's defense against contract upgrades and
            // pointer aliasing, and it cannot be disabled.
            // The values being non-zero value makes deployment a bit more expensive,
            // but in exchange the refund on every call to nonReentrant will be lower in
            // amount. Since refunds are capped to a percentage of the total
            // transaction's gas, it is best to keep them low in cases like this one, to
            // increase the likelihood of the full refund coming into effect.
            uint256 private constant _NOT_ENTERED = 1;
            uint256 private constant _ENTERED = 2;
            uint256 private _status;
            constructor () {
                _status = _NOT_ENTERED;
            }
            /**
             * @dev Prevents a contract from calling itself, directly or indirectly.
             * Calling a `nonReentrant` function from another `nonReentrant`
             * function is not supported. It is possible to prevent this from happening
             * by making the `nonReentrant` function external, and make it call a
             * `private` function that does the actual work.
             */
            modifier nonReentrant() {
                // On the first call to nonReentrant, _notEntered will be true
                require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
                // Any calls to nonReentrant after this point will fail
                _status = _ENTERED;
                _;
                // By storing the original value once again, a refund is triggered (see
                // https://eips.ethereum.org/EIPS/eip-2200)
                _status = _NOT_ENTERED;
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        pragma abicoder v2;
        import "@openzeppelin/contracts/math/SafeMath.sol";
        import "@openzeppelin/contracts/access/Ownable.sol";
        import "./Pool.sol";
        contract Factory is Ownable {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // VARIABLES
            mapping(uint256 => Pool) public getPool; // poolId -> PoolInfo
            address[] public allPools;
            address public immutable router;
            address public defaultFeeLibrary; // address for retrieving fee params for swaps
            //---------------------------------------------------------------------------
            // MODIFIERS
            modifier onlyRouter() {
                require(msg.sender == router, "Stargate: caller must be Router.");
                _;
            }
            constructor(address _router) {
                require(_router != address(0x0), "Stargate: _router cant be 0x0"); // 1 time only
                router = _router;
            }
            function setDefaultFeeLibrary(address _defaultFeeLibrary) external onlyOwner {
                require(_defaultFeeLibrary != address(0x0), "Stargate: fee library cant be 0x0");
                defaultFeeLibrary = _defaultFeeLibrary;
            }
            function allPoolsLength() external view returns (uint256) {
                return allPools.length;
            }
            function createPool(
                uint256 _poolId,
                address _token,
                uint8 _sharedDecimals,
                uint8 _localDecimals,
                string memory _name,
                string memory _symbol
            ) public onlyRouter returns (address poolAddress) {
                require(address(getPool[_poolId]) == address(0x0), "Stargate: Pool already created");
                Pool pool = new Pool(_poolId, router, _token, _sharedDecimals, _localDecimals, defaultFeeLibrary, _name, _symbol);
                getPool[_poolId] = pool;
                poolAddress = address(pool);
                allPools.push(poolAddress);
            }
            function renounceOwnership() public override onlyOwner {}
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        pragma abicoder v2;
        // imports
        import "@openzeppelin/contracts/access/Ownable.sol";
        import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
        import "./LPTokenERC20.sol";
        import "./interfaces/IStargateFeeLibrary.sol";
        // libraries
        import "@openzeppelin/contracts/math/SafeMath.sol";
        /// Pool contracts on other chains and managed by the Stargate protocol.
        contract Pool is LPTokenERC20, ReentrancyGuard {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // CONSTANTS
            bytes4 private constant SELECTOR = bytes4(keccak256(bytes("transfer(address,uint256)")));
            uint256 public constant BP_DENOMINATOR = 10000;
            //---------------------------------------------------------------------------
            // STRUCTS
            struct ChainPath {
                bool ready; // indicate if the counter chainPath has been created.
                uint16 dstChainId;
                uint256 dstPoolId;
                uint256 weight;
                uint256 balance;
                uint256 lkb;
                uint256 credits;
                uint256 idealBalance;
            }
            struct SwapObj {
                uint256 amount;
                uint256 eqFee;
                uint256 eqReward;
                uint256 lpFee;
                uint256 protocolFee;
                uint256 lkbRemove;
            }
            struct CreditObj {
                uint256 credits;
                uint256 idealBalance;
            }
            //---------------------------------------------------------------------------
            // VARIABLES
            // chainPath
            ChainPath[] public chainPaths; // list of connected chains with shared pools
            mapping(uint16 => mapping(uint256 => uint256)) public chainPathIndexLookup; // lookup for chainPath by chainId => poolId =>index
            // metadata
            uint256 public immutable poolId; // shared id between chains to represent same pool
            uint256 public sharedDecimals; // the shared decimals (lowest common decimals between chains)
            uint256 public localDecimals; // the decimals for the token
            uint256 public immutable convertRate; // the decimals for the token
            address public immutable token; // the token for the pool
            address public immutable router; // the token for the pool
            bool public stopSwap; // flag to stop swapping in extreme cases
            // Fee and Liquidity
            uint256 public totalLiquidity; // the total amount of tokens added on this side of the chain (fees + deposits - withdrawals)
            uint256 public totalWeight; // total weight for pool percentages
            uint256 public mintFeeBP; // fee basis points for the mint/deposit
            uint256 public protocolFeeBalance; // fee balance created from dao fee
            uint256 public mintFeeBalance; // fee balance created from mint fee
            uint256 public eqFeePool; // pool rewards in Shared Decimal format. indicate the total budget for reverse swap incentive
            address public feeLibrary; // address for retrieving fee params for swaps
            // Delta related
            uint256 public deltaCredit; // credits accumulated from txn
            bool public batched; // flag to indicate if we want batch processing.
            bool public defaultSwapMode; // flag for the default mode for swap
            bool public defaultLPMode; // flag for the default mode for lp
            uint256 public swapDeltaBP; // basis points of poolCredits to activate Delta in swap
            uint256 public lpDeltaBP; // basis points of poolCredits to activate Delta in liquidity events
            //---------------------------------------------------------------------------
            // EVENTS
            event Mint(address to, uint256 amountLP, uint256 amountSD, uint256 mintFeeAmountSD);
            event Burn(address from, uint256 amountLP, uint256 amountSD);
            event RedeemLocalCallback(address _to, uint256 _amountSD, uint256 _amountToMintSD);
            event Swap(
                uint16 chainId,
                uint256 dstPoolId,
                address from,
                uint256 amountSD,
                uint256 eqReward,
                uint256 eqFee,
                uint256 protocolFee,
                uint256 lpFee
            );
            event SendCredits(uint16 dstChainId, uint256 dstPoolId, uint256 credits, uint256 idealBalance);
            event RedeemRemote(uint16 chainId, uint256 dstPoolId, address from, uint256 amountLP, uint256 amountSD);
            event RedeemLocal(address from, uint256 amountLP, uint256 amountSD, uint16 chainId, uint256 dstPoolId, bytes to);
            event InstantRedeemLocal(address from, uint256 amountLP, uint256 amountSD, address to);
            event CreditChainPath(uint16 chainId, uint256 srcPoolId, uint256 amountSD, uint256 idealBalance);
            event SwapRemote(address to, uint256 amountSD, uint256 protocolFee, uint256 dstFee);
            event WithdrawRemote(uint16 srcChainId, uint256 srcPoolId, uint256 swapAmount, uint256 mintAmount);
            event ChainPathUpdate(uint16 dstChainId, uint256 dstPoolId, uint256 weight);
            event FeesUpdated(uint256 mintFeeBP);
            event FeeLibraryUpdated(address feeLibraryAddr);
            event StopSwapUpdated(bool swapStop);
            event WithdrawProtocolFeeBalance(address to, uint256 amountSD);
            event WithdrawMintFeeBalance(address to, uint256 amountSD);
            event DeltaParamUpdated(bool batched, uint256 swapDeltaBP, uint256 lpDeltaBP, bool defaultSwapMode, bool defaultLPMode);
            //---------------------------------------------------------------------------
            // MODIFIERS
            modifier onlyRouter() {
                require(msg.sender == router, "Stargate: only the router can call this method");
                _;
            }
            constructor(
                uint256 _poolId,
                address _router,
                address _token,
                uint256 _sharedDecimals,
                uint256 _localDecimals,
                address _feeLibrary,
                string memory _name,
                string memory _symbol
            ) LPTokenERC20(_name, _symbol) {
                require(_token != address(0x0), "Stargate: _token cannot be 0x0");
                require(_router != address(0x0), "Stargate: _router cannot be 0x0");
                poolId = _poolId;
                router = _router;
                token = _token;
                sharedDecimals = _sharedDecimals;
                decimals = uint8(_sharedDecimals);
                localDecimals = _localDecimals;
                convertRate = 10**(uint256(localDecimals).sub(sharedDecimals));
                totalWeight = 0;
                feeLibrary = _feeLibrary;
                //delta algo related
                batched = false;
                defaultSwapMode = true;
                defaultLPMode = true;
            }
            function getChainPathsLength() public view returns (uint256) {
                return chainPaths.length;
            }
            //---------------------------------------------------------------------------
            // LOCAL CHAIN FUNCTIONS
            function mint(address _to, uint256 _amountLD) external nonReentrant onlyRouter returns (uint256) {
                return _mintLocal(_to, _amountLD, true, true);
            }
            // Local                                    Remote
            // -------                                  ---------
            // swap             ->                      swapRemote
            function swap(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                address _from,
                uint256 _amountLD,
                uint256 _minAmountLD,
                bool newLiquidity
            ) external nonReentrant onlyRouter returns (SwapObj memory) {
                require(!stopSwap, "Stargate: swap func stopped");
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == true, "Stargate: counter chainPath is not ready");
                uint256 amountSD = amountLDtoSD(_amountLD);
                uint256 minAmountSD = amountLDtoSD(_minAmountLD);
                // request fee params from library
                SwapObj memory s = IStargateFeeLibrary(feeLibrary).getFees(poolId, _dstPoolId, _dstChainId, _from, amountSD);
                // equilibrium fee and reward. note eqFee/eqReward are separated from swap liquidity
                eqFeePool = eqFeePool.sub(s.eqReward);
                // update the new amount the user gets minus the fees
                s.amount = amountSD.sub(s.eqFee).sub(s.protocolFee).sub(s.lpFee);
                // users will also get the eqReward
                require(s.amount.add(s.eqReward) >= minAmountSD, "Stargate: slippage too high");
                // behaviours
                //     - protocolFee: booked, stayed and withdrawn at remote.
                //     - eqFee: booked, stayed and withdrawn at remote.
                //     - lpFee: booked and stayed at remote, can be withdrawn anywhere
                s.lkbRemove = amountSD.sub(s.lpFee).add(s.eqReward);
                // check for transfer solvency.
                require(cp.balance >= s.lkbRemove, "Stargate: dst balance too low");
                cp.balance = cp.balance.sub(s.lkbRemove);
                if (newLiquidity) {
                    deltaCredit = deltaCredit.add(amountSD).add(s.eqReward);
                } else if (s.eqReward > 0) {
                    deltaCredit = deltaCredit.add(s.eqReward);
                }
                // distribute credits on condition.
                if (!batched || deltaCredit >= totalLiquidity.mul(swapDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultSwapMode);
                }
                emit Swap(_dstChainId, _dstPoolId, _from, s.amount, s.eqReward, s.eqFee, s.protocolFee, s.lpFee);
                return s;
            }
            // Local                                    Remote
            // -------                                  ---------
            // sendCredits      ->                      creditChainPath
            function sendCredits(uint16 _dstChainId, uint256 _dstPoolId) external nonReentrant onlyRouter returns (CreditObj memory c) {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == true, "Stargate: counter chainPath is not ready");
                cp.lkb = cp.lkb.add(cp.credits);
                c.idealBalance = totalLiquidity.mul(cp.weight).div(totalWeight);
                c.credits = cp.credits;
                cp.credits = 0;
                emit SendCredits(_dstChainId, _dstPoolId, c.credits, c.idealBalance);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemRemote   ->                        swapRemote
            function redeemRemote(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                address _from,
                uint256 _amountLP
            ) external nonReentrant onlyRouter {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                uint256 amountSD = _burnLocal(_from, _amountLP);
                //run Delta
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultLPMode);
                }
                uint256 amountLD = amountSDtoLD(amountSD);
                emit RedeemRemote(_dstChainId, _dstPoolId, _from, _amountLP, amountLD);
            }
            function instantRedeemLocal(
                address _from,
                uint256 _amountLP,
                address _to
            ) external nonReentrant onlyRouter returns (uint256 amountSD) {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                uint256 _deltaCredit = deltaCredit; // sload optimization.
                uint256 _capAmountLP = _amountSDtoLP(_deltaCredit);
                if (_amountLP > _capAmountLP) _amountLP = _capAmountLP;
                amountSD = _burnLocal(_from, _amountLP);
                deltaCredit = _deltaCredit.sub(amountSD);
                uint256 amountLD = amountSDtoLD(amountSD);
                _safeTransfer(token, _to, amountLD);
                emit InstantRedeemLocal(_from, _amountLP, amountSD, _to);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal   ->                         redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocal(
                address _from,
                uint256 _amountLP,
                uint16 _dstChainId,
                uint256 _dstPoolId,
                bytes calldata _to
            ) external nonReentrant onlyRouter returns (uint256 amountSD) {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                // safeguard.
                require(chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]].ready == true, "Stargate: counter chainPath is not ready");
                amountSD = _burnLocal(_from, _amountLP);
                // run Delta
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(false);
                }
                emit RedeemLocal(_from, _amountLP, amountSD, _dstChainId, _dstPoolId, _to);
            }
            //---------------------------------------------------------------------------
            // REMOTE CHAIN FUNCTIONS
            // Local                                    Remote
            // -------                                  ---------
            // sendCredits      ->                      creditChainPath
            function creditChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                CreditObj memory _c
            ) external nonReentrant onlyRouter {
                ChainPath storage cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                cp.balance = cp.balance.add(_c.credits);
                if (cp.idealBalance != _c.idealBalance) {
                    cp.idealBalance = _c.idealBalance;
                }
                emit CreditChainPath(_dstChainId, _dstPoolId, _c.credits, _c.idealBalance);
            }
            // Local                                    Remote
            // -------                                  ---------
            // swap             ->                      swapRemote
            function swapRemote(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                address _to,
                SwapObj memory _s
            ) external nonReentrant onlyRouter returns (uint256 amountLD) {
                // booking lpFee
                totalLiquidity = totalLiquidity.add(_s.lpFee);
                // booking eqFee
                eqFeePool = eqFeePool.add(_s.eqFee);
                // booking stargateFee
                protocolFeeBalance = protocolFeeBalance.add(_s.protocolFee);
                // update LKB
                uint256 chainPathIndex = chainPathIndexLookup[_srcChainId][_srcPoolId];
                chainPaths[chainPathIndex].lkb = chainPaths[chainPathIndex].lkb.sub(_s.lkbRemove);
                // user receives the amount + the srcReward
                amountLD = amountSDtoLD(_s.amount.add(_s.eqReward));
                _safeTransfer(token, _to, amountLD);
                emit SwapRemote(_to, _s.amount.add(_s.eqReward), _s.protocolFee, _s.eqFee);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal   ->                         redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocalCallback(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                address _to,
                uint256 _amountSD,
                uint256 _amountToMintSD
            ) external nonReentrant onlyRouter {
                if (_amountToMintSD > 0) {
                    _mintLocal(_to, amountSDtoLD(_amountToMintSD), false, false);
                }
                ChainPath storage cp = getAndCheckCP(_srcChainId, _srcPoolId);
                cp.lkb = cp.lkb.sub(_amountSD);
                uint256 amountLD = amountSDtoLD(_amountSD);
                _safeTransfer(token, _to, amountLD);
                emit RedeemLocalCallback(_to, _amountSD, _amountToMintSD);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal(amount)   ->               redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocalCheckOnRemote(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                uint256 _amountSD
            ) external nonReentrant onlyRouter returns (uint256 swapAmount, uint256 mintAmount) {
                ChainPath storage cp = getAndCheckCP(_srcChainId, _srcPoolId);
                if (_amountSD > cp.balance) {
                    mintAmount = _amountSD - cp.balance;
                    swapAmount = cp.balance;
                    cp.balance = 0;
                } else {
                    cp.balance = cp.balance.sub(_amountSD);
                    swapAmount = _amountSD;
                    mintAmount = 0;
                }
                emit WithdrawRemote(_srcChainId, _srcPoolId, swapAmount, mintAmount);
            }
            //---------------------------------------------------------------------------
            // DAO Calls
            function createChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint256 _weight
            ) external onlyRouter {
                for (uint256 i = 0; i < chainPaths.length; ++i) {
                    ChainPath memory cp = chainPaths[i];
                    bool exists = cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId;
                    require(!exists, "Stargate: cant createChainPath of existing dstChainId and _dstPoolId");
                }
                totalWeight = totalWeight.add(_weight);
                chainPathIndexLookup[_dstChainId][_dstPoolId] = chainPaths.length;
                chainPaths.push(ChainPath(false, _dstChainId, _dstPoolId, _weight, 0, 0, 0, 0));
                emit ChainPathUpdate(_dstChainId, _dstPoolId, _weight);
            }
            function setWeightForChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint16 _weight
            ) external onlyRouter {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                totalWeight = totalWeight.sub(cp.weight).add(_weight);
                cp.weight = _weight;
                emit ChainPathUpdate(_dstChainId, _dstPoolId, _weight);
            }
            function setFee(uint256 _mintFeeBP) external onlyRouter {
                require(_mintFeeBP <= BP_DENOMINATOR, "Bridge: cum fees > 100%");
                mintFeeBP = _mintFeeBP;
                emit FeesUpdated(mintFeeBP);
            }
            function setFeeLibrary(address _feeLibraryAddr) external onlyRouter {
                require(_feeLibraryAddr != address(0x0), "Stargate: fee library cant be 0x0");
                feeLibrary = _feeLibraryAddr;
                emit FeeLibraryUpdated(_feeLibraryAddr);
            }
            function setSwapStop(bool _swapStop) external onlyRouter {
                stopSwap = _swapStop;
                emit StopSwapUpdated(_swapStop);
            }
            function setDeltaParam(
                bool _batched,
                uint256 _swapDeltaBP,
                uint256 _lpDeltaBP,
                bool _defaultSwapMode,
                bool _defaultLPMode
            ) external onlyRouter {
                require(_swapDeltaBP <= BP_DENOMINATOR && _lpDeltaBP <= BP_DENOMINATOR, "Stargate: wrong Delta param");
                batched = _batched;
                swapDeltaBP = _swapDeltaBP;
                lpDeltaBP = _lpDeltaBP;
                defaultSwapMode = _defaultSwapMode;
                defaultLPMode = _defaultLPMode;
                emit DeltaParamUpdated(_batched, _swapDeltaBP, _lpDeltaBP, _defaultSwapMode, _defaultLPMode);
            }
            function callDelta(bool _fullMode) external onlyRouter {
                _delta(_fullMode);
            }
            function activateChainPath(uint16 _dstChainId, uint256 _dstPoolId) external onlyRouter {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == false, "Stargate: chainPath is already active");
                // this func will only be called once
                cp.ready = true;
            }
            function withdrawProtocolFeeBalance(address _to) external onlyRouter {
                if (protocolFeeBalance > 0) {
                    uint256 amountOfLD = amountSDtoLD(protocolFeeBalance);
                    protocolFeeBalance = 0;
                    _safeTransfer(token, _to, amountOfLD);
                    emit WithdrawProtocolFeeBalance(_to, amountOfLD);
                }
            }
            function withdrawMintFeeBalance(address _to) external onlyRouter {
                if (mintFeeBalance > 0) {
                    uint256 amountOfLD = amountSDtoLD(mintFeeBalance);
                    mintFeeBalance = 0;
                    _safeTransfer(token, _to, amountOfLD);
                    emit WithdrawMintFeeBalance(_to, amountOfLD);
                }
            }
            //---------------------------------------------------------------------------
            // INTERNAL
            // Conversion Helpers
            //---------------------------------------------------------------------------
            function amountLPtoLD(uint256 _amountLP) external view returns (uint256) {
                return amountSDtoLD(_amountLPtoSD(_amountLP));
            }
            function _amountLPtoSD(uint256 _amountLP) internal view returns (uint256) {
                require(totalSupply > 0, "Stargate: cant convert LPtoSD when totalSupply == 0");
                return _amountLP.mul(totalLiquidity).div(totalSupply);
            }
            function _amountSDtoLP(uint256 _amountSD) internal view returns (uint256) {
                require(totalLiquidity > 0, "Stargate: cant convert SDtoLP when totalLiq == 0");
                return _amountSD.mul(totalSupply).div(totalLiquidity);
            }
            function amountSDtoLD(uint256 _amount) internal view returns (uint256) {
                return _amount.mul(convertRate);
            }
            function amountLDtoSD(uint256 _amount) internal view returns (uint256) {
                return _amount.div(convertRate);
            }
            function getAndCheckCP(uint16 _dstChainId, uint256 _dstPoolId) internal view returns (ChainPath storage) {
                require(chainPaths.length > 0, "Stargate: no chainpaths exist");
                ChainPath storage cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                require(cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId, "Stargate: local chainPath does not exist");
                return cp;
            }
            function getChainPath(uint16 _dstChainId, uint256 _dstPoolId) external view returns (ChainPath memory) {
                ChainPath memory cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                require(cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId, "Stargate: local chainPath does not exist");
                return cp;
            }
            function _burnLocal(address _from, uint256 _amountLP) internal returns (uint256) {
                require(totalSupply > 0, "Stargate: cant burn when totalSupply == 0");
                uint256 amountOfLPTokens = balanceOf[_from];
                require(amountOfLPTokens >= _amountLP, "Stargate: not enough LP tokens to burn");
                uint256 amountSD = _amountLP.mul(totalLiquidity).div(totalSupply);
                //subtract totalLiquidity accordingly
                totalLiquidity = totalLiquidity.sub(amountSD);
                _burn(_from, _amountLP);
                emit Burn(_from, _amountLP, amountSD);
                return amountSD;
            }
            function _delta(bool fullMode) internal {
                if (deltaCredit > 0 && totalWeight > 0) {
                    uint256 cpLength = chainPaths.length;
                    uint256[] memory deficit = new uint256[](cpLength);
                    uint256 totalDeficit = 0;
                    // algorithm steps 6-9: calculate the total and the amounts required to get to balance state
                    for (uint256 i = 0; i < cpLength; ++i) {
                        ChainPath storage cp = chainPaths[i];
                        // (liquidity * (weight/totalWeight)) - (lkb+credits)
                        uint256 balLiq = totalLiquidity.mul(cp.weight).div(totalWeight);
                        uint256 currLiq = cp.lkb.add(cp.credits);
                        if (balLiq > currLiq) {
                            // save gas since we know balLiq > currLiq and we know deficit[i] > 0
                            deficit[i] = balLiq - currLiq;
                            totalDeficit = totalDeficit.add(deficit[i]);
                        }
                    }
                    // indicates how much delta credit is distributed
                    uint256 spent;
                    // handle credits with 2 tranches. the [ < totalDeficit] [excessCredit]
                    // run full Delta, allocate all credits
                    if (totalDeficit == 0) {
                        // only fullMode delta will allocate excess credits
                        if (fullMode && deltaCredit > 0) {
                            // credit ChainPath by weights
                            for (uint256 i = 0; i < cpLength; ++i) {
                                ChainPath storage cp = chainPaths[i];
                                // credits = credits + toBalanceChange + remaining allocation based on weight
                                uint256 amtToCredit = deltaCredit.mul(cp.weight).div(totalWeight);
                                spent = spent.add(amtToCredit);
                                cp.credits = cp.credits.add(amtToCredit);
                            }
                        } // else do nth
                    } else if (totalDeficit <= deltaCredit) {
                        if (fullMode) {
                            // algorithm step 13: calculate amount to disperse to bring to balance state or as close as possible
                            uint256 excessCredit = deltaCredit - totalDeficit;
                            // algorithm steps 14-16: calculate credits
                            for (uint256 i = 0; i < cpLength; ++i) {
                                if (deficit[i] > 0) {
                                    ChainPath storage cp = chainPaths[i];
                                    // credits = credits + deficit + remaining allocation based on weight
                                    uint256 amtToCredit = deficit[i].add(excessCredit.mul(cp.weight).div(totalWeight));
                                    spent = spent.add(amtToCredit);
                                    cp.credits = cp.credits.add(amtToCredit);
                                }
                            }
                        } else {
                            // totalDeficit <= deltaCredit but not running fullMode
                            // credit chainPaths as is if any deficit, not using all deltaCredit
                            for (uint256 i = 0; i < cpLength; ++i) {
                                if (deficit[i] > 0) {
                                    ChainPath storage cp = chainPaths[i];
                                    uint256 amtToCredit = deficit[i];
                                    spent = spent.add(amtToCredit);
                                    cp.credits = cp.credits.add(amtToCredit);
                                }
                            }
                        }
                    } else {
                        // totalDeficit > deltaCredit, fullMode or not, normalize the deficit by deltaCredit
                        for (uint256 i = 0; i < cpLength; ++i) {
                            if (deficit[i] > 0) {
                                ChainPath storage cp = chainPaths[i];
                                uint256 proportionalDeficit = deficit[i].mul(deltaCredit).div(totalDeficit);
                                spent = spent.add(proportionalDeficit);
                                cp.credits = cp.credits.add(proportionalDeficit);
                            }
                        }
                    }
                    // deduct the amount of credit sent
                    deltaCredit = deltaCredit.sub(spent);
                }
            }
            function _mintLocal(
                address _to,
                uint256 _amountLD,
                bool _feesEnabled,
                bool _creditDelta
            ) internal returns (uint256 amountSD) {
                require(totalWeight > 0, "Stargate: No ChainPaths exist");
                amountSD = amountLDtoSD(_amountLD);
                uint256 mintFeeSD = 0;
                if (_feesEnabled) {
                    mintFeeSD = amountSD.mul(mintFeeBP).div(BP_DENOMINATOR);
                    amountSD = amountSD.sub(mintFeeSD);
                    mintFeeBalance = mintFeeBalance.add(mintFeeSD);
                }
                if (_creditDelta) {
                    deltaCredit = deltaCredit.add(amountSD);
                }
                uint256 amountLPTokens = amountSD;
                if (totalSupply != 0) {
                    amountLPTokens = amountSD.mul(totalSupply).div(totalLiquidity);
                }
                totalLiquidity = totalLiquidity.add(amountSD);
                _mint(_to, amountLPTokens);
                emit Mint(_to, amountLPTokens, amountSD, mintFeeSD);
                // add to credits and call delta. short circuit to save gas
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultLPMode);
                }
            }
            function _safeTransfer(
                address _token,
                address _to,
                uint256 _value
            ) private {
                (bool success, bytes memory data) = _token.call(abi.encodeWithSelector(SELECTOR, _to, _value));
                require(success && (data.length == 0 || abi.decode(data, (bool))), "Stargate: TRANSFER_FAILED");
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        pragma abicoder v2;
        // imports
        import "@openzeppelin/contracts/access/Ownable.sol";
        import "./Pool.sol";
        import "./Router.sol";
        // interfaces
        import "@layerzerolabs/contracts/contracts/interfaces/ILayerZeroReceiver.sol";
        import "@layerzerolabs/contracts/contracts/interfaces/ILayerZeroEndpoint.sol";
        import "@layerzerolabs/contracts/contracts/interfaces/ILayerZeroUserApplicationConfig.sol";
        // libraries
        import "@openzeppelin/contracts/math/SafeMath.sol";
        contract Bridge is Ownable, ILayerZeroReceiver, ILayerZeroUserApplicationConfig {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // CONSTANTS
            uint8 internal constant TYPE_SWAP_REMOTE = 1;
            uint8 internal constant TYPE_ADD_LIQUIDITY = 2;
            uint8 internal constant TYPE_REDEEM_LOCAL_CALL_BACK = 3;
            uint8 internal constant TYPE_WITHDRAW_REMOTE = 4;
            //---------------------------------------------------------------------------
            // VARIABLES
            ILayerZeroEndpoint public immutable layerZeroEndpoint;
            mapping(uint16 => bytes) public bridgeLookup;
            mapping(uint16 => mapping(uint8 => uint256)) public gasLookup;
            Router public immutable router;
            bool public useLayerZeroToken;
            //---------------------------------------------------------------------------
            // EVENTS
            event SendMsg(uint8 msgType, uint64 nonce);
            //---------------------------------------------------------------------------
            // MODIFIERS
            modifier onlyRouter() {
                require(msg.sender == address(router), "Stargate: caller must be Router.");
                _;
            }
            constructor(address _layerZeroEndpoint, address _router) {
                require(_layerZeroEndpoint != address(0x0), "Stargate: _layerZeroEndpoint cannot be 0x0");
                require(_router != address(0x0), "Stargate: _router cannot be 0x0");
                layerZeroEndpoint = ILayerZeroEndpoint(_layerZeroEndpoint);
                router = Router(_router);
            }
            //---------------------------------------------------------------------------
            // EXTERNAL functions
            function lzReceive(
                uint16 _srcChainId,
                bytes memory _srcAddress,
                uint64 _nonce,
                bytes memory _payload
            ) external override {
                require(msg.sender == address(layerZeroEndpoint), "Stargate: only LayerZero endpoint can call lzReceive");
                require(
                    _srcAddress.length == bridgeLookup[_srcChainId].length && keccak256(_srcAddress) == keccak256(bridgeLookup[_srcChainId]),
                    "Stargate: bridge does not match"
                );
                uint8 functionType;
                assembly {
                    functionType := mload(add(_payload, 32))
                }
                if (functionType == TYPE_SWAP_REMOTE) {
                    (
                        ,
                        uint256 srcPoolId,
                        uint256 dstPoolId,
                        uint256 dstGasForCall,
                        Pool.CreditObj memory c,
                        Pool.SwapObj memory s,
                        bytes memory to,
                        bytes memory payload
                    ) = abi.decode(_payload, (uint8, uint256, uint256, uint256, Pool.CreditObj, Pool.SwapObj, bytes, bytes));
                    address toAddress;
                    assembly {
                        toAddress := mload(add(to, 20))
                    }
                    router.creditChainPath(_srcChainId, srcPoolId, dstPoolId, c);
                    router.swapRemote(_srcChainId, _srcAddress, _nonce, srcPoolId, dstPoolId, dstGasForCall, toAddress, s, payload);
                } else if (functionType == TYPE_ADD_LIQUIDITY) {
                    (, uint256 srcPoolId, uint256 dstPoolId, Pool.CreditObj memory c) = abi.decode(_payload, (uint8, uint256, uint256, Pool.CreditObj));
                    router.creditChainPath(_srcChainId, srcPoolId, dstPoolId, c);
                } else if (functionType == TYPE_REDEEM_LOCAL_CALL_BACK) {
                    (, uint256 srcPoolId, uint256 dstPoolId, Pool.CreditObj memory c, uint256 amountSD, uint256 mintAmountSD, bytes memory to) = abi
                        .decode(_payload, (uint8, uint256, uint256, Pool.CreditObj, uint256, uint256, bytes));
                    address toAddress;
                    assembly {
                        toAddress := mload(add(to, 20))
                    }
                    router.creditChainPath(_srcChainId, srcPoolId, dstPoolId, c);
                    router.redeemLocalCallback(_srcChainId, _srcAddress, _nonce, srcPoolId, dstPoolId, toAddress, amountSD, mintAmountSD);
                } else if (functionType == TYPE_WITHDRAW_REMOTE) {
                    (, uint256 srcPoolId, uint256 dstPoolId, Pool.CreditObj memory c, uint256 amountSD, bytes memory to) = abi.decode(
                        _payload,
                        (uint8, uint256, uint256, Pool.CreditObj, uint256, bytes)
                    );
                    router.creditChainPath(_srcChainId, srcPoolId, dstPoolId, c);
                    router.redeemLocalCheckOnRemote(_srcChainId, _srcAddress, _nonce, srcPoolId, dstPoolId, amountSD, to);
                }
            }
            //---------------------------------------------------------------------------
            // LOCAL CHAIN FUNCTIONS
            function swap(
                uint16 _chainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                Pool.CreditObj memory _c,
                Pool.SwapObj memory _s,
                IStargateRouter.lzTxObj memory _lzTxParams,
                bytes calldata _to,
                bytes calldata _payload
            ) external payable onlyRouter {
                bytes memory payload = abi.encode(TYPE_SWAP_REMOTE, _srcPoolId, _dstPoolId, _lzTxParams.dstGasForCall, _c, _s, _to, _payload);
                _call(_chainId, TYPE_SWAP_REMOTE, _refundAddress, _lzTxParams, payload);
            }
            function redeemLocalCallback(
                uint16 _chainId,
                address payable _refundAddress,
                Pool.CreditObj memory _c,
                IStargateRouter.lzTxObj memory _lzTxParams,
                bytes memory _payload
            ) external payable onlyRouter {
                bytes memory payload;
                {
                    (, uint256 srcPoolId, uint256 dstPoolId, uint256 amountSD, uint256 mintAmountSD, bytes memory to) = abi.decode(
                        _payload,
                        (uint8, uint256, uint256, uint256, uint256, bytes)
                    );
                    // swap dst and src because we are headed back
                    payload = abi.encode(TYPE_REDEEM_LOCAL_CALL_BACK, dstPoolId, srcPoolId, _c, amountSD, mintAmountSD, to);
                }
                _call(_chainId, TYPE_REDEEM_LOCAL_CALL_BACK, _refundAddress, _lzTxParams, payload);
            }
            function redeemLocal(
                uint16 _chainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                Pool.CreditObj memory _c,
                uint256 _amountSD,
                bytes calldata _to,
                IStargateRouter.lzTxObj memory _lzTxParams
            ) external payable onlyRouter {
                bytes memory payload = abi.encode(TYPE_WITHDRAW_REMOTE, _srcPoolId, _dstPoolId, _c, _amountSD, _to);
                _call(_chainId, TYPE_WITHDRAW_REMOTE, _refundAddress, _lzTxParams, payload);
            }
            function sendCredits(
                uint16 _chainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                Pool.CreditObj memory _c
            ) external payable onlyRouter {
                bytes memory payload = abi.encode(TYPE_ADD_LIQUIDITY, _srcPoolId, _dstPoolId, _c);
                IStargateRouter.lzTxObj memory lzTxObj = IStargateRouter.lzTxObj(0, 0, "0x");
                _call(_chainId, TYPE_ADD_LIQUIDITY, _refundAddress, lzTxObj, payload);
            }
            function quoteLayerZeroFee(
                uint16 _chainId,
                uint8 _functionType,
                bytes calldata _toAddress,
                bytes calldata _transferAndCallPayload,
                IStargateRouter.lzTxObj memory _lzTxParams
            ) external view returns (uint256, uint256) {
                bytes memory payload = "";
                Pool.CreditObj memory c = Pool.CreditObj(1, 1);
                if (_functionType == TYPE_SWAP_REMOTE) {
                    Pool.SwapObj memory s = Pool.SwapObj(1, 1, 1, 1, 1, 1);
                    payload = abi.encode(TYPE_SWAP_REMOTE, 0, 0, 0, c, s, _toAddress, _transferAndCallPayload);
                } else if (_functionType == TYPE_ADD_LIQUIDITY) {
                    payload = abi.encode(TYPE_ADD_LIQUIDITY, 0, 0, c);
                } else if (_functionType == TYPE_REDEEM_LOCAL_CALL_BACK) {
                    payload = abi.encode(TYPE_REDEEM_LOCAL_CALL_BACK, 0, 0, c, 0, 0, _toAddress);
                } else if (_functionType == TYPE_WITHDRAW_REMOTE) {
                    payload = abi.encode(TYPE_WITHDRAW_REMOTE, 0, 0, c, 0, _toAddress);
                } else {
                    revert("Stargate: unsupported function type");
                }
                bytes memory lzTxParamBuilt = _txParamBuilder(_chainId, _functionType, _lzTxParams);
                return layerZeroEndpoint.estimateFees(_chainId, address(this), payload, useLayerZeroToken, lzTxParamBuilt);
            }
            //---------------------------------------------------------------------------
            // dao functions
            function setBridge(uint16 _chainId, bytes calldata _bridgeAddress) external onlyOwner {
                require(bridgeLookup[_chainId].length == 0, "Stargate: Bridge already set!");
                bridgeLookup[_chainId] = _bridgeAddress;
            }
            function setGasAmount(
                uint16 _chainId,
                uint8 _functionType,
                uint256 _gasAmount
            ) external onlyOwner {
                require(_functionType >= 1 && _functionType <= 4, "Stargate: invalid _functionType");
                gasLookup[_chainId][_functionType] = _gasAmount;
            }
            function approveTokenSpender(
                address token,
                address spender,
                uint256 amount
            ) external onlyOwner {
                IERC20(token).approve(spender, amount);
            }
            function setUseLayerZeroToken(bool enable) external onlyOwner {
                useLayerZeroToken = enable;
            }
            function forceResumeReceive(uint16 _srcChainId, bytes calldata _srcAddress) external override onlyOwner {
                layerZeroEndpoint.forceResumeReceive(_srcChainId, _srcAddress);
            }
            //---------------------------------------------------------------------------
            // generic config for user Application
            function setConfig(
                uint16 _version,
                uint16 _chainId,
                uint256 _configType,
                bytes calldata _config
            ) external override onlyOwner {
                layerZeroEndpoint.setConfig(_version, _chainId, _configType, _config);
            }
            function setSendVersion(uint16 version) external override onlyOwner {
                layerZeroEndpoint.setSendVersion(version);
            }
            function setReceiveVersion(uint16 version) external override onlyOwner {
                layerZeroEndpoint.setReceiveVersion(version);
            }
            //---------------------------------------------------------------------------
            // INTERNAL functions
            function txParamBuilderType1(uint256 _gasAmount) internal pure returns (bytes memory) {
                uint16 txType = 1;
                return abi.encodePacked(txType, _gasAmount);
            }
            function txParamBuilderType2(
                uint256 _gasAmount,
                uint256 _dstNativeAmount,
                bytes memory _dstNativeAddr
            ) internal pure returns (bytes memory) {
                uint16 txType = 2;
                return abi.encodePacked(txType, _gasAmount, _dstNativeAmount, _dstNativeAddr);
            }
            function _txParamBuilder(
                uint16 _chainId,
                uint8 _type,
                IStargateRouter.lzTxObj memory _lzTxParams
            ) internal view returns (bytes memory) {
                bytes memory lzTxParam;
                address dstNativeAddr;
                {
                    bytes memory dstNativeAddrBytes = _lzTxParams.dstNativeAddr;
                    assembly {
                        dstNativeAddr := mload(add(dstNativeAddrBytes, 20))
                    }
                }
                uint256 totalGas = gasLookup[_chainId][_type].add(_lzTxParams.dstGasForCall);
                if (_lzTxParams.dstNativeAmount > 0 && dstNativeAddr != address(0x0)) {
                    lzTxParam = txParamBuilderType2(totalGas, _lzTxParams.dstNativeAmount, _lzTxParams.dstNativeAddr);
                } else {
                    lzTxParam = txParamBuilderType1(totalGas);
                }
                return lzTxParam;
            }
            function _call(
                uint16 _chainId,
                uint8 _type,
                address payable _refundAddress,
                IStargateRouter.lzTxObj memory _lzTxParams,
                bytes memory _payload
            ) internal {
                bytes memory lzTxParamBuilt = _txParamBuilder(_chainId, _type, _lzTxParams);
                uint64 nextNonce = layerZeroEndpoint.getOutboundNonce(_chainId, address(this)) + 1;
                layerZeroEndpoint.send{value: msg.value}(_chainId, bridgeLookup[_chainId], _payload, _refundAddress, address(this), lzTxParamBuilt);
                emit SendMsg(_type, nextNonce);
            }
            function renounceOwnership() public override onlyOwner {}
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        /**
         * @dev Interface of the ERC20 standard as defined in the EIP.
         */
        interface IERC20 {
            /**
             * @dev Returns the amount of tokens in existence.
             */
            function totalSupply() external view returns (uint256);
            /**
             * @dev Returns the amount of tokens owned by `account`.
             */
            function balanceOf(address account) external view returns (uint256);
            /**
             * @dev Moves `amount` tokens from the caller's account to `recipient`.
             *
             * Returns a boolean value indicating whether the operation succeeded.
             *
             * Emits a {Transfer} event.
             */
            function transfer(address recipient, uint256 amount) external returns (bool);
            /**
             * @dev Returns the remaining number of tokens that `spender` will be
             * allowed to spend on behalf of `owner` through {transferFrom}. This is
             * zero by default.
             *
             * This value changes when {approve} or {transferFrom} are called.
             */
            function allowance(address owner, address spender) external view returns (uint256);
            /**
             * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
             *
             * Returns a boolean value indicating whether the operation succeeded.
             *
             * IMPORTANT: Beware that changing an allowance with this method brings the risk
             * that someone may use both the old and the new allowance by unfortunate
             * transaction ordering. One possible solution to mitigate this race
             * condition is to first reduce the spender's allowance to 0 and set the
             * desired value afterwards:
             * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
             *
             * Emits an {Approval} event.
             */
            function approve(address spender, uint256 amount) external returns (bool);
            /**
             * @dev Moves `amount` tokens from `sender` to `recipient` using the
             * allowance mechanism. `amount` is then deducted from the caller's
             * allowance.
             *
             * Returns a boolean value indicating whether the operation succeeded.
             *
             * Emits a {Transfer} event.
             */
            function transferFrom(address sender, address recipient, uint256 amount) external returns (bool);
            /**
             * @dev Emitted when `value` tokens are moved from one account (`from`) to
             * another (`to`).
             *
             * Note that `value` may be zero.
             */
            event Transfer(address indexed from, address indexed to, uint256 value);
            /**
             * @dev Emitted when the allowance of a `spender` for an `owner` is set by
             * a call to {approve}. `value` is the new allowance.
             */
            event Approval(address indexed owner, address indexed spender, uint256 value);
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        pragma abicoder v2;
        interface IStargateRouter {
            struct lzTxObj {
                uint256 dstGasForCall;
                uint256 dstNativeAmount;
                bytes dstNativeAddr;
            }
            function addLiquidity(
                uint256 _poolId,
                uint256 _amountLD,
                address _to
            ) external;
            function swap(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLD,
                uint256 _minAmountLD,
                lzTxObj memory _lzTxParams,
                bytes calldata _to,
                bytes calldata _payload
            ) external payable;
            function redeemRemote(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLP,
                uint256 _minAmountLD,
                bytes calldata _to,
                lzTxObj memory _lzTxParams
            ) external payable;
            function instantRedeemLocal(
                uint16 _srcPoolId,
                uint256 _amountLP,
                address _to
            ) external returns (uint256);
            function redeemLocal(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress,
                uint256 _amountLP,
                bytes calldata _to,
                lzTxObj memory _lzTxParams
            ) external payable;
            function sendCredits(
                uint16 _dstChainId,
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                address payable _refundAddress
            ) external payable;
            function quoteLayerZeroFee(
                uint16 _dstChainId,
                uint8 _functionType,
                bytes calldata _toAddress,
                bytes calldata _transferAndCallPayload,
                lzTxObj memory _lzTxParams
            ) external view returns (uint256, uint256);
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        interface IStargateReceiver {
            function sgReceive(
                uint16 _chainId,
                bytes memory _srcAddress,
                uint256 _nonce,
                address _token,
                uint256 amountLD,
                bytes memory payload
            ) external;
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        /**
         * @dev Wrappers over Solidity's arithmetic operations with added overflow
         * checks.
         *
         * Arithmetic operations in Solidity wrap on overflow. This can easily result
         * in bugs, because programmers usually assume that an overflow raises an
         * error, which is the standard behavior in high level programming languages.
         * `SafeMath` restores this intuition by reverting the transaction when an
         * operation overflows.
         *
         * Using this library instead of the unchecked operations eliminates an entire
         * class of bugs, so it's recommended to use it always.
         */
        library SafeMath {
            /**
             * @dev Returns the addition of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                uint256 c = a + b;
                if (c < a) return (false, 0);
                return (true, c);
            }
            /**
             * @dev Returns the substraction of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b > a) return (false, 0);
                return (true, a - b);
            }
            /**
             * @dev Returns the multiplication of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                // Gas optimization: this is cheaper than requiring 'a' not being zero, but the
                // benefit is lost if 'b' is also tested.
                // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
                if (a == 0) return (true, 0);
                uint256 c = a * b;
                if (c / a != b) return (false, 0);
                return (true, c);
            }
            /**
             * @dev Returns the division of two unsigned integers, with a division by zero flag.
             *
             * _Available since v3.4._
             */
            function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b == 0) return (false, 0);
                return (true, a / b);
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
             *
             * _Available since v3.4._
             */
            function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b == 0) return (false, 0);
                return (true, a % b);
            }
            /**
             * @dev Returns the addition of two unsigned integers, reverting on
             * overflow.
             *
             * Counterpart to Solidity's `+` operator.
             *
             * Requirements:
             *
             * - Addition cannot overflow.
             */
            function add(uint256 a, uint256 b) internal pure returns (uint256) {
                uint256 c = a + b;
                require(c >= a, "SafeMath: addition overflow");
                return c;
            }
            /**
             * @dev Returns the subtraction of two unsigned integers, reverting on
             * overflow (when the result is negative).
             *
             * Counterpart to Solidity's `-` operator.
             *
             * Requirements:
             *
             * - Subtraction cannot overflow.
             */
            function sub(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b <= a, "SafeMath: subtraction overflow");
                return a - b;
            }
            /**
             * @dev Returns the multiplication of two unsigned integers, reverting on
             * overflow.
             *
             * Counterpart to Solidity's `*` operator.
             *
             * Requirements:
             *
             * - Multiplication cannot overflow.
             */
            function mul(uint256 a, uint256 b) internal pure returns (uint256) {
                if (a == 0) return 0;
                uint256 c = a * b;
                require(c / a == b, "SafeMath: multiplication overflow");
                return c;
            }
            /**
             * @dev Returns the integer division of two unsigned integers, reverting on
             * division by zero. The result is rounded towards zero.
             *
             * Counterpart to Solidity's `/` operator. Note: this function uses a
             * `revert` opcode (which leaves remaining gas untouched) while Solidity
             * uses an invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function div(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b > 0, "SafeMath: division by zero");
                return a / b;
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
             * reverting when dividing by zero.
             *
             * Counterpart to Solidity's `%` operator. This function uses a `revert`
             * opcode (which leaves remaining gas untouched) while Solidity uses an
             * invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function mod(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b > 0, "SafeMath: modulo by zero");
                return a % b;
            }
            /**
             * @dev Returns the subtraction of two unsigned integers, reverting with custom message on
             * overflow (when the result is negative).
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {trySub}.
             *
             * Counterpart to Solidity's `-` operator.
             *
             * Requirements:
             *
             * - Subtraction cannot overflow.
             */
            function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b <= a, errorMessage);
                return a - b;
            }
            /**
             * @dev Returns the integer division of two unsigned integers, reverting with custom message on
             * division by zero. The result is rounded towards zero.
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {tryDiv}.
             *
             * Counterpart to Solidity's `/` operator. Note: this function uses a
             * `revert` opcode (which leaves remaining gas untouched) while Solidity
             * uses an invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b > 0, errorMessage);
                return a / b;
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
             * reverting with custom message when dividing by zero.
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {tryMod}.
             *
             * Counterpart to Solidity's `%` operator. This function uses a `revert`
             * opcode (which leaves remaining gas untouched) while Solidity uses an
             * invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b > 0, errorMessage);
                return a % b;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity >=0.6.0 <0.8.0;
        /*
         * @dev Provides information about the current execution context, including the
         * sender of the transaction and its data. While these are generally available
         * via msg.sender and msg.data, they should not be accessed in such a direct
         * manner, since when dealing with GSN meta-transactions the account sending and
         * paying for execution may not be the actual sender (as far as an application
         * is concerned).
         *
         * This contract is only required for intermediate, library-like contracts.
         */
        abstract contract Context {
            function _msgSender() internal view virtual returns (address payable) {
                return msg.sender;
            }
            function _msgData() internal view virtual returns (bytes memory) {
                this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
                return msg.data;
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        // libraries
        import "@openzeppelin/contracts/math/SafeMath.sol";
        contract LPTokenERC20 {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // CONSTANTS
            string public name;
            string public symbol;
            bytes32 public constant PERMIT_TYPEHASH = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9;
            // set in constructor
            bytes32 public DOMAIN_SEPARATOR;
            //---------------------------------------------------------------------------
            // VARIABLES
            uint256 public decimals;
            uint256 public totalSupply;
            mapping(address => uint256) public balanceOf;
            mapping(address => mapping(address => uint256)) public allowance;
            mapping(address => uint256) public nonces;
            //---------------------------------------------------------------------------
            // EVENTS
            event Approval(address indexed owner, address indexed spender, uint256 value);
            event Transfer(address indexed from, address indexed to, uint256 value);
            constructor(string memory _name, string memory _symbol) {
                name = _name;
                symbol = _symbol;
                uint256 chainId;
                assembly {
                    chainId := chainid()
                }
                DOMAIN_SEPARATOR = keccak256(
                    abi.encode(
                        keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"),
                        keccak256(bytes(name)),
                        keccak256(bytes("1")),
                        chainId,
                        address(this)
                    )
                );
            }
            function _mint(address to, uint256 value) internal {
                totalSupply = totalSupply.add(value);
                balanceOf[to] = balanceOf[to].add(value);
                emit Transfer(address(0), to, value);
            }
            function _burn(address from, uint256 value) internal {
                balanceOf[from] = balanceOf[from].sub(value);
                totalSupply = totalSupply.sub(value);
                emit Transfer(from, address(0), value);
            }
            function _approve(
                address owner,
                address spender,
                uint256 value
            ) private {
                allowance[owner][spender] = value;
                emit Approval(owner, spender, value);
            }
            function _transfer(
                address from,
                address to,
                uint256 value
            ) private {
                balanceOf[from] = balanceOf[from].sub(value);
                balanceOf[to] = balanceOf[to].add(value);
                emit Transfer(from, to, value);
            }
            function approve(address spender, uint256 value) external returns (bool) {
                _approve(msg.sender, spender, value);
                return true;
            }
            function transfer(address to, uint256 value) external returns (bool) {
                _transfer(msg.sender, to, value);
                return true;
            }
            function transferFrom(
                address from,
                address to,
                uint256 value
            ) external returns (bool) {
                if (allowance[from][msg.sender] != uint256(-1)) {
                    allowance[from][msg.sender] = allowance[from][msg.sender].sub(value);
                }
                _transfer(from, to, value);
                return true;
            }
            function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
                _approve(msg.sender, spender, allowance[msg.sender][spender].add(addedValue));
                return true;
            }
            function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
                _approve(msg.sender, spender, allowance[msg.sender][spender].sub(subtractedValue, "ERC20: decreased allowance below zero"));
                return true;
            }
            function permit(
                address owner,
                address spender,
                uint256 value,
                uint256 deadline,
                uint8 v,
                bytes32 r,
                bytes32 s
            ) external {
                require(deadline >= block.timestamp, "Bridge: EXPIRED");
                bytes32 digest = keccak256(
                    abi.encodePacked(
                        "\\x19\\x01",
                        DOMAIN_SEPARATOR,
                        keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline))
                    )
                );
                address recoveredAddress = ecrecover(digest, v, r, s);
                require(recoveredAddress != address(0) && recoveredAddress == owner, "Bridge: INVALID_SIGNATURE");
                _approve(owner, spender, value);
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity ^0.7.6;
        pragma abicoder v2;
        import "../Pool.sol";
        interface IStargateFeeLibrary {
            function getFees(
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                uint16 _dstChainId,
                address _from,
                uint256 _amountSD
            ) external returns (Pool.SwapObj memory s);
            function getVersion() external view returns (string memory);
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity >=0.5.0;
        interface ILayerZeroReceiver {
            // @notice LayerZero endpoint will invoke this function to deliver the message on the destination
            // @param _srcChainId - the source endpoint identifier
            // @param _srcAddress - the source sending contract address from the source chain
            // @param _nonce - the ordered message nonce
            // @param _payload - the signed payload is the UA bytes has encoded to be sent
            function lzReceive(uint16 _srcChainId, bytes calldata _srcAddress, uint64 _nonce, bytes calldata _payload) external;
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity >=0.5.0;
        import "./ILayerZeroUserApplicationConfig.sol";
        interface ILayerZeroEndpoint is ILayerZeroUserApplicationConfig {
            // @notice send a LayerZero message to the specified address at a LayerZero endpoint.
            // @param _dstChainId - the destination chain identifier
            // @param _destination - the address on destination chain (in bytes). address length/format may vary by chains
            // @param _payload - a custom bytes payload to send to the destination contract
            // @param _refundAddress - if the source transaction is cheaper than the amount of value passed, refund the additional amount to this address
            // @param _zroPaymentAddress - the address of the ZRO token holder who would pay for the transaction
            // @param _adapterParams - parameters for custom functionality. ie: pay for a specified destination gasAmount, or receive airdropped native gas from the relayer on destination
            function send(uint16 _dstChainId, bytes calldata _destination, bytes calldata _payload, address payable _refundAddress, address _zroPaymentAddress, bytes calldata _adapterParams) external payable;
            // @notice used by the messaging library to publish verified payload
            // @param _srcChainId - the source chain identifier
            // @param _srcAddress - the source contract (as bytes) at the source chain
            // @param _dstAddress - the address on destination chain
            // @param _nonce - the unbound message ordering nonce
            // @param _gasLimit - the gas limit for external contract execution
            // @param _payload - verified payload to send to the destination contract
            function receivePayload(uint16 _srcChainId, bytes calldata _srcAddress, address _dstAddress, uint64 _nonce, uint _gasLimit, bytes calldata _payload) external;
            // @notice get the inboundNonce of a receiver from a source chain which could be EVM or non-EVM chain
            // @param _srcChainId - the source chain identifier
            // @param _srcAddress - the source chain contract address
            function getInboundNonce(uint16 _srcChainId, bytes calldata _srcAddress) external view returns (uint64);
            // @notice get the outboundNonce from this source chain which, consequently, is always an EVM
            // @param _srcAddress - the source chain contract address
            function getOutboundNonce(uint16 _dstChainId, address _srcAddress) external view returns (uint64);
            // @notice gets a quote in source native gas, for the amount that send() requires to pay for message delivery
            // @param _dstChainId - the destination chain identifier
            // @param _userApplication - the user app address on this EVM chain
            // @param _payload - the custom message to send over LayerZero
            // @param _payInZRO - if false, user app pays the protocol fee in native token
            // @param _adapterParam - parameters for the adapter service, e.g. send some dust native token to dstChain
            function estimateFees(uint16 _dstChainId, address _userApplication, bytes calldata _payload, bool _payInZRO, bytes calldata _adapterParam) external view returns (uint nativeFee, uint zroFee);
            // @notice get this Endpoint's immutable source identifier
            function getChainId() external view returns (uint16);
            // @notice the interface to retry failed message on this Endpoint destination
            // @param _srcChainId - the source chain identifier
            // @param _srcAddress - the source chain contract address
            // @param _payload - the payload to be retried
            function retryPayload(uint16 _srcChainId, bytes calldata _srcAddress, bytes calldata _payload) external;
            // @notice query if any STORED payload (message blocking) at the endpoint.
            // @param _srcChainId - the source chain identifier
            // @param _srcAddress - the source chain contract address
            function hasStoredPayload(uint16 _srcChainId, bytes calldata _srcAddress) external view returns (bool);
            // @notice query if the _libraryAddress is valid for sending msgs.
            // @param _userApplication - the user app address on this EVM chain
            function getSendLibraryAddress(address _userApplication) external view returns (address);
            // @notice query if the _libraryAddress is valid for receiving msgs.
            // @param _userApplication - the user app address on this EVM chain
            function getReceiveLibraryAddress(address _userApplication) external view returns (address);
            // @notice query if the non-reentrancy guard for send() is on
            // @return true if the guard is on. false otherwise
            function isSendingPayload() external view returns (bool);
            // @notice query if the non-reentrancy guard for receive() is on
            // @return true if the guard is on. false otherwise
            function isReceivingPayload() external view returns (bool);
            // @notice get the configuration of the LayerZero messaging library of the specified version
            // @param _version - messaging library version
            // @param _chainId - the chainId for the pending config change
            // @param _userApplication - the contract address of the user application
            // @param _configType - type of configuration. every messaging library has its own convention.
            function getConfig(uint16 _version, uint16 _chainId, address _userApplication, uint _configType) external view returns (bytes memory);
            // @notice get the send() LayerZero messaging library version
            // @param _userApplication - the contract address of the user application
            function getSendVersion(address _userApplication) external view returns (uint16);
            // @notice get the lzReceive() LayerZero messaging library version
            // @param _userApplication - the contract address of the user application
            function getReceiveVersion(address _userApplication) external view returns (uint16);
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity >=0.5.0;
        interface ILayerZeroUserApplicationConfig {
            // @notice set the configuration of the LayerZero messaging library of the specified version
            // @param _version - messaging library version
            // @param _chainId - the chainId for the pending config change
            // @param _configType - type of configuration. every messaging library has its own convention.
            // @param _config - configuration in the bytes. can encode arbitrary content.
            function setConfig(uint16 _version, uint16 _chainId, uint _configType, bytes calldata _config) external;
            // @notice set the send() LayerZero messaging library version to _version
            // @param _version - new messaging library version
            function setSendVersion(uint16 _version) external;
            // @notice set the lzReceive() LayerZero messaging library version to _version
            // @param _version - new messaging library version
            function setReceiveVersion(uint16 _version) external;
            // @notice Only when the UA needs to resume the message flow in blocking mode and clear the stored payload
            // @param _srcChainId - the chainId of the source chain
            // @param _srcAddress - the contract address of the source contract at the source chain
            function forceResumeReceive(uint16 _srcChainId, bytes calldata _srcAddress) external;
        }
        

        File 5 of 6: Factory
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        pragma abicoder v2;
        import "@openzeppelin/contracts/math/SafeMath.sol";
        import "@openzeppelin/contracts/access/Ownable.sol";
        import "./Pool.sol";
        contract Factory is Ownable {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // VARIABLES
            mapping(uint256 => Pool) public getPool; // poolId -> PoolInfo
            address[] public allPools;
            address public immutable router;
            address public defaultFeeLibrary; // address for retrieving fee params for swaps
            //---------------------------------------------------------------------------
            // MODIFIERS
            modifier onlyRouter() {
                require(msg.sender == router, "Stargate: caller must be Router.");
                _;
            }
            constructor(address _router) {
                require(_router != address(0x0), "Stargate: _router cant be 0x0"); // 1 time only
                router = _router;
            }
            function setDefaultFeeLibrary(address _defaultFeeLibrary) external onlyOwner {
                require(_defaultFeeLibrary != address(0x0), "Stargate: fee library cant be 0x0");
                defaultFeeLibrary = _defaultFeeLibrary;
            }
            function allPoolsLength() external view returns (uint256) {
                return allPools.length;
            }
            function createPool(
                uint256 _poolId,
                address _token,
                uint8 _sharedDecimals,
                uint8 _localDecimals,
                string memory _name,
                string memory _symbol
            ) public onlyRouter returns (address poolAddress) {
                require(address(getPool[_poolId]) == address(0x0), "Stargate: Pool already created");
                Pool pool = new Pool(_poolId, router, _token, _sharedDecimals, _localDecimals, defaultFeeLibrary, _name, _symbol);
                getPool[_poolId] = pool;
                poolAddress = address(pool);
                allPools.push(poolAddress);
            }
            function renounceOwnership() public override onlyOwner {}
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        /**
         * @dev Wrappers over Solidity's arithmetic operations with added overflow
         * checks.
         *
         * Arithmetic operations in Solidity wrap on overflow. This can easily result
         * in bugs, because programmers usually assume that an overflow raises an
         * error, which is the standard behavior in high level programming languages.
         * `SafeMath` restores this intuition by reverting the transaction when an
         * operation overflows.
         *
         * Using this library instead of the unchecked operations eliminates an entire
         * class of bugs, so it's recommended to use it always.
         */
        library SafeMath {
            /**
             * @dev Returns the addition of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                uint256 c = a + b;
                if (c < a) return (false, 0);
                return (true, c);
            }
            /**
             * @dev Returns the substraction of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b > a) return (false, 0);
                return (true, a - b);
            }
            /**
             * @dev Returns the multiplication of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                // Gas optimization: this is cheaper than requiring 'a' not being zero, but the
                // benefit is lost if 'b' is also tested.
                // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
                if (a == 0) return (true, 0);
                uint256 c = a * b;
                if (c / a != b) return (false, 0);
                return (true, c);
            }
            /**
             * @dev Returns the division of two unsigned integers, with a division by zero flag.
             *
             * _Available since v3.4._
             */
            function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b == 0) return (false, 0);
                return (true, a / b);
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
             *
             * _Available since v3.4._
             */
            function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b == 0) return (false, 0);
                return (true, a % b);
            }
            /**
             * @dev Returns the addition of two unsigned integers, reverting on
             * overflow.
             *
             * Counterpart to Solidity's `+` operator.
             *
             * Requirements:
             *
             * - Addition cannot overflow.
             */
            function add(uint256 a, uint256 b) internal pure returns (uint256) {
                uint256 c = a + b;
                require(c >= a, "SafeMath: addition overflow");
                return c;
            }
            /**
             * @dev Returns the subtraction of two unsigned integers, reverting on
             * overflow (when the result is negative).
             *
             * Counterpart to Solidity's `-` operator.
             *
             * Requirements:
             *
             * - Subtraction cannot overflow.
             */
            function sub(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b <= a, "SafeMath: subtraction overflow");
                return a - b;
            }
            /**
             * @dev Returns the multiplication of two unsigned integers, reverting on
             * overflow.
             *
             * Counterpart to Solidity's `*` operator.
             *
             * Requirements:
             *
             * - Multiplication cannot overflow.
             */
            function mul(uint256 a, uint256 b) internal pure returns (uint256) {
                if (a == 0) return 0;
                uint256 c = a * b;
                require(c / a == b, "SafeMath: multiplication overflow");
                return c;
            }
            /**
             * @dev Returns the integer division of two unsigned integers, reverting on
             * division by zero. The result is rounded towards zero.
             *
             * Counterpart to Solidity's `/` operator. Note: this function uses a
             * `revert` opcode (which leaves remaining gas untouched) while Solidity
             * uses an invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function div(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b > 0, "SafeMath: division by zero");
                return a / b;
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
             * reverting when dividing by zero.
             *
             * Counterpart to Solidity's `%` operator. This function uses a `revert`
             * opcode (which leaves remaining gas untouched) while Solidity uses an
             * invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function mod(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b > 0, "SafeMath: modulo by zero");
                return a % b;
            }
            /**
             * @dev Returns the subtraction of two unsigned integers, reverting with custom message on
             * overflow (when the result is negative).
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {trySub}.
             *
             * Counterpart to Solidity's `-` operator.
             *
             * Requirements:
             *
             * - Subtraction cannot overflow.
             */
            function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b <= a, errorMessage);
                return a - b;
            }
            /**
             * @dev Returns the integer division of two unsigned integers, reverting with custom message on
             * division by zero. The result is rounded towards zero.
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {tryDiv}.
             *
             * Counterpart to Solidity's `/` operator. Note: this function uses a
             * `revert` opcode (which leaves remaining gas untouched) while Solidity
             * uses an invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b > 0, errorMessage);
                return a / b;
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
             * reverting with custom message when dividing by zero.
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {tryMod}.
             *
             * Counterpart to Solidity's `%` operator. This function uses a `revert`
             * opcode (which leaves remaining gas untouched) while Solidity uses an
             * invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b > 0, errorMessage);
                return a % b;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        import "../utils/Context.sol";
        /**
         * @dev Contract module which provides a basic access control mechanism, where
         * there is an account (an owner) that can be granted exclusive access to
         * specific functions.
         *
         * By default, the owner account will be the one that deploys the contract. This
         * can later be changed with {transferOwnership}.
         *
         * This module is used through inheritance. It will make available the modifier
         * `onlyOwner`, which can be applied to your functions to restrict their use to
         * the owner.
         */
        abstract contract Ownable is Context {
            address private _owner;
            event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
            /**
             * @dev Initializes the contract setting the deployer as the initial owner.
             */
            constructor () {
                address msgSender = _msgSender();
                _owner = msgSender;
                emit OwnershipTransferred(address(0), msgSender);
            }
            /**
             * @dev Returns the address of the current owner.
             */
            function owner() public view virtual returns (address) {
                return _owner;
            }
            /**
             * @dev Throws if called by any account other than the owner.
             */
            modifier onlyOwner() {
                require(owner() == _msgSender(), "Ownable: caller is not the owner");
                _;
            }
            /**
             * @dev Leaves the contract without owner. It will not be possible to call
             * `onlyOwner` functions anymore. Can only be called by the current owner.
             *
             * NOTE: Renouncing ownership will leave the contract without an owner,
             * thereby removing any functionality that is only available to the owner.
             */
            function renounceOwnership() public virtual onlyOwner {
                emit OwnershipTransferred(_owner, address(0));
                _owner = address(0);
            }
            /**
             * @dev Transfers ownership of the contract to a new account (`newOwner`).
             * Can only be called by the current owner.
             */
            function transferOwnership(address newOwner) public virtual onlyOwner {
                require(newOwner != address(0), "Ownable: new owner is the zero address");
                emit OwnershipTransferred(_owner, newOwner);
                _owner = newOwner;
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        pragma abicoder v2;
        // imports
        import "@openzeppelin/contracts/access/Ownable.sol";
        import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
        import "./LPTokenERC20.sol";
        import "./interfaces/IStargateFeeLibrary.sol";
        // libraries
        import "@openzeppelin/contracts/math/SafeMath.sol";
        /// Pool contracts on other chains and managed by the Stargate protocol.
        contract Pool is LPTokenERC20, ReentrancyGuard {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // CONSTANTS
            bytes4 private constant SELECTOR = bytes4(keccak256(bytes("transfer(address,uint256)")));
            uint256 public constant BP_DENOMINATOR = 10000;
            //---------------------------------------------------------------------------
            // STRUCTS
            struct ChainPath {
                bool ready; // indicate if the counter chainPath has been created.
                uint16 dstChainId;
                uint256 dstPoolId;
                uint256 weight;
                uint256 balance;
                uint256 lkb;
                uint256 credits;
                uint256 idealBalance;
            }
            struct SwapObj {
                uint256 amount;
                uint256 eqFee;
                uint256 eqReward;
                uint256 lpFee;
                uint256 protocolFee;
                uint256 lkbRemove;
            }
            struct CreditObj {
                uint256 credits;
                uint256 idealBalance;
            }
            //---------------------------------------------------------------------------
            // VARIABLES
            // chainPath
            ChainPath[] public chainPaths; // list of connected chains with shared pools
            mapping(uint16 => mapping(uint256 => uint256)) public chainPathIndexLookup; // lookup for chainPath by chainId => poolId =>index
            // metadata
            uint256 public immutable poolId; // shared id between chains to represent same pool
            uint256 public sharedDecimals; // the shared decimals (lowest common decimals between chains)
            uint256 public localDecimals; // the decimals for the token
            uint256 public immutable convertRate; // the decimals for the token
            address public immutable token; // the token for the pool
            address public immutable router; // the token for the pool
            bool public stopSwap; // flag to stop swapping in extreme cases
            // Fee and Liquidity
            uint256 public totalLiquidity; // the total amount of tokens added on this side of the chain (fees + deposits - withdrawals)
            uint256 public totalWeight; // total weight for pool percentages
            uint256 public mintFeeBP; // fee basis points for the mint/deposit
            uint256 public protocolFeeBalance; // fee balance created from dao fee
            uint256 public mintFeeBalance; // fee balance created from mint fee
            uint256 public eqFeePool; // pool rewards in Shared Decimal format. indicate the total budget for reverse swap incentive
            address public feeLibrary; // address for retrieving fee params for swaps
            // Delta related
            uint256 public deltaCredit; // credits accumulated from txn
            bool public batched; // flag to indicate if we want batch processing.
            bool public defaultSwapMode; // flag for the default mode for swap
            bool public defaultLPMode; // flag for the default mode for lp
            uint256 public swapDeltaBP; // basis points of poolCredits to activate Delta in swap
            uint256 public lpDeltaBP; // basis points of poolCredits to activate Delta in liquidity events
            //---------------------------------------------------------------------------
            // EVENTS
            event Mint(address to, uint256 amountLP, uint256 amountSD, uint256 mintFeeAmountSD);
            event Burn(address from, uint256 amountLP, uint256 amountSD);
            event RedeemLocalCallback(address _to, uint256 _amountSD, uint256 _amountToMintSD);
            event Swap(
                uint16 chainId,
                uint256 dstPoolId,
                address from,
                uint256 amountSD,
                uint256 eqReward,
                uint256 eqFee,
                uint256 protocolFee,
                uint256 lpFee
            );
            event SendCredits(uint16 dstChainId, uint256 dstPoolId, uint256 credits, uint256 idealBalance);
            event RedeemRemote(uint16 chainId, uint256 dstPoolId, address from, uint256 amountLP, uint256 amountSD);
            event RedeemLocal(address from, uint256 amountLP, uint256 amountSD, uint16 chainId, uint256 dstPoolId, bytes to);
            event InstantRedeemLocal(address from, uint256 amountLP, uint256 amountSD, address to);
            event CreditChainPath(uint16 chainId, uint256 srcPoolId, uint256 amountSD, uint256 idealBalance);
            event SwapRemote(address to, uint256 amountSD, uint256 protocolFee, uint256 dstFee);
            event WithdrawRemote(uint16 srcChainId, uint256 srcPoolId, uint256 swapAmount, uint256 mintAmount);
            event ChainPathUpdate(uint16 dstChainId, uint256 dstPoolId, uint256 weight);
            event FeesUpdated(uint256 mintFeeBP);
            event FeeLibraryUpdated(address feeLibraryAddr);
            event StopSwapUpdated(bool swapStop);
            event WithdrawProtocolFeeBalance(address to, uint256 amountSD);
            event WithdrawMintFeeBalance(address to, uint256 amountSD);
            event DeltaParamUpdated(bool batched, uint256 swapDeltaBP, uint256 lpDeltaBP, bool defaultSwapMode, bool defaultLPMode);
            //---------------------------------------------------------------------------
            // MODIFIERS
            modifier onlyRouter() {
                require(msg.sender == router, "Stargate: only the router can call this method");
                _;
            }
            constructor(
                uint256 _poolId,
                address _router,
                address _token,
                uint256 _sharedDecimals,
                uint256 _localDecimals,
                address _feeLibrary,
                string memory _name,
                string memory _symbol
            ) LPTokenERC20(_name, _symbol) {
                require(_token != address(0x0), "Stargate: _token cannot be 0x0");
                require(_router != address(0x0), "Stargate: _router cannot be 0x0");
                poolId = _poolId;
                router = _router;
                token = _token;
                sharedDecimals = _sharedDecimals;
                decimals = uint8(_sharedDecimals);
                localDecimals = _localDecimals;
                convertRate = 10**(uint256(localDecimals).sub(sharedDecimals));
                totalWeight = 0;
                feeLibrary = _feeLibrary;
                //delta algo related
                batched = false;
                defaultSwapMode = true;
                defaultLPMode = true;
            }
            function getChainPathsLength() public view returns (uint256) {
                return chainPaths.length;
            }
            //---------------------------------------------------------------------------
            // LOCAL CHAIN FUNCTIONS
            function mint(address _to, uint256 _amountLD) external nonReentrant onlyRouter returns (uint256) {
                return _mintLocal(_to, _amountLD, true, true);
            }
            // Local                                    Remote
            // -------                                  ---------
            // swap             ->                      swapRemote
            function swap(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                address _from,
                uint256 _amountLD,
                uint256 _minAmountLD,
                bool newLiquidity
            ) external nonReentrant onlyRouter returns (SwapObj memory) {
                require(!stopSwap, "Stargate: swap func stopped");
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == true, "Stargate: counter chainPath is not ready");
                uint256 amountSD = amountLDtoSD(_amountLD);
                uint256 minAmountSD = amountLDtoSD(_minAmountLD);
                // request fee params from library
                SwapObj memory s = IStargateFeeLibrary(feeLibrary).getFees(poolId, _dstPoolId, _dstChainId, _from, amountSD);
                // equilibrium fee and reward. note eqFee/eqReward are separated from swap liquidity
                eqFeePool = eqFeePool.sub(s.eqReward);
                // update the new amount the user gets minus the fees
                s.amount = amountSD.sub(s.eqFee).sub(s.protocolFee).sub(s.lpFee);
                // users will also get the eqReward
                require(s.amount.add(s.eqReward) >= minAmountSD, "Stargate: slippage too high");
                // behaviours
                //     - protocolFee: booked, stayed and withdrawn at remote.
                //     - eqFee: booked, stayed and withdrawn at remote.
                //     - lpFee: booked and stayed at remote, can be withdrawn anywhere
                s.lkbRemove = amountSD.sub(s.lpFee).add(s.eqReward);
                // check for transfer solvency.
                require(cp.balance >= s.lkbRemove, "Stargate: dst balance too low");
                cp.balance = cp.balance.sub(s.lkbRemove);
                if (newLiquidity) {
                    deltaCredit = deltaCredit.add(amountSD).add(s.eqReward);
                } else if (s.eqReward > 0) {
                    deltaCredit = deltaCredit.add(s.eqReward);
                }
                // distribute credits on condition.
                if (!batched || deltaCredit >= totalLiquidity.mul(swapDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultSwapMode);
                }
                emit Swap(_dstChainId, _dstPoolId, _from, s.amount, s.eqReward, s.eqFee, s.protocolFee, s.lpFee);
                return s;
            }
            // Local                                    Remote
            // -------                                  ---------
            // sendCredits      ->                      creditChainPath
            function sendCredits(uint16 _dstChainId, uint256 _dstPoolId) external nonReentrant onlyRouter returns (CreditObj memory c) {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == true, "Stargate: counter chainPath is not ready");
                cp.lkb = cp.lkb.add(cp.credits);
                c.idealBalance = totalLiquidity.mul(cp.weight).div(totalWeight);
                c.credits = cp.credits;
                cp.credits = 0;
                emit SendCredits(_dstChainId, _dstPoolId, c.credits, c.idealBalance);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemRemote   ->                        swapRemote
            function redeemRemote(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                address _from,
                uint256 _amountLP
            ) external nonReentrant onlyRouter {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                uint256 amountSD = _burnLocal(_from, _amountLP);
                //run Delta
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultLPMode);
                }
                uint256 amountLD = amountSDtoLD(amountSD);
                emit RedeemRemote(_dstChainId, _dstPoolId, _from, _amountLP, amountLD);
            }
            function instantRedeemLocal(
                address _from,
                uint256 _amountLP,
                address _to
            ) external nonReentrant onlyRouter returns (uint256 amountSD) {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                uint256 _deltaCredit = deltaCredit; // sload optimization.
                uint256 _capAmountLP = _amountSDtoLP(_deltaCredit);
                if (_amountLP > _capAmountLP) _amountLP = _capAmountLP;
                amountSD = _burnLocal(_from, _amountLP);
                deltaCredit = _deltaCredit.sub(amountSD);
                uint256 amountLD = amountSDtoLD(amountSD);
                _safeTransfer(token, _to, amountLD);
                emit InstantRedeemLocal(_from, _amountLP, amountSD, _to);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal   ->                         redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocal(
                address _from,
                uint256 _amountLP,
                uint16 _dstChainId,
                uint256 _dstPoolId,
                bytes calldata _to
            ) external nonReentrant onlyRouter returns (uint256 amountSD) {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                // safeguard.
                require(chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]].ready == true, "Stargate: counter chainPath is not ready");
                amountSD = _burnLocal(_from, _amountLP);
                // run Delta
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(false);
                }
                emit RedeemLocal(_from, _amountLP, amountSD, _dstChainId, _dstPoolId, _to);
            }
            //---------------------------------------------------------------------------
            // REMOTE CHAIN FUNCTIONS
            // Local                                    Remote
            // -------                                  ---------
            // sendCredits      ->                      creditChainPath
            function creditChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                CreditObj memory _c
            ) external nonReentrant onlyRouter {
                ChainPath storage cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                cp.balance = cp.balance.add(_c.credits);
                if (cp.idealBalance != _c.idealBalance) {
                    cp.idealBalance = _c.idealBalance;
                }
                emit CreditChainPath(_dstChainId, _dstPoolId, _c.credits, _c.idealBalance);
            }
            // Local                                    Remote
            // -------                                  ---------
            // swap             ->                      swapRemote
            function swapRemote(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                address _to,
                SwapObj memory _s
            ) external nonReentrant onlyRouter returns (uint256 amountLD) {
                // booking lpFee
                totalLiquidity = totalLiquidity.add(_s.lpFee);
                // booking eqFee
                eqFeePool = eqFeePool.add(_s.eqFee);
                // booking stargateFee
                protocolFeeBalance = protocolFeeBalance.add(_s.protocolFee);
                // update LKB
                uint256 chainPathIndex = chainPathIndexLookup[_srcChainId][_srcPoolId];
                chainPaths[chainPathIndex].lkb = chainPaths[chainPathIndex].lkb.sub(_s.lkbRemove);
                // user receives the amount + the srcReward
                amountLD = amountSDtoLD(_s.amount.add(_s.eqReward));
                _safeTransfer(token, _to, amountLD);
                emit SwapRemote(_to, _s.amount.add(_s.eqReward), _s.protocolFee, _s.eqFee);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal   ->                         redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocalCallback(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                address _to,
                uint256 _amountSD,
                uint256 _amountToMintSD
            ) external nonReentrant onlyRouter {
                if (_amountToMintSD > 0) {
                    _mintLocal(_to, amountSDtoLD(_amountToMintSD), false, false);
                }
                ChainPath storage cp = getAndCheckCP(_srcChainId, _srcPoolId);
                cp.lkb = cp.lkb.sub(_amountSD);
                uint256 amountLD = amountSDtoLD(_amountSD);
                _safeTransfer(token, _to, amountLD);
                emit RedeemLocalCallback(_to, _amountSD, _amountToMintSD);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal(amount)   ->               redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocalCheckOnRemote(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                uint256 _amountSD
            ) external nonReentrant onlyRouter returns (uint256 swapAmount, uint256 mintAmount) {
                ChainPath storage cp = getAndCheckCP(_srcChainId, _srcPoolId);
                if (_amountSD > cp.balance) {
                    mintAmount = _amountSD - cp.balance;
                    swapAmount = cp.balance;
                    cp.balance = 0;
                } else {
                    cp.balance = cp.balance.sub(_amountSD);
                    swapAmount = _amountSD;
                    mintAmount = 0;
                }
                emit WithdrawRemote(_srcChainId, _srcPoolId, swapAmount, mintAmount);
            }
            //---------------------------------------------------------------------------
            // DAO Calls
            function createChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint256 _weight
            ) external onlyRouter {
                for (uint256 i = 0; i < chainPaths.length; ++i) {
                    ChainPath memory cp = chainPaths[i];
                    bool exists = cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId;
                    require(!exists, "Stargate: cant createChainPath of existing dstChainId and _dstPoolId");
                }
                totalWeight = totalWeight.add(_weight);
                chainPathIndexLookup[_dstChainId][_dstPoolId] = chainPaths.length;
                chainPaths.push(ChainPath(false, _dstChainId, _dstPoolId, _weight, 0, 0, 0, 0));
                emit ChainPathUpdate(_dstChainId, _dstPoolId, _weight);
            }
            function setWeightForChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint16 _weight
            ) external onlyRouter {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                totalWeight = totalWeight.sub(cp.weight).add(_weight);
                cp.weight = _weight;
                emit ChainPathUpdate(_dstChainId, _dstPoolId, _weight);
            }
            function setFee(uint256 _mintFeeBP) external onlyRouter {
                require(_mintFeeBP <= BP_DENOMINATOR, "Bridge: cum fees > 100%");
                mintFeeBP = _mintFeeBP;
                emit FeesUpdated(mintFeeBP);
            }
            function setFeeLibrary(address _feeLibraryAddr) external onlyRouter {
                require(_feeLibraryAddr != address(0x0), "Stargate: fee library cant be 0x0");
                feeLibrary = _feeLibraryAddr;
                emit FeeLibraryUpdated(_feeLibraryAddr);
            }
            function setSwapStop(bool _swapStop) external onlyRouter {
                stopSwap = _swapStop;
                emit StopSwapUpdated(_swapStop);
            }
            function setDeltaParam(
                bool _batched,
                uint256 _swapDeltaBP,
                uint256 _lpDeltaBP,
                bool _defaultSwapMode,
                bool _defaultLPMode
            ) external onlyRouter {
                require(_swapDeltaBP <= BP_DENOMINATOR && _lpDeltaBP <= BP_DENOMINATOR, "Stargate: wrong Delta param");
                batched = _batched;
                swapDeltaBP = _swapDeltaBP;
                lpDeltaBP = _lpDeltaBP;
                defaultSwapMode = _defaultSwapMode;
                defaultLPMode = _defaultLPMode;
                emit DeltaParamUpdated(_batched, _swapDeltaBP, _lpDeltaBP, _defaultSwapMode, _defaultLPMode);
            }
            function callDelta(bool _fullMode) external onlyRouter {
                _delta(_fullMode);
            }
            function activateChainPath(uint16 _dstChainId, uint256 _dstPoolId) external onlyRouter {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == false, "Stargate: chainPath is already active");
                // this func will only be called once
                cp.ready = true;
            }
            function withdrawProtocolFeeBalance(address _to) external onlyRouter {
                if (protocolFeeBalance > 0) {
                    uint256 amountOfLD = amountSDtoLD(protocolFeeBalance);
                    protocolFeeBalance = 0;
                    _safeTransfer(token, _to, amountOfLD);
                    emit WithdrawProtocolFeeBalance(_to, amountOfLD);
                }
            }
            function withdrawMintFeeBalance(address _to) external onlyRouter {
                if (mintFeeBalance > 0) {
                    uint256 amountOfLD = amountSDtoLD(mintFeeBalance);
                    mintFeeBalance = 0;
                    _safeTransfer(token, _to, amountOfLD);
                    emit WithdrawMintFeeBalance(_to, amountOfLD);
                }
            }
            //---------------------------------------------------------------------------
            // INTERNAL
            // Conversion Helpers
            //---------------------------------------------------------------------------
            function amountLPtoLD(uint256 _amountLP) external view returns (uint256) {
                return amountSDtoLD(_amountLPtoSD(_amountLP));
            }
            function _amountLPtoSD(uint256 _amountLP) internal view returns (uint256) {
                require(totalSupply > 0, "Stargate: cant convert LPtoSD when totalSupply == 0");
                return _amountLP.mul(totalLiquidity).div(totalSupply);
            }
            function _amountSDtoLP(uint256 _amountSD) internal view returns (uint256) {
                require(totalLiquidity > 0, "Stargate: cant convert SDtoLP when totalLiq == 0");
                return _amountSD.mul(totalSupply).div(totalLiquidity);
            }
            function amountSDtoLD(uint256 _amount) internal view returns (uint256) {
                return _amount.mul(convertRate);
            }
            function amountLDtoSD(uint256 _amount) internal view returns (uint256) {
                return _amount.div(convertRate);
            }
            function getAndCheckCP(uint16 _dstChainId, uint256 _dstPoolId) internal view returns (ChainPath storage) {
                require(chainPaths.length > 0, "Stargate: no chainpaths exist");
                ChainPath storage cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                require(cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId, "Stargate: local chainPath does not exist");
                return cp;
            }
            function getChainPath(uint16 _dstChainId, uint256 _dstPoolId) external view returns (ChainPath memory) {
                ChainPath memory cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                require(cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId, "Stargate: local chainPath does not exist");
                return cp;
            }
            function _burnLocal(address _from, uint256 _amountLP) internal returns (uint256) {
                require(totalSupply > 0, "Stargate: cant burn when totalSupply == 0");
                uint256 amountOfLPTokens = balanceOf[_from];
                require(amountOfLPTokens >= _amountLP, "Stargate: not enough LP tokens to burn");
                uint256 amountSD = _amountLP.mul(totalLiquidity).div(totalSupply);
                //subtract totalLiquidity accordingly
                totalLiquidity = totalLiquidity.sub(amountSD);
                _burn(_from, _amountLP);
                emit Burn(_from, _amountLP, amountSD);
                return amountSD;
            }
            function _delta(bool fullMode) internal {
                if (deltaCredit > 0 && totalWeight > 0) {
                    uint256 cpLength = chainPaths.length;
                    uint256[] memory deficit = new uint256[](cpLength);
                    uint256 totalDeficit = 0;
                    // algorithm steps 6-9: calculate the total and the amounts required to get to balance state
                    for (uint256 i = 0; i < cpLength; ++i) {
                        ChainPath storage cp = chainPaths[i];
                        // (liquidity * (weight/totalWeight)) - (lkb+credits)
                        uint256 balLiq = totalLiquidity.mul(cp.weight).div(totalWeight);
                        uint256 currLiq = cp.lkb.add(cp.credits);
                        if (balLiq > currLiq) {
                            // save gas since we know balLiq > currLiq and we know deficit[i] > 0
                            deficit[i] = balLiq - currLiq;
                            totalDeficit = totalDeficit.add(deficit[i]);
                        }
                    }
                    // indicates how much delta credit is distributed
                    uint256 spent;
                    // handle credits with 2 tranches. the [ < totalDeficit] [excessCredit]
                    // run full Delta, allocate all credits
                    if (totalDeficit == 0) {
                        // only fullMode delta will allocate excess credits
                        if (fullMode && deltaCredit > 0) {
                            // credit ChainPath by weights
                            for (uint256 i = 0; i < cpLength; ++i) {
                                ChainPath storage cp = chainPaths[i];
                                // credits = credits + toBalanceChange + remaining allocation based on weight
                                uint256 amtToCredit = deltaCredit.mul(cp.weight).div(totalWeight);
                                spent = spent.add(amtToCredit);
                                cp.credits = cp.credits.add(amtToCredit);
                            }
                        } // else do nth
                    } else if (totalDeficit <= deltaCredit) {
                        if (fullMode) {
                            // algorithm step 13: calculate amount to disperse to bring to balance state or as close as possible
                            uint256 excessCredit = deltaCredit - totalDeficit;
                            // algorithm steps 14-16: calculate credits
                            for (uint256 i = 0; i < cpLength; ++i) {
                                if (deficit[i] > 0) {
                                    ChainPath storage cp = chainPaths[i];
                                    // credits = credits + deficit + remaining allocation based on weight
                                    uint256 amtToCredit = deficit[i].add(excessCredit.mul(cp.weight).div(totalWeight));
                                    spent = spent.add(amtToCredit);
                                    cp.credits = cp.credits.add(amtToCredit);
                                }
                            }
                        } else {
                            // totalDeficit <= deltaCredit but not running fullMode
                            // credit chainPaths as is if any deficit, not using all deltaCredit
                            for (uint256 i = 0; i < cpLength; ++i) {
                                if (deficit[i] > 0) {
                                    ChainPath storage cp = chainPaths[i];
                                    uint256 amtToCredit = deficit[i];
                                    spent = spent.add(amtToCredit);
                                    cp.credits = cp.credits.add(amtToCredit);
                                }
                            }
                        }
                    } else {
                        // totalDeficit > deltaCredit, fullMode or not, normalize the deficit by deltaCredit
                        for (uint256 i = 0; i < cpLength; ++i) {
                            if (deficit[i] > 0) {
                                ChainPath storage cp = chainPaths[i];
                                uint256 proportionalDeficit = deficit[i].mul(deltaCredit).div(totalDeficit);
                                spent = spent.add(proportionalDeficit);
                                cp.credits = cp.credits.add(proportionalDeficit);
                            }
                        }
                    }
                    // deduct the amount of credit sent
                    deltaCredit = deltaCredit.sub(spent);
                }
            }
            function _mintLocal(
                address _to,
                uint256 _amountLD,
                bool _feesEnabled,
                bool _creditDelta
            ) internal returns (uint256 amountSD) {
                require(totalWeight > 0, "Stargate: No ChainPaths exist");
                amountSD = amountLDtoSD(_amountLD);
                uint256 mintFeeSD = 0;
                if (_feesEnabled) {
                    mintFeeSD = amountSD.mul(mintFeeBP).div(BP_DENOMINATOR);
                    amountSD = amountSD.sub(mintFeeSD);
                    mintFeeBalance = mintFeeBalance.add(mintFeeSD);
                }
                if (_creditDelta) {
                    deltaCredit = deltaCredit.add(amountSD);
                }
                uint256 amountLPTokens = amountSD;
                if (totalSupply != 0) {
                    amountLPTokens = amountSD.mul(totalSupply).div(totalLiquidity);
                }
                totalLiquidity = totalLiquidity.add(amountSD);
                _mint(_to, amountLPTokens);
                emit Mint(_to, amountLPTokens, amountSD, mintFeeSD);
                // add to credits and call delta. short circuit to save gas
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultLPMode);
                }
            }
            function _safeTransfer(
                address _token,
                address _to,
                uint256 _value
            ) private {
                (bool success, bytes memory data) = _token.call(abi.encodeWithSelector(SELECTOR, _to, _value));
                require(success && (data.length == 0 || abi.decode(data, (bool))), "Stargate: TRANSFER_FAILED");
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity >=0.6.0 <0.8.0;
        /*
         * @dev Provides information about the current execution context, including the
         * sender of the transaction and its data. While these are generally available
         * via msg.sender and msg.data, they should not be accessed in such a direct
         * manner, since when dealing with GSN meta-transactions the account sending and
         * paying for execution may not be the actual sender (as far as an application
         * is concerned).
         *
         * This contract is only required for intermediate, library-like contracts.
         */
        abstract contract Context {
            function _msgSender() internal view virtual returns (address payable) {
                return msg.sender;
            }
            function _msgData() internal view virtual returns (bytes memory) {
                this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
                return msg.data;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        /**
         * @dev Contract module that helps prevent reentrant calls to a function.
         *
         * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
         * available, which can be applied to functions to make sure there are no nested
         * (reentrant) calls to them.
         *
         * Note that because there is a single `nonReentrant` guard, functions marked as
         * `nonReentrant` may not call one another. This can be worked around by making
         * those functions `private`, and then adding `external` `nonReentrant` entry
         * points to them.
         *
         * TIP: If you would like to learn more about reentrancy and alternative ways
         * to protect against it, check out our blog post
         * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
         */
        abstract contract ReentrancyGuard {
            // Booleans are more expensive than uint256 or any type that takes up a full
            // word because each write operation emits an extra SLOAD to first read the
            // slot's contents, replace the bits taken up by the boolean, and then write
            // back. This is the compiler's defense against contract upgrades and
            // pointer aliasing, and it cannot be disabled.
            // The values being non-zero value makes deployment a bit more expensive,
            // but in exchange the refund on every call to nonReentrant will be lower in
            // amount. Since refunds are capped to a percentage of the total
            // transaction's gas, it is best to keep them low in cases like this one, to
            // increase the likelihood of the full refund coming into effect.
            uint256 private constant _NOT_ENTERED = 1;
            uint256 private constant _ENTERED = 2;
            uint256 private _status;
            constructor () {
                _status = _NOT_ENTERED;
            }
            /**
             * @dev Prevents a contract from calling itself, directly or indirectly.
             * Calling a `nonReentrant` function from another `nonReentrant`
             * function is not supported. It is possible to prevent this from happening
             * by making the `nonReentrant` function external, and make it call a
             * `private` function that does the actual work.
             */
            modifier nonReentrant() {
                // On the first call to nonReentrant, _notEntered will be true
                require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
                // Any calls to nonReentrant after this point will fail
                _status = _ENTERED;
                _;
                // By storing the original value once again, a refund is triggered (see
                // https://eips.ethereum.org/EIPS/eip-2200)
                _status = _NOT_ENTERED;
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        // libraries
        import "@openzeppelin/contracts/math/SafeMath.sol";
        contract LPTokenERC20 {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // CONSTANTS
            string public name;
            string public symbol;
            bytes32 public constant PERMIT_TYPEHASH = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9;
            // set in constructor
            bytes32 public DOMAIN_SEPARATOR;
            //---------------------------------------------------------------------------
            // VARIABLES
            uint256 public decimals;
            uint256 public totalSupply;
            mapping(address => uint256) public balanceOf;
            mapping(address => mapping(address => uint256)) public allowance;
            mapping(address => uint256) public nonces;
            //---------------------------------------------------------------------------
            // EVENTS
            event Approval(address indexed owner, address indexed spender, uint256 value);
            event Transfer(address indexed from, address indexed to, uint256 value);
            constructor(string memory _name, string memory _symbol) {
                name = _name;
                symbol = _symbol;
                uint256 chainId;
                assembly {
                    chainId := chainid()
                }
                DOMAIN_SEPARATOR = keccak256(
                    abi.encode(
                        keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"),
                        keccak256(bytes(name)),
                        keccak256(bytes("1")),
                        chainId,
                        address(this)
                    )
                );
            }
            function _mint(address to, uint256 value) internal {
                totalSupply = totalSupply.add(value);
                balanceOf[to] = balanceOf[to].add(value);
                emit Transfer(address(0), to, value);
            }
            function _burn(address from, uint256 value) internal {
                balanceOf[from] = balanceOf[from].sub(value);
                totalSupply = totalSupply.sub(value);
                emit Transfer(from, address(0), value);
            }
            function _approve(
                address owner,
                address spender,
                uint256 value
            ) private {
                allowance[owner][spender] = value;
                emit Approval(owner, spender, value);
            }
            function _transfer(
                address from,
                address to,
                uint256 value
            ) private {
                balanceOf[from] = balanceOf[from].sub(value);
                balanceOf[to] = balanceOf[to].add(value);
                emit Transfer(from, to, value);
            }
            function approve(address spender, uint256 value) external returns (bool) {
                _approve(msg.sender, spender, value);
                return true;
            }
            function transfer(address to, uint256 value) external returns (bool) {
                _transfer(msg.sender, to, value);
                return true;
            }
            function transferFrom(
                address from,
                address to,
                uint256 value
            ) external returns (bool) {
                if (allowance[from][msg.sender] != uint256(-1)) {
                    allowance[from][msg.sender] = allowance[from][msg.sender].sub(value);
                }
                _transfer(from, to, value);
                return true;
            }
            function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
                _approve(msg.sender, spender, allowance[msg.sender][spender].add(addedValue));
                return true;
            }
            function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
                _approve(msg.sender, spender, allowance[msg.sender][spender].sub(subtractedValue, "ERC20: decreased allowance below zero"));
                return true;
            }
            function permit(
                address owner,
                address spender,
                uint256 value,
                uint256 deadline,
                uint8 v,
                bytes32 r,
                bytes32 s
            ) external {
                require(deadline >= block.timestamp, "Bridge: EXPIRED");
                bytes32 digest = keccak256(
                    abi.encodePacked(
                        "\\x19\\x01",
                        DOMAIN_SEPARATOR,
                        keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline))
                    )
                );
                address recoveredAddress = ecrecover(digest, v, r, s);
                require(recoveredAddress != address(0) && recoveredAddress == owner, "Bridge: INVALID_SIGNATURE");
                _approve(owner, spender, value);
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity ^0.7.6;
        pragma abicoder v2;
        import "../Pool.sol";
        interface IStargateFeeLibrary {
            function getFees(
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                uint16 _dstChainId,
                address _from,
                uint256 _amountSD
            ) external returns (Pool.SwapObj memory s);
            function getVersion() external view returns (string memory);
        }
        

        File 6 of 6: Pool
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        pragma abicoder v2;
        // imports
        import "@openzeppelin/contracts/access/Ownable.sol";
        import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
        import "./LPTokenERC20.sol";
        import "./interfaces/IStargateFeeLibrary.sol";
        // libraries
        import "@openzeppelin/contracts/math/SafeMath.sol";
        /// Pool contracts on other chains and managed by the Stargate protocol.
        contract Pool is LPTokenERC20, ReentrancyGuard {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // CONSTANTS
            bytes4 private constant SELECTOR = bytes4(keccak256(bytes("transfer(address,uint256)")));
            uint256 public constant BP_DENOMINATOR = 10000;
            //---------------------------------------------------------------------------
            // STRUCTS
            struct ChainPath {
                bool ready; // indicate if the counter chainPath has been created.
                uint16 dstChainId;
                uint256 dstPoolId;
                uint256 weight;
                uint256 balance;
                uint256 lkb;
                uint256 credits;
                uint256 idealBalance;
            }
            struct SwapObj {
                uint256 amount;
                uint256 eqFee;
                uint256 eqReward;
                uint256 lpFee;
                uint256 protocolFee;
                uint256 lkbRemove;
            }
            struct CreditObj {
                uint256 credits;
                uint256 idealBalance;
            }
            //---------------------------------------------------------------------------
            // VARIABLES
            // chainPath
            ChainPath[] public chainPaths; // list of connected chains with shared pools
            mapping(uint16 => mapping(uint256 => uint256)) public chainPathIndexLookup; // lookup for chainPath by chainId => poolId =>index
            // metadata
            uint256 public immutable poolId; // shared id between chains to represent same pool
            uint256 public sharedDecimals; // the shared decimals (lowest common decimals between chains)
            uint256 public localDecimals; // the decimals for the token
            uint256 public immutable convertRate; // the decimals for the token
            address public immutable token; // the token for the pool
            address public immutable router; // the token for the pool
            bool public stopSwap; // flag to stop swapping in extreme cases
            // Fee and Liquidity
            uint256 public totalLiquidity; // the total amount of tokens added on this side of the chain (fees + deposits - withdrawals)
            uint256 public totalWeight; // total weight for pool percentages
            uint256 public mintFeeBP; // fee basis points for the mint/deposit
            uint256 public protocolFeeBalance; // fee balance created from dao fee
            uint256 public mintFeeBalance; // fee balance created from mint fee
            uint256 public eqFeePool; // pool rewards in Shared Decimal format. indicate the total budget for reverse swap incentive
            address public feeLibrary; // address for retrieving fee params for swaps
            // Delta related
            uint256 public deltaCredit; // credits accumulated from txn
            bool public batched; // flag to indicate if we want batch processing.
            bool public defaultSwapMode; // flag for the default mode for swap
            bool public defaultLPMode; // flag for the default mode for lp
            uint256 public swapDeltaBP; // basis points of poolCredits to activate Delta in swap
            uint256 public lpDeltaBP; // basis points of poolCredits to activate Delta in liquidity events
            //---------------------------------------------------------------------------
            // EVENTS
            event Mint(address to, uint256 amountLP, uint256 amountSD, uint256 mintFeeAmountSD);
            event Burn(address from, uint256 amountLP, uint256 amountSD);
            event RedeemLocalCallback(address _to, uint256 _amountSD, uint256 _amountToMintSD);
            event Swap(
                uint16 chainId,
                uint256 dstPoolId,
                address from,
                uint256 amountSD,
                uint256 eqReward,
                uint256 eqFee,
                uint256 protocolFee,
                uint256 lpFee
            );
            event SendCredits(uint16 dstChainId, uint256 dstPoolId, uint256 credits, uint256 idealBalance);
            event RedeemRemote(uint16 chainId, uint256 dstPoolId, address from, uint256 amountLP, uint256 amountSD);
            event RedeemLocal(address from, uint256 amountLP, uint256 amountSD, uint16 chainId, uint256 dstPoolId, bytes to);
            event InstantRedeemLocal(address from, uint256 amountLP, uint256 amountSD, address to);
            event CreditChainPath(uint16 chainId, uint256 srcPoolId, uint256 amountSD, uint256 idealBalance);
            event SwapRemote(address to, uint256 amountSD, uint256 protocolFee, uint256 dstFee);
            event WithdrawRemote(uint16 srcChainId, uint256 srcPoolId, uint256 swapAmount, uint256 mintAmount);
            event ChainPathUpdate(uint16 dstChainId, uint256 dstPoolId, uint256 weight);
            event FeesUpdated(uint256 mintFeeBP);
            event FeeLibraryUpdated(address feeLibraryAddr);
            event StopSwapUpdated(bool swapStop);
            event WithdrawProtocolFeeBalance(address to, uint256 amountSD);
            event WithdrawMintFeeBalance(address to, uint256 amountSD);
            event DeltaParamUpdated(bool batched, uint256 swapDeltaBP, uint256 lpDeltaBP, bool defaultSwapMode, bool defaultLPMode);
            //---------------------------------------------------------------------------
            // MODIFIERS
            modifier onlyRouter() {
                require(msg.sender == router, "Stargate: only the router can call this method");
                _;
            }
            constructor(
                uint256 _poolId,
                address _router,
                address _token,
                uint256 _sharedDecimals,
                uint256 _localDecimals,
                address _feeLibrary,
                string memory _name,
                string memory _symbol
            ) LPTokenERC20(_name, _symbol) {
                require(_token != address(0x0), "Stargate: _token cannot be 0x0");
                require(_router != address(0x0), "Stargate: _router cannot be 0x0");
                poolId = _poolId;
                router = _router;
                token = _token;
                sharedDecimals = _sharedDecimals;
                decimals = uint8(_sharedDecimals);
                localDecimals = _localDecimals;
                convertRate = 10**(uint256(localDecimals).sub(sharedDecimals));
                totalWeight = 0;
                feeLibrary = _feeLibrary;
                //delta algo related
                batched = false;
                defaultSwapMode = true;
                defaultLPMode = true;
            }
            function getChainPathsLength() public view returns (uint256) {
                return chainPaths.length;
            }
            //---------------------------------------------------------------------------
            // LOCAL CHAIN FUNCTIONS
            function mint(address _to, uint256 _amountLD) external nonReentrant onlyRouter returns (uint256) {
                return _mintLocal(_to, _amountLD, true, true);
            }
            // Local                                    Remote
            // -------                                  ---------
            // swap             ->                      swapRemote
            function swap(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                address _from,
                uint256 _amountLD,
                uint256 _minAmountLD,
                bool newLiquidity
            ) external nonReentrant onlyRouter returns (SwapObj memory) {
                require(!stopSwap, "Stargate: swap func stopped");
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == true, "Stargate: counter chainPath is not ready");
                uint256 amountSD = amountLDtoSD(_amountLD);
                uint256 minAmountSD = amountLDtoSD(_minAmountLD);
                // request fee params from library
                SwapObj memory s = IStargateFeeLibrary(feeLibrary).getFees(poolId, _dstPoolId, _dstChainId, _from, amountSD);
                // equilibrium fee and reward. note eqFee/eqReward are separated from swap liquidity
                eqFeePool = eqFeePool.sub(s.eqReward);
                // update the new amount the user gets minus the fees
                s.amount = amountSD.sub(s.eqFee).sub(s.protocolFee).sub(s.lpFee);
                // users will also get the eqReward
                require(s.amount.add(s.eqReward) >= minAmountSD, "Stargate: slippage too high");
                // behaviours
                //     - protocolFee: booked, stayed and withdrawn at remote.
                //     - eqFee: booked, stayed and withdrawn at remote.
                //     - lpFee: booked and stayed at remote, can be withdrawn anywhere
                s.lkbRemove = amountSD.sub(s.lpFee).add(s.eqReward);
                // check for transfer solvency.
                require(cp.balance >= s.lkbRemove, "Stargate: dst balance too low");
                cp.balance = cp.balance.sub(s.lkbRemove);
                if (newLiquidity) {
                    deltaCredit = deltaCredit.add(amountSD).add(s.eqReward);
                } else if (s.eqReward > 0) {
                    deltaCredit = deltaCredit.add(s.eqReward);
                }
                // distribute credits on condition.
                if (!batched || deltaCredit >= totalLiquidity.mul(swapDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultSwapMode);
                }
                emit Swap(_dstChainId, _dstPoolId, _from, s.amount, s.eqReward, s.eqFee, s.protocolFee, s.lpFee);
                return s;
            }
            // Local                                    Remote
            // -------                                  ---------
            // sendCredits      ->                      creditChainPath
            function sendCredits(uint16 _dstChainId, uint256 _dstPoolId) external nonReentrant onlyRouter returns (CreditObj memory c) {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == true, "Stargate: counter chainPath is not ready");
                cp.lkb = cp.lkb.add(cp.credits);
                c.idealBalance = totalLiquidity.mul(cp.weight).div(totalWeight);
                c.credits = cp.credits;
                cp.credits = 0;
                emit SendCredits(_dstChainId, _dstPoolId, c.credits, c.idealBalance);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemRemote   ->                        swapRemote
            function redeemRemote(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                address _from,
                uint256 _amountLP
            ) external nonReentrant onlyRouter {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                uint256 amountSD = _burnLocal(_from, _amountLP);
                //run Delta
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultLPMode);
                }
                uint256 amountLD = amountSDtoLD(amountSD);
                emit RedeemRemote(_dstChainId, _dstPoolId, _from, _amountLP, amountLD);
            }
            function instantRedeemLocal(
                address _from,
                uint256 _amountLP,
                address _to
            ) external nonReentrant onlyRouter returns (uint256 amountSD) {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                uint256 _deltaCredit = deltaCredit; // sload optimization.
                uint256 _capAmountLP = _amountSDtoLP(_deltaCredit);
                if (_amountLP > _capAmountLP) _amountLP = _capAmountLP;
                amountSD = _burnLocal(_from, _amountLP);
                deltaCredit = _deltaCredit.sub(amountSD);
                uint256 amountLD = amountSDtoLD(amountSD);
                _safeTransfer(token, _to, amountLD);
                emit InstantRedeemLocal(_from, _amountLP, amountSD, _to);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal   ->                         redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocal(
                address _from,
                uint256 _amountLP,
                uint16 _dstChainId,
                uint256 _dstPoolId,
                bytes calldata _to
            ) external nonReentrant onlyRouter returns (uint256 amountSD) {
                require(_from != address(0x0), "Stargate: _from cannot be 0x0");
                // safeguard.
                require(chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]].ready == true, "Stargate: counter chainPath is not ready");
                amountSD = _burnLocal(_from, _amountLP);
                // run Delta
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(false);
                }
                emit RedeemLocal(_from, _amountLP, amountSD, _dstChainId, _dstPoolId, _to);
            }
            //---------------------------------------------------------------------------
            // REMOTE CHAIN FUNCTIONS
            // Local                                    Remote
            // -------                                  ---------
            // sendCredits      ->                      creditChainPath
            function creditChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                CreditObj memory _c
            ) external nonReentrant onlyRouter {
                ChainPath storage cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                cp.balance = cp.balance.add(_c.credits);
                if (cp.idealBalance != _c.idealBalance) {
                    cp.idealBalance = _c.idealBalance;
                }
                emit CreditChainPath(_dstChainId, _dstPoolId, _c.credits, _c.idealBalance);
            }
            // Local                                    Remote
            // -------                                  ---------
            // swap             ->                      swapRemote
            function swapRemote(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                address _to,
                SwapObj memory _s
            ) external nonReentrant onlyRouter returns (uint256 amountLD) {
                // booking lpFee
                totalLiquidity = totalLiquidity.add(_s.lpFee);
                // booking eqFee
                eqFeePool = eqFeePool.add(_s.eqFee);
                // booking stargateFee
                protocolFeeBalance = protocolFeeBalance.add(_s.protocolFee);
                // update LKB
                uint256 chainPathIndex = chainPathIndexLookup[_srcChainId][_srcPoolId];
                chainPaths[chainPathIndex].lkb = chainPaths[chainPathIndex].lkb.sub(_s.lkbRemove);
                // user receives the amount + the srcReward
                amountLD = amountSDtoLD(_s.amount.add(_s.eqReward));
                _safeTransfer(token, _to, amountLD);
                emit SwapRemote(_to, _s.amount.add(_s.eqReward), _s.protocolFee, _s.eqFee);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal   ->                         redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocalCallback(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                address _to,
                uint256 _amountSD,
                uint256 _amountToMintSD
            ) external nonReentrant onlyRouter {
                if (_amountToMintSD > 0) {
                    _mintLocal(_to, amountSDtoLD(_amountToMintSD), false, false);
                }
                ChainPath storage cp = getAndCheckCP(_srcChainId, _srcPoolId);
                cp.lkb = cp.lkb.sub(_amountSD);
                uint256 amountLD = amountSDtoLD(_amountSD);
                _safeTransfer(token, _to, amountLD);
                emit RedeemLocalCallback(_to, _amountSD, _amountToMintSD);
            }
            // Local                                    Remote
            // -------                                  ---------
            // redeemLocal(amount)   ->               redeemLocalCheckOnRemote
            // redeemLocalCallback             <-
            function redeemLocalCheckOnRemote(
                uint16 _srcChainId,
                uint256 _srcPoolId,
                uint256 _amountSD
            ) external nonReentrant onlyRouter returns (uint256 swapAmount, uint256 mintAmount) {
                ChainPath storage cp = getAndCheckCP(_srcChainId, _srcPoolId);
                if (_amountSD > cp.balance) {
                    mintAmount = _amountSD - cp.balance;
                    swapAmount = cp.balance;
                    cp.balance = 0;
                } else {
                    cp.balance = cp.balance.sub(_amountSD);
                    swapAmount = _amountSD;
                    mintAmount = 0;
                }
                emit WithdrawRemote(_srcChainId, _srcPoolId, swapAmount, mintAmount);
            }
            //---------------------------------------------------------------------------
            // DAO Calls
            function createChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint256 _weight
            ) external onlyRouter {
                for (uint256 i = 0; i < chainPaths.length; ++i) {
                    ChainPath memory cp = chainPaths[i];
                    bool exists = cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId;
                    require(!exists, "Stargate: cant createChainPath of existing dstChainId and _dstPoolId");
                }
                totalWeight = totalWeight.add(_weight);
                chainPathIndexLookup[_dstChainId][_dstPoolId] = chainPaths.length;
                chainPaths.push(ChainPath(false, _dstChainId, _dstPoolId, _weight, 0, 0, 0, 0));
                emit ChainPathUpdate(_dstChainId, _dstPoolId, _weight);
            }
            function setWeightForChainPath(
                uint16 _dstChainId,
                uint256 _dstPoolId,
                uint16 _weight
            ) external onlyRouter {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                totalWeight = totalWeight.sub(cp.weight).add(_weight);
                cp.weight = _weight;
                emit ChainPathUpdate(_dstChainId, _dstPoolId, _weight);
            }
            function setFee(uint256 _mintFeeBP) external onlyRouter {
                require(_mintFeeBP <= BP_DENOMINATOR, "Bridge: cum fees > 100%");
                mintFeeBP = _mintFeeBP;
                emit FeesUpdated(mintFeeBP);
            }
            function setFeeLibrary(address _feeLibraryAddr) external onlyRouter {
                require(_feeLibraryAddr != address(0x0), "Stargate: fee library cant be 0x0");
                feeLibrary = _feeLibraryAddr;
                emit FeeLibraryUpdated(_feeLibraryAddr);
            }
            function setSwapStop(bool _swapStop) external onlyRouter {
                stopSwap = _swapStop;
                emit StopSwapUpdated(_swapStop);
            }
            function setDeltaParam(
                bool _batched,
                uint256 _swapDeltaBP,
                uint256 _lpDeltaBP,
                bool _defaultSwapMode,
                bool _defaultLPMode
            ) external onlyRouter {
                require(_swapDeltaBP <= BP_DENOMINATOR && _lpDeltaBP <= BP_DENOMINATOR, "Stargate: wrong Delta param");
                batched = _batched;
                swapDeltaBP = _swapDeltaBP;
                lpDeltaBP = _lpDeltaBP;
                defaultSwapMode = _defaultSwapMode;
                defaultLPMode = _defaultLPMode;
                emit DeltaParamUpdated(_batched, _swapDeltaBP, _lpDeltaBP, _defaultSwapMode, _defaultLPMode);
            }
            function callDelta(bool _fullMode) external onlyRouter {
                _delta(_fullMode);
            }
            function activateChainPath(uint16 _dstChainId, uint256 _dstPoolId) external onlyRouter {
                ChainPath storage cp = getAndCheckCP(_dstChainId, _dstPoolId);
                require(cp.ready == false, "Stargate: chainPath is already active");
                // this func will only be called once
                cp.ready = true;
            }
            function withdrawProtocolFeeBalance(address _to) external onlyRouter {
                if (protocolFeeBalance > 0) {
                    uint256 amountOfLD = amountSDtoLD(protocolFeeBalance);
                    protocolFeeBalance = 0;
                    _safeTransfer(token, _to, amountOfLD);
                    emit WithdrawProtocolFeeBalance(_to, amountOfLD);
                }
            }
            function withdrawMintFeeBalance(address _to) external onlyRouter {
                if (mintFeeBalance > 0) {
                    uint256 amountOfLD = amountSDtoLD(mintFeeBalance);
                    mintFeeBalance = 0;
                    _safeTransfer(token, _to, amountOfLD);
                    emit WithdrawMintFeeBalance(_to, amountOfLD);
                }
            }
            //---------------------------------------------------------------------------
            // INTERNAL
            // Conversion Helpers
            //---------------------------------------------------------------------------
            function amountLPtoLD(uint256 _amountLP) external view returns (uint256) {
                return amountSDtoLD(_amountLPtoSD(_amountLP));
            }
            function _amountLPtoSD(uint256 _amountLP) internal view returns (uint256) {
                require(totalSupply > 0, "Stargate: cant convert LPtoSD when totalSupply == 0");
                return _amountLP.mul(totalLiquidity).div(totalSupply);
            }
            function _amountSDtoLP(uint256 _amountSD) internal view returns (uint256) {
                require(totalLiquidity > 0, "Stargate: cant convert SDtoLP when totalLiq == 0");
                return _amountSD.mul(totalSupply).div(totalLiquidity);
            }
            function amountSDtoLD(uint256 _amount) internal view returns (uint256) {
                return _amount.mul(convertRate);
            }
            function amountLDtoSD(uint256 _amount) internal view returns (uint256) {
                return _amount.div(convertRate);
            }
            function getAndCheckCP(uint16 _dstChainId, uint256 _dstPoolId) internal view returns (ChainPath storage) {
                require(chainPaths.length > 0, "Stargate: no chainpaths exist");
                ChainPath storage cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                require(cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId, "Stargate: local chainPath does not exist");
                return cp;
            }
            function getChainPath(uint16 _dstChainId, uint256 _dstPoolId) external view returns (ChainPath memory) {
                ChainPath memory cp = chainPaths[chainPathIndexLookup[_dstChainId][_dstPoolId]];
                require(cp.dstChainId == _dstChainId && cp.dstPoolId == _dstPoolId, "Stargate: local chainPath does not exist");
                return cp;
            }
            function _burnLocal(address _from, uint256 _amountLP) internal returns (uint256) {
                require(totalSupply > 0, "Stargate: cant burn when totalSupply == 0");
                uint256 amountOfLPTokens = balanceOf[_from];
                require(amountOfLPTokens >= _amountLP, "Stargate: not enough LP tokens to burn");
                uint256 amountSD = _amountLP.mul(totalLiquidity).div(totalSupply);
                //subtract totalLiquidity accordingly
                totalLiquidity = totalLiquidity.sub(amountSD);
                _burn(_from, _amountLP);
                emit Burn(_from, _amountLP, amountSD);
                return amountSD;
            }
            function _delta(bool fullMode) internal {
                if (deltaCredit > 0 && totalWeight > 0) {
                    uint256 cpLength = chainPaths.length;
                    uint256[] memory deficit = new uint256[](cpLength);
                    uint256 totalDeficit = 0;
                    // algorithm steps 6-9: calculate the total and the amounts required to get to balance state
                    for (uint256 i = 0; i < cpLength; ++i) {
                        ChainPath storage cp = chainPaths[i];
                        // (liquidity * (weight/totalWeight)) - (lkb+credits)
                        uint256 balLiq = totalLiquidity.mul(cp.weight).div(totalWeight);
                        uint256 currLiq = cp.lkb.add(cp.credits);
                        if (balLiq > currLiq) {
                            // save gas since we know balLiq > currLiq and we know deficit[i] > 0
                            deficit[i] = balLiq - currLiq;
                            totalDeficit = totalDeficit.add(deficit[i]);
                        }
                    }
                    // indicates how much delta credit is distributed
                    uint256 spent;
                    // handle credits with 2 tranches. the [ < totalDeficit] [excessCredit]
                    // run full Delta, allocate all credits
                    if (totalDeficit == 0) {
                        // only fullMode delta will allocate excess credits
                        if (fullMode && deltaCredit > 0) {
                            // credit ChainPath by weights
                            for (uint256 i = 0; i < cpLength; ++i) {
                                ChainPath storage cp = chainPaths[i];
                                // credits = credits + toBalanceChange + remaining allocation based on weight
                                uint256 amtToCredit = deltaCredit.mul(cp.weight).div(totalWeight);
                                spent = spent.add(amtToCredit);
                                cp.credits = cp.credits.add(amtToCredit);
                            }
                        } // else do nth
                    } else if (totalDeficit <= deltaCredit) {
                        if (fullMode) {
                            // algorithm step 13: calculate amount to disperse to bring to balance state or as close as possible
                            uint256 excessCredit = deltaCredit - totalDeficit;
                            // algorithm steps 14-16: calculate credits
                            for (uint256 i = 0; i < cpLength; ++i) {
                                if (deficit[i] > 0) {
                                    ChainPath storage cp = chainPaths[i];
                                    // credits = credits + deficit + remaining allocation based on weight
                                    uint256 amtToCredit = deficit[i].add(excessCredit.mul(cp.weight).div(totalWeight));
                                    spent = spent.add(amtToCredit);
                                    cp.credits = cp.credits.add(amtToCredit);
                                }
                            }
                        } else {
                            // totalDeficit <= deltaCredit but not running fullMode
                            // credit chainPaths as is if any deficit, not using all deltaCredit
                            for (uint256 i = 0; i < cpLength; ++i) {
                                if (deficit[i] > 0) {
                                    ChainPath storage cp = chainPaths[i];
                                    uint256 amtToCredit = deficit[i];
                                    spent = spent.add(amtToCredit);
                                    cp.credits = cp.credits.add(amtToCredit);
                                }
                            }
                        }
                    } else {
                        // totalDeficit > deltaCredit, fullMode or not, normalize the deficit by deltaCredit
                        for (uint256 i = 0; i < cpLength; ++i) {
                            if (deficit[i] > 0) {
                                ChainPath storage cp = chainPaths[i];
                                uint256 proportionalDeficit = deficit[i].mul(deltaCredit).div(totalDeficit);
                                spent = spent.add(proportionalDeficit);
                                cp.credits = cp.credits.add(proportionalDeficit);
                            }
                        }
                    }
                    // deduct the amount of credit sent
                    deltaCredit = deltaCredit.sub(spent);
                }
            }
            function _mintLocal(
                address _to,
                uint256 _amountLD,
                bool _feesEnabled,
                bool _creditDelta
            ) internal returns (uint256 amountSD) {
                require(totalWeight > 0, "Stargate: No ChainPaths exist");
                amountSD = amountLDtoSD(_amountLD);
                uint256 mintFeeSD = 0;
                if (_feesEnabled) {
                    mintFeeSD = amountSD.mul(mintFeeBP).div(BP_DENOMINATOR);
                    amountSD = amountSD.sub(mintFeeSD);
                    mintFeeBalance = mintFeeBalance.add(mintFeeSD);
                }
                if (_creditDelta) {
                    deltaCredit = deltaCredit.add(amountSD);
                }
                uint256 amountLPTokens = amountSD;
                if (totalSupply != 0) {
                    amountLPTokens = amountSD.mul(totalSupply).div(totalLiquidity);
                }
                totalLiquidity = totalLiquidity.add(amountSD);
                _mint(_to, amountLPTokens);
                emit Mint(_to, amountLPTokens, amountSD, mintFeeSD);
                // add to credits and call delta. short circuit to save gas
                if (!batched || deltaCredit > totalLiquidity.mul(lpDeltaBP).div(BP_DENOMINATOR)) {
                    _delta(defaultLPMode);
                }
            }
            function _safeTransfer(
                address _token,
                address _to,
                uint256 _value
            ) private {
                (bool success, bytes memory data) = _token.call(abi.encodeWithSelector(SELECTOR, _to, _value));
                require(success && (data.length == 0 || abi.decode(data, (bool))), "Stargate: TRANSFER_FAILED");
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        import "../utils/Context.sol";
        /**
         * @dev Contract module which provides a basic access control mechanism, where
         * there is an account (an owner) that can be granted exclusive access to
         * specific functions.
         *
         * By default, the owner account will be the one that deploys the contract. This
         * can later be changed with {transferOwnership}.
         *
         * This module is used through inheritance. It will make available the modifier
         * `onlyOwner`, which can be applied to your functions to restrict their use to
         * the owner.
         */
        abstract contract Ownable is Context {
            address private _owner;
            event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
            /**
             * @dev Initializes the contract setting the deployer as the initial owner.
             */
            constructor () {
                address msgSender = _msgSender();
                _owner = msgSender;
                emit OwnershipTransferred(address(0), msgSender);
            }
            /**
             * @dev Returns the address of the current owner.
             */
            function owner() public view virtual returns (address) {
                return _owner;
            }
            /**
             * @dev Throws if called by any account other than the owner.
             */
            modifier onlyOwner() {
                require(owner() == _msgSender(), "Ownable: caller is not the owner");
                _;
            }
            /**
             * @dev Leaves the contract without owner. It will not be possible to call
             * `onlyOwner` functions anymore. Can only be called by the current owner.
             *
             * NOTE: Renouncing ownership will leave the contract without an owner,
             * thereby removing any functionality that is only available to the owner.
             */
            function renounceOwnership() public virtual onlyOwner {
                emit OwnershipTransferred(_owner, address(0));
                _owner = address(0);
            }
            /**
             * @dev Transfers ownership of the contract to a new account (`newOwner`).
             * Can only be called by the current owner.
             */
            function transferOwnership(address newOwner) public virtual onlyOwner {
                require(newOwner != address(0), "Ownable: new owner is the zero address");
                emit OwnershipTransferred(_owner, newOwner);
                _owner = newOwner;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        /**
         * @dev Contract module that helps prevent reentrant calls to a function.
         *
         * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
         * available, which can be applied to functions to make sure there are no nested
         * (reentrant) calls to them.
         *
         * Note that because there is a single `nonReentrant` guard, functions marked as
         * `nonReentrant` may not call one another. This can be worked around by making
         * those functions `private`, and then adding `external` `nonReentrant` entry
         * points to them.
         *
         * TIP: If you would like to learn more about reentrancy and alternative ways
         * to protect against it, check out our blog post
         * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
         */
        abstract contract ReentrancyGuard {
            // Booleans are more expensive than uint256 or any type that takes up a full
            // word because each write operation emits an extra SLOAD to first read the
            // slot's contents, replace the bits taken up by the boolean, and then write
            // back. This is the compiler's defense against contract upgrades and
            // pointer aliasing, and it cannot be disabled.
            // The values being non-zero value makes deployment a bit more expensive,
            // but in exchange the refund on every call to nonReentrant will be lower in
            // amount. Since refunds are capped to a percentage of the total
            // transaction's gas, it is best to keep them low in cases like this one, to
            // increase the likelihood of the full refund coming into effect.
            uint256 private constant _NOT_ENTERED = 1;
            uint256 private constant _ENTERED = 2;
            uint256 private _status;
            constructor () {
                _status = _NOT_ENTERED;
            }
            /**
             * @dev Prevents a contract from calling itself, directly or indirectly.
             * Calling a `nonReentrant` function from another `nonReentrant`
             * function is not supported. It is possible to prevent this from happening
             * by making the `nonReentrant` function external, and make it call a
             * `private` function that does the actual work.
             */
            modifier nonReentrant() {
                // On the first call to nonReentrant, _notEntered will be true
                require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
                // Any calls to nonReentrant after this point will fail
                _status = _ENTERED;
                _;
                // By storing the original value once again, a refund is triggered (see
                // https://eips.ethereum.org/EIPS/eip-2200)
                _status = _NOT_ENTERED;
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity 0.7.6;
        // libraries
        import "@openzeppelin/contracts/math/SafeMath.sol";
        contract LPTokenERC20 {
            using SafeMath for uint256;
            //---------------------------------------------------------------------------
            // CONSTANTS
            string public name;
            string public symbol;
            bytes32 public constant PERMIT_TYPEHASH = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9;
            // set in constructor
            bytes32 public DOMAIN_SEPARATOR;
            //---------------------------------------------------------------------------
            // VARIABLES
            uint256 public decimals;
            uint256 public totalSupply;
            mapping(address => uint256) public balanceOf;
            mapping(address => mapping(address => uint256)) public allowance;
            mapping(address => uint256) public nonces;
            //---------------------------------------------------------------------------
            // EVENTS
            event Approval(address indexed owner, address indexed spender, uint256 value);
            event Transfer(address indexed from, address indexed to, uint256 value);
            constructor(string memory _name, string memory _symbol) {
                name = _name;
                symbol = _symbol;
                uint256 chainId;
                assembly {
                    chainId := chainid()
                }
                DOMAIN_SEPARATOR = keccak256(
                    abi.encode(
                        keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"),
                        keccak256(bytes(name)),
                        keccak256(bytes("1")),
                        chainId,
                        address(this)
                    )
                );
            }
            function _mint(address to, uint256 value) internal {
                totalSupply = totalSupply.add(value);
                balanceOf[to] = balanceOf[to].add(value);
                emit Transfer(address(0), to, value);
            }
            function _burn(address from, uint256 value) internal {
                balanceOf[from] = balanceOf[from].sub(value);
                totalSupply = totalSupply.sub(value);
                emit Transfer(from, address(0), value);
            }
            function _approve(
                address owner,
                address spender,
                uint256 value
            ) private {
                allowance[owner][spender] = value;
                emit Approval(owner, spender, value);
            }
            function _transfer(
                address from,
                address to,
                uint256 value
            ) private {
                balanceOf[from] = balanceOf[from].sub(value);
                balanceOf[to] = balanceOf[to].add(value);
                emit Transfer(from, to, value);
            }
            function approve(address spender, uint256 value) external returns (bool) {
                _approve(msg.sender, spender, value);
                return true;
            }
            function transfer(address to, uint256 value) external returns (bool) {
                _transfer(msg.sender, to, value);
                return true;
            }
            function transferFrom(
                address from,
                address to,
                uint256 value
            ) external returns (bool) {
                if (allowance[from][msg.sender] != uint256(-1)) {
                    allowance[from][msg.sender] = allowance[from][msg.sender].sub(value);
                }
                _transfer(from, to, value);
                return true;
            }
            function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
                _approve(msg.sender, spender, allowance[msg.sender][spender].add(addedValue));
                return true;
            }
            function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
                _approve(msg.sender, spender, allowance[msg.sender][spender].sub(subtractedValue, "ERC20: decreased allowance below zero"));
                return true;
            }
            function permit(
                address owner,
                address spender,
                uint256 value,
                uint256 deadline,
                uint8 v,
                bytes32 r,
                bytes32 s
            ) external {
                require(deadline >= block.timestamp, "Bridge: EXPIRED");
                bytes32 digest = keccak256(
                    abi.encodePacked(
                        "\\x19\\x01",
                        DOMAIN_SEPARATOR,
                        keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline))
                    )
                );
                address recoveredAddress = ecrecover(digest, v, r, s);
                require(recoveredAddress != address(0) && recoveredAddress == owner, "Bridge: INVALID_SIGNATURE");
                _approve(owner, spender, value);
            }
        }
        // SPDX-License-Identifier: BUSL-1.1
        pragma solidity ^0.7.6;
        pragma abicoder v2;
        import "../Pool.sol";
        interface IStargateFeeLibrary {
            function getFees(
                uint256 _srcPoolId,
                uint256 _dstPoolId,
                uint16 _dstChainId,
                address _from,
                uint256 _amountSD
            ) external returns (Pool.SwapObj memory s);
            function getVersion() external view returns (string memory);
        }
        // SPDX-License-Identifier: MIT
        pragma solidity ^0.7.0;
        /**
         * @dev Wrappers over Solidity's arithmetic operations with added overflow
         * checks.
         *
         * Arithmetic operations in Solidity wrap on overflow. This can easily result
         * in bugs, because programmers usually assume that an overflow raises an
         * error, which is the standard behavior in high level programming languages.
         * `SafeMath` restores this intuition by reverting the transaction when an
         * operation overflows.
         *
         * Using this library instead of the unchecked operations eliminates an entire
         * class of bugs, so it's recommended to use it always.
         */
        library SafeMath {
            /**
             * @dev Returns the addition of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                uint256 c = a + b;
                if (c < a) return (false, 0);
                return (true, c);
            }
            /**
             * @dev Returns the substraction of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b > a) return (false, 0);
                return (true, a - b);
            }
            /**
             * @dev Returns the multiplication of two unsigned integers, with an overflow flag.
             *
             * _Available since v3.4._
             */
            function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                // Gas optimization: this is cheaper than requiring 'a' not being zero, but the
                // benefit is lost if 'b' is also tested.
                // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
                if (a == 0) return (true, 0);
                uint256 c = a * b;
                if (c / a != b) return (false, 0);
                return (true, c);
            }
            /**
             * @dev Returns the division of two unsigned integers, with a division by zero flag.
             *
             * _Available since v3.4._
             */
            function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b == 0) return (false, 0);
                return (true, a / b);
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
             *
             * _Available since v3.4._
             */
            function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
                if (b == 0) return (false, 0);
                return (true, a % b);
            }
            /**
             * @dev Returns the addition of two unsigned integers, reverting on
             * overflow.
             *
             * Counterpart to Solidity's `+` operator.
             *
             * Requirements:
             *
             * - Addition cannot overflow.
             */
            function add(uint256 a, uint256 b) internal pure returns (uint256) {
                uint256 c = a + b;
                require(c >= a, "SafeMath: addition overflow");
                return c;
            }
            /**
             * @dev Returns the subtraction of two unsigned integers, reverting on
             * overflow (when the result is negative).
             *
             * Counterpart to Solidity's `-` operator.
             *
             * Requirements:
             *
             * - Subtraction cannot overflow.
             */
            function sub(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b <= a, "SafeMath: subtraction overflow");
                return a - b;
            }
            /**
             * @dev Returns the multiplication of two unsigned integers, reverting on
             * overflow.
             *
             * Counterpart to Solidity's `*` operator.
             *
             * Requirements:
             *
             * - Multiplication cannot overflow.
             */
            function mul(uint256 a, uint256 b) internal pure returns (uint256) {
                if (a == 0) return 0;
                uint256 c = a * b;
                require(c / a == b, "SafeMath: multiplication overflow");
                return c;
            }
            /**
             * @dev Returns the integer division of two unsigned integers, reverting on
             * division by zero. The result is rounded towards zero.
             *
             * Counterpart to Solidity's `/` operator. Note: this function uses a
             * `revert` opcode (which leaves remaining gas untouched) while Solidity
             * uses an invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function div(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b > 0, "SafeMath: division by zero");
                return a / b;
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
             * reverting when dividing by zero.
             *
             * Counterpart to Solidity's `%` operator. This function uses a `revert`
             * opcode (which leaves remaining gas untouched) while Solidity uses an
             * invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function mod(uint256 a, uint256 b) internal pure returns (uint256) {
                require(b > 0, "SafeMath: modulo by zero");
                return a % b;
            }
            /**
             * @dev Returns the subtraction of two unsigned integers, reverting with custom message on
             * overflow (when the result is negative).
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {trySub}.
             *
             * Counterpart to Solidity's `-` operator.
             *
             * Requirements:
             *
             * - Subtraction cannot overflow.
             */
            function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b <= a, errorMessage);
                return a - b;
            }
            /**
             * @dev Returns the integer division of two unsigned integers, reverting with custom message on
             * division by zero. The result is rounded towards zero.
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {tryDiv}.
             *
             * Counterpart to Solidity's `/` operator. Note: this function uses a
             * `revert` opcode (which leaves remaining gas untouched) while Solidity
             * uses an invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b > 0, errorMessage);
                return a / b;
            }
            /**
             * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
             * reverting with custom message when dividing by zero.
             *
             * CAUTION: This function is deprecated because it requires allocating memory for the error
             * message unnecessarily. For custom revert reasons use {tryMod}.
             *
             * Counterpart to Solidity's `%` operator. This function uses a `revert`
             * opcode (which leaves remaining gas untouched) while Solidity uses an
             * invalid opcode to revert (consuming all remaining gas).
             *
             * Requirements:
             *
             * - The divisor cannot be zero.
             */
            function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
                require(b > 0, errorMessage);
                return a % b;
            }
        }
        // SPDX-License-Identifier: MIT
        pragma solidity >=0.6.0 <0.8.0;
        /*
         * @dev Provides information about the current execution context, including the
         * sender of the transaction and its data. While these are generally available
         * via msg.sender and msg.data, they should not be accessed in such a direct
         * manner, since when dealing with GSN meta-transactions the account sending and
         * paying for execution may not be the actual sender (as far as an application
         * is concerned).
         *
         * This contract is only required for intermediate, library-like contracts.
         */
        abstract contract Context {
            function _msgSender() internal view virtual returns (address payable) {
                return msg.sender;
            }
            function _msgData() internal view virtual returns (bytes memory) {
                this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
                return msg.data;
            }
        }