GEB Docs
Search
⌃K

Proxy Actions

Convenience class to call functions from GebProxyActions through a proxy contract registered in the GebProxyRegistry. These actions bundle multiple actions in one (e.g: open a safe + lock some ETH + draw some system coins).

Constructors

+ new GebProxyActions(proxyAddress: string, network: GebDeployment, chainProvider: GebProviderInterface): GebProxyActions
Parameters:
Name
Type
proxyAddress
string
network
GebDeployment
chainProvider
GebProviderInterface
Returns: GebProxyActions

Properties

proxy

proxy: DsProxy
Underlying proxy object. Can be used to make custom calls to the proxy using the proxy.execute() function.

proxyActionCoreAddress

proxyActionCoreAddress: string
Address of the base proxy action contract.

proxyActionGlobalSettlementAddress

proxyActionGlobalSettlementAddress: string
Address of the proxy action contract for global settlement.

proxyActionIncentiveAddress

proxyActionIncentiveAddress: string
Address of the proxy action contract for Uniswap LP share staking.

proxyActionLeverageAddress

proxyActionLeverageAddress: string
Address of the proxy action contract used for leverage with flash loans.

proxyAddress

proxyAddress: string
Address of the underlying proxy.

Methods

allowSAFE

allowSAFE(safe: BigNumberish, usr: string, ok: BigNumberish): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
usr
string
ok
BigNumberish
Returns: TransactionRequest

approveSAFEModification

approveSAFEModification(obj: string, usr: string): TransactionRequest
Parameters:
Name
Type
obj
string
usr
string
Returns: TransactionRequest

coinJoin_join

coinJoin_join(apt: string, safeHandler: string, wad: BigNumberish): TransactionRequest
Parameters:
Name
Type
apt
string
safeHandler
string
wad
BigNumberish
Returns: TransactionRequest

denySAFEModification

denySAFEModification(obj: string, usr: string): TransactionRequest
Parameters:
Name
Type
obj
string
usr
string
Returns: TransactionRequest

enterSystem

enterSystem(src: string, safe: BigNumberish): TransactionRequest
Parameters:
Name
Type
src
string
safe
BigNumberish
Returns: TransactionRequest

exitETH

exitETH(safe: BigNumberish, wad: BigNumberish): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
wad
BigNumberish
Returns: TransactionRequest

exitTokenCollateral

exitTokenCollateral(collateralJoin: string, safe: BigNumberish, amt: BigNumberish): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
safe
BigNumberish
amt
BigNumberish
Returns: TransactionRequest

flashDeleverage

flashDeleverage(uniswapV2Pair: string, callbackProxy: string, collateralType: BytesLike, safe: BigNumberish): TransactionRequest
Parameters:
Name
Type
uniswapV2Pair
string
callbackProxy
string
collateralType
BytesLike
safe
BigNumberish
Returns: TransactionRequest

flashDeleverageFreeETH

flashDeleverageFreeETH(uniswapV2Pair: string, callbackProxy: string, collateralType: BytesLike, safe: BigNumberish, amountToFree: BigNumberish): TransactionRequest
Parameters:
Name
Type
uniswapV2Pair
string
callbackProxy
string
collateralType
BytesLike
safe
BigNumberish
amountToFree
BigNumberish
Returns: TransactionRequest

flashLeverage

flashLeverage(uniswapV2Pair: string, callbackProxy: string, collateralType: BytesLike, safe: BigNumberish, leverage: BigNumberish): TransactionRequest
Parameters:
Name
Type
uniswapV2Pair
string
callbackProxy
string
collateralType
BytesLike
safe
BigNumberish
leverage
BigNumberish
Returns: TransactionRequest

freeETH

freeETH(safe: BigNumberish, wad: BigNumberish): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
wad
BigNumberish
Returns: TransactionRequest

freeTokenCollateral

freeTokenCollateral(collateralJoin: string, safe: BigNumberish, amt: BigNumberish): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
safe
BigNumberish
amt
BigNumberish
Returns: TransactionRequest

freeTokenCollateralGlobalSettlement

freeTokenCollateralGlobalSettlement(collateralJoin: string, safe: BigNumberish): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
safe
BigNumberish
Returns: TransactionRequest

generateDebt

generateDebt(safe: BigNumberish, wad: BigNumberish): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
wad
BigNumberish
Returns: TransactionRequest

generateDebtAndProtectSAFE

generateDebtAndProtectSAFE(safe: BigNumberish, wad: BigNumberish, saviour: string): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
wad
BigNumberish
saviour
string
Returns: TransactionRequest

lockETH

lockETH(ethValue: BigNumberish, safe: BigNumberish): TransactionRequest
Parameters:
Name
Type
ethValue
BigNumberish
safe
BigNumberish
Returns: TransactionRequest

lockETHAndGenerateDebt

lockETHAndGenerateDebt(ethValue: BigNumberish, safe: BigNumberish, deltaWad: BigNumberish): TransactionRequest
Parameters:
Name
Type
ethValue
BigNumberish
safe
BigNumberish
deltaWad
BigNumberish
Returns: TransactionRequest

lockETHLeverage

lockETHLeverage(ethValue: BigNumberish, uniswapV2Pair: string, callbackProxy: string, collateralType: BytesLike, safe: BigNumberish, leverage: BigNumberish): TransactionRequest
Parameters:
Name
Type
ethValue
BigNumberish
uniswapV2Pair
string
callbackProxy
string
collateralType
BytesLike
safe
BigNumberish
leverage
BigNumberish
Returns: TransactionRequest

lockTokenCollateral

lockTokenCollateral(collateralJoin: string, safe: BigNumberish, amt: BigNumberish, transferFrom: boolean): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
safe
BigNumberish
amt
BigNumberish
transferFrom
boolean
Returns: TransactionRequest

lockTokenCollateralAndGenerateDebt

lockTokenCollateralAndGenerateDebt(collateralJoin: string, safe: BigNumberish, collateralAmount: BigNumberish, deltaWad: BigNumberish, transferFrom: boolean): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
safe
BigNumberish
collateralAmount
BigNumberish
deltaWad
BigNumberish
transferFrom
boolean
Returns: TransactionRequest

lockTokenCollateralGenerateDebtAndProtectSAFE

lockTokenCollateralGenerateDebtAndProtectSAFE(collateralJoin: string, safe: BigNumberish, collateralAmount: BigNumberish, deltaWad: BigNumberish, transferFrom: boolean, saviour: string): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
safe
BigNumberish
collateralAmount
BigNumberish
deltaWad
BigNumberish
transferFrom
boolean
saviour
string
Returns: TransactionRequest

makeCollateralBag

makeCollateralBag(collateralJoin: string): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
Returns: TransactionRequest

modifySAFECollateralization

modifySAFECollateralization(safe: BigNumberish, deltaCollateral: BigNumberish, deltaDebt: BigNumberish): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
deltaCollateral
BigNumberish
deltaDebt
BigNumberish
Returns: TransactionRequest

moveSAFE

moveSAFE(safeSrc: BigNumberish, safeDst: BigNumberish): TransactionRequest
Parameters:
Name
Type
safeSrc
BigNumberish
safeDst
BigNumberish
Returns: TransactionRequest

openLockETHAndGenerateDebt

openLockETHAndGenerateDebt(ethValue: BigNumberish, collateralType: BytesLike, deltaWad: BigNumberish): TransactionRequest
Parameters:
Name
Type
ethValue
BigNumberish
collateralType
BytesLike
deltaWad
BigNumberish
Returns: TransactionRequest

openLockETHGenerateDebtAndProtectSAFE

openLockETHGenerateDebtAndProtectSAFE(ethValue: BigNumberish, collateralType: BytesLike, deltaWad: BigNumberish, saviour: string): TransactionRequest
Parameters:
Name
Type
ethValue
BigNumberish
collateralType
BytesLike
deltaWad
BigNumberish
saviour
string
Returns: TransactionRequest

openLockETHLeverage

openLockETHLeverage(ethValue: BigNumberish, uniswapV2Pair: string, callbackProxy: string, collateralType: BytesLike, leverage: BigNumberish): TransactionRequest
Parameters:
Name
Type
ethValue
BigNumberish
uniswapV2Pair
string
callbackProxy
string
collateralType
BytesLike
leverage
BigNumberish
Returns: TransactionRequest

openLockGNTAndGenerateDebt

openLockGNTAndGenerateDebt(gntJoin: string, collateralType: BytesLike, collateralAmount: BigNumberish, deltaWad: BigNumberish): TransactionRequest
Parameters:
Name
Type
gntJoin
string
collateralType
BytesLike
collateralAmount
BigNumberish
deltaWad
BigNumberish
Returns: TransactionRequest

openLockGNTGenerateDebtAndProtectSAFE

openLockGNTGenerateDebtAndProtectSAFE(gntJoin: string, collateralType: BytesLike, collateralAmount: BigNumberish, deltaWad: BigNumberish, saviour: string): TransactionRequest
Parameters:
Name
Type
gntJoin
string
collateralType
BytesLike
collateralAmount
BigNumberish
deltaWad
BigNumberish
saviour
string
Returns: TransactionRequest

openLockTokenCollateralAndGenerateDebt

openLockTokenCollateralAndGenerateDebt(collateralJoin: string, collateralType: BytesLike, collateralAmount: BigNumberish, deltaWad: BigNumberish, transferFrom: boolean): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
collateralType
BytesLike
collateralAmount
BigNumberish
deltaWad
BigNumberish
transferFrom
boolean
Returns: TransactionRequest

openLockTokenCollateralGenerateDebtAndProtectSAFE

openLockTokenCollateralGenerateDebtAndProtectSAFE(collateralJoin: string, collateralType: BytesLike, collateralAmount: BigNumberish, deltaWad: BigNumberish, transferFrom: boolean, saviour: string): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
collateralType
BytesLike
collateralAmount
BigNumberish
deltaWad
BigNumberish
transferFrom
boolean
saviour
string
Returns: TransactionRequest

openSAFE

openSAFE(collateralType: BytesLike, usr: string): TransactionRequest
Parameters:
Name
Type
collateralType
BytesLike
usr
string
Returns: TransactionRequest

prepareCoinsForRedeemingGlobalSettlement

prepareCoinsForRedeemingGlobalSettlement(wad: BigNumberish): TransactionRequest
Parameters:
Name
Type
wad
BigNumberish
Returns: TransactionRequest

protectSAFE

protectSAFE(safe: BigNumberish, saviour: string): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
saviour
string
Returns: TransactionRequest

quitSystem

quitSystem(safe: BigNumberish, dst: string): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
dst
string
Returns: TransactionRequest

redeemETHGlobalSettlement

redeemETHGlobalSettlement(ethJoin: string, collateralType: BytesLike, wad: BigNumberish): TransactionRequest
Parameters:
Name
Type
ethJoin
string
collateralType
BytesLike
wad
BigNumberish
Returns: TransactionRequest

redeemTokenCollateralGlobalSettlement

redeemTokenCollateralGlobalSettlement(collateralJoin: string, collateralType: BytesLike, wad: BigNumberish): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
collateralType
BytesLike
wad
BigNumberish
Returns: TransactionRequest

repayAllDebt

repayAllDebt(safe: BigNumberish): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
Returns: TransactionRequest

repayAllDebtAndFreeETH

repayAllDebtAndFreeETH(safe: BigNumberish, collateralWad: BigNumberish): TransactionRequest
Parameters:
Name
Type
safe
BigNumberish
collateralWad
BigNumberish
Returns: TransactionRequest

repayAllDebtAndFreeTokenCollateral

repayAllDebtAndFreeTokenCollateral(collateralJoin: string, safe: BigNumberish, collateralAmount: BigNumberish): TransactionRequest
Parameters:
Name
Type
collateralJoin
string
safe
BigNumberish
collateralAmount