aegis-swap-widget 0.1.0

package/README.md

@@ -0,0 +1,193 @@
+# Aegis Swap Widget
+
+Embeddable React swap widget for WATER, WOOD, GRASS, and STONE. It does not import the private Aegis Engine SDK and does not use Uniswap widget packages.
+
+The widget quotes the configured Uniswap v4 pool, handles ERC20 approval to Permit2, signs a Permit2 batch for the Aegis router, and submits the direct pool swap.
+
+## Install
+
+```bash
+npm install aegis-swap-widget
+```
+
+## Basic Usage
+
+```tsx
+import { AegisSwapWidget } from 'aegis-swap-widget'
+import 'aegis-swap-widget/styles.css'
+
+export function Swap() {
+  return (
+    <AegisSwapWidget
+      defaultTarget="GRASS"
+      theme="dark"
+      accentColor="#31d48a"
+    />
+  )
+}
+```
+
+By default the component uses `window.ethereum` when available, so injected wallets
+like MetaMask and Rabby work without any wallet props.
+
+Token icons are hydrated from the same metadata table used by the Aegis website:
+`GlobalToken.iconURL` from the Aegis metadata GraphQL API. The default endpoint is
+`https://aegis.markets/graphql/meta`.
+
+## Appearance
+
+Hosts can choose the widget surface and brand accent at instantiation time:
+
+```tsx
+<AegisSwapWidget
+  theme="light"
+  accentColor="#006adc"
+  accentTextColor="#ffffff"
+/>
+```
+
+`theme` supports `dark` and `light`. `accentColor` accepts any CSS color value and is used for the CTA, selected pools, focus states, links, and swap controls. `accentTextColor` is optional and only needed when the accent color needs a different CTA text color for contrast.
+
+## Instantiate From Pool Keys
+
+Pass the direct pools you want to expose. When `poolKeys` is provided, the widget only renders those token buttons unless you also pass `targets`.
+
+```tsx
+import {
+  AegisSwapWidget,
+  AEGIS_SWAP_MARKETS,
+  type AegisSwapPoolKeys,
+} from 'aegis-swap-widget'
+
+const poolKeys: AegisSwapPoolKeys = {
+  GRASS: {
+    poolKey: AEGIS_SWAP_MARKETS.GRASS.poolKey,
+    label: 'USDC / GRASS',
+  },
+  WATER: {
+    poolKey: AEGIS_SWAP_MARKETS.WATER.poolKey,
+    label: 'USDC / WATER',
+  },
+}
+
+export function Swap() {
+  return <AegisSwapWidget poolKeys={poolKeys} defaultTarget="GRASS" />
+}
+```
+
+For the built-in WATER, WOOD, GRASS, and STONE symbols, the widget fills in token metadata, router, Permit2, Quoter, and pool id automatically. You can override any of those fields inside each pool-key config.
+
+## Chains
+
+The default chain is Ethereum mainnet. You can override mainnet RPCs or provide another chain config:
+
+```tsx
+import { mainnet } from 'viem/chains'
+
+<AegisSwapWidget
+  chainId={1}
+  chains={{
+    1: {
+      chain: mainnet,
+      rpcUrls: ['https://your-mainnet-rpc.example'],
+    },
+  }}
+  poolKeys={poolKeys}
+/>
+```
+
+For a new chain, provide a viem `chain`, router, Permit2, Quoter, and RPC URLs. Pool-key entries can set `chainId`, `token`, and `counterToken` when the token addresses differ by chain.
+
+## Token Icons
+
+The widget fetches token icons by address using the metadata IDs from the Aegis metadata API:
+`evm_${chainId}_${tokenAddressLowercase}`.
+
+```tsx
+<AegisSwapWidget
+  metadataEndpoint="/graphql/meta"
+  poolKeys={poolKeys}
+/>
+```
+
+Use `metadataEndpoint={null}` to disable backend icon hydration. Tokens can also provide `iconUrl` directly when passed through a custom `market` or pool-key token override.
+
+## With Existing Wallet UI
+
+If a site already has wallet state, pass its EIP-1193 provider and account:
+
+```tsx
+<AegisSwapWidget
+  provider={provider}
+  account={account}
+  onConnectWallet={openWallet}
+  defaultTarget="STONE"
+  onSubmitted={(hash) => console.log(hash)}
+/>
+```
+
+For wallet libraries where the provider is resolved lazily, pass `getProvider`:
+
+```tsx
+<AegisSwapWidget
+  account={account}
+  getProvider={async () => walletConnector.getProvider()}
+  onConnectWallet={openWallet}
+/>
+```
+
+`onConnectWallet` can also return the connection directly, which is useful when a
+host connect modal creates the provider during the button click:
+
+```tsx
+<AegisSwapWidget
+  onConnectWallet={async () => {
+    const connection = await openWallet()
+    return {
+      provider: connection.provider,
+      account: connection.account,
+    }
+  }}
+/>
+```
+
+If none of these props are supplied, the widget still checks `window.ethereum`
+automatically when it renders and again when the user clicks connect/swap.
+
+## Props
+
+- `provider`: optional EIP-1193 provider. Defaults to auto-detected `window.ethereum`.
+- `account`: optional connected account from the host wallet UI.
+- `getProvider`: optional provider resolver for wallet libraries with async providers.
+- `onConnectWallet`: optional callback for opening the host wallet modal. It may return `{ provider, account }`.
+- `chainId`: active chain id. Defaults to Ethereum mainnet.
+- `chains`: optional chain config overrides or additional chain configs.
+- `poolKeys`: optional direct pool keys to render and swap against.
+- `targets`: optional token button order/subset.
+- `defaultTarget`: `WATER`, `WOOD`, `GRASS`, or `STONE`.
+- `defaultDirection`: `intoTarget` for USDC to target, or `outOfTarget` for target to USDC.
+- `markets`: optional override for pool/router/quoter config.
+- `rpcUrls`: optional RPC fallback list for the active chain.
+- `metadataEndpoint`: optional metadata GraphQL endpoint for `GlobalToken.iconURL` token icons. Set to `null` to disable.
+- `theme`: `dark` or `light`. Defaults to `dark`.
+- `themeMode`: legacy alias for `theme`.
+- `accentColor`: CSS accent color for the CTA, selected pools, focus states, links, and swap controls.
+- `accentTextColor`: optional CTA text color for contrast with the chosen accent.
+
+## Default Markets
+
+The package ships mainnet direct-pool configs for:
+
+- `USDC / WATER`
+- `USDC / WOOD`
+- `USDC / GRASS`
+- `USDC / STONE`
+
+These use the Aegis mainnet router `0x00581261a1200956ea05d1810fF28ffd66D8E254`, Permit2, and the public Uniswap v4 Quoter.
+
+## Local Demo
+
+```bash
+npm install
+npm run dev
+```

package/dist/abis.d.ts

@@ -0,0 +1,188 @@
+export declare const AEGIS_ROUTER_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "execute";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "batches";
+        readonly type: "tuple[]";
+        readonly components: readonly [{
+            readonly name: "requiresV4Unlock";
+            readonly type: "bool";
+        }, {
+            readonly name: "actions";
+            readonly type: "bytes";
+        }, {
+            readonly name: "params";
+            readonly type: "bytes[]";
+        }];
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "multicall";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "data";
+        readonly type: "bytes[]";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "results";
+        readonly type: "bytes[]";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "permitBatch";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "permitBatch";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "details";
+            readonly type: "tuple[]";
+            readonly components: readonly [{
+                readonly name: "token";
+                readonly type: "address";
+            }, {
+                readonly name: "amount";
+                readonly type: "uint160";
+            }, {
+                readonly name: "expiration";
+                readonly type: "uint48";
+            }, {
+                readonly name: "nonce";
+                readonly type: "uint48";
+            }];
+        }, {
+            readonly name: "spender";
+            readonly type: "address";
+        }, {
+            readonly name: "sigDeadline";
+            readonly type: "uint256";
+        }];
+    }, {
+        readonly name: "signature";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [];
+}];
+export declare const PERMIT2_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "allowance";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "token";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "amount";
+        readonly type: "uint160";
+    }, {
+        readonly name: "expiration";
+        readonly type: "uint48";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint48";
+    }];
+}];
+export declare const UNISWAP_V4_QUOTER_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "quoteExactInputSingle";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "params";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "poolKey";
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly name: "currency0";
+                readonly type: "address";
+            }, {
+                readonly name: "currency1";
+                readonly type: "address";
+            }, {
+                readonly name: "fee";
+                readonly type: "uint24";
+            }, {
+                readonly name: "tickSpacing";
+                readonly type: "int24";
+            }, {
+                readonly name: "hooks";
+                readonly type: "address";
+            }];
+        }, {
+            readonly name: "zeroForOne";
+            readonly type: "bool";
+        }, {
+            readonly name: "exactAmount";
+            readonly type: "uint128";
+        }, {
+            readonly name: "hookData";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [{
+        readonly name: "amountOut";
+        readonly type: "uint256";
+    }, {
+        readonly name: "gasEstimate";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "quoteExactOutputSingle";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "params";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "poolKey";
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly name: "currency0";
+                readonly type: "address";
+            }, {
+                readonly name: "currency1";
+                readonly type: "address";
+            }, {
+                readonly name: "fee";
+                readonly type: "uint24";
+            }, {
+                readonly name: "tickSpacing";
+                readonly type: "int24";
+            }, {
+                readonly name: "hooks";
+                readonly type: "address";
+            }];
+        }, {
+            readonly name: "zeroForOne";
+            readonly type: "bool";
+        }, {
+            readonly name: "exactAmount";
+            readonly type: "uint128";
+        }, {
+            readonly name: "hookData";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [{
+        readonly name: "amountIn";
+        readonly type: "uint256";
+    }, {
+        readonly name: "gasEstimate";
+        readonly type: "uint256";
+    }];
+}];
+//# sourceMappingURL=abis.d.ts.map

package/dist/abis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abis.d.ts","sourceRoot":"","sources":["../src/abis.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsDnB,CAAA;AAEV,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;EAgBd,CAAA;AAEV,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+DxB,CAAA"}