[ECO-1866] Assorted docs (#127)

Co-authored-by: Matt <[email protected]>
Co-authored-by: alnoki <[email protected]>

.github/workflows/verify-doc-site-build.yaml

@@ -10,10 +10,7 @@ jobs:
     - uses: 'actions/setup-node@v3'
       with:
         node-version: 20
-    - uses: 'pnpm/action-setup@v2'
-      with:
-        run_install: false
-        version: '9.1.2'
+    - uses: 'pnpm/action-setup@v4'
     - run: 'pnpm install --frozen-lockfile'
     - run: 'pnpm build'
 name: 'Verify docs site build'

cfg/cspell-dictionary.txt

@@ -60,6 +60,7 @@ presale
 rica
 rustup
 sint
+solana
 struct
 structs
 subdir

doc/doc-site/docs/about/about.md

@@ -0,0 +1,14 @@
+---
+slug: /
+title: ⬛ About emojicoin.fun
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+In the ever-evolving landscape of decentralized finance, Econia Labs is
+thrilled to introduce its new platform — emojicoin.fun: where all launched
+and tradable coins are emojicoins.
+
+Our goal is to merge the engaging, expressive nature of emojis with the
+dynamic world of decentralized finance, creating a vibrant, fair, and
+user-friendly environment for traders and communities.

doc/doc-site/docs/about/emojicoin-LP.md

@@ -0,0 +1,41 @@
+---
+slug: /emojicoin-LP
+title: ⛲ Emojicoin LP
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+AMMs, such as those used on the emojicoin platform, enable the creation of
+liquidity pools containing tokens X and Y (e.g., emojicoin and APT).
+The initial ratio of these tokens sets their starting relative price,
+while the liquidity curve dictates price changes with each swap transaction.
+
+## How It Works
+
+### 1. Swapping Tokens
+
+- Users swap one token for another, paying a small transaction fee.
+
+### 2. Providing Liquidity
+
+- Liquidity providers (LPs) contribute both X and Y tokens to the pool.
+- In exchange, LPs receive LP tokens, representing their share in the pool,
+  which are needed to withdraw their liquidity.
+- LPs earn a portion of the transaction fees from swaps.
+
+## Key Concept - Constant Function
+
+Most AMMs, including Uniswap v2, use a Constant Function to calculate the
+relative prices of the two tokens. This formula takes the following form:
+
+$$
+X*Y=K
+$$
+
+- X = Emojicoin
+- Y  = APT
+- K = Constant Product
+
+This design ensures that the pool maintains its liquidity and cannot be
+completely drained. The standard liquidity curve function introduced
+by Uniswap v2 is crucial for price stability and availability of liquidity.

doc/doc-site/docs/about/how-it-works.md

@@ -0,0 +1,65 @@
+---
+slug: /how-it-works
+title: ⚙️ How It Works
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+**Bonding Curve Enabled Launchpad**: When a new emojicoin launches, its pricing
+mechanics are defined as an abridged Concentrated Liquidity Automated Market
+Maker (CLAMM) with a single price range. Once the market cap of the emojicoin
+reaches 45,000 APT value, the money used to purchase the coin by traders is
+deployed to an emojicoin AMM pool.
+
+- The only coins that can be launched are emojicoins that are from the
+  standardized [Unicode emoji library].
+- **emojicoin AMM Pool**: The emojicoin AMM follows the popular and
+  standardized Uniswap v2 design.
+  \$$
+  X*Y=K
+  $\$
+
+## Example: The Life Cycle of the emojicoin — From Launchpad to Pool 🫃
+
+**Introduction**: Congratulations! You've decided to take on the daring journey
+of parenthood and give birth to a beautiful emojicoin. Econia is your favorite
+protocol on the Aptos blockchain, so you decide to name your fictional baby
+emojicoin after her.
+
+Unlike birthing a human child, giving birth to your beautiful Econia emojicoin
+is painless and cheap by leveraging the Aptos blockchain. We'll now walk you
+through your emojicoin's lifecycle.
+
+### First Baby Steps — Launch your emojicoin
+
+- With just 1 APT, you can launch your emojicoin — We don't believe in screwing
+  over new parents with expensive medical bills.
+
+### Growing up and raising your emojicoin  — Leaving the bonding curve
+
+- Emojicoins are like just like humans, as they grow up and mature they want to
+  leave the house to take the world on their own.
+- The emojicoin.fun platform utilizes a bonding curve for initial price
+  discovery to take place. - The bonding curve is essentially an emojicoin's
+  home. The way your emojicoin matures is depicted by the size of its market
+  cap.
+- The market cap size required to leave the bonding curve = 45,000 APT.
+  For the emojicoin to reach a 45,000 APT market cap, it must have a net
+  buy/sell pressure of +10,000 APT.
+
+### Going to College and Joining emojicoin AMM Liquidity Pools
+
+- Once your emojicoin reaches a 45,000 APT market cap size, the coin's market
+  experiences a 'state change' — The 10,000 APT used to purchase the coin is
+  deposited into an emojicoin AMM Liquidity Pool, alongside 23% of the emojicoin
+  token supply. This 'state change' is like your emojicoin baby now going to
+  college and joining a sorority. This Liquidity Pool is locked and its LP
+  tokens to represent it are burned — it can never be removed.
+- The emojicoin in this LP is now available for users to liquidity farm, and
+  of course still be available for trading.
+
+We understand watching your child grow up is bittersweet, but it's a natural
+part of life and you should be proud of what you've accomplished (like breaking
+out of the bonding curve)!
+
+[unicode emoji library]: https://www.unicode.org/emoji/charts/full-emoji-list.html

doc/doc-site/docs/about/why-we-built-emojicoin.md

@@ -0,0 +1,45 @@
+---
+slug: /why-we-built-emojicoin
+title: 🛠️ Why We built emojicoin.fun
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+<!--- cspell:words memecoins -->
+
+<!--- cspell:words presales -->
+
+## Accessibility, Fairness, and Fun
+
+- **Engagement**: Emojis are universally recognized and loved, making our
+  platform instantly engaging and approachable. By using emojis as coin symbols,
+  we lower the barrier to entry for those who might find traditional crypto
+  trading intimidating or too complex.
+
+- **Fairly Launched**: In the world of memecoins, oftentimes new buyers of
+  coins fall to scams or unfair token supply distributions — Resulting in an
+  immediate loss of funds. The emojicoin.fun platform enables users to launch
+  emojicoins in a fair launch style, where fairness and transparent distribution
+  are ensured without presales or team allocations.
+
+- **Fun**: We’re not trying to revolutionize finance with this product, we’re
+  trying to create a fun environment for speculation where the house doesn’t
+  always have the better odds.
+
+## Community Building
+
+- **Social Interaction**: Emojis are inherently social, often used to express
+  emotions and ideas in digital communication. Our platform encourages a
+  community-driven atmosphere where users can bond over their emojicoins
+  and unite under one emoji banner to be the top dog.
+- **Inclusive Environment**: By leveraging the universal appeal of emojis,
+  we aim to create an inclusive trading environment that welcomes users from
+  diverse backgrounds and skill levels.
+
+## Showcasing the technical prowess of Aptos
+
+- Aptos is not just fast and affordable, it’s one of the quickest and cheapest
+  decentralized networks in the world. One key reason for crafting this
+  degenerately fun environment was to showcase what happens when a fun
+  product idea leverages next-generation technology. Say goodbye to failed
+  transactions and high gas fees — And try having fun for once.

doc/doc-site/docs/resources/audit.md

@@ -0,0 +1,6 @@
+---
+slug: /audit
+title: 🍆 Audit
+hide_title: false
+description: Documentation for emojicoin dot fun
+---

doc/doc-site/docs/resources/bug-submission-form.md

@@ -0,0 +1,8 @@
+---
+slug: /bug-submission-form
+title: 🐞 Bug Submission Form
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+Fill out the form to submit bugs: <https://form.typeform.com/to/mMylFJQo>

doc/doc-site/docs/resources/faq.md

@@ -0,0 +1,45 @@
+---
+slug: /faq
+title: 💬 Faq
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+Please note this is not financial advice and nothing the emojicoin monkey says
+should be taken seriously. He just likes to listen to himself talk and has
+caught the emojicoin bug.
+![monkey](./monkey.png "monkey")
+
+### Q: What is the cost to launch an Emojicoin?
+
+A:  1 APT — About the cost of a bushel of bananas
+
+### Q: What is the market cap needed for an emojicoin to leave the bonding
+
+### curve?
+
+A:  45,000 APT Market Cap
+
+### Q: Assuming nobody sells their tokens, how much buy pressure is required for
+
+### the Emojicoin reach a 45,000 APT market cap?
+
+A:  10,000 APT
+
+### Q: If an Emojicoin market is already launched, can I launch a second one of
+
+### the same Emoji?
+
+A:  No, once a particular Emojicoin trading pair is launched, you cannot launch
+another. You should potentially explore launching Emojicoin combinations
+instead. Get creative, don't be lame.
+
+### Q: Are emojicoins the future?
+
+A: Emojis are a universal language, transcending borders and languages. 🌍 With
+the rise of decentralized finance and the integration of emojicoins, I believe
+will see a global shift where emojicoins become the standard for transactions.
+So get ready to live, laugh, and love with emojicoins! They're not just a
+trend; they're a revolution. Embrace the future, where every transaction is a
+smile, a laugh, and a story. Emojicoins are here to stay, and they're going
+to change the world one emoji at a time. 🌈🚀💖

doc/doc-site/docs/resources/glossary.md

@@ -0,0 +1,43 @@
+---
+slug: /glossary
+title: 🍆 Glossary
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+<!--- cspell:words degen -->
+
+<!--- cspell:words LARPS -->
+
+<!--- cspell:words Degen -->
+
+Degenerate vocabulary you must know
+
+**Bonding Curve**: smart contracts that determine a token's price based on its
+circulating supply. In this case the first state of the emojicoin will be here
+before transitioning into the CPAMM.
+
+**Concentrated Liquidity Automated Market Maker (CLAMM)**:More efficient AMM
+design where users have more control over price where liquidity is placed.
+
+**Constant Product Automated Market Maker (CPAMM)**: The most popular AMM design
+
+- Uniswap v2 style.
+  Where, ‘x’ and ‘y’ represent the quantities of two assets in a liquidity pool,
+  and ‘k’ is a constant.
+
+**Degen**: Someone who LARPS as a gambler but doesn't actually make any money.
+
+- Tim: I love NFTs and Web3.  I'm such a degen.
+
+**Degenerate**: Professional gambler that finds asymmetric opportunities that
+the rest of the market overlooks
+
+- "She was a degenerate, she longed BTC in 2010."
+
+**Degenerately**: The act of finding asymmetric opportunities that the rest of
+the market overlooks.
+
+- We degenerately bought the entire supply of three emojicoins this morning."
+
+**emojicoin**: emojicoins are emojis that are tradeable on emojicoin.fun.

doc/doc-site/docs/start-here/aptos-wallet-and-cex.md

@@ -0,0 +1,27 @@
+---
+slug: /aptos-wallet-and-cex
+title: 👛 Getting Started (Aptos Wallet + CEX)
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+Use this guide if you are using an Aptos wallet and using Coinbase to onramp.
+
+1. Open Petra wallet and click Buy
+   ![cex1](./images/cex1.png "cex1")
+1. Choose Coinbase Pay
+   ![cex2](./images/cex2.png "cex2")
+1. Click Buy or Transfer with Coinbase
+   ![cex2](./images/cex2.png "cex3")
+1. Login
+   ![cex4](./images/cex4.png "cex4")
+1. Choose transfer or buy new asset
+   ![cex5](./images/cex5.png "cex5")
+1. Choose amount you want to buy or transfer
+   ![cex6](./images/cex6.png "cex6")
+1. Confirm purchase
+   ![cex7](./images/cex7.png "cex7")
+1. Wait a few seconds for the purchased APT to hit your wallet
+   ![cex8](./images/cex8.png "cex8")
+   Congrats! You are now ready to start trading at Emojicoin.fun with the
+   APT you now have in your wallet!

doc/doc-site/docs/start-here/aptos-wallet-and-moonpay.md

@@ -0,0 +1,18 @@
+---
+slug: /aptos-wallet-and-moonpay
+title: 🔥 Getting Started (Aptos Wallet + Moonpay)
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+Use this guide if you are using an Aptos wallet and Moonpay.
+
+1. Open your Petra wallet and click Buy
+   ![apt1](./images/apt1.png "apt1")
+1. Choose Moonpay
+   ![apt2](./images/apt2.png "apt2")
+1. Enter amount you want to purchase
+   ![apt3](./images/apt3.png "apt3")
+
+Congrats! You are now ready to start trading at Emojicoin.fun with the APT you
+now have in your wallet!

doc/doc-site/docs/start-here/bridging-from-eth.md

@@ -0,0 +1,46 @@
+---
+slug: /bridging-from-eth
+title: 🌈 Bridging From Ethereum to Aptos
+hide_title: false
+description: Documentation for emojicoin dot fun
+---
+
+<!--- cspell:words Panora -->
+
+Use this guide if you are bridging from Ethereum to Aptos.
+
+### Prerequisites
+
+Before we begin, you will need to have the following:
+
+- A wallet with USDC or ETH
+- A browser with wallet extensions installed
+- An Aptos wallet
+
+### Steps to Bridge USDC (LayerZero) into Aptos
+
+1. Go to [The Aptos Bridge] website
+   ![eth1](./images/eth1.png "eth1")
+1. Click Transfer
+   ![eth2](./images/eth2.png "eth2")
+1. Connect your EVM and Aptos Wallet
+   ![eth3](./images/eth3.png "eth3")
+1. Select the "From" and "To" tokens. In this case,  select " ETH" ( or USDC
+   on your given chain) or ETH for the "From" token and "WETH" on APT for the
+   "To" token.
+   ![eth4](./images/eth4.png "eth4")
+1. Enter the amount
+1. Click on the "Bridge" button
+1. Review the transaction details and click on the "Confirm" button
+1. The bridge will be executed and your wrapped USDC (LayerZero) coins for
+   Aptos will be deposited into your Aptos wallet
+1. Now heading over to Panora to swap WETH_lz to APT
+   ![eth5](./images/eth5.png "eth5")
+1. Connect wallet
+   ![eth6](./images/eth6.png "eth6")
+1. Enter the amount of funds you would like to turn into APT
+
+Congrats! You are now ready to start trading at Emojicoin.fun with the APT you
+now have in your wallet!
+
+[the aptos bridge]: https://theaptosbridge.com/