Add more information to the readme

contracts/external/cw-abc/README.md

@@ -1,12 +1,12 @@
 # cw-abc
 
-Implments an augmented bonding curve.
+Implments an [Augmented Bonding Curve](https://medium.com/commonsstack/deep-dive-augmented-bonding-curves-b5ca4fad4436).
 
 Forked from and heavily inspired by the work on [cw20-bonding](https://github.com/cosmwasm/cw-tokens/tree/main/contracts/cw20-bonding). This contract uses native and token factory tokens instead.
 
 NOTE: this contract is unaudited and experimental. NOT RECOMMENDED FOR PRODUCTION USE.
 
-## Overview
+## What are Augmented Bonding Curves?
 Before we get to the *Augmented* part, we must first describe bonding curves themselves.
 
 ### Token Bonding Curves
@@ -23,54 +23,21 @@ This contract implements two methods:
 
 It is possible to use this contact as a basic bonding curve, without any of the augmented features.
 
-#### Benefits
-
-There are a number of benefits to bonding curves:
-- There is enough liquidity to back the entire supply
-- Easier to wind down projects (there is no going to zero)
-- Transparent pricing: looking at the curve will tell you a lot about what kind of project it is.
-- DAO treasuries can be funded by entry and exit fees on the curve
-
-## Extended Reading
-
-Augmented Bonding Curves are nothing new, some articles that inspired this implementation:
-- https://medium.com/commonsstack/deep-dive-augmented-bonding-curves-b5ca4fad4436
-- https://tokeneconomy.co/token-bonding-curves-in-practice-3eb904720cb8
-
-Read more about [bonding curve math here](https://yos.io/2018/11/10/bonding-curves/).
-
-## Future Work
-
-Taking inspiration from [this article](https://medium.com/commonsstack/deep-dive-augmented-bonding-curves-b5ca4fad4436) on augmented bonding curves:
-
-- [ ] Optionally vest tokens during the hatch phase
-- [ ] Update `cw-vesting` to allow for partcipating in DAOs?
-
-### Math
+#### Math
 
-Given a price curve `f(x)` = price of the `x`th token, we want to figure out
-how to buy into and sell from the bonding curve. In fact we can look at
-the total supply issued. let `F(x)` be the integral of `f(x)`. We have issued
-`x` tokens for `F(x)` sent to the contract. Or, in reverse, if we send
-`x` tokens to the contract, it will mint `F^-1(x)` tokens.
+Given a price curve `f(x)` = price of the `x`th token, we want to figure out how to buy into and sell from the bonding curve. In fact we can look at the total supply issued. let `F(x)` be the integral of `f(x)`. We have issued `x` tokens for `F(x)` sent to the contract. Or, in reverse, if we send `x` tokens to the contract, it will mint `F^-1(x)` tokens.
 
-From this we can create some formulas. Assume we currently have issued `S`
-tokens in exchange for `N = F(S)` input tokens. If someone sends us `x` tokens,
-how much will we issue?
+From this we can create some formulas. Assume we currently have issued `S` tokens in exchange for `N = F(S)` input tokens. If someone sends us `x` tokens, how much will we issue?
 
 `F^-1(N+x) - F^-1(N)` = `F^-1(N+x) - S`
 
 And if we sell `x` tokens, how much we will get out:
 
 `F(S) - F(S-x)` = `N - F(S-x)`
 
-Just one calculation each side. To be safe, make sure to round down and
-always check against `F(S)` when using `F^-1(S)` to estimate how much
-should be issued. This will also safely give us how many tokens to return.
+Just one calculation each side. To be safe, make sure to round down and always check against `F(S)` when using `F^-1(S)` to estimate how much should be issued. This will also safely give us how many tokens to return.
 
-There is built in support for safely [raising i128 to an integer power](https://doc.rust-lang.org/std/primitive.i128.html#method.checked_pow).
-There is also a crate to [provide nth-root of for all integers](https://docs.rs/num-integer/0.1.43/num_integer/trait.Roots.html).
-With these two, we can handle most math except for logs/exponents.
+There is built in support for safely [raising i128 to an integer power](https://doc.rust-lang.org/std/primitive.i128.html#method.checked_pow). There is also a crate to [provide nth-root of for all integers](https://docs.rs/num-integer/0.1.43/num_integer/trait.Roots.html). With these two, we can handle most math except for logs/exponents.
 
 Compare this to [writing it all in solidity](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/7b7ff729b82ea73ea168e495d9c94cb901ae95ce/contracts/math/Power.sol)
 
@@ -82,5 +49,86 @@ Price Linear: `f(x) = kx` and `F(x) = kx^2/2` and `F^-1(x) = (2x/k)^(0.5)`
 
 Price Square Root: `f(x) = x^0.5` and `F(x) = x^1.5/1.5` and `F^-1(x) = (1.5*x)^(2/3)`
 
-We will only implement these curves to start with, and leave it to others to import this with more complex curves,
-such as logarithms.
+[You can read more about bonding curve math here](https://yos.io/2018/11/10/bonding-curves/).
+
+#### Benefits
+
+There are a number of benefits to bonding curves:
+- There is enough liquidity to back the entire supply without having to list tokens on DEXs
+- Easier to wind down projects (there is no going to zero)
+- Transparent pricing: looking at the curve will tell you a lot about what kind of project it is.
+
+### Augmented Bonding Curves
+
+Augmented Bonding Curves are nothing new, some articles that inspired this implementation:
+- https://medium.com/commonsstack/deep-dive-augmented-bonding-curves-b5ca4fad4436
+- https://tokeneconomy.co/token-bonding-curves-in-practice-3eb904720cb8
+
+At a high level, augmented bonding curves extend bonding curves with new funcationality:
+- Entry and exit fees
+- Different phases representing the life cycles of projects
+
+## Features
+
+Example Instantiation message:
+
+``` json
+{
+    "fees_recipient": "address that recieves fees",
+    "token_issuer_code_id": 0,
+    "supply": {
+        "subdenom": "utokenname",
+        "metadata": {
+            "name": "tokenname",
+            "description": "Token description.",
+            "symbol": "TOKEN",
+            "display": "Token",
+        },
+        "decimals": 6,
+        "max_supply": "100000000000000"
+    },
+    reserve: {
+        "denom": "ujuno",
+        "decimals": 6,
+    },
+    curve_type: {
+        "linear": {
+            "slope": "2",
+            "scale": 1
+        }
+    },
+    phase_config: {
+        "hatch": {
+            "contribution_limits": {
+                "min": "10000000",
+                "max": "100000000000"
+            },
+            "initial_raise": {
+                "min": "10000000",
+                "max": "100000000000"
+            },
+            "initial_allocation_ratio": "0.25",
+            "exit_tax": "0.10"
+        },
+        "open": {
+            "exit_tax": "0.01",
+            "allocation_percentage": "0.01"
+        },
+        "closed": {}
+    },
+    hatcher_allowlist: ["allowlist addresses, leave blank for no allowlist"],
+}
+```
+
+- `fees_recipient`: the address that will recieve fees (usually a DAO).
+- `token_issuer_code_id`: the CosmWasm code ID for a `cw-tokenfactory_issuer` contract.
+- `supply`: infor about the token that will be minted by the curve. This is the token that is created by the bonding curve.
+- `reserve`: this is the token that is used to mint the supply token.
+- `curve_type`: information about the pricing curve.
+- `phase_config`: configuration for the different phase of the augmented bonding curve.
+- `hatcher_allowlist`: the list of address allowed to participate in a hatch.
+
+## Future Work
+- [ ] Optionally vest tokens during the hatch phase
+- [ ] Implement an expanded set of pricing curves to choose from
+