PanopticFactory

Git Source

Inherits: FactoryNFT, Multicall

Author: Axicon Labs Limited

Facilitates deployment of Panoptic pools.

State Variables

UNIV3_FACTORY

The Uniswap V3 factory contract to use.

IUniswapV3Factory internal immutable UNIV3_FACTORY;

SFPM

The Semi Fungible Position Manager (SFPM) which tracks option positions across Panoptic Pools.

SemiFungiblePositionManager internal immutable SFPM;

POOL_REFERENCE

Reference implementation of the PanopticPool to clone.

address internal immutable POOL_REFERENCE;

COLLATERAL_REFERENCE

Reference implementation of the CollateralTracker to clone.

address internal immutable COLLATERAL_REFERENCE;

CARDINALITY_INCREASE

The observationCardinalityNext to set on the Uniswap pool when a new PanopticPool is deployed.

uint16 internal constant CARDINALITY_INCREASE = 51;

s_getPanopticPool

Mapping from address(UniswapV3Pool) to address(PanopticPool) that stores the address of all deployed Panoptic Pools.

mapping(IUniswapV3Pool univ3pool => PanopticPool panopticPool) internal s_getPanopticPool;

Functions

constructor

Set immutable variables and store metadata pointers.

constructor(
    SemiFungiblePositionManager _SFPM,
    IUniswapV3Factory _univ3Factory,
    address _poolReference,
    address _collateralReference,
    bytes32[] memory properties,
    uint256[][] memory indices,
    Pointer[][] memory pointers
) FactoryNFT(properties, indices, pointers);

Parameters

Name	Type	Description
_SFPM	SemiFungiblePositionManager	The canonical SemiFungiblePositionManager deployment
_univ3Factory	IUniswapV3Factory	The canonical Uniswap V3 Factory deployment
_poolReference	address	The reference implementation of the PanopticPool to clone
_collateralReference	address	The reference implementation of the CollateralTracker to clone
properties	bytes32[]	An array of identifiers for different categories of metadata
indices	uint256[][]	A nested array of keys for K-V metadata pairs for each property in properties
pointers	Pointer[][]	Contains pointers to the metadata values stored in contract data slices for each index in indices

deployNewPool

Create a new Panoptic Pool linked to the given Uniswap pool identified uniquely by the incoming parameters.

There is a 1:1 mapping between a Panoptic Pool and a Uniswap Pool.

A Uniswap pool is uniquely identified by its tokens and the fee.

Salt used in PanopticPool CREATE2 is [leading 20 msg.sender chars][leading 20 pool address chars][salt].

function deployNewPool(address token0, address token1, uint24 fee, uint96 salt)
    external
    returns (PanopticPool newPoolContract);

Parameters

Name	Type	Description
token0	address	Address of token0 for the underlying Uniswap V3 pool
token1	address	Address of token1 for the underlying Uniswap V3 pool
fee	uint24	The fee tier of the underlying Uniswap V3 pool, denominated in hundredths of bips
salt	uint96	User-defined component of salt used in CREATE2 for the PanopticPool (must be a uint96 number)

Returns

Name	Type	Description
newPoolContract	PanopticPool	The address of the newly deployed Panoptic pool

minePoolAddress

Find the salt which would give a Panoptic Pool the highest rarity within the search parameters.

The rarity is defined in terms of how many leading zeros the Panoptic pool address has.

Note that the final salt may overflow if too many loops are given relative to the amount in salt.

function minePoolAddress(address deployerAddress, address v3Pool, uint96 salt, uint256 loops, uint256 minTargetRarity)
    external
    view
    returns (uint96 bestSalt, uint256 highestRarity);

Parameters

Name	Type	Description
deployerAddress	address	Address of the account that deploys the new PanopticPool
v3Pool	address	Address of the underlying UniswapV3Pool
salt	uint96	Salt value to start from, useful as a checkpoint across multiple calls
loops	uint256	The number of mining operations starting from salt in trying to find the highest rarity
minTargetRarity	uint256	The minimum target rarity to mine for. The internal loop stops when this is reached or when no more iterations

Returns

Name	Type	Description
bestSalt	uint96	The salt of the rarest pool (potentially at the specified minimum target)
highestRarity	uint256	The rarity of bestSalt

getPanopticPool

Return the address of the Panoptic Pool associated with univ3pool.

function getPanopticPool(IUniswapV3Pool univ3pool) external view returns (PanopticPool);

Parameters

Name	Type	Description
univ3pool	IUniswapV3Pool	The Uniswap V3 pool address to query

Returns

Name	Type	Description
<none>	PanopticPool	Address of the Panoptic Pool associated with univ3pool

Events

PoolDeployed

Emitted when a Panoptic Pool is created.

event PoolDeployed(
    PanopticPool indexed poolAddress,
    IUniswapV3Pool indexed uniswapPool,
    CollateralTracker collateralTracker0,
    CollateralTracker collateralTracker1
);

Parameters

Name	Type	Description
poolAddress	PanopticPool	Address of the deployed Panoptic pool
uniswapPool	IUniswapV3Pool	Address of the underlying Uniswap V3 pool
collateralTracker0	CollateralTracker	Address of the collateral tracker contract for token0
collateralTracker1	CollateralTracker	Address of the collateral tracker contract for token1