polkamarkets-js 1.0.1 → 3.1.0

package/_book/README.md

@@ -0,0 +1,590 @@
+## Classes
+
+<dl>
+<dt><a href="#FixedSwapContract">FixedSwapContract</a></dt>
+<dd></dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#setNewOwner">setNewOwner(address)</a></dt>
+<dd><p>Set New Owner of the Contract</p>
+</dd>
+<dt><a href="#owner">owner()</a> ⇒ <code>string</code></dt>
+<dd><p>Get Owner of the Contract</p>
+</dd>
+<dt><a href="#isPaused">isPaused()</a> ⇒ <code>boolean</code></dt>
+<dd><p>Get Owner of the Contract</p>
+</dd>
+<dt><a href="#pauseContract">pauseContract()</a> ⇒ <code>admin</code></dt>
+<dd><p>Pause Contract</p>
+</dd>
+<dt><a href="#erc20">erc20()</a> ⇒ <code>Address</code></dt>
+<dd><p>Get Token Address</p>
+</dd>
+<dt><a href="#decimals">decimals()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Decimals</p>
+</dd>
+<dt><a href="#unpauseContract">unpauseContract()</a> ⇒ <code>admin</code></dt>
+<dd><p>Unpause Contract</p>
+</dd>
+<dt><a href="#tradeValue">tradeValue()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get swapratio for the pool</p>
+</dd>
+<dt><a href="#startDate">startDate()</a> ⇒ <code>Date</code></dt>
+<dd><p>Get Start Date of Pool</p>
+</dd>
+<dt><a href="#endDate">endDate()</a> ⇒ <code>Date</code></dt>
+<dd><p>Get End Date of Pool</p>
+</dd>
+<dt><a href="#isFinalized">isFinalized()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>To see if contract was finalized</p>
+</dd>
+<dt><a href="#individualMinimumAmount">individualMinimumAmount()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Individual Minimum Amount for each address</p>
+</dd>
+<dt><a href="#individualMaximumAmount">individualMaximumAmount()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Individual Maximum Amount for each address</p>
+</dd>
+<dt><a href="#minimumRaiseAchieved">minimumRaiseAchieved()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Was Minimum Raise Achieved</p>
+</dd>
+<dt><a href="#minimumRaise">minimumRaise()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Minimum Raise amount for Token Sale</p>
+</dd>
+<dt><a href="#tokensAllocated">tokensAllocated()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Total tokens Allocated already, therefore the tokens bought until now</p>
+</dd>
+<dt><a href="#tokensForSale">tokensForSale()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Total tokens Allocated/In Sale for the Pool</p>
+</dd>
+<dt><a href="#hasMinimumRaise">hasMinimumRaise()</a> ⇒ <code>Boolea</code></dt>
+<dd><p>See if hasMinimumRaise</p>
+</dd>
+<dt><a href="#minimumReached">minimumReached()</a> ⇒ <code>Integer</code></dt>
+<dd><p>See if minimumRaise was Reached</p>
+</dd>
+<dt><a href="#tokensAvailable">tokensAvailable()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Total tokens owned by the Pool</p>
+</dd>
+<dt><a href="#tokensLeft">tokensLeft()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Total tokens available to be sold in the pool</p>
+</dd>
+<dt><a href="#withdrawableUnsoldTokens">withdrawableUnsoldTokens()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Total tokens available to be withdrawn by the admin</p>
+</dd>
+<dt><a href="#withdrawableFunds">withdrawableFunds()</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get Total funds raised to be withdrawn by the admin</p>
+</dd>
+<dt><a href="#isTokenSwapAtomic">isTokenSwapAtomic()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if the Token Swap is atomic on this pool</p>
+</dd>
+<dt><a href="#hasWhitelisting">hasWhitelisting()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if swap has whitelisting</p>
+</dd>
+<dt><a href="#isWhitelisted">isWhitelisted()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if address is whitelisted</p>
+</dd>
+<dt><a href="#wereUnsoldTokensReedemed">wereUnsoldTokensReedemed()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if the admin already reemeded unsold tokens</p>
+</dd>
+<dt><a href="#isFunded">isFunded()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if the Token Sale is Funded with all Tokens proposed in tokensForSale</p>
+</dd>
+<dt><a href="#isOpen">isOpen()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if the Token Sale is Open for Swap</p>
+</dd>
+<dt><a href="#hasStarted">hasStarted()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if the Token Sale has started the Swap</p>
+</dd>
+<dt><a href="#hasFinalized">hasFinalized()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if the Token Sale has finalized, if the current date is after endDate</p>
+</dd>
+<dt><a href="#isPreStart">isPreStart()</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if the Token Sale in not open yet, where the admin can fund the pool</p>
+</dd>
+<dt><a href="#getPurchase">getPurchase(purchase_id)</a> ⇒ <code>Integer</code> | <code>Integer</code> | <code>Address</code> | <code>Integer</code> | <code>Date</code> | <code>Boolean</code> | <code>Boolean</code></dt>
+<dd><p>Get Purchase based on ID</p>
+</dd>
+<dt><a href="#getWhiteListedAddresses">getWhiteListedAddresses()</a> ⇒ <code>Array</code> | <code>Address</code></dt>
+<dd><p>Get Whitelisted Addresses</p>
+</dd>
+<dt><a href="#getBuyers">getBuyers()</a> ⇒ <code>Array</code> | <code>Integer</code></dt>
+<dd><p>Get Buyers</p>
+</dd>
+<dt><a href="#getPurchaseIds">getPurchaseIds()</a> ⇒ <code>Array</code> | <code>Integer</code></dt>
+<dd><p>Get All Purchase Ids</p>
+</dd>
+<dt><a href="#getPurchaseIds">getPurchaseIds(address)</a> ⇒ <code>Array</code> | <code>Integer</code></dt>
+<dd><p>Get All Purchase Ids filter by Address/Purchaser</p>
+</dd>
+<dt><a href="#getETHCostFromTokens">getETHCostFromTokens(tokenAmount)</a> ⇒ <code>Integer</code></dt>
+<dd><p>Get ETH Cost from Tokens Amount</p>
+</dd>
+<dt><a href="#swap">swap(tokenAmount)</a></dt>
+<dd><p>Swap tokens by Ethereum</p>
+</dd>
+<dt><a href="#redeemTokens(isStandard)">redeemTokens(purchase_id)</a></dt>
+<dd><p>Reedem tokens bought</p>
+</dd>
+<dt><a href="#redeemGivenMinimumGoalNotAchieved(isStandard)">redeemGivenMinimumGoalNotAchieved(purchase_id)</a></dt>
+<dd><p>Reedem Ethereum from sale that did not achieve minimum goal</p>
+</dd>
+<dt><a href="#withdrawUnsoldTokens">withdrawUnsoldTokens()</a></dt>
+<dd><p>Withdraw unsold tokens of sale</p>
+</dd>
+<dt><a href="#withdrawFunds">withdrawFunds()</a></dt>
+<dd><p>Withdraw all funds from tokens sold</p>
+</dd>
+<dt><a href="#approveFundERC20">approveFundERC20()</a></dt>
+<dd><p>Approve the pool to use approved tokens for sale</p>
+</dd>
+<dt><a href="#isApproved">isApproved(tokenAmount, address)</a> ⇒ <code>Boolean</code></dt>
+<dd><p>Verify if the Admin has approved the pool to use receive the tokens for sale</p>
+</dd>
+<dt><a href="#fund">fund(tokenAmount)</a></dt>
+<dd><p>Send tokens to pool for sale, fund the sale</p>
+</dd>
+<dt><a href="#addWhitelistedAddress">addWhitelistedAddress(Addresses)</a></dt>
+<dd><p>add WhiteListed Address</p>
+</dd>
+<dt><a href="#removeWhitelistedAddress">removeWhitelistedAddress()</a></dt>
+<dd><p>remove WhiteListed Address</p>
+</dd>
+<dt><a href="#safePull">safePull()</a></dt>
+<dd><p>Safe Pull all tokens &amp; ETH</p>
+</dd>
+<dt><a href="#removeOtherERC20Tokens">removeOtherERC20Tokens(tokenAddress, toAddress)</a></dt>
+<dd><p>Remove Tokens from other ERC20 Address (in case of accident)</p>
+</dd>
+<dt><a href="#deploy">deploy()</a></dt>
+<dd><p>Deploy the Pool Contract</p>
+</dd>
+<dt><a href="#getOwner">getOwner(Address)</a></dt>
+<dd><p>Get owner address of contract</p>
+</dd>
+<dt><a href="#getBalance">getBalance(Balance)</a></dt>
+<dd><p>Get Balance of Contract</p>
+</dd>
+</dl>
+
+<a name="FixedSwapContract"></a>
+
+## FixedSwapContract
+**Kind**: global class  
+<a name="new_FixedSwapContract_new"></a>
+
+### new FixedSwapContract(web3, tokenAddress, decimals, contractAddress)
+Fixed Swap Object
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| web3 | <code>Web3</code> |  |
+| tokenAddress | <code>Address</code> |  |
+| decimals | <code>Integer</code> |  |
+| contractAddress | <code>Address</code> | ? (opt) |
+
+<a name="setNewOwner"></a>
+
+## setNewOwner(address)
+Set New Owner of the Contract
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| address | <code>string</code> | 
+
+<a name="owner"></a>
+
+## owner() ⇒ <code>string</code>
+Get Owner of the Contract
+
+**Kind**: global function  
+**Returns**: <code>string</code> - address  
+<a name="isPaused"></a>
+
+## isPaused() ⇒ <code>boolean</code>
+Get Owner of the Contract
+
+**Kind**: global function  
+<a name="pauseContract"></a>
+
+## pauseContract() ⇒ <code>admin</code>
+Pause Contract
+
+**Kind**: global function  
+<a name="erc20"></a>
+
+## erc20() ⇒ <code>Address</code>
+Get Token Address
+
+**Kind**: global function  
+**Returns**: <code>Address</code> - Token Address  
+<a name="decimals"></a>
+
+## decimals() ⇒ <code>Integer</code>
+Get Decimals
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - Integer  
+<a name="unpauseContract"></a>
+
+## unpauseContract() ⇒ <code>admin</code>
+Unpause Contract
+
+**Kind**: global function  
+<a name="tradeValue"></a>
+
+## tradeValue() ⇒ <code>Integer</code>
+Get swapratio for the pool
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - trade value against ETH  
+<a name="startDate"></a>
+
+## startDate() ⇒ <code>Date</code>
+Get Start Date of Pool
+
+**Kind**: global function  
+<a name="endDate"></a>
+
+## endDate() ⇒ <code>Date</code>
+Get End Date of Pool
+
+**Kind**: global function  
+<a name="isFinalized"></a>
+
+## isFinalized() ⇒ <code>Boolean</code>
+To see if contract was finalized
+
+**Kind**: global function  
+<a name="individualMinimumAmount"></a>
+
+## individualMinimumAmount() ⇒ <code>Integer</code>
+Get Individual Minimum Amount for each address
+
+**Kind**: global function  
+<a name="individualMaximumAmount"></a>
+
+## individualMaximumAmount() ⇒ <code>Integer</code>
+Get Individual Maximum Amount for each address
+
+**Kind**: global function  
+<a name="minimumRaiseAchieved"></a>
+
+## minimumRaiseAchieved() ⇒ <code>Boolean</code>
+Was Minimum Raise Achieved
+
+**Kind**: global function  
+<a name="minimumRaise"></a>
+
+## minimumRaise() ⇒ <code>Integer</code>
+Get Minimum Raise amount for Token Sale
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - Amount in Tokens  
+<a name="tokensAllocated"></a>
+
+## tokensAllocated() ⇒ <code>Integer</code>
+Get Total tokens Allocated already, therefore the tokens bought until now
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - Amount in Tokens  
+<a name="tokensForSale"></a>
+
+## tokensForSale() ⇒ <code>Integer</code>
+Get Total tokens Allocated/In Sale for the Pool
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - Amount in Tokens  
+<a name="hasMinimumRaise"></a>
+
+## hasMinimumRaise() ⇒ <code>Boolea</code>
+See if hasMinimumRaise
+
+**Kind**: global function  
+<a name="minimumReached"></a>
+
+## minimumReached() ⇒ <code>Integer</code>
+See if minimumRaise was Reached
+
+**Kind**: global function  
+<a name="tokensAvailable"></a>
+
+## tokensAvailable() ⇒ <code>Integer</code>
+Get Total tokens owned by the Pool
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - Amount in Tokens  
+<a name="tokensLeft"></a>
+
+## tokensLeft() ⇒ <code>Integer</code>
+Get Total tokens available to be sold in the pool
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - Amount in Tokens  
+<a name="withdrawableUnsoldTokens"></a>
+
+## withdrawableUnsoldTokens() ⇒ <code>Integer</code>
+Get Total tokens available to be withdrawn by the admin
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - Amount in Tokens  
+<a name="withdrawableFunds"></a>
+
+## withdrawableFunds() ⇒ <code>Integer</code>
+Get Total funds raised to be withdrawn by the admin
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - Amount in ETH  
+<a name="isTokenSwapAtomic"></a>
+
+## isTokenSwapAtomic() ⇒ <code>Boolean</code>
+Verify if the Token Swap is atomic on this pool
+
+**Kind**: global function  
+<a name="hasWhitelisting"></a>
+
+## hasWhitelisting() ⇒ <code>Boolean</code>
+Verify if swap has whitelisting
+
+**Kind**: global function  
+<a name="isWhitelisted"></a>
+
+## isWhitelisted() ⇒ <code>Boolean</code>
+Verify if address is whitelisted
+
+**Kind**: global function  
+<a name="wereUnsoldTokensReedemed"></a>
+
+## wereUnsoldTokensReedemed() ⇒ <code>Boolean</code>
+Verify if the admin already reemeded unsold tokens
+
+**Kind**: global function  
+<a name="isFunded"></a>
+
+## isFunded() ⇒ <code>Boolean</code>
+Verify if the Token Sale is Funded with all Tokens proposed in tokensForSale
+
+**Kind**: global function  
+<a name="isOpen"></a>
+
+## isOpen() ⇒ <code>Boolean</code>
+Verify if the Token Sale is Open for Swap
+
+**Kind**: global function  
+<a name="hasStarted"></a>
+
+## hasStarted() ⇒ <code>Boolean</code>
+Verify if the Token Sale has started the Swap
+
+**Kind**: global function  
+<a name="hasFinalized"></a>
+
+## hasFinalized() ⇒ <code>Boolean</code>
+Verify if the Token Sale has finalized, if the current date is after endDate
+
+**Kind**: global function  
+<a name="isPreStart"></a>
+
+## isPreStart() ⇒ <code>Boolean</code>
+Verify if the Token Sale in not open yet, where the admin can fund the pool
+
+**Kind**: global function  
+<a name="getPurchase"></a>
+
+## getPurchase(purchase_id) ⇒ <code>Integer</code> \| <code>Integer</code> \| <code>Address</code> \| <code>Integer</code> \| <code>Date</code> \| <code>Boolean</code> \| <code>Boolean</code>
+Get Purchase based on ID
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - _id<code>Integer</code> - amount<code>Address</code> - purchaser<code>Integer</code> - ethAmount<code>Date</code> - timestamp<code>Boolean</code> - wasFinalized<code>Boolean</code> - reverted  
+
+| Param | Type |
+| --- | --- |
+| purchase_id | <code>Integer</code> | 
+
+<a name="getWhiteListedAddresses"></a>
+
+## getWhiteListedAddresses() ⇒ <code>Array</code> \| <code>Address</code>
+Get Whitelisted Addresses
+
+**Kind**: global function  
+**Returns**: <code>Array</code> \| <code>Address</code> - addresses  
+<a name="getBuyers"></a>
+
+## getBuyers() ⇒ <code>Array</code> \| <code>Integer</code>
+Get Buyers
+
+**Kind**: global function  
+**Returns**: <code>Array</code> \| <code>Integer</code> - _ids  
+<a name="getPurchaseIds"></a>
+
+## getPurchaseIds() ⇒ <code>Array</code> \| <code>Integer</code>
+Get All Purchase Ids
+
+**Kind**: global function  
+**Returns**: <code>Array</code> \| <code>Integer</code> - _ids  
+<a name="getPurchaseIds"></a>
+
+## getPurchaseIds(address) ⇒ <code>Array</code> \| <code>Integer</code>
+Get All Purchase Ids filter by Address/Purchaser
+
+**Kind**: global function  
+**Returns**: <code>Array</code> \| <code>Integer</code> - _ids  
+
+| Param | Type |
+| --- | --- |
+| address | <code>Address</code> | 
+
+<a name="getETHCostFromTokens"></a>
+
+## getETHCostFromTokens(tokenAmount) ⇒ <code>Integer</code>
+Get ETH Cost from Tokens Amount
+
+**Kind**: global function  
+**Returns**: <code>Integer</code> - ethAmount  
+
+| Param | Type |
+| --- | --- |
+| tokenAmount | <code>Integer</code> | 
+
+<a name="swap"></a>
+
+## swap(tokenAmount)
+Swap tokens by Ethereum
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| tokenAmount | <code>Integer</code> | 
+
+<a name="redeemTokens(isStandard)"></a>
+
+## redeemTokens(purchase_id)
+Reedem tokens bought
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| purchase_id | <code>Integer</code> | 
+
+<a name="redeemGivenMinimumGoalNotAchieved(isStandard)"></a>
+
+## redeemGivenMinimumGoalNotAchieved(purchase_id)
+Reedem Ethereum from sale that did not achieve minimum goal
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| purchase_id | <code>Integer</code> | 
+
+<a name="withdrawUnsoldTokens"></a>
+
+## withdrawUnsoldTokens()
+Withdraw unsold tokens of sale
+
+**Kind**: global function  
+<a name="withdrawFunds"></a>
+
+## withdrawFunds()
+Withdraw all funds from tokens sold
+
+**Kind**: global function  
+<a name="approveFundERC20"></a>
+
+## approveFundERC20()
+Approve the pool to use approved tokens for sale
+
+**Kind**: global function  
+<a name="isApproved"></a>
+
+## isApproved(tokenAmount, address) ⇒ <code>Boolean</code>
+Verify if the Admin has approved the pool to use receive the tokens for sale
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| tokenAmount | <code>Integer</code> | 
+| address | <code>Address</code> | 
+
+<a name="fund"></a>
+
+## fund(tokenAmount)
+Send tokens to pool for sale, fund the sale
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| tokenAmount | <code>Integer</code> | 
+
+<a name="addWhitelistedAddress"></a>
+
+## addWhitelistedAddress(Addresses)
+add WhiteListed Address
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| Addresses | <code>Array</code> \| <code>Addresses</code> | 
+
+<a name="removeWhitelistedAddress"></a>
+
+## removeWhitelistedAddress()
+remove WhiteListed Address
+
+**Kind**: global function  
+<a name="safePull"></a>
+
+## safePull()
+Safe Pull all tokens & ETH
+
+**Kind**: global function  
+<a name="removeOtherERC20Tokens"></a>
+
+## removeOtherERC20Tokens(tokenAddress, toAddress)
+Remove Tokens from other ERC20 Address (in case of accident)
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| tokenAddress | <code>Address</code> | 
+| toAddress | <code>Address</code> | 
+
+<a name="deploy"></a>
+
+## deploy()
+Deploy the Pool Contract
+
+**Kind**: global function  
+<a name="getOwner"></a>
+
+## getOwner(Address)
+Get owner address of contract
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| Address | <code>Address</code> | 
+
+<a name="getBalance"></a>
+
+## getBalance(Balance)
+Get Balance of Contract
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| Balance | <code>Integer</code> | 
+

package/_book/core.md

@@ -0,0 +1,50 @@
+---
+title: Pools
+tags: pools, documentation
+---
+
+# Introduction
+
+Each Uniswap liquidity pool is a trading venue for a pair of ERC20 tokens. When a pool contract is created, its balances of each token are 0; in order for the pool to begin facilitating trades, someone must seed it with an initial deposit of each token. This first liquidity provider is the one who sets the initial price of the pool. They are incentivized to deposit an equal _value_ of both tokens into the pool. To see why, consider the case where the first liquidity provider deposits tokens at a ratio different from the current market rate. This immediately creates a profitable arbitrage opportunity, which is likely to be taken by an external party.
+
+When other liquidity providers add to an existing pool, they must deposit pair tokens proportional to the current price. If they don’t, the liquidity they added is at risk of being arbitraged as well. If they believe the current price is not correct, they may arbitrage it to the level they desire, and add liquidity at that price.
+
+# Pool tokens
+
+Whenever liquidity is deposited into a pool, special tokens known as _liquidity tokens_ are minted to the provider’s address, in proportion to how much liquidity they contributed to the pool. These tokens are a representation of a liquidity provider’s contribution to a pool. Whenever a trade occurs, the 0.3% fee which is levied is distributed _pro-rata_ to all LPs in the pool at the moment of the trade. To receive the underlying liquidity back, plus any fees that were accrued while their liquidity was locked, LPs must burn their liquidity tokens.
+
+Liquidity providers can also choose to sell, transfer, or otherwise use their liquidity tokens in any way they see fit.
+
+Learn more with advanced topics :
+
+# Why pools?
+
+Uniswap is unique in that it doesn’t use an order book to derive the price of an asset or to match buyers and sellers of tokens. Instead, Uniswap uses what are called Liquidity Pools.
+
+Liquidity is typically represented by discrete orders placed by individuals onto a centrally operated order book. A participant looking to provide liquidity or make markets must actively manage their orders, continuously updating them in response to the activity of others in the marketplace.
+
+While order books are foundational to finance and work great for certain usecases, they suffer from a few important limitations that are especially magnified when applied to a decentralized or blockchain-native setting. Order books require intermediary infrastructure to host the orderbook and match orders. This creates points of control and adds additional layers of complexity. They also require active participation and management from market makers who usually use sophsticated infrastructure and algorithms, limiting participation to advanced traders. Order books were invented in a world with relatively few assets being traded, so it is not surprising they aren't ideal for an ecosystem where anyone can create their own token and those tokens usually have low liquidity. In sum, with the infrastrucural trade-offs presented by a platform like Ethereum, order books are not the native architecture for implementing a liquidity protocol on a blockchain.
+
+Uniswap focuses on the strengths of Ethereum to reimagine token swaps from first principles.
+
+A blockchain-native liquidity protocol should take advantage of the trusted code execution environment, the autonomous and perpetually running virtual machine, and an open, permissionless, and inclusive access model that produces an exponentially growing ecosystem of virtual assets.
+
+<!-- Enter Uniswap and its underlying core mechanism of Liquidity Pools.
+
+The goal of a liquidity provider is to earn fees from making markets (enabling the trading) for some asset. Instead of requiring liquidity providers to place discrete orders onto an order book, Uniswap combines (or pools) all available liquidity between two tokens in an Ethereum smart contract called a Liquidity Pool.
+
+A liquidity pool is an autonomous program (smart contract) that holds a supply of two different tokens and enforces a novel set of rules about how those tokens can be added or removed.
+
+These rules enable functionality one might expect from a token liquidity protocol.
+
+Users can swap one token for another by depositing a token into one side of the pool and withdrawing tokens from the other side. The price is determined automatically by the pool based on a predetermined formula.
+
+Liquidity providers can earn fees by supplying an equal proportion of tokens to the pool. -->
+
+It is important to reiterate that a Pool is just a smart contract, operated by users calling functions on it. Swapping tokens is calling `swap` on a Pool contract instance, while providing liquidity is calling `deposit`.
+
+Just how end-users can interact with the Uniswap protocol through the Interface (which in turn interacts with the underlying contracts), developers can interact directly with the smart contracts and integrate Uniswap functionality into their own applications without relying on intermediaries or needing permission.
+
+# Developer resources
+
+- To see how to pool tokens in a smart contract read [Providing Liquidity](/docs/v2/smart-contract-integration/providing-liquidity/).