@mania-labs/mania-sdk 1.0.1 → 1.0.3

package/README.md

@@ -61,7 +61,7 @@ console.log("Migration Progress:", tokenInfo.migrationProgress, "%");
 const result = await sdk.create({
   name: "My Token",
   symbol: "MTK",
-  uri: "ipfs://...", // Metadata URI
+  uri: "ipfs://...", // Metadata URI (see Token Metadata below)
   creator: "0x...", // Creator address (receives fees)
 });
 
@@ -69,6 +69,60 @@ console.log("Token created:", result.tokenAddress);
 console.log("Transaction:", result.hash);
 ```
 
+### Token Metadata
+
+The `uri` parameter should point to an IPFS URL containing a JSON metadata file. You must upload your metadata JSON to IPFS first, then pass the resulting IPFS URL to the `uri` field.
+
+**Metadata Structure:**
+
+```json
+{
+  "name": "HOMER",
+  "symbol": "HOMER",
+  "description": "A description of your token",
+  "image": "ipfs://bafybeigpul3iw2yok735e7ozc5siwg7l3gcmuovcsawkzelsq7kwbtexxu",
+  "attributes": {
+    "twitter": "https://x.com/yourproject",
+    "website": "https://yourproject.com",
+    "github": "https://github.com/yourproject",
+    "discord": "https://discord.gg/yourproject"
+  }
+}
+```
+
+**Fields:**
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `name` | Yes | Token display name |
+| `symbol` | Yes | Token symbol (ticker) |
+| `description` | No | Description of the token |
+| `image` | No | IPFS URL to token image (e.g., `ipfs://bafy...`) |
+| `attributes` | No | Social links and additional metadata |
+
+**Adding an Image:**
+
+1. Upload your image to IPFS (using Pinata, NFT.Storage, or any IPFS pinning service)
+2. Get the resulting CID (e.g., `bafybeigpul3iw2yok735e7ozc5siwg7l3gcmuovcsawkzelsq7kwbtexxu`)
+3. Use the `ipfs://` protocol prefix: `ipfs://<CID>`
+4. Include this URL in the `image` field of your metadata JSON
+5. Upload the complete metadata JSON to IPFS
+6. Pass the metadata IPFS URL as the `uri` parameter when creating the token
+
+**Example:**
+
+```typescript
+// After uploading metadata.json to IPFS and getting the CID
+const metadataUri = "ipfs://bafkreihdwdcef3fksy7ygjxwfxjfujdi4mfg6rn4m5jqnz3gyvhqorvnrm";
+
+const result = await sdk.create({
+  name: "HOMER",
+  symbol: "HOMER",
+  uri: metadataUri,
+  creator: "0x...",
+});
+```
+
 ### Create and Buy in One Transaction
 
 ```typescript
@@ -204,6 +258,15 @@ sdk.watchMigrationEvents((event) => {
 unwatch();
 ```
 
+### Reading Token Metadata
+
+```typescript
+// Get token name and symbol
+const { name, symbol } = await sdk.getTokenMetadata(tokenAddress);
+console.log("Name:", name);
+console.log("Symbol:", symbol);
+```
+
 ### Reading Global State
 
 ```typescript
@@ -215,6 +278,31 @@ console.log("Pool Migration Fee:", globalState.poolMigrationFee);
 console.log("Token Total Supply:", globalState.tokenTotalSupply);
 ```
 
+### Trading Migrated Tokens
+
+After a token migrates to Uniswap V3, use these methods to get quotes:
+
+```typescript
+import { parseEther } from "viem";
+
+// Check if token has migrated
+const isMigrated = await sdk.isMigrated(tokenAddress);
+
+if (isMigrated) {
+  // Get Uniswap V3 pool address
+  const poolAddress = await sdk.getPoolAddress(tokenAddress);
+  console.log("Pool:", poolAddress);
+
+  // Get buy quote (ETH -> Token)
+  const tokensOut = await sdk.getMigratedBuyQuote(tokenAddress, parseEther("1"));
+  console.log("Tokens for 1 ETH:", tokensOut);
+
+  // Get sell quote (Token -> ETH)
+  const ethOut = await sdk.getMigratedSellQuote(tokenAddress, parseEther("1000"));
+  console.log("ETH for 1000 tokens:", ethOut);
+}
+```
+
 ## Utility Functions
 
 ```typescript
@@ -280,12 +368,12 @@ console.log(UNISWAP_FEE_TIER); // 3000
 import { getChainConfig, CHAIN_CONFIGS } from "@mania-labs/mania-sdk";
 
 // Get config for a specific chain
-const baseConfig = getChainConfig(8453);
+const baseConfig = getChainConfig(4326);
 console.log(baseConfig?.factoryAddress);
 console.log(baseConfig?.wethAddress);
 
 // Or create SDK from chain ID
-const sdk = ManiaSDK.fromChainId(8453, "https://mainnet.base.org");
+const sdk = ManiaSDK.fromChainId(4326, "https://megaeth.blockscout.com");
 ```
 
 ## Advanced Usage
@@ -299,18 +387,18 @@ import { privateKeyToAccount } from "viem/accounts";
 
 const publicClient = createPublicClient({
   chain: base,
-  transport: http("https://mainnet.base.org"),
+  transport: http("https://megaeth.blockscout.com"),
 });
 
 const walletClient = createWalletClient({
   account: privateKeyToAccount("0x..."),
   chain: base,
-  transport: http("https://mainnet.base.org"),
+  transport: http("https://megaeth.blockscout.com"),
 });
 
 const sdk = new ManiaSDK({
   factoryAddress: "0x...",
-  chainId: 8453,
+  chainId: 4326,
 });
 
 sdk.setPublicClient(publicClient);

package/dist/index.d.mts

@@ -411,6 +411,15 @@ declare class ManiaSDK {
      * @param token - Token address
      */
     getTokenInfo(token: Address): Promise<TokenInfo>;
+    /**
+     * Get token name and symbol
+     *
+     * @param token - Token address
+     */
+    getTokenMetadata(token: Address): Promise<{
+        name: string;
+        symbol: string;
+    }>;
     /**
      * Get buy quote from contract
      *
@@ -548,6 +557,36 @@ declare class ManiaSDK {
      * Get the wallet client
      */
     getWalletClient(): WalletClient | null;
+    /**
+     * Get chain config or throw if not found
+     */
+    private getChainConfigOrThrow;
+    /**
+     * Get quote for buying tokens with ETH on Kumbaya DEX (Uniswap V3)
+     * Use this for tokens that have migrated from the bonding curve
+     *
+     * @param token - Token address
+     * @param ethAmount - ETH amount in wei
+     * @returns Token amount out
+     */
+    getMigratedBuyQuote(token: Address, ethAmount: bigint): Promise<bigint>;
+    /**
+     * Get quote for selling tokens for ETH on Kumbaya DEX (Uniswap V3)
+     * Use this for tokens that have migrated from the bonding curve
+     *
+     * @param token - Token address
+     * @param tokenAmount - Token amount to sell
+     * @returns ETH amount out in wei
+     */
+    getMigratedSellQuote(token: Address, tokenAmount: bigint): Promise<bigint>;
+    /**
+     * Get the Uniswap V3 pool address for a token/WETH pair
+     *
+     * @param token - Token address
+     * @returns Pool address
+     * @throws Error if pool not found
+     */
+    getPoolAddress(token: Address): Promise<Address>;
 }
 
 /**
@@ -587,6 +626,7 @@ interface ChainConfig {
     wethAddress: Address;
     nonfungiblePositionManager: Address;
     uniswapV3Factory: Address;
+    quoterV2: Address;
     blockExplorer: string;
 }
 /**
@@ -1026,6 +1066,238 @@ declare const MANIA_FACTORY_ABI: readonly [{
     }];
     readonly anonymous: false;
 }];
+declare const QUOTER_V2_ABI: readonly [{
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "_factory";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "_WETH9";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "constructor";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "WETH9";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "factory";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes";
+        readonly name: "path";
+        readonly type: "bytes";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "amountIn";
+        readonly type: "uint256";
+    }];
+    readonly name: "quoteExactInput";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "amountOut";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint160[]";
+        readonly name: "sqrtPriceX96AfterList";
+        readonly type: "uint160[]";
+    }, {
+        readonly internalType: "uint32[]";
+        readonly name: "initializedTicksCrossedList";
+        readonly type: "uint32[]";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "gasEstimate";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "tokenIn";
+            readonly type: "address";
+        }, {
+            readonly internalType: "address";
+            readonly name: "tokenOut";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "amountIn";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint24";
+            readonly name: "fee";
+            readonly type: "uint24";
+        }, {
+            readonly internalType: "uint160";
+            readonly name: "sqrtPriceLimitX96";
+            readonly type: "uint160";
+        }];
+        readonly internalType: "struct IQuoterV2.QuoteExactInputSingleParams";
+        readonly name: "params";
+        readonly type: "tuple";
+    }];
+    readonly name: "quoteExactInputSingle";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "amountOut";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint160";
+        readonly name: "sqrtPriceX96After";
+        readonly type: "uint160";
+    }, {
+        readonly internalType: "uint32";
+        readonly name: "initializedTicksCrossed";
+        readonly type: "uint32";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "gasEstimate";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "bytes";
+        readonly name: "path";
+        readonly type: "bytes";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "amountOut";
+        readonly type: "uint256";
+    }];
+    readonly name: "quoteExactOutput";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "amountIn";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint160[]";
+        readonly name: "sqrtPriceX96AfterList";
+        readonly type: "uint160[]";
+    }, {
+        readonly internalType: "uint32[]";
+        readonly name: "initializedTicksCrossedList";
+        readonly type: "uint32[]";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "gasEstimate";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "tokenIn";
+            readonly type: "address";
+        }, {
+            readonly internalType: "address";
+            readonly name: "tokenOut";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "amount";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint24";
+            readonly name: "fee";
+            readonly type: "uint24";
+        }, {
+            readonly internalType: "uint160";
+            readonly name: "sqrtPriceLimitX96";
+            readonly type: "uint160";
+        }];
+        readonly internalType: "struct IQuoterV2.QuoteExactOutputSingleParams";
+        readonly name: "params";
+        readonly type: "tuple";
+    }];
+    readonly name: "quoteExactOutputSingle";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "amountIn";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint160";
+        readonly name: "sqrtPriceX96After";
+        readonly type: "uint160";
+    }, {
+        readonly internalType: "uint32";
+        readonly name: "initializedTicksCrossed";
+        readonly type: "uint32";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "gasEstimate";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "int256";
+        readonly name: "amount0Delta";
+        readonly type: "int256";
+    }, {
+        readonly internalType: "int256";
+        readonly name: "amount1Delta";
+        readonly type: "int256";
+    }, {
+        readonly internalType: "bytes";
+        readonly name: "path";
+        readonly type: "bytes";
+    }];
+    readonly name: "uniswapV3SwapCallback";
+    readonly outputs: readonly [];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+declare const UNISWAP_V3_FACTORY_ABI: readonly [{
+    readonly inputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "constructor";
+}, {
+    readonly inputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "tokenA";
+        readonly type: "address";
+    }, {
+        readonly internalType: "address";
+        readonly name: "tokenB";
+        readonly type: "address";
+    }, {
+        readonly internalType: "uint24";
+        readonly name: "fee";
+        readonly type: "uint24";
+    }];
+    readonly name: "getPool";
+    readonly outputs: readonly [{
+        readonly internalType: "address";
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
 declare const ERC20_ABI: readonly [{
     readonly type: "function";
     readonly name: "name";
@@ -1113,4 +1385,4 @@ declare const ERC20_ABI: readonly [{
     readonly stateMutability: "nonpayable";
 }];
 
-export { BPS_DENOMINATOR, BondingCurve, type BondingCurveState, type BuyParams, type BuyQuote, CHAIN_CONFIGS, CREATOR_FEE_BASIS_POINTS, type ChainConfig, type CompleteEvent, type CreateAndBuyParams, type CreateEvent, type CreateTokenParams, DEFAULT_SLIPPAGE_BPS, ERC20_ABI, type GlobalState, MANIA_FACTORY_ABI, MAX_FEE_BASIS_POINTS, MAX_MIGRATE_FEES, MIGRATION_THRESHOLD, ManiaSDK, type ManiaSDKConfig, type MigrateParams, type MigrationEvent, PROTOCOL_FEE_BASIS_POINTS, type SellParams, type SellQuote, type SetParamsInput, type SlippageConfig, TICK_LOWER, TICK_UPPER, TOKENS_FOR_LP, TOTAL_FEE_BASIS_POINTS, type TokenInfo, type TradeEvent, type TransactionResult, UNISWAP_FEE_TIER, bpsToPercent, calculateBuyAmount, calculateMigrationProgress, calculatePriceImpact, calculateSellAmount, calculateWithSlippage, formatEthValue, formatMarketCap, formatPrice, formatTokenAmount, getChainConfig, isValidAddress, parseEthValue, percentToBps, sleep, truncateAddress, withRetry };
+export { BPS_DENOMINATOR, BondingCurve, type BondingCurveState, type BuyParams, type BuyQuote, CHAIN_CONFIGS, CREATOR_FEE_BASIS_POINTS, type ChainConfig, type CompleteEvent, type CreateAndBuyParams, type CreateEvent, type CreateTokenParams, DEFAULT_SLIPPAGE_BPS, ERC20_ABI, type GlobalState, MANIA_FACTORY_ABI, MAX_FEE_BASIS_POINTS, MAX_MIGRATE_FEES, MIGRATION_THRESHOLD, ManiaSDK, type ManiaSDKConfig, type MigrateParams, type MigrationEvent, PROTOCOL_FEE_BASIS_POINTS, QUOTER_V2_ABI, type SellParams, type SellQuote, type SetParamsInput, type SlippageConfig, TICK_LOWER, TICK_UPPER, TOKENS_FOR_LP, TOTAL_FEE_BASIS_POINTS, type TokenInfo, type TradeEvent, type TransactionResult, UNISWAP_FEE_TIER, UNISWAP_V3_FACTORY_ABI, bpsToPercent, calculateBuyAmount, calculateMigrationProgress, calculatePriceImpact, calculateSellAmount, calculateWithSlippage, formatEthValue, formatMarketCap, formatPrice, formatTokenAmount, getChainConfig, isValidAddress, parseEthValue, percentToBps, sleep, truncateAddress, withRetry };