IAmmalgamFactory
Functions
feeTo
Returns the fee recipient address.
function feeTo() external view returns (address);
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | The address of the fee recipient. |
feeToSetter
Returns the address that can change the fee recipient.
function feeToSetter() external view returns (address);
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | The address of the fee setter. |
getPair
Returns the pair address for two tokens.
function getPair(address tokenA, address tokenB) external view returns (address pair);
Parameters
| Name | Type | Description |
|---|---|---|
tokenA | address | The first token. |
tokenB | address | The second token. |
Returns
| Name | Type | Description |
|---|---|---|
pair | address | The address of the pair for the two tokens. |
allPairs
Returns the pair address at a specific index.
function allPairs(uint256 index) external view returns (address pair);
Parameters
| Name | Type | Description |
|---|---|---|
index | uint256 | The index of the pair. |
Returns
| Name | Type | Description |
|---|---|---|
pair | address | The address of the pair at the given index. |
allPairsLength
Returns the total number of token pairs.
function allPairsLength() external view returns (uint256);
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | The total number of token pairs. |
createPair
Creates a new pair for two tokens.
function createPair(address tokenA, address tokenB) external returns (address pair);
Parameters
| Name | Type | Description |
|---|---|---|
tokenA | address | The first token. |
tokenB | address | The second token. |
Returns
| Name | Type | Description |
|---|---|---|
pair | address | The address of the new pair. |
setFeeTo
Changes the fee recipient address.
function setFeeTo(address newFeeTo) external;
Parameters
| Name | Type | Description |
|---|---|---|
newFeeTo | address | The new fee recipient address. |
setFeeToSetter
Changes the address that can change the fee recipient.
function setFeeToSetter(address newFeeToSetter) external;
Parameters
| Name | Type | Description |
|---|---|---|
newFeeToSetter | address | The new fee setter address. |
Events
PairCreated
Emitted when a new pair is created.
event PairCreated(address indexed tokenX, address indexed tokenY, address pair, uint256 allPairsLength);
Parameters
| Name | Type | Description |
|---|---|---|
tokenX | address | The first token in the pair. |
tokenY | address | The second token in the pair. |
pair | address | The address of the new pair. |
allPairsLength | uint256 | The current total number of token pairs. |