Factory

White Whale's factory contract is used to create pair (pool) contracts. Pools are comprised of two tokens, which can be either native, ibc or cw20 tokens. Once a pool is created it's stored in state, meaning the factory acts as a pool registry, which can be queried for reference. Note that the pool factory is permissioned, meaning the messages can only be executed by the owner of the contract.

Create a pair

Creating a pair (pool) can be done via the create_pair message. Note that for creating pools with native or ibc tokens, add_native_token_decimals should be called in advance with a small amount of the desired asset (say one micro unit). This is used to whitelist native/ibc tokens, allowing pools to be created with those.

The code for the Factory contract can be found here.

The following are the messages that can be executed on the factory:

Instantiate

Instantiates the pool factory.

{
  "pair_code_id": 1,
  "trio_code_id": 2,
  "token_code_id": 3,
  "fee_collector_addr": "fee_collector_addr"
}

Key	Type	Description
`pair_code_id`	u64	Code id for the pair/pool contract
`trio_code_id`	u64	Code id for the stableswap 3pool contract
`token_code_id`	u64	Code id for the token contract
`fee_collector_addr`	String	Address of the fee collector contract

Migrate

Migrates the pool factory.

{}

ExecuteMsg

Add Native Token Decimals

Used to validate native or ibc tokens, adding them to a whitelist so pools can be created with them. Along with this message, a small amount of the token should be transferred.

{% hint style="warning" %} Note: This should be called before a pool with the given native/ibc token can be created. {% endhint %}

{
  "add_native_token_decimals": {
    "denom": "uwhale",
    "decimals": 6
  }
}

Key	Type	Description
`denom`	String	denom of the native/ibc asset
`decimals`	u8	Decimal places for that asset

Create pair

Creates a pool with the given assets and pool fees. If the pool already exists, the transaction will fail.

{
  "create_pair": {
    "asset_infos": [
      {
        "native_token": {
          "denom": "uluna"
        }
      },
      {
        "token": {
          "contract_addr": "terra1..."
        }
      }
    ],
    "pool_fees": {
      "protocol_fee": {
        "share": "0.001"
      },
      "swap_fee": {
        "share": "0.003"
      },
      "burn_fee": {
        "share": "0.0"
      }
    },
    "pair_type": "constant_product",
    "token_factory_lp": true
  }
}

Key	Type	Description
`asset_infos`	[AssetInfo; 2]	Information about the two assets to create the pair with
`pool_fees`	PoolFee	Pool fees for the given pair
`pair_type`	PairType	The variant of pair to create, it can be ConstantProduct or StableSwap
`token_factory_lp`	bool	If true, the pair will use the token factory to create the LP token. If false, it will use a cw20 token instead

Create trio

Creates a pool with the 3 assets. If the pool already exists, the transaction will fail.

{
  "create_trio": {
    "asset_infos": [
      {
        "native_token": {
          "denom": "usdc"
        }
      },
      {
        "native_token": {
          "denom": "usdt"
        }
      },
      {
        "native_token": {
          "denom": "axlusdc"
        }
      }
    ],
    "pool_fees": {
      "protocol_fee": {
        "share": "0.001"
      },
      "swap_fee": {
        "share": "0.003"
      },
      "burn_fee": {
        "share": "0.0"
      }
    },
    "amp_factor": 85,
    "token_factory_lp": true
  }
}

Key	Type	Description
`asset_infos`	[AssetInfo; 3]	Information about the two assets to create the pair with
`pool_fees`	PoolFee	Pool fees for the given pair
`amp_factor`	u64	Amplification factor to use for the 3 pool. This affects the swap curve, see https://curve.fi/files/stableswap-paper.pdf for more details
`token_factory_lp`	bool	If true, the pair will use the token factory to create the LP token. If false, it will use a cw20 token instead

Migrate pair

Migrates a pool with the given address to the desired code id.

{
  "migrate_pair": {
    "contract": "pair_address",
    "code_id": 123
  }
}

Key	Type	Description
`contract`	String	Pair contract address to be migrated
`code_id`	Option<u64>	Code id for the pair contract to be migrated to

Migrate trio

Migrates a trio pool with the given address to the desired code id.

{
  "migrate_trio": {
    "contract": "trio_address",
    "code_id": 123
  }
}

Key	Type	Description
`contract`	String	Trio contract address to be migrated
`code_id`	Option<u64>	Code id for the pair contract to be migrated to

Remove pair

Removes a pair for the pool registry. Note that the pool will still live on the blockchain, this action though will make it invisible to the factory, meaning it will be orphan by the protocol. This action could be used in case a pool is no longer desired, e.g. if a pool was set up incorrectly (and can't be fixed by updating the config). Ideally, this should only be done after the pool's liquidity has been withdrawn or migrated.

{
  "remove_pair": {
    "asset_infos": [
      {
        "native_token": {
          "denom": "uluna"
        }
      },
      {
        "token": {
          "contract_addr": "terra1..."
        }
      }
    ]
  }
}

Key	Type	Description
`asset_infos`	[AssetInfo; 2]	Asset infos of the Pair contract to be removed from the factory registry

Remove trio

Removes a trio for the pool registry. Note that the pool will still live on the blockchain, this action though will make it invisible to the factory, meaning it will be orphan by the protocol. This action could be used in case a pool is no longer desired, e.g. if a pool was set up incorrectly (and can't be fixed by updating the config). Ideally, this should only be done after the pool's liquidity has been withdrawn or migrated.

{
  "remove_trio": {
    "asset_infos": [
      {
        "native_token": {
          "denom": "usdc"
        }
      },
      {
        "native_token": {
          "denom": "usdt"
        }
      },
      {
        "native_token": {
          "denom": "axlusdc"
        }
      }
    ]
  }
}

Key	Type	Description
`asset_infos`	[AssetInfo; 3]	Asset infos of the Trio contract to be removed from the factory registry

Update config

Updates the configuration of the factory.

{
  "update_config": {
    "owner": "owner",
    "fee_collector_addr": "fee_collector_addr",
    "token_code_id": 123,
    "pair_code_id": 456,
    "trio_code_id": 789
  }
}

Key	Type	Description
`owner`	Option<String>	New owner of the contract
`fee_collector_addr`	Option<String>	New fee collector address
`token_code_id`	Option<u64>	New code id for the token contract, used by the pair contract to create LP tokens from
`pair_code_id`	Option<u64>	New code id for the pair contract, used by the factory to create pools from
`trio_code_id`	Option<u64>	New code id for the trio contract, used by the factory to create pools from

Update pair config

Updates the configuration of the pair created by the factory.

{
  "update_pair_config": {
    "pair_addr": "pair_contract_addr",
    "owner": "new_owner",
    "fee_collector_addr": "fee_collector_addr",
    "pool_fees": {
      "protocol_fee": {
        "share": "0.001"
      },
      "swap_fee": {
        "share": "0.002"
      },
      "burn_fee": {
        "share": "0.0"
      }
    },
    "feature_toggle": {
      "withdrawals_enabled": true,
      "deposits_enabled": true,
      "swaps_enabled": true
    }
  }
}

Key	Type	Description
`pair_addr`	String	Pair contract address to update the config
`owner`	Option<String>	New owner address
`fee_collector_addr`	Option<String>	New fee collector address
`pool_fees`	Option<PoolFee>	New pool fees
`feature_toggle`	Option<FeatureToggle>	New feature toggle options for the pool

Update trio config

Updates the configuration of the trio created by the factory.

{
  "update_pair_config": {
    "trio_addr": "trio_contract_addr",
    "owner": "new_owner",
    "fee_collector_addr": "fee_collector_addr",
    "pool_fees": {
      "protocol_fee": {
        "share": "0.001"
      },
      "swap_fee": {
        "share": "0.002"
      },
      "burn_fee": {
        "share": "0.0"
      }
    },
    "feature_toggle": {
      "withdrawals_enabled": true,
      "deposits_enabled": true,
      "swaps_enabled": true
    },
    "amp_factor": {
      "future_a": 80,
      "future_block": 1337
    }
  }
}

Key	Type	Description
`trio_addr`	String	Trio contract address to update the config
`owner`	Option<String>	New owner address
`fee_collector_addr`	Option<String>	New fee collector address
`pool_fees`	Option<PoolFee>	New pool fees
`feature_toggle`	Option<FeatureToggle>	New feature toggle options for the pool
`amp_factor`	Option<RampAmp>	New settings for the amplification factor

Queries

Config

Retrieves the configuration of the factory.

{% tabs %} {% tab title="Query" %}

{
  "config": {}
}

{% endtab %}

{% tab title="Response (ConfigResponse)" %}

{
  "owner": "migaloo1...",
  "fee_collector_addr": "migaloo1...",
  "pair_code_id": 123,
  "trio_code_id": 456,
  "token_code_id": 789
}

Key	Type	Description
`owner`	String	Contract's owner address
`fee_collector_addr`	String	Fee collector contract address
`pair_code_id`	u64	Code id for the pair contract
`trio_code_id`	u64	Code id for the trio contract
`token_code_id`	u64	Code id for the token contract

{% endtab %} {% endtabs %}

Native token decimals

Retrieves the native token decimals for the given denom.

{% tabs %} {% tab title="Query" %}

{
  "native_token_decimals": {
    "denom": "uwhale"
  }
}

Key	Type	Description
`denom`	String	Native or IBC denom to query decimals for

{% endtab %}

{% tab title="Response (NativeTokenDecimalsResponse)" %}

{
  "decimals": 6
}

Key	Type	Description
`decimals`	u8	Native or IBC denom decimals for the given denom

{% endtab %} {% endtabs %}

Pair

Retrieves pool information for a given pair.

{% tabs %} {% tab title="Query" %}

{
  "pair": {
    "asset_infos": [
      {
        "native_token": {
          "denom": "uwhale"
        }
      },
      {
        "token": {
          "contract_addr": "migaloo1..."
        }
      }
    ]
  }
}

Key	Type	Description
`asset_infos`	[AssetInfo; 2]	Asset info for the pair to retrieve info about

{% endtab %}

{% tab title="Response (PairInfo)" %}

{
  "asset_infos": [
    {
      "native_token": {
        "denom": "uwhale"
      }
    },
    {
      "token": {
        "contract_addr": "migaloo1..."
      }
    }
  ],
  "contract_addr": "migaloo1...",
  "liquidity_token": "migaloo1...",
  "asset_decimals": [
    6,
    6
  ]
}

Key	Type	Description
`asset_infos`	[AssetInfo; 2]	Asset infos for the pair
`contract_addr`	String	Pair contract address
`liquidity_token`	String	LP token contract address for the pair
`asset_decimals`	[u8; 2]	Decimals for the assets within the pool

{% endtab %} {% endtabs %}

Pairs

Retrieves multiple pool informations. Considering the pool registry can get extensive, pagination is possible. The default limit for the query is 10, while the maximum is 30.

{% tabs %} {% tab title="Query" %}

{
  "pairs": {
    "start_after": [
      {
        "token": {
          "contract_addr": "migaloo1..."
        }
      },
      {
        "native_token": {
          "denom": "uwhale"
        }
      }
    ],
    "limit": 30
  }
}

Key	Type	Description
`start_after`	Option<[AssetInfo; 2]>	Asset infos to start fetching from (when pagination is needed)
`limit`	Option<u32>	How many items to fetch at once. Default is `10`, max `30`

{% endtab %}

{% tab title="Response (PairsResponse)" %}

{
  "pairs": [
    {
      "asset_infos": [
        {
          "native_token": {
            "denom": "uwhale"
          }
        },
        {
          "token": {
            "contract_addr": "migaloo1..."
          }
        }
      ],
      "contract_addr": "migaloo1...",
      "liquidity_token": {
        "native_token": {
          "denom": "factory/migaloo1.../uLP"
        }
      },
      "asset_decimals": [
        6,
        6
      ],
      "pair_type": "constant_product"
    },
    {
      "asset_infos": [
        {
          "native_token": {
            "denom": "uwhale"
          }
        },
        {
          "native_token": {
            "denom": "ibc/107D152BB3176FAEBF4C2A84C5FFDEEA7C7CB4FE1BBDAB710F1FD25BCD055CBF"
          }
        }
      ],
      "contract_addr": "migaloo1...",
      "liquidity_token": {
        "token": {
          "contract_addr": "migaloo1..."
        }
      },
      "asset_decimals": [
        6,
        6
      ],
      "pair_type": {
        "stable_swap": {
          "amp": 85
        }
      }
    }
  ]
}

Key	Type	Description
`pairs`	Vec<PairInfo>	Vector with information about the requested pairs

{% endtab %} {% endtabs %}

Trio

Retrieves pool information for a given trio.

{% tabs %} {% tab title="Query" %}

{
  "trio": {
    "asset_infos": [
      {
        "native_token": {
          "denom": "usdc"
        }
      },
      {
        "native_token": {
          "denom": "usdt"
        }
      },
      {
        "native_token": {
          "denom": "axlusdc"
        }
      }
    ]
  }
}

Key	Type	Description
`asset_infos`	[AssetInfo; 3]	Asset info for the trio to retrieve info about

{% endtab %}

{% tab title="Response (TrioInfo)" %}

{
  "asset_infos": [
    {
      "native_token": {
        "denom": "usdc"
      }
    },
    {
      "native_token": {
        "denom": "usdt"
      }
    },
    {
      "native_token": {
        "denom": "axlusdc"
      }
    }
  ],
  "contract_addr": "migaloo1...",
  "liquidity_token": "migaloo1...",
  "asset_decimals": [
    6,
    6,
    6
  ]
}

Key	Type	Description
`asset_infos`	[AssetInfo; 3]	Asset infos for the trio
`contract_addr`	String	Trio contract address
`liquidity_token`	String	LP token contract address for the trio
`asset_decimals`	[u8; 3]	Decimals for the assets within the pool

{% endtab %} {% endtabs %}

Trios

Retrieves multiple trio pool informations. Considering the pool registry can get extensive, pagination is possible. The default limit for the query is 10, while the maximum is 30.

{% tabs %} {% tab title="Query" %}

{
  "trios": {
    "start_after": [
      {
        "native_token": {
          "denom": "usdc"
        }
      },
      {
        "native_token": {
          "denom": "usdt"
        }
      },
      {
        "native_token": {
          "denom": "axlusdc"
        }
      }
    ],
    "limit": 30
  }
}

Key	Type	Description
`start_after`	Option<[AssetInfo; 3]>	Asset infos to start fetching from (when pagination is needed)
`limit`	Option<u32>	How many items to fetch at once. Default is `10`, max `30`

{% endtab %}

{% tab title="Response (TriosResponse)" %}

{
  "trios": [
    {
      "asset_infos": [
        {
          "native_token": {
            "denom": "usdc"
          }
        },
        {
          "native_token": {
            "denom": "usdt"
          }
        },
        {
          "native_token": {
            "denom": "axlusdc"
          }
        }
      ],
      "contract_addr": "migaloo1...",
      "liquidity_token": "migaloo1...",
      "asset_decimals": [
        6,
        6,
        6
      ]
    },
    {
      "asset_infos": [
        {
          "native_token": {
            "denom": "usdc"
          }
        },
        {
          "token": {
            "contract_addr": "migaloo1..."
          }
        },
        {
          "native_token": {
            "denom": "axlusdc"
          }
        }
      ],
      "contract_addr": "migaloo1...",
      "liquidity_token": "migaloo1...",
      "asset_decimals": [
        6,
        6,
        6
      ]
    }
  ]
}

Key	Type	Description
`trios`	Vec<TrioInfo>	Vector with information about the requested trios

{% endtab %} {% endtabs %}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

terraswap-factory.md

terraswap-factory.md

Factory

Create a pair

Instantiate

Migrate

ExecuteMsg

Add Native Token Decimals

Create pair

Create trio

Migrate pair

Migrate trio

Remove pair

Remove trio

Update config

Update pair config

Update trio config

Queries

Config

Native token decimals

Pair

Pairs

Trio

Trios

Files

terraswap-factory.md

Latest commit

History

terraswap-factory.md

File metadata and controls

Factory

Create a pair

Instantiate

Migrate

ExecuteMsg

Add Native Token Decimals

Create pair

Create trio

Migrate pair

Migrate trio

Remove pair

Remove trio

Update config

Update pair config

Update trio config

Queries

Config

Native token decimals

Pair

Pairs

Trio

Trios