v1.0

README.md

@@ -1,47 +1,77 @@
-# Reverse Mirage [![GitHub Actions][gha-badge]][gha] [![npm version][npm-badge]][npm] [![npm bundle size][bundle-badge]][bundle]
+# Reverse Mirage [![GitHub Actions][gha-badge]][gha] [![npm version][npm-badge]][npm]
 
 [gha]: https://github.com/kyscott18/reverse-mirage/actions
 [gha-badge]: https://github.com/kyscott18/reverse-mirage/actions/workflows/main.yml/badge.svg
 [npm]: https://www.npmjs.com/package/reverse-mirage/v/latest
 [npm-badge]: https://img.shields.io/npm/v/reverse-mirage/latest.svg
-[bundle]: https://bundlephobia.com/result?p=reverse-mirage@latest
-[bundle-badge]:https://img.shields.io/bundlephobia/minzip/reverse-mirage/latest.svg
 
-Application level typescript utilities for Ethereum.
+Building blocks for Ethereum app development. Built using [Viem](https://viem.sh).
 
 ## Features
 
-- ✅ ~30x faster than `@uniswap/sdk-core`
+- ✅ 10x-100x faster, 10.4x smaller than [`@uniswap/sdk-core`](https://github.com/uniswap/sdk-core)
 - ✅ Abstactions for most commonly used token standards
 - ✅ Supports `permit`
 - ✅ Extensible to build apps and libraries
 - ✅ Seamless extension to [Viem](https://github.com/wagmi-dev/viem)
 - ✅ TypeScript ready
-- ✅ Test suite running against [forked](https://ethereum.org/en/glossary/#fork) Ethereum network
+- ✅ Test suite running against local Ethereum network
 
 ## Example
 
 ```ts
 import { createPublicClient, http } from 'viem'
-import {publicActions, amountToNumber} from 'reverse-mirage'
+import { mainnet } from 'viem/chains'
+import { publicActionsReverseMirage, amountToNumber } from 'reverse-mirage'
 
 export const publicClient = createPublicClient({
   chain: mainnet,
   transport: http()
-}).extend(publicActions)
+}).extend(publicActionsReverseMirage)
 
 // read token metadata
 const usdc = await publicClient.getERC20({
   address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // usdc
+  id: mainnet.id
 })
 
 console.log(usdc.decimals) // 6
+console.log(usdc.name) // USD Coin
 
 // read a balance
 const vitalikBalance = await publicClient.getERC20Balance({
   erc20: usdc,
   address: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045' // vitalik
 })
 
+console.log(vitalikBalance.amount) // 420690000n
 console.log(amountToNumber(vitalikBalance)) // 420.69
 ```
+
+## Installation
+
+```sh
+$ npm i reverse-mirage
+```
+
+## Benchmarks
+
+Benchmarks are done with [mitata](https://github.com/evanwashere/mitata). To reproduce: 
+
+```sh
+$ cd packages/core/
+$ bun run src/amount/utils.bench.ts
+```
+
+### Results
+
+* amount add: `reverse mirage` **8.17x** faster than `@uniswap/sdk-core`
+* amount equal to: `reverse-mirage` **10.63x** faster than `@uniswap/sdk-core`
+* amount to number: `reverse-mirage` **136.14x** faster than `@uniswap/sdk-core`
+* amount to significant: `reverse-mirage` **30.03x** faster than `@uniswap/sdk-core`
+
+## Bundle Size
+
+`reverse-mirage`: **5.12 kB**
+
+`@uniswap/sdk-core`: **53.4 kB**

docs/.vitepress/config.mts

@@ -4,32 +4,34 @@ import { defineConfig } from "vitepress";
 export default defineConfig({
   title: "Reverse Mirage",
   description: "Application level typescript utilities for Ethereum",
-  head: [["script", { src: "/_vercel/insights/script.js" }]],
+  head: [
+    ["script", { src: "https://cdn.vercel-insights.com/v1/script.debug.js" }],
+  ],
   themeConfig: {
     search: {
       provider: "local",
     },
 
     sidebar: [
+      { text: "Introduction", link: "/" },
       {
-        text: "Introduction",
+        text: "Overview",
         items: [
-          { text: "Getting started", link: "/" },
-          { text: "Installation", link: "/installation" },
+          { text: "Getting started", link: "/start" },
+          { text: "Benchmarks", link: "/benchmark" },
+          { text: "Examples", link: "/example" },
         ],
       },
       {
         text: "ERC20",
         collapsed: true,
         items: [
-          { text: "Introduction", link: "" },
-
           {
             text: "Utilities",
             items: [
               {
                 text: "createERC20",
-                link: "",
+                link: "/erc20/createERC20",
               },
               {
                 text: "createERC20Amount",
@@ -102,19 +104,19 @@ export default defineConfig({
             text: "Wallet Actions",
             items: [
               {
-                text: "simulateERC20Transfer",
+                text: "writeERC20Transfer",
                 link: "",
               },
               {
-                text: "simulateERC20Approve",
+                text: "writeERC20Approve",
                 link: "",
               },
               {
-                text: "simulateERC20TransferFrom",
+                text: "writeERC20TransferFrom",
                 link: "",
               },
               {
-                text: "simulateERC20Permit",
+                text: "writeERC20Permit",
                 link: "",
               },
               {
@@ -129,7 +131,6 @@ export default defineConfig({
         text: "Native",
         collapsed: true,
         items: [
-          { text: "Introduction", link: "" },
           {
             text: "Utilities",
             items: [
@@ -154,8 +155,6 @@ export default defineConfig({
         text: "WETH",
         collapsed: true,
         items: [
-          { text: "Introduction", link: "" },
-
           {
             text: "Utilities",
             items: [
@@ -169,11 +168,11 @@ export default defineConfig({
             text: "Wallet Actions",
             items: [
               {
-                text: "simulateWETHDeposit",
+                text: "writeWETHDeposit",
                 link: "",
               },
               {
-                text: "simulateWETHWithdraw",
+                text: "writeWETHWithdraw",
                 link: "",
               },
             ],
@@ -184,7 +183,6 @@ export default defineConfig({
         text: "ERC721",
         collapsed: true,
         items: [
-          { text: "Introduction", link: "" },
           {
             text: "Utilities",
             items: [
@@ -196,10 +194,6 @@ export default defineConfig({
                 text: "createERC721Data",
                 link: "",
               },
-              {
-                text: "createERC721DataID",
-                link: "",
-              },
             ],
           },
           {
@@ -245,25 +239,21 @@ export default defineConfig({
                 text: "getERC721Data",
                 link: "",
               },
-              {
-                text: "getERC721DataID",
-                link: "",
-              },
             ],
           },
           {
             text: "Wallet Actions",
             items: [
               {
-                text: "simulateERC721Transfer",
+                text: "writeERC721Transfer",
                 link: "",
               },
               {
-                text: "simulateERC721Approve",
+                text: "writeERC721Approve",
                 link: "",
               },
               {
-                text: "simulateERC721SetApprovalForAll",
+                text: "writeERC721SetApprovalForAll",
                 link: "",
               },
             ],
@@ -274,7 +264,6 @@ export default defineConfig({
         text: "ERC1155",
         collapsed: true,
         items: [
-          { text: "Introduction", link: "" },
           {
             text: "Utilities",
             items: [
@@ -313,15 +302,15 @@ export default defineConfig({
             text: "Wallet Actions",
             items: [
               {
-                text: "simulateERC1155Transfer",
+                text: "writeERC1155Transfer",
                 link: "",
               },
               {
-                text: "simulateERC1155TransferBatch",
+                text: "writeERC1155TransferBatch",
                 link: "",
               },
               {
-                text: "simulateERC1155SetApprovalForAll",
+                text: "writeERC1155SetApprovalForAll",
                 link: "",
               },
             ],
@@ -332,7 +321,6 @@ export default defineConfig({
         text: "Amount",
         collapsed: true,
         items: [
-          { text: "Introduction", link: "" },
           {
             text: "createAmountFromString",
             link: "",
@@ -387,7 +375,6 @@ export default defineConfig({
         text: "Price",
         collapsed: true,
         items: [
-          { text: "Introduction", link: "" },
           {
             text: "createPrice",
             link: "",
@@ -458,7 +445,6 @@ export default defineConfig({
         text: "Fraction",
         collapsed: true,
         items: [
-          { text: "Introduction", link: "" },
           {
             text: "createFraction",
             link: "",
@@ -517,15 +503,6 @@ export default defineConfig({
         text: "Chains",
         link: "",
       },
-      {
-        text: "Utilities",
-        items: [
-          {
-            text: "getQueryKey",
-            link: "",
-          },
-        ],
-      },
     ],
 
     socialLinks: [

docs/benchmark.md

@@ -0,0 +1,14 @@
+# Benchmarks
+
+## Results
+
+* amount add: `reverse mirage` **8.17x** faster than `@uniswap/sdk-core`
+* amount equal to: `reverse-mirage` **10.63x** faster than `@uniswap/sdk-core`
+* amount to number: `reverse-mirage` **136.14x** faster than `@uniswap/sdk-core`
+* amount to significant: `reverse-mirage` **30.03x** faster than `@uniswap/sdk-core`
+
+## Bundle Size
+
+`reverse-mirage`: **5.12 kB**
+
+`@uniswap/sdk-core`: **53.4 kB**

docs/erc20/createERC20.md

@@ -0,0 +1,41 @@
+---
+head:
+  - - meta
+    - property: og:title
+      content: createERC20
+  - - meta
+    - name: description
+      content: Create an erc20.
+  - - meta
+    - property: og:description
+      content: Creates an erc20.
+
+---
+
+# createERC20
+
+Creates an `erc20`.
+
+## Usage
+
+::: code-group
+
+```ts [example.ts]
+import { createERC20 } from 'reverse-mirage'
+
+const usdc = createERC20({ // [!code focus:7]
+  address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+  name: 'USD Coin',
+  symbol: 'USDC',
+  decimals: 6,
+  chainID: 1,
+})
+```
+
+:::
+
+## Returns
+
+`erc20`
+
+The erc20 token that was just created.

docs/example.md

@@ -0,0 +1,12 @@
+# Examples
+
+A [beta interface](https://github.com/kyscott18/reverse-mirage/tree/v1/examples/next-interface) has been built using `reverse-mirage`.
+
+## Features
+
+* Runs on an anvil local node
+* Query balances, automatically update after transactions
+* Transfer test tokens
+* Reset node state from interface
+
+<img width="1014" alt="Screenshot 2023-09-26 at 5 25 36 PM" src="https://github.com/kyscott18/reverse-mirage/assets/43524469/406b46d3-9777-44b0-92c6-c236a7e16c28">