View Source Uniswap.Contracts.V3Factory (Uniswap v0.0.1-dev)

Uniswap V3 Factory Contract

Summary

Functions

Default address of the contract. Returns nil if not specified.

Prepares contract constructor values for deployment.

Prepares createPool(address tokenA, address tokenB, uint24 fee) call parameters on the contract.

Prepares enableFeeAmount(uint24 fee, int24 tickSpacing) call parameters on the contract.

Prepares feeAmountTickSpacing(uint24) call parameters on the contract.

Prepares getPool(address, address, uint24) call parameters on the contract.

Prepares owner() call parameters on the contract.

Prepares parameters() call parameters on the contract.

Prepares setOwner(address _owner) call parameters on the contract.

Functions

@spec __default_address__() :: Ethers.Types.t_address()

Default address of the contract. Returns nil if not specified.

To specify a default address see Ethers.Contract

@spec constructor() :: binary()

Prepares contract constructor values for deployment.

To deploy a contracts use Ethers.deploy/2 and pass the result of this function as :encoded_constructor option.

Parameters

Link to this function

create_pool(token_a, token_b, fee)

View Source

Prepares createPool(address tokenA, address tokenB, uint24 fee) call parameters on the contract.

This function can be used for a transaction or additionally called for results (Use Ethers.send/2). No amount of Ether can be sent with this function.

State mutability: non_payable

Function Parameter Types

  • tokenA: :address
  • tokenB: :address
  • fee: {:uint, 24}

Return Types (when called with Ethers.call/2)

  • pool: :address
Link to this function

enable_fee_amount(fee, tick_spacing)

View Source
@spec enable_fee_amount(non_neg_integer(), integer()) :: Ethers.TxData.t()

Prepares enableFeeAmount(uint24 fee, int24 tickSpacing) call parameters on the contract.

This function can be used for a transaction or additionally called for results (Use Ethers.send/2). No amount of Ether can be sent with this function.

State mutability: non_payable

Function Parameter Types

  • fee: {:uint, 24}
  • tickSpacing: {:int, 24}

Return Types (when called with Ethers.call/2)

This function does not return any values!

Link to this function

fee_amount_tick_spacing(arg1)

View Source
@spec fee_amount_tick_spacing(non_neg_integer()) :: Ethers.TxData.t()

Prepares feeAmountTickSpacing(uint24) call parameters on the contract.

This function should only be called for result and never in a transaction on its own. (Use Ethers.call/2)

State mutability: view

Function Parameter Types

  • {:uint, 24}

Return Types (when called with Ethers.call/2)

  • {:int, 24}
Link to this function

get_pool(arg1, arg2, arg3)

View Source

Prepares getPool(address, address, uint24) call parameters on the contract.

This function should only be called for result and never in a transaction on its own. (Use Ethers.call/2)

State mutability: view

Function Parameter Types

  • :address
  • :address
  • {:uint, 24}

Return Types (when called with Ethers.call/2)

  • :address
@spec owner() :: Ethers.TxData.t()

Prepares owner() call parameters on the contract.

This function should only be called for result and never in a transaction on its own. (Use Ethers.call/2)

State mutability: view

Return Types (when called with Ethers.call/2)

  • :address
@spec parameters() :: Ethers.TxData.t()

Prepares parameters() call parameters on the contract.

This function should only be called for result and never in a transaction on its own. (Use Ethers.call/2)

State mutability: view

Return Types (when called with Ethers.call/2)

  • factory: :address
  • token0: :address
  • token1: :address
  • fee: {:uint, 24}
  • tickSpacing: {:int, 24}
@spec set_owner(Ethers.Types.t_address()) :: Ethers.TxData.t()

Prepares setOwner(address _owner) call parameters on the contract.

This function can be used for a transaction or additionally called for results (Use Ethers.send/2). No amount of Ether can be sent with this function.

State mutability: non_payable

Function Parameter Types

  • _owner: :address

Return Types (when called with Ethers.call/2)

This function does not return any values!