mirror of
https://github.com/alexgo-io/alex-v1-docs.git
synced 2026-01-12 06:23:46 +08:00
GITBOOK-197: change request with no subject merged in GitBook
This commit is contained in:
Alex Daddy
@@ -39,4 +39,6 @@
|
||||
|
||||
* [Testnet](developers/testnet.md)
|
||||
* [Smart Contracts](developers/smart-contracts/README.md)
|
||||
* [Token List](developers/smart-contracts/token-list.md)
|
||||
* [AMM Pool Mapping](developers/amm-pool-mapping.md)
|
||||
* [API References](developers/api-references.md)
|
||||
|
||||
204
developers/amm-pool-mapping.md
Normal file
204
developers/amm-pool-mapping.md
Normal file
@@ -0,0 +1,204 @@
|
||||
# AMM Pool Mapping
|
||||
|
||||
Below table maps the pool listed on [https://app.alexlab.co/pool](https://app.alexlab.co/pool) to smart contracts with the relevant parameters
|
||||
|
||||
## Pool Types
|
||||
|
||||
We have three smart contracts in production that provide AMM.
|
||||
|
||||
### Trading Pool
|
||||
|
||||
[Trading Pool](../trading-lending-and-borrowing/trading-pool.md) is the latest AMM smart contract that developers should use whenever possible.
|
||||
|
||||
Trading Pool implements Generalised Mean Equation and, with a suitable parameterisation, supports both risky pairs (i.e. $$x y=L$$), stable pairs (i.e. $$x +y=L$$) and any linear combination in-between (i.e. Curve).
|
||||
|
||||
Trading Pool is parameterised with a single parameter $$t$$. $$t$$ can be between 0 and 1, with $$t=1$$ being equivalent of constant product formula (i.e. Uniswap V2) and $$t=0$$ being equivalent of constant sum formula (i.e. mStable). $$0<t <1$$ then gives a Curve-like formula.
|
||||
|
||||
#### Contract address
|
||||
|
||||
`SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.amm-swap-pool-v1-1`
|
||||
|
||||
### Fixed Weight Pool
|
||||
|
||||
Fixed Weight Pool is based on Balancer and allows to create AMM pools with custom (i.e. non equal-weight), fixed-weight, pools.
|
||||
|
||||
Fixed Weight Pool has been deprecated since the introduction of [Trading Pool](amm-pool-mapping.md#trading-pool).
|
||||
|
||||
#### Contract address
|
||||
|
||||
`SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.fixed-weight-pool-v1-01`
|
||||
|
||||
### Simple Weight Pool
|
||||
|
||||
Simple Weight Pool supports the constant product formula (i.e. $$x y=L$$).
|
||||
|
||||
Simple Weight Pool has been deprecated since the introduction of [Trading Pool](amm-pool-mapping.md#trading-pool).
|
||||
|
||||
#### Contract address
|
||||
|
||||
`SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.simple-weight-pool-alex`
|
||||
|
||||
## AMM Pools
|
||||
|
||||
### STX-xBTC-1
|
||||
|
||||
**Smart Contract**: [Trading Pool](amm-pool-mapping.md#trading-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wbtc`
|
||||
* `factor`: 1e8
|
||||
|
||||
### STX-sUSDT-1
|
||||
|
||||
**Smart Contract**: [Trading Pool](amm-pool-mapping.md#trading-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-susdt`
|
||||
* `factor`: 1e8
|
||||
|
||||
### STX-ALEX-1
|
||||
|
||||
**Smart Contract**: [Trading Pool](amm-pool-mapping.md#trading-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.age000-governance-token`
|
||||
* `factor`: 1e8
|
||||
|
||||
### ALEX-ATALEXV2-1
|
||||
|
||||
**Smart Contract**: [Trading Pool](amm-pool-mapping.md#trading-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.age000-governance-token`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.auto-alex-v2`
|
||||
* `factor`: 1e8
|
||||
|
||||
### ALEX-DIKO-1
|
||||
|
||||
**Smart Contract**: [Trading Pool](amm-pool-mapping.md#trading-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.age000-governance-token`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wdiko`
|
||||
* `factor`: 1e8
|
||||
|
||||
### STX-VIBES-1
|
||||
|
||||
**Smart Contract**: [Trading Pool](amm-pool-mapping.md#trading-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wvibes`
|
||||
* `factor`: 1e8
|
||||
|
||||
### STX-ALEX-50-50
|
||||
|
||||
**Smart Contract**: [Fixed Weight Pool](amm-pool-mapping.md#fixed-weight-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.age000-governance-token`
|
||||
* `weight-x`: 0.5e8
|
||||
* `weight-y`: 0.5e8
|
||||
|
||||
### STX-xBTC-50-50
|
||||
|
||||
**Smart Contract**: [Fixed Weight Pool](amm-pool-mapping.md#fixed-weight-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wbtc`
|
||||
* `weight-x`: 0.5e8
|
||||
* `weight-y`: 0.5e8
|
||||
|
||||
### STX-xUSD-50-50
|
||||
|
||||
**Smart Contract**: [Fixed Weight Pool](amm-pool-mapping.md#fixed-weight-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wxusd`
|
||||
* `weight-x`: 0.5e8
|
||||
* `weight-y`: 0.5e8
|
||||
|
||||
### xUSD-USDA-0.005
|
||||
|
||||
**Smart Contract**: [Trading Pool](amm-pool-mapping.md#trading-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wxusd`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wusda`
|
||||
* `factor`: 0.005e8
|
||||
|
||||
### ALEX-USDA-50-50
|
||||
|
||||
**Smart Contract**: [Simple Weight Pool](amm-pool-mapping.md#simple-weight-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.age000-governance-token`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wusda`
|
||||
|
||||
### STX-CORGI-1
|
||||
|
||||
**Smart Contract**: [Trading Pool](amm-pool-mapping.md#trading-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wcorgi`
|
||||
* `factor`: 1e8
|
||||
|
||||
### STX-MIA-50-50
|
||||
|
||||
**Smart Contract**: [Fixed Weight Pool](amm-pool-mapping.md#fixed-weight-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wmia`
|
||||
* `weight-x`: 0.5e8
|
||||
* `weight-y`: 0.5e8
|
||||
|
||||
### STX-NYCC-50-50
|
||||
|
||||
**Smart Contract**: [Fixed Weight Pool](amm-pool-mapping.md#fixed-weight-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wnycc`
|
||||
* `weight-x`: 0.5e8
|
||||
* `weight-y`: 0.5e8
|
||||
|
||||
### ALEX-BANABA-50-50
|
||||
|
||||
**Smart Contract**: [Simple Weight Pool](amm-pool-mapping.md#simple-weight-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.age000-governance-token`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wban`
|
||||
|
||||
### ALEX-SLIME-50-50
|
||||
|
||||
**Smart Contract**: [Simple Weight Pool](amm-pool-mapping.md#simple-weight-pool)
|
||||
|
||||
#### Parameters
|
||||
|
||||
* `token-x`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.age000-governance-token`
|
||||
* `token-y`: `SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wslm`
|
||||
|
||||
13
developers/smart-contracts/token-list.md
Normal file
13
developers/smart-contracts/token-list.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Token List
|
||||
|
||||
Where applicable, ALEX uses "wrapped" token to ensure certain functionalities (mainly the support for the fixed notation) are added to the native, 3rd-party, tokens.
|
||||
|
||||
These "wrapped" tokens do not hold any native tokens, but are "pass-throughs". They call the relevant functions of the native tokens (e.g. `transfer`) to complete the user requests, but ensure these are done in a consistent manner across all tokens handled by ALEX.
|
||||
|
||||
<table><thead><tr><th width="154">Token</th><th>Address</th></tr></thead><tbody><tr><td>STX</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx</code></td></tr><tr><td>ALEX</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.age000-governance-token</code></td></tr><tr><td>xBTC</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wbtc</code></td></tr><tr><td>sUSDT</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-susdt</code></td></tr><tr><td>xUSD</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wxusd</code></td></tr><tr><td>autoALEX</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.auto-alex-v2</code></td></tr><tr><td>USDA</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wusda</code></td></tr><tr><td>DIKO</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wdiko</code></td></tr><tr><td>MIA</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wmia</code></td></tr><tr><td>NYC</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wnycc</code></td></tr><tr><td>BANANA</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wban</code></td></tr><tr><td>SLIME</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wslm</code></td></tr><tr><td>WELSH</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wcorgi</code></td></tr><tr><td>VIBES</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wvibes</code></td></tr></tbody></table>
|
||||
|
||||
## BRC20 Tokens
|
||||
|
||||
BRC20 tokens on ALEX represent those BRC20 tokens that are pegged in from Bitcoin.
|
||||
|
||||
<table><thead><tr><th width="161">Token</th><th>Address</th></tr></thead><tbody><tr><td>$B20</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-db20</code></td></tr><tr><td>MAXI</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-maxi</code></td></tr><tr><td>SHNT</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-shnt</code></td></tr><tr><td>PIZA</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-piza</code></td></tr><tr><td>LONG</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-long</code></td></tr><tr><td>INSC</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-insc</code></td></tr><tr><td>MAJO</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-majo</code></td></tr><tr><td>DEXM</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-dexm</code></td></tr><tr><td>ATMT</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-aiptp</code></td></tr><tr><td>CVLT</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-cvlt</code></td></tr><tr><td>LBOW</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-lbow</code></td></tr><tr><td>SBTC</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-sbtc</code></td></tr><tr><td>OXBT</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-oxbt</code></td></tr><tr><td>₿</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-spacesignb</code></td></tr><tr><td>ORDS</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-ords</code></td></tr><tr><td>NYTO</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-nyto</code></td></tr><tr><td>BENG</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-beng</code></td></tr><tr><td>TRAC</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-trac</code></td></tr><tr><td>SATS</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-sats</code></td></tr><tr><td>TARO</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-taro</code></td></tr><tr><td>10MM</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-10mm</code></td></tr><tr><td>PEPE</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-pepe</code></td></tr><tr><td>VMPX</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-vmpx</code></td></tr><tr><td>@LFG</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-atlfg</code></td></tr><tr><td>ORDI</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-ordi</code></td></tr><tr><td>$BIT</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-dbit</code></td></tr><tr><td>MXRC</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-mxrc</code></td></tr><tr><td>IGLI</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-igli</code></td></tr><tr><td>OHMS</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-ohms</code></td></tr><tr><td>JAKE</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-jake</code></td></tr><tr><td>MEME</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-meme</code></td></tr><tr><td>NALS</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-nals</code></td></tr><tr><td>XING</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-xing</code></td></tr><tr><td>BANK</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-bank</code></td></tr><tr><td>PASS</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-pass</code></td></tr><tr><td>WZRD</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-wzrd</code></td></tr><tr><td>MOON</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-moon</code></td></tr><tr><td>DRAC</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-drac</code></td></tr><tr><td>LOVE</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-love</code></td></tr><tr><td>ZBIT</td><td><code>SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-zbit</code></td></tr></tbody></table>
|
||||
Reference in New Issue
Block a user