@kasarlabs/erc20-mcp 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kasar Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# Snak - ERC20 Plugin
+
+The ERC20 Plugin provides comprehensive tools for interacting with ERC20 tokens on the Starknet blockchain.
+
+## Features
+
+This plugin adds the following tools:
+
+- **erc20_get_allowance**: Get the amount of tokens that a spender is allowed to spend on behalf of an owner.
+- **erc20_get_my_given_allowance**: Get the amount of tokens that a spender is allowed to spend on your behalf.
+- **erc20_get_allowance_given_to_me**: Get the amount of tokens that you are allowed to spend on behalf of an owner.
+- **erc20_get_total_supply**: Get the total supply of a token.
+- **erc20_transfer_from**: Transfer tokens from one address to another using an allowance.
+- **erc20_get_balance**: Get the balance of an asset for a given wallet address.
+- **erc20_get_own_balance**: Get the balance of an asset in your wallet.
+- **erc20_approve**: Approve a spender to spend tokens on your behalf.
+- **erc20_transfer**: Transfer ERC20 tokens to a specific address.
+- **erc20_deploy_new_contract**: Create and deploy a new ERC20 contract.
+
+## Usage
+
+The ERC20 Plugin is used internally by the Starknet Agent and doesn't need to be called directly. When the agent is initialized, it automatically registers these tools, making them available for use.
+
+## Example
+
+When asking the agent to perform ERC20-related tasks, it will use the appropriate tool from this plugin:
+
+```
+"Approve 50 USDC for address 0x1234..."  // Uses erc20_approve
+"What's the total supply of DAI?"  // Uses erc20_get_total_supply
+"Deploy a new token called MyToken"  // Uses erc20_deploy_new_contract
+```
+
+## Development
+
+To extend this plugin, add new tools in the `src/tools` directory and register them in the `registerTools` function in `src/tools/index.ts`.

package/bin/erc20-mcp.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import { existsSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const buildPath = join(__dirname, '..', 'build', 'index.js');
+
+if (!existsSync(buildPath)) {
+  console.error('Build not found. Run: npm run build');
+  process.exit(1);
+}
+
+await import(buildPath);

package/build/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export declare const RegisterToolInServer: () => Promise<void>;

package/build/index.js

@@ -0,0 +1,128 @@
+#!/usr/bin/env node
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import { registerToolsWithServer, getOnchainWrite, } from '@kasarlabs/ask-starknet-core';
+import dotenv from 'dotenv';
+import { getAllowanceSchema, getTotalSupplySchema, transferFromSchema, getBalanceSchema, getOwnBalanceSchema, approveSchema, transferSchema, getMyGivenAllowanceSchema, getAllowanceGivenToMeSchema, deployERC20Schema, } from './schemas/index.js';
+import { getAllowance } from './tools/getAllowance.js';
+import { getTotalSupply } from './tools/getTotalSupply.js';
+import { transferFrom } from './tools/transferFrom.js';
+import { getBalance, getOwnBalance } from './tools/getBalance.js';
+import { approve } from './tools/approve.js';
+import { transfer } from './tools/transfer.js';
+import { getMyGivenAllowance } from './tools/getAllowance.js';
+import { getAllowanceGivenToMe } from './tools/getAllowance.js';
+import { deployERC20Contract } from './tools/deployERC20.js';
+dotenv.config();
+const server = new McpServer({
+    name: 'starknet-erc20-mcp',
+    version: '0.0.1',
+});
+const registerTools = (Erc20ToolRegistry) => {
+    Erc20ToolRegistry.push({
+        name: 'erc20_get_allowance',
+        description: 'Get the amount of tokens that a spender is allowed to spend on behalf of an owner. Requires the token symbol (e.g., ETH, USDC), the owner address and the spender address.',
+        schema: getAllowanceSchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await getAllowance(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_get_my_given_allowance',
+        description: 'Get the amount of tokens that a spender is allowed to spend on your behalf. Requires the token symbol (e.g., ETH, USDC) and the spender address.',
+        schema: getMyGivenAllowanceSchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await getMyGivenAllowance(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_get_allowance_given_to_me',
+        description: 'Get the amount of tokens that a you are allowed to spend on the behalf of an owner. Requires the token symbol (e.g., ETH, USDC) and the owner address.',
+        schema: getAllowanceGivenToMeSchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await getAllowanceGivenToMe(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_get_total_supply',
+        description: 'Get the total supply of an token token',
+        schema: getTotalSupplySchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await getTotalSupply(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_transfer_from',
+        description: 'Transfer tokens from one address to another using an allowance',
+        schema: transferFromSchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await transferFrom(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_get_balance',
+        description: 'Get the balance of an asset for a given wallet address',
+        schema: getBalanceSchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await getBalance(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_get_own_balance',
+        description: 'Get the balance of an asset in your wallet',
+        schema: getOwnBalanceSchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await getOwnBalance(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_approve',
+        description: 'Approve a spender to spend tokens on your behalf',
+        schema: approveSchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await approve(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_transfer',
+        description: 'Transfer ERC20 tokens to a specific address',
+        schema: transferSchema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await transfer(onchainWrite, params);
+        },
+    });
+    Erc20ToolRegistry.push({
+        name: 'erc20_deploy_new_contract',
+        description: 'Create and deploy a new ERC20 contract, returns the address of the deployed contract',
+        schema: deployERC20Schema,
+        execute: async (params) => {
+            const onchainWrite = getOnchainWrite();
+            return await deployERC20Contract(onchainWrite, params);
+        },
+    });
+};
+export const RegisterToolInServer = async () => {
+    const tools = [];
+    registerTools(tools);
+    await registerToolsWithServer(server, tools);
+};
+async function main() {
+    const transport = new StdioServerTransport();
+    await RegisterToolInServer();
+    await server.connect(transport);
+    console.error('Starknet ERC20 MCP Server running on stdio');
+}
+main().catch((error) => {
+    console.error('Fatal error in main():', error);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AAEjF,OAAO,EAEL,uBAAuB,EACvB,eAAe,GAChB,MAAM,8BAA8B,CAAC;AACtC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,yBAAyB,EACzB,2BAA2B,EAC3B,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,MAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;IAC3B,IAAI,EAAE,oBAAoB;IAC1B,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,iBAA4B,EAAE,EAAE;IACrD,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EACT,4KAA4K;QAC9K,MAAM,EAAE,kBAAkB;QAC1B,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,YAAY,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QACzD,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,8BAA8B;QACpC,WAAW,EACT,kJAAkJ;QACpJ,MAAM,EAAE,yBAAyB;QACjC,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,mBAAmB,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QAChE,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,iCAAiC;QACvC,WAAW,EACT,wJAAwJ;QAC1J,MAAM,EAAE,2BAA2B;QACnC,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,qBAAqB,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,wCAAwC;QACrD,MAAM,EAAE,oBAAoB;QAC5B,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,cAAc,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QAC3D,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EACT,gEAAgE;QAClE,MAAM,EAAE,kBAAkB;QAC1B,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,YAAY,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QACzD,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,mBAAmB;QACzB,WAAW,EAAE,wDAAwD;QACrE,MAAM,EAAE,gBAAgB;QACxB,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,UAAU,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QACvD,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,uBAAuB;QAC7B,WAAW,EAAE,4CAA4C;QACzD,MAAM,EAAE,mBAAmB;QAC3B,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,aAAa,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QAC1D,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,kDAAkD;QAC/D,MAAM,EAAE,aAAa;QACrB,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,OAAO,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QACpD,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,6CAA6C;QAC1D,MAAM,EAAE,cAAc;QACtB,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,QAAQ,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC;KACF,CAAC,CAAC;IAEH,iBAAiB,CAAC,IAAI,CAAC;QACrB,IAAI,EAAE,2BAA2B;QACjC,WAAW,EACT,sFAAsF;QACxF,MAAM,EAAE,iBAAiB;QACzB,OAAO,EAAE,KAAK,EAAE,MAAW,EAAE,EAAE;YAC7B,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,OAAO,MAAM,mBAAmB,CAAC,YAAmB,EAAE,MAAM,CAAC,CAAC;QAChE,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,IAAI,EAAE;IAC7C,MAAM,KAAK,GAAc,EAAE,CAAC;IAC5B,aAAa,CAAC,KAAK,CAAC,CAAC;IACrB,MAAM,uBAAuB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEF,KAAK,UAAU,IAAI;IACjB,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;IAE7C,MAAM,oBAAoB,EAAE,CAAC;IAC7B,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAC9D,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;IAC/C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/build/lib/abis/new.d.ts

@@ -0,0 +1,184 @@
+export declare const NEW_ERC20_ABI_SEPOLIA: ({
+    name: string;
+    type: string;
+    interface_name: string;
+    members?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    members: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    variants: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    items: {
+        name: string;
+        type: string;
+        inputs: {
+            name: string;
+            type: string;
+        }[];
+        outputs: {
+            type: string;
+        }[];
+        state_mutability: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    variants?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+} | {
+    name: string;
+    type: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    kind?: undefined;
+} | {
+    kind: string;
+    name: string;
+    type: string;
+    members: {
+        kind: string;
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+} | {
+    kind: string;
+    name: string;
+    type: string;
+    variants: {
+        kind: string;
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+})[];
+export declare const NEW_ERC20_ABI_MAINNET: ({
+    type: string;
+    name: string;
+    interface_name: string;
+    members?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+} | {
+    type: string;
+    name: string;
+    members: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+} | {
+    type: string;
+    name: string;
+    variants: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+} | {
+    type: string;
+    name: string;
+    items: {
+        type: string;
+        name: string;
+        inputs: {
+            name: string;
+            type: string;
+        }[];
+        outputs: {
+            type: string;
+        }[];
+        state_mutability: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    variants?: undefined;
+    inputs?: undefined;
+    kind?: undefined;
+} | {
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    kind?: undefined;
+} | {
+    type: string;
+    name: string;
+    kind: string;
+    members: {
+        name: string;
+        type: string;
+        kind: string;
+    }[];
+    interface_name?: undefined;
+    variants?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+} | {
+    type: string;
+    name: string;
+    kind: string;
+    variants: {
+        name: string;
+        type: string;
+        kind: string;
+    }[];
+    interface_name?: undefined;
+    members?: undefined;
+    items?: undefined;
+    inputs?: undefined;
+})[];