@kasarlabs/avnu-mcp 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +27 -0
- package/bin/avnu-mcp.js +2 -0
- package/build/index.d.ts +2 -0
- package/build/index.js +49 -0
- package/build/index.js.map +1 -0
- package/build/interfaces/index.d.ts +7 -0
- package/build/interfaces/index.js +2 -0
- package/build/interfaces/index.js.map +1 -0
- package/build/lib/abis/erc20Abi.d.ts +92 -0
- package/build/lib/abis/erc20Abi.js +676 -0
- package/build/lib/abis/erc20Abi.js.map +1 -0
- package/build/lib/constants/index.d.ts +2 -0
- package/build/lib/constants/index.js +3 -0
- package/build/lib/constants/index.js.map +1 -0
- package/build/lib/dependances/types.d.ts +85 -0
- package/build/lib/dependances/types.js +51 -0
- package/build/lib/dependances/types.js.map +1 -0
- package/build/lib/types/index.d.ts +51 -0
- package/build/lib/types/index.js +2 -0
- package/build/lib/types/index.js.map +1 -0
- package/build/lib/utils/contractInteractor.d.ts +16 -0
- package/build/lib/utils/contractInteractor.js +114 -0
- package/build/lib/utils/contractInteractor.js.map +1 -0
- package/build/lib/utils/transactionMonitor.d.ts +11 -0
- package/build/lib/utils/transactionMonitor.js +82 -0
- package/build/lib/utils/transactionMonitor.js.map +1 -0
- package/build/lib/utils/utils.d.ts +6 -0
- package/build/lib/utils/utils.js +9 -0
- package/build/lib/utils/utils.js.map +1 -0
- package/build/schemas/index.d.ts +28 -0
- package/build/schemas/index.js +20 -0
- package/build/schemas/index.js.map +1 -0
- package/build/tools/approval.d.ts +8 -0
- package/build/tools/approval.js +46 -0
- package/build/tools/approval.js.map +1 -0
- package/build/tools/fetchRoute.d.ts +13 -0
- package/build/tools/fetchRoute.js +67 -0
- package/build/tools/fetchRoute.js.map +1 -0
- package/build/tools/fetchTokens.d.ts +10 -0
- package/build/tools/fetchTokens.js +30 -0
- package/build/tools/fetchTokens.js.map +1 -0
- package/build/tools/swap.d.ts +17 -0
- package/build/tools/swap.js +92 -0
- package/build/tools/swap.js.map +1 -0
- package/package.json +44 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Kasar Labs
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Snak - AVNU Plugin
|
|
2
|
+
|
|
3
|
+
The AVNU Plugin provides tools for interacting with the AVNU decentralized exchange on the Starknet blockchain, enabling token swaps and route information.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
This plugin adds the following tools:
|
|
8
|
+
|
|
9
|
+
- **avnu_swap_tokens**: Swap a specified amount of one token for another token.
|
|
10
|
+
- **avnu_get_route**: Get a specific routing path for a token swap.
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
The AVNU 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.
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
When asking the agent to perform AVNU-related tasks, it will use the appropriate tool from this plugin:
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
"Swap 0.1 ETH for USDC on AVNU" // Uses avnu_swap_tokens
|
|
22
|
+
"Find the best route to swap ETH to DAI" // Uses avnu_get_route
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Development
|
|
26
|
+
|
|
27
|
+
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/avnu-mcp.js
ADDED
package/build/index.d.ts
ADDED
package/build/index.js
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
3
|
+
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
|
|
4
|
+
import { registerToolsWithServer, getOnchainWrite, } from '@kasarlabs/ask-starknet-core';
|
|
5
|
+
import dotenv from 'dotenv';
|
|
6
|
+
import { routeSchema, swapSchema } from './schemas/index.js';
|
|
7
|
+
import { swapTokens } from './tools/swap.js';
|
|
8
|
+
import { getRoute } from './tools/fetchRoute.js';
|
|
9
|
+
dotenv.config();
|
|
10
|
+
const server = new McpServer({
|
|
11
|
+
name: 'starknet-avnu-mcp',
|
|
12
|
+
version: '0.0.1',
|
|
13
|
+
});
|
|
14
|
+
const registerTools = (AvnuToolRegistry) => {
|
|
15
|
+
AvnuToolRegistry.push({
|
|
16
|
+
name: 'avnu_swap_tokens',
|
|
17
|
+
description: 'Swap a specified amount of one token for another token',
|
|
18
|
+
schema: swapSchema,
|
|
19
|
+
execute: async (params) => {
|
|
20
|
+
const onchainWrite = getOnchainWrite();
|
|
21
|
+
return await swapTokens(onchainWrite, params);
|
|
22
|
+
},
|
|
23
|
+
});
|
|
24
|
+
AvnuToolRegistry.push({
|
|
25
|
+
name: 'avnu_get_route',
|
|
26
|
+
description: 'Get a specific route',
|
|
27
|
+
schema: routeSchema,
|
|
28
|
+
execute: async (params) => {
|
|
29
|
+
const onchainWrite = getOnchainWrite();
|
|
30
|
+
return await getRoute(onchainWrite, params);
|
|
31
|
+
},
|
|
32
|
+
});
|
|
33
|
+
};
|
|
34
|
+
export const RegisterToolInServer = async () => {
|
|
35
|
+
const tools = [];
|
|
36
|
+
registerTools(tools);
|
|
37
|
+
await registerToolsWithServer(server, tools);
|
|
38
|
+
};
|
|
39
|
+
async function main() {
|
|
40
|
+
const transport = new StdioServerTransport();
|
|
41
|
+
await RegisterToolInServer();
|
|
42
|
+
await server.connect(transport);
|
|
43
|
+
console.error('Starknet AVNU MCP Server running on stdio');
|
|
44
|
+
}
|
|
45
|
+
main().catch((error) => {
|
|
46
|
+
console.error('Fatal error in main():', error);
|
|
47
|
+
process.exit(1);
|
|
48
|
+
});
|
|
49
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD,MAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;IAC3B,IAAI,EAAE,mBAAmB;IACzB,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAC,gBAA2B,EAAE,EAAE;IACpD,gBAAgB,CAAC,IAAI,CAAC;QACpB,IAAI,EAAE,kBAAkB;QACxB,WAAW,EAAE,wDAAwD;QACrE,MAAM,EAAE,UAAU;QAClB,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,gBAAgB,CAAC,IAAI,CAAC;QACpB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,sBAAsB;QACnC,MAAM,EAAE,WAAW;QACnB,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;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,2CAA2C,CAAC,CAAC;AAC7D,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"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
export declare const ERC20_ABI: ({
|
|
2
|
+
type: string;
|
|
3
|
+
name: string;
|
|
4
|
+
interface_name: string;
|
|
5
|
+
variants?: undefined;
|
|
6
|
+
members?: undefined;
|
|
7
|
+
items?: undefined;
|
|
8
|
+
inputs?: undefined;
|
|
9
|
+
kind?: undefined;
|
|
10
|
+
} | {
|
|
11
|
+
type: string;
|
|
12
|
+
name: string;
|
|
13
|
+
variants: {
|
|
14
|
+
name: string;
|
|
15
|
+
type: string;
|
|
16
|
+
}[];
|
|
17
|
+
interface_name?: undefined;
|
|
18
|
+
members?: undefined;
|
|
19
|
+
items?: undefined;
|
|
20
|
+
inputs?: undefined;
|
|
21
|
+
kind?: undefined;
|
|
22
|
+
} | {
|
|
23
|
+
type: string;
|
|
24
|
+
name: string;
|
|
25
|
+
members: {
|
|
26
|
+
name: string;
|
|
27
|
+
type: string;
|
|
28
|
+
}[];
|
|
29
|
+
interface_name?: undefined;
|
|
30
|
+
variants?: undefined;
|
|
31
|
+
items?: undefined;
|
|
32
|
+
inputs?: undefined;
|
|
33
|
+
kind?: undefined;
|
|
34
|
+
} | {
|
|
35
|
+
type: string;
|
|
36
|
+
name: string;
|
|
37
|
+
items: {
|
|
38
|
+
type: string;
|
|
39
|
+
name: string;
|
|
40
|
+
inputs: {
|
|
41
|
+
name: string;
|
|
42
|
+
type: string;
|
|
43
|
+
}[];
|
|
44
|
+
outputs: {
|
|
45
|
+
type: string;
|
|
46
|
+
}[];
|
|
47
|
+
state_mutability: string;
|
|
48
|
+
}[];
|
|
49
|
+
interface_name?: undefined;
|
|
50
|
+
variants?: undefined;
|
|
51
|
+
members?: undefined;
|
|
52
|
+
inputs?: undefined;
|
|
53
|
+
kind?: undefined;
|
|
54
|
+
} | {
|
|
55
|
+
type: string;
|
|
56
|
+
name: string;
|
|
57
|
+
inputs: {
|
|
58
|
+
name: string;
|
|
59
|
+
type: string;
|
|
60
|
+
}[];
|
|
61
|
+
interface_name?: undefined;
|
|
62
|
+
variants?: undefined;
|
|
63
|
+
members?: undefined;
|
|
64
|
+
items?: undefined;
|
|
65
|
+
kind?: undefined;
|
|
66
|
+
} | {
|
|
67
|
+
type: string;
|
|
68
|
+
name: string;
|
|
69
|
+
kind: string;
|
|
70
|
+
members: {
|
|
71
|
+
name: string;
|
|
72
|
+
type: string;
|
|
73
|
+
kind: string;
|
|
74
|
+
}[];
|
|
75
|
+
interface_name?: undefined;
|
|
76
|
+
variants?: undefined;
|
|
77
|
+
items?: undefined;
|
|
78
|
+
inputs?: undefined;
|
|
79
|
+
} | {
|
|
80
|
+
type: string;
|
|
81
|
+
name: string;
|
|
82
|
+
kind: string;
|
|
83
|
+
variants: {
|
|
84
|
+
name: string;
|
|
85
|
+
type: string;
|
|
86
|
+
kind: string;
|
|
87
|
+
}[];
|
|
88
|
+
interface_name?: undefined;
|
|
89
|
+
members?: undefined;
|
|
90
|
+
items?: undefined;
|
|
91
|
+
inputs?: undefined;
|
|
92
|
+
})[];
|