Skip to content

Commit 13e65d5

Browse files
author
vcart
committed
chore: fixed naming from StarkNet to Starknet
1 parent c7392b7 commit 13e65d5

7 files changed

Lines changed: 55 additions & 55 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -302,14 +302,14 @@ main();
302302
- "Get information about the latest block on Starknet"
303303
- "Look up the owner of NFT #123 in collection 0x..."
304304

305-
### Example: Getting an ETH Balance with StarkNet ID
305+
### Example: Getting an ETH Balance with Starknet ID
306306

307307
```javascript
308-
// Example of using the MCP client to check an ETH balance using StarkNet ID
308+
// Example of using the MCP client to check an ETH balance using Starknet ID
309309
const mcp = new McpClient("http://localhost:3000");
310310

311311
const result = await mcp.invokeTool("get_starknet_eth_balance", {
312-
address: "vitalik.stark", // StarkNet ID instead of address
312+
address: "vitalik.stark", // Starknet ID instead of address
313313
network: "mainnet"
314314
});
315315

@@ -320,10 +320,10 @@ console.log(result);
320320
// }
321321
```
322322

323-
### Example: Resolving a StarkNet ID
323+
### Example: Resolving a Starknet ID
324324

325325
```javascript
326-
// Example of using the MCP client to resolve a StarkNet ID to an address
326+
// Example of using the MCP client to resolve a Starknet ID to an address
327327
const mcp = new McpClient("http://localhost:3000");
328328

329329
const result = await mcp.invokeTool("resolve_starknet_address", {
@@ -390,7 +390,7 @@ This server implements the following MCP tools:
390390
- `get_supported_starknet_networks`: Get a list of supported Starknet networks
391391

392392
#### Balance Tools
393-
- `get_starknet_eth_balance`: Get the ETH balance for a Starknet address or StarkNet ID
393+
- `get_starknet_eth_balance`: Get the ETH balance for a Starknet address or Starknet ID
394394
- `get_starknet_token_balance`: Get the balance of any token for an address
395395
- `get_starknet_strk_balance`: Get the STRK token balance for an address
396396
- `get_starknet_native_balances`: Get all native token balances (ETH and STRK) for an address
@@ -501,7 +501,7 @@ starknet-mcp-server/
501501
│ │ ├── blocks.ts # Block services
502502
│ │ ├── clients.ts # Client utilities
503503
│ │ ├── contracts.ts # Contract interactions
504-
│ │ ├── starknetid.ts # StarkNet ID services
504+
│ │ ├── starknetid.ts # Starknet ID services
505505
│ │ ├── tokens.ts # Token services
506506
│ │ ├── transactions.ts # Transaction services
507507
│ │ ├── transfer.ts # Transfer services

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"module": "src/index.ts",
44
"type": "module",
55
"version": "1.0.0",
6-
"description": "Model Context Protocol (MCP) server for interacting with StarkNet",
6+
"description": "Model Context Protocol (MCP) server for interacting with Starknet",
77
"private": false,
88
"main": "build/index.js",
99
"bin": {

src/core/resources.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ export function registerResources(server: McpServer) {
149149
const network = params.network as string;
150150
const address = params.address as string;
151151

152-
// Try to resolve the address if it's a StarkNet ID
152+
// Try to resolve the address if it's a Starknet ID
153153
const resolvedAddress = await services.utils.resolveNameOrAddress(address, network);
154154
const ethBalance = await services.getETHBalance(resolvedAddress, network);
155155
const provider = services.getProvider(network);
@@ -315,7 +315,7 @@ export function registerResources(server: McpServer) {
315315
const network = params.network as string;
316316
const address = params.address as string;
317317

318-
// Try to resolve the address if it's a StarkNet ID
318+
// Try to resolve the address if it's a Starknet ID
319319
const resolvedAddress = await services.utils.resolveNameOrAddress(address, network);
320320
const profile = await services.getStarkProfile(resolvedAddress, network);
321321

src/core/services/clients.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export function getContract(
9191
}
9292

9393
/**
94-
* Parse a StarkNet address to ensure it's properly formatted
94+
* Parse a Starknet address to ensure it's properly formatted
9595
* @param address The address to parse
9696
* @returns The formatted address
9797
*/

src/core/services/transfer.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ interface TransferResult {
1818
interface TransferBaseParams {
1919
privateKey: string;
2020
from: string;
21-
to: string; // Can be an address or a StarkNet ID
21+
to: string; // Can be an address or a Starknet ID
2222
amount: string | bigint;
2323
maxFee?: string | bigint;
2424
}
@@ -38,7 +38,7 @@ async function prepareTransfer(
3838
const amount = typeof params.amount === 'string' ? BigInt(params.amount) : params.amount;
3939
const fromAddress = parseStarknetAddress(params.from);
4040

41-
// Resolve the 'to' parameter which could be either an address or a StarkNet ID
41+
// Resolve the 'to' parameter which could be either an address or a Starknet ID
4242
const toAddress = parseStarknetAddress(await utils.resolveNameOrAddress(params.to, network));
4343

4444
// Create account instance
@@ -185,7 +185,7 @@ export async function executeContract(
185185
params: {
186186
privateKey: string;
187187
accountAddress: string;
188-
contractAddress: string; // Can be an address or a StarkNet ID
188+
contractAddress: string; // Can be an address or a Starknet ID
189189
entrypoint: string;
190190
calldata?: any[];
191191
maxFee?: string | bigint;
@@ -196,7 +196,7 @@ export async function executeContract(
196196
const provider = getProvider(network);
197197
const accountAddress = parseStarknetAddress(params.accountAddress);
198198

199-
// Resolve the contract address which could be either an address or a StarkNet ID
199+
// Resolve the contract address which could be either an address or a Starknet ID
200200
const contractAddress = parseStarknetAddress(
201201
await utils.resolveNameOrAddress(params.contractAddress, network)
202202
);

src/core/services/utils.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ export const utils = {
104104
},
105105

106106
/**
107-
* Resolve a StarkNet ID name to an address or return the address if already valid
108-
* @param nameOrAddress StarkNet name (starknet.id) or address
107+
* Resolve a Starknet ID name to an address or return the address if already valid
108+
* @param nameOrAddress Starknet name (starknet.id) or address
109109
* @param network Network name (mainnet, sepolia)
110110
* @returns The resolved address
111111
* @throws Error if name cannot be resolved or address is invalid
@@ -129,20 +129,20 @@ export const utils = {
129129
// Create StarknetIdNavigator instance
130130
const navigator = new StarknetIdNavigator(provider, chainId);
131131

132-
// Check if it's a valid StarkNet domain
132+
// Check if it's a valid Starknet domain
133133
if (starknetIdUtils.isStarkDomain(nameOrAddress)) {
134134
// Make sure it has .stark suffix
135135
const name = nameOrAddress.endsWith('.stark') ? nameOrAddress : `${nameOrAddress}.stark`;
136136
const address = await navigator.getAddressFromStarkName(name);
137137

138138
if (!address || address === '0x0') {
139-
throw new Error(`Could not resolve StarkNet ID: ${name}`);
139+
throw new Error(`Could not resolve Starknet ID: ${name}`);
140140
}
141141

142142
return address;
143143
}
144144

145-
throw new Error(`Invalid address or unresolvable StarkNet ID: ${nameOrAddress}`);
145+
throw new Error(`Invalid address or unresolvable Starknet ID: ${nameOrAddress}`);
146146
} catch (error) {
147147
const errorMessage = error instanceof Error ? error.message : String(error);
148148
throw new Error(`Error resolving name or address: ${errorMessage}`);

0 commit comments

Comments
 (0)