1.0.0
Understand Options
Options
Interfacing with Pods
Code Integration Guides
User Guides
Security
APPENDIX
Additional Resources
Smart Contracts
.png?alt=media&token=539abea8-b0a5-4b7f-83d1-822ea815c767)
Option Instrument Diagram
Main contracts
OptionFactory
Contract responsible for creating/deploying new option contracts. This contract can create four different option's contracts:
PodPut, WPodPut, PodCall, WPodCall. It uses the "Mega Factory" pattern, where it uses auxiliary "builder" contracts (PodPutBuilder, WPodPutBuilder, PodCallBuilder, WPodCallBuilder). From the users/developer's perspective, they do not need to interact with those auxiliary contracts. OptionFactory has only one function:PodPut
The contract for American or European Put options. It works with any
ERC20 pair as the strike asset and underlying asset. This contract is also compatible with aTokens on the strike asset or the underlying asset. It is possible to interact with the contract mainly using:WPodPut
Same logic as the PodPut, but with some special function to convert
ETH into WETH. The underlying asset of that contract must be the official WETH address. The only function that has a different signature is theexerciseEth. Although the other functions work differently under the hood, they have the same signature of the PodPut:If you want to manage
WETH / ETH conversion yourself, you can simply use PodPut with WETH in the underlying asset parameter.If you are using WPodPut on a testnet, you should use a contract address for the underlying asset with the same interface of the mainnet WETH. You can check our WETH address for testnets on our deployed contracts page.
PodCall
The contract for American or European Call options. It works with any
ERC20 pair as the strike asset and underlying asset. This contract is also compatible with aTokens on the strike asset or the underlying asset. It is possible to interact with the contract mainly using:WPodCall
Same logic as the PodCall, but with some special function to convert
ETH into WETH. The underlying asset of that contract must be the official WETH address. The only function that has a different signature is the mintEth. Although the other functions work differently under the hood, they have the same signature of the PodPut:If you want to manage
WETH / ETH conversion yourself, you can use PodCall with WETH in the underlying asset parameter.If you are using WPodCall on a testnet, you should use a contract address for the underlying asset with the same interface of the mainnet
WETH. You can check our WETH address for testnets on our deployed contracts page. Auxiliary Contracts
PodPutBuilder / PodCallBuilder / WPodPutBuilder / WPodCallBuilder
All those contracts are the direct factories of the Option contracts. We will not cover them in our documentation, but you can check directly on our code. Check our Github. They all have the same function and parameters used to deploy a new option contract:
- buildOption()
Last modified 1yr ago