Skip to content

Commit fc568ab

Browse files
tarrencevtarrencev
authored
Simplify Controller interface (#1759)
1 parent c8dc7d4 commit fc568ab

File tree

12 files changed

+242
-33
lines changed

12 files changed

+242
-33
lines changed

‎examples/next/src/components/providers/StarknetProvider.tsx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,12 +167,24 @@ if (process.env.NEXT_PUBLIC_RPC_LOCAL) {
167167

168168
const controller = new ControllerConnector({
169169
policies,
170+
// With the defaults, you can omit chains and defaultChainId if you want to use:
171+
// - chains: [
172+
// { rpcUrl: "https://api.cartridge.gg/x/starknet/sepolia" },
173+
// { rpcUrl: "https://api.cartridge.gg/x/starknet/mainnet" },
174+
// ]
175+
// - defaultChainId: constants.StarknetChainId.SN_MAIN
176+
//
177+
// However, if you want to use custom RPC URLs or a different default chain,
178+
// you can still specify them:
170179
chains: controllerConnectorChains,
171180
defaultChainId: constants.StarknetChainId.SN_SEPOLIA,
172181
url: keychainUrl,
173182
profileUrl: profileUrl,
174183
slot: "eternum",
175184
preset: "eternum",
185+
// By default, preset policies take precedence over manually provided policies
186+
// Set shouldOverridePresetPolicies to true if you want your policies to override preset
187+
// shouldOverridePresetPolicies: true,
176188
tokens: {
177189
erc20: ["lords"],
178190
},

‎packages/controller/jest.config.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ const config: Config = {
88
transform: {
99
'^.+\\.tsx?$': 'ts-jest',
1010
},
11+
setupFilesAfterEnv: ['<rootDir>/src/__tests__/setup.ts'],
12+
testTimeout: 10000,
1113
};
1214

1315
export default config;

‎packages/controller/package.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@
5151
},
5252
"devDependencies": {
5353
"@cartridge/tsconfig": "workspace:*",
54-
"@types/jest": "^29.5.14",
54+
"@types/jest": "catalog:",
55+
"@types/mocha": "catalog:",
5556
"@types/node": "catalog:",
5657
"jest": "^29.7.0",
5758
"prettier": "catalog:",
@@ -65,4 +66,4 @@
6566
"vite-plugin-top-level-await": "catalog:",
6667
"vite-plugin-wasm": "catalog:"
6768
}
68-
}
69+
}

‎packages/controller/src/__tests__/controllerDefaults.test.ts‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
import { constants } from "starknet";
2+
import ControllerProvider from "../controller";
3+
4+
describe("ControllerProvider defaults", () => {
5+
let originalConsoleError: any;
6+
let originalConsoleWarn: any;
7+
8+
beforeEach(() => {
9+
// Mock console methods to suppress expected errors/warnings
10+
originalConsoleError = console.error;
11+
originalConsoleWarn = console.warn;
12+
console.error = jest.fn();
13+
console.warn = jest.fn();
14+
});
15+
16+
afterEach(() => {
17+
console.error = originalConsoleError;
18+
console.warn = originalConsoleWarn;
19+
});
20+
21+
test("should use default chains and chainId when not provided", () => {
22+
const controller = new ControllerProvider({});
23+
24+
expect(controller.rpcUrl()).toBe(
25+
"https://api.cartridge.gg/x/starknet/mainnet",
26+
);
27+
});
28+
29+
test("should use custom chains when provided", () => {
30+
const customChains = [
31+
{ rpcUrl: "https://api.cartridge.gg/x/starknet/sepolia" },
32+
];
33+
34+
const controller = new ControllerProvider({
35+
chains: customChains,
36+
defaultChainId: constants.StarknetChainId.SN_SEPOLIA,
37+
});
38+
39+
expect(controller.rpcUrl()).toBe(
40+
"https://api.cartridge.gg/x/starknet/sepolia",
41+
);
42+
});
43+
44+
test("should throw error when using non-Cartridge RPC for mainnet", async () => {
45+
const invalidChains = [
46+
{ rpcUrl: "https://some-other-provider.com/starknet/mainnet" },
47+
];
48+
49+
expect(() => {
50+
new ControllerProvider({
51+
chains: invalidChains,
52+
defaultChainId: constants.StarknetChainId.SN_MAIN,
53+
});
54+
}).toThrow("Only Cartridge RPC providers are allowed for mainnet");
55+
});
56+
57+
test("should throw error when using non-Cartridge RPC for sepolia", async () => {
58+
const invalidChains = [
59+
{ rpcUrl: "https://some-other-provider.com/starknet/sepolia" },
60+
];
61+
62+
expect(() => {
63+
new ControllerProvider({
64+
chains: invalidChains,
65+
defaultChainId: constants.StarknetChainId.SN_SEPOLIA,
66+
});
67+
}).toThrow("Only Cartridge RPC providers are allowed for sepolia");
68+
});
69+
70+
test("should allow non-Cartridge RPC for custom chains", () => {
71+
const customChains = [{ rpcUrl: "http://localhost:5050" }];
72+
73+
// This should not throw
74+
expect(() => {
75+
new ControllerProvider({
76+
chains: customChains,
77+
});
78+
}).not.toThrow();
79+
});
80+
});

‎packages/controller/src/__tests__/parseChainId.test.ts‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,6 @@ describe("parseChainId", () => {
2323
).toBe(shortString.encodeShortString("WP_SLOT"));
2424
});
2525

26-
test("identifies slot chain on localhost", () => {
27-
expect(parseChainId(new URL("http://localhost:8001/x/slot/katana"))).toBe(
28-
shortString.encodeShortString("WP_SLOT"),
29-
);
30-
});
31-
3226
test("identifies slot chain with hyphenated name", () => {
3327
expect(
3428
parseChainId(

‎packages/controller/src/__tests__/setup.ts‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Jest setup file to handle cleanup of timers and open handles
2+
3+
// Mock starknetkit to prevent it from creating timers
4+
jest.mock("starknetkit", () => ({
5+
connect: jest.fn(),
6+
StarknetWindowObject: {},
7+
}));
8+
9+
jest.mock("starknetkit/injected", () => ({
10+
InjectedConnector: jest.fn(),
11+
}));
12+
13+
// Clean up any remaining timers after each test
14+
afterEach(() => {
15+
jest.clearAllTimers();
16+
jest.useRealTimers();
17+
});
18+
19+
// Force cleanup after all tests
20+
afterAll(() => {
21+
// Clear any remaining timers
22+
jest.clearAllTimers();
23+
jest.useRealTimers();
24+
25+
// Force garbage collection if available
26+
if (global.gc) {
27+
global.gc();
28+
}
29+
});

‎packages/controller/src/controller.ts‎

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {
66
AddStarknetChainParameters,
77
ChainId,
88
} from "@starknet-io/types-js";
9-
import { shortString, WalletAccount } from "starknet";
9+
import { constants, shortString, WalletAccount } from "starknet";
1010
import { version } from "../package.json";
1111
import ControllerAccount from "./account";
1212
import { NotReadyToConnect } from "./errors";
@@ -41,7 +41,19 @@ export default class ControllerProvider extends BaseProvider {
4141
constructor(options: ControllerOptions) {
4242
super();
4343

44-
this.selectedChain = options.defaultChainId;
44+
// Default Cartridge chains that are always available
45+
const cartridgeChains: Chain[] = [
46+
{ rpcUrl: "https://api.cartridge.gg/x/starknet/sepolia" },
47+
{ rpcUrl: "https://api.cartridge.gg/x/starknet/mainnet" },
48+
];
49+
50+
// Merge user chains with default chains
51+
// User chains take precedence if they specify the same network
52+
const chains = [...(options.chains || []), ...cartridgeChains];
53+
const defaultChainId =
54+
options.defaultChainId || constants.StarknetChainId.SN_MAIN;
55+
56+
this.selectedChain = defaultChainId;
4557
this.chains = new Map<ChainId, Chain>();
4658

4759
this.iframes = {
@@ -54,9 +66,9 @@ export default class ControllerProvider extends BaseProvider {
5466
}),
5567
};
5668

57-
this.options = options;
69+
this.options = { ...options, chains, defaultChainId };
5870

59-
this.validateChains(options.chains);
71+
this.initializeChains(chains);
6072

6173
if (typeof window !== "undefined") {
6274
(window as any).starknet_controller = this;
@@ -166,7 +178,15 @@ export default class ControllerProvider extends BaseProvider {
166178

167179
try {
168180
let response = await this.keychain.connect(
169-
this.options.policies || {},
181+
// Policy precedence logic:
182+
// 1. If shouldOverridePresetPolicies is true and policies are provided, use policies
183+
// 2. Otherwise, if preset is defined, use empty object (let preset take precedence)
184+
// 3. Otherwise, use provided policies or empty object
185+
this.options.shouldOverridePresetPolicies && this.options.policies
186+
? this.options.policies
187+
: this.options.preset
188+
? {}
189+
: this.options.policies || {},
170190
this.rpcUrl(),
171191
this.options.signupOptions,
172192
version,
@@ -408,14 +428,28 @@ export default class ControllerProvider extends BaseProvider {
408428
return await this.keychain.delegateAccount();
409429
}
410430

411-
private async validateChains(chains: Chain[]) {
431+
private initializeChains(chains: Chain[]) {
412432
for (const chain of chains) {
413433
try {
414434
const url = new URL(chain.rpcUrl);
415-
const chainId = await parseChainId(url);
435+
const chainId = parseChainId(url);
436+
437+
// Validate that mainnet and sepolia must use Cartridge RPC
438+
const isMainnet = chainId === constants.StarknetChainId.SN_MAIN;
439+
const isSepolia = chainId === constants.StarknetChainId.SN_SEPOLIA;
440+
const isCartridgeRpc = url.hostname === "api.cartridge.gg";
441+
442+
if ((isMainnet || isSepolia) && !isCartridgeRpc) {
443+
throw new Error(
444+
`Only Cartridge RPC providers are allowed for ${isMainnet ? "mainnet" : "sepolia"}. ` +
445+
`Please use: https://api.cartridge.gg/x/starknet/${isMainnet ? "mainnet" : "sepolia"}`,
446+
);
447+
}
448+
416449
this.chains.set(chainId, chain);
417450
} catch (error) {
418451
console.error(`Failed to parse chainId for ${chain.rpcUrl}:`, error);
452+
throw error; // Re-throw to ensure invalid chains fail fast
419453
}
420454
}
421455

‎packages/controller/src/types.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,8 @@ export type Chain = {
201201
};
202202

203203
export type ProviderOptions = {
204-
defaultChainId: ChainId;
205-
chains: Chain[];
204+
defaultChainId?: ChainId;
205+
chains?: Chain[];
206206
};
207207

208208
export type KeychainOptions = IFrameOptions & {
@@ -217,6 +217,8 @@ export type KeychainOptions = IFrameOptions & {
217217
feeSource?: FeeSource;
218218
/** Signup options (the order of the options is reflected in the UI. It's recommended to group socials and wallets together ) */
219219
signupOptions?: AuthOptions;
220+
/** When true, manually provided policies will override preset policies. Default is false. */
221+
shouldOverridePresetPolicies?: boolean;
220222
};
221223

222224
export type ProfileOptions = IFrameOptions & {

‎packages/controller/src/utils.ts‎

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import {
55
constants,
66
getChecksumAddress,
77
hash,
8-
Provider,
98
shortString,
109
typedData,
1110
TypedDataRevision,
@@ -28,8 +27,6 @@ const ALLOWED_PROPERTIES = new Set([
2827
"primaryType",
2928
]);
3029

31-
const LOCAL_HOSTNAMES = ["localhost", "127.0.0.1", "0.0.0.0"];
32-
3330
function validatePropertyName(prop: string): void {
3431
if (!ALLOWED_PROPERTIES.has(prop)) {
3532
throw new Error(`Invalid property name: ${prop}`);
@@ -139,9 +136,55 @@ export function humanizeString(str: string): string {
139136
);
140137
}
141138

142-
export async function parseChainId(url: URL): Promise<ChainId> {
139+
export function parseChainId(url: URL): ChainId {
143140
const parts = url.pathname.split("/");
144141

142+
// Handle localhost URLs by making a synchronous call to getChainId
143+
if (
144+
url.hostname === "localhost" ||
145+
url.hostname === "127.0.0.1" ||
146+
url.hostname === "0.0.0.0"
147+
) {
148+
// Check if we're in a browser environment
149+
if (typeof XMLHttpRequest === "undefined") {
150+
// In Node.js environment (like tests), we can't make synchronous HTTP calls
151+
// For now, we'll use a placeholder chainId for localhost in tests
152+
console.warn(
153+
`Cannot make synchronous HTTP call in Node.js environment for ${url.toString()}`,
154+
);
155+
return shortString.encodeShortString("LOCALHOST") as ChainId;
156+
}
157+
158+
// Use a synchronous XMLHttpRequest to get the chain ID
159+
const xhr = new XMLHttpRequest();
160+
xhr.open("POST", url.toString(), false); // false makes it synchronous
161+
xhr.setRequestHeader("Content-Type", "application/json");
162+
163+
const requestBody = JSON.stringify({
164+
jsonrpc: "2.0",
165+
method: "starknet_chainId",
166+
params: [],
167+
id: 1,
168+
});
169+
170+
try {
171+
xhr.send(requestBody);
172+
173+
if (xhr.status === 200) {
174+
const response = JSON.parse(xhr.responseText);
175+
if (response.result) {
176+
return response.result as ChainId;
177+
}
178+
}
179+
180+
throw new Error(
181+
`Failed to get chain ID from ${url.toString()}: ${xhr.status} ${xhr.statusText}`,
182+
);
183+
} catch (error) {
184+
throw new Error(`Failed to connect to ${url.toString()}: ${error}`);
185+
}
186+
}
187+
145188
if (parts.includes("starknet")) {
146189
if (parts.includes("mainnet")) {
147190
return constants.StarknetChainId.SN_MAIN;
@@ -161,12 +204,5 @@ export async function parseChainId(url: URL): Promise<ChainId> {
161204
}
162205
}
163206

164-
if (LOCAL_HOSTNAMES.includes(url.hostname)) {
165-
const provider = new Provider({
166-
nodeUrl: url.toString(),
167-
});
168-
return await provider.getChainId();
169-
}
170-
171207
throw new Error(`Chain ${url.toString()} not supported`);
172208
}

‎packages/controller/tsconfig.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
"rootDir": ".",
66
"outDir": "./dist",
77
"composite": false,
8-
"incremental": false
8+
"incremental": false,
9+
"types": ["jest", "node"]
910
},
1011
"include": ["src/**/*"],
11-
"exclude": ["node_modules", "dist", "**/*.test.ts"]
12+
"exclude": ["node_modules", "dist"]
1213
}

0 commit comments

Comments
 (0)