starkzap-sdk

Name: starkzap-sdk
Author: keep-starknet-strange

81stars25forks

How to install starkzap-sdk?

keep-starknet-strange/starknet-agentic/starkzap-sdk

$npx -y skills add keep-starknet-strange/starknet-agentic --skill starkzap-sdk

Installs into the current project.

Summary

Reference for integrating or maintaining applications built with keep-starknet-strange/starkzap, including StarkSDK setup, onboarding, wallet lifecycle, sponsored transactions, ERC20 flows, staking, and transaction builder usage.

Files · 1

View on GitHub

SKILL.md

1	# Starkzap SDK
2
3	Project-focused guide for `https://github.com/keep-starknet-strange/starkzap`.
4
5	Use this skill when requests involve Starkzap SDK code, examples, or docs.
6
7	## When to Use
8
9	Trigger for tasks like:
10	- "Add a new onboarding flow in Starkzap"
11	- "Fix sponsored transaction behavior in wallet.execute"
12	- "Update staking pool logic or validator presets"
13	- "Patch Privy signer/server integration"
14	- "Review Starkzap tests/docs/examples"
15
16	## When NOT to Use
17
18	- Generic Starknet SDK work outside the Starkzap codebase.
19	- Cairo contract authoring, deployment operations, or security audits.
20
21	## Quick Start
22
23	1. Open the target Starkzap repository paths below and choose the smallest workflow surface first.
24	2. Use [skills catalog](../README.md) when the task crosses into generic Starknet wallet, deployment, or audit flows.
25
26	## Repository Map
27
28	Primary implementation:
29	- `src/sdk.ts` - top-level orchestration (`StarkSDK`)
30	- `src/wallet/*` - wallet implementations and lifecycle
31	- `src/signer/*` - `StarkSigner`, `PrivySigner`, signer adapter
32	- `src/tx/*` - `Tx` and `TxBuilder`
33	- `src/erc20/*` - token helpers, balance/transfer logic
34	- `src/staking/*` - staking operations and pool discovery
35	- `src/types/*` - shared domain types (`Address`, `Amount`, config)
36
37	Operational and docs:
38	- `tests/` and `tests/integration/`
39	- `examples/web`, `examples/server`, `examples/mobile`, `examples/flappy-bird`
40	- `scripts/*` for generated artifacts in the Starkzap repo
41	- `docs/` and `mintlify-docs/`
42
43	Skill resources:
44	- `skills/starkzap-sdk/references/signer-integration.md` - signer trust boundaries and auth assumptions
45	- `skills/starkzap-sdk/references/sponsored-transactions.md` - paymaster flow and fee mode behavior
46	- `skills/starkzap-sdk/references/erc20-helpers.md` - `Amount` semantics and transfer patterns
47	- `skills/starkzap-sdk/references/staking-reliability.md` - pool discovery and timeout/abort safety
48	- `skills/starkzap-sdk/scripts/wallet-execute-example.ts` - wallet readiness and execute flow
49	- `skills/starkzap-sdk/scripts/staking-pool-discovery.ts` - staking pool discovery and diagnostics
50
51	## Quick Reference
52
53	Common starknet.js patterns (provider/account/call/execute/listen):
54
55	```typescript
56	import { Account, Contract, RpcProvider } from "starknet";
57
58	const provider = await RpcProvider.create({
59	nodeUrl: process.env.RPC_URL!,
60	});
61
62	const account = new Account({
63	provider,
64	address: process.env.ACCOUNT_ADDRESS!,
65	signer: process.env.PRIVATE_KEY!,
66	cairoVersion: "1",
67	});
68
69	const contract = new Contract({
70	abi,
71	address: process.env.CONTRACT_ADDRESS!,
72	providerOrAccount: account,
73	});
74	await contract.call("balance_of", [account.address]); // read
75
76	const tx = await account.execute([
77	{
78	contractAddress: process.env.CONTRACT_ADDRESS!,
79	entrypoint: "do_work",
80	calldata: [],
81	},
82	]);
83	await provider.waitForTransaction(tx.transaction_hash);
84	```
85
86	```typescript
87	// With Starkzap Tx wrapper
88	const submitted = await wallet.execute(calls, { feeMode: "user_pays" });
89	const stop = submitted.watch(
90	({ finality, execution }) => console.log(finality, execution),
91	{ pollIntervalMs: 5000, timeoutMs: 120000 }
92	);
93	// stop(); // call to unsubscribe early
94	```
95
96	Common error classes and immediate recovery:
97
98	\| Error Class \| Typical Signal \| Immediate Recovery \|
99	\| --- \| --- \| --- \|
100	\| `VALIDATION_ERROR` \| `Invalid token decimals`, `Amount.parse(...)` failure \| Re-check token decimals/symbol, parse from known token preset, avoid mixing token types. \|
101	\| `UNDEPLOYED_ACCOUNT` \| `Account is not deployed` on `wallet.execute(...)` \| Run `wallet.ensureReady({ deploy: "if_needed" })` before `user_pays` writes. \|
102	\| `RPC_OR_NETWORK` \| timeout, 429, provider mismatch \| Retry with backoff, confirm `rpcUrl` and `chainId`, switch to stable RPC for production. \|
103	\| `TX_REVERTED` \| `preflight.ok === false` or reverted receipt \| Run `wallet.preflight({ calls })`, inspect reason, reduce batch size, verify call ordering. \|
104	\| `AUTH_OR_PERMISSION` \| Privy 401/403, invalid signature response \| Verify signer server auth, headers/body resolver, and trusted `serverUrl`. \|
105
106	See also:
107	- `skills/starkzap-sdk/references/*` for implementation-specific troubleshooting
108	- `skills/starkzap-sdk/scripts/*` for runnable diagnostic examples
109
110	## Core Workflows
111
112	### 1) Configure `StarkSDK`

People who liked this also viewed

6 picks

Type

starkzap-sdk

81stars25forks

View on GitHub

How to install starkzap-sdk?

keep-starknet-strange/starknet-agentic/starkzap-sdk

$npx -y skills add keep-starknet-strange/starknet-agentic --skill starkzap-sdk

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Starkzap SDK
2
3	Project-focused guide for `https://github.com/keep-starknet-strange/starkzap`.
4
5	Use this skill when requests involve Starkzap SDK code, examples, or docs.
6
7	## When to Use
8
9	Trigger for tasks like:
10	- "Add a new onboarding flow in Starkzap"
11	- "Fix sponsored transaction behavior in wallet.execute"
12	- "Update staking pool logic or validator presets"
13	- "Patch Privy signer/server integration"
14	- "Review Starkzap tests/docs/examples"
15
16	## When NOT to Use
17
18	- Generic Starknet SDK work outside the Starkzap codebase.
19	- Cairo contract authoring, deployment operations, or security audits.
20
21	## Quick Start
22
23	1. Open the target Starkzap repository paths below and choose the smallest workflow surface first.
24	2. Use [skills catalog](../README.md) when the task crosses into generic Starknet wallet, deployment, or audit flows.
25
26	## Repository Map
27
28	Primary implementation:
29	- `src/sdk.ts` - top-level orchestration (`StarkSDK`)
30	- `src/wallet/*` - wallet implementations and lifecycle
31	- `src/signer/*` - `StarkSigner`, `PrivySigner`, signer adapter
32	- `src/tx/*` - `Tx` and `TxBuilder`
33	- `src/erc20/*` - token helpers, balance/transfer logic
34	- `src/staking/*` - staking operations and pool discovery
35	- `src/types/*` - shared domain types (`Address`, `Amount`, config)
36
37	Operational and docs:
38	- `tests/` and `tests/integration/`
39	- `examples/web`, `examples/server`, `examples/mobile`, `examples/flappy-bird`
40	- `scripts/*` for generated artifacts in the Starkzap repo
41	- `docs/` and `mintlify-docs/`
42
43	Skill resources:
44	- `skills/starkzap-sdk/references/signer-integration.md` - signer trust boundaries and auth assumptions
45	- `skills/starkzap-sdk/references/sponsored-transactions.md` - paymaster flow and fee mode behavior
46	- `skills/starkzap-sdk/references/erc20-helpers.md` - `Amount` semantics and transfer patterns
47	- `skills/starkzap-sdk/references/staking-reliability.md` - pool discovery and timeout/abort safety
48	- `skills/starkzap-sdk/scripts/wallet-execute-example.ts` - wallet readiness and execute flow
49	- `skills/starkzap-sdk/scripts/staking-pool-discovery.ts` - staking pool discovery and diagnostics
50
51	## Quick Reference
52
53	Common starknet.js patterns (provider/account/call/execute/listen):
54
55	```typescript
56	import { Account, Contract, RpcProvider } from "starknet";
57
58	const provider = await RpcProvider.create({
59	nodeUrl: process.env.RPC_URL!,
60	});
61
62	const account = new Account({
63	provider,
64	address: process.env.ACCOUNT_ADDRESS!,
65	signer: process.env.PRIVATE_KEY!,
66	cairoVersion: "1",
67	});
68
69	const contract = new Contract({
70	abi,
71	address: process.env.CONTRACT_ADDRESS!,
72	providerOrAccount: account,
73	});
74	await contract.call("balance_of", [account.address]); // read
75
76	const tx = await account.execute([
77	{
78	contractAddress: process.env.CONTRACT_ADDRESS!,
79	entrypoint: "do_work",
80	calldata: [],
81	},
82	]);
83	await provider.waitForTransaction(tx.transaction_hash);
84	```
85
86	```typescript
87	// With Starkzap Tx wrapper
88	const submitted = await wallet.execute(calls, { feeMode: "user_pays" });
89	const stop = submitted.watch(
90	({ finality, execution }) => console.log(finality, execution),
91	{ pollIntervalMs: 5000, timeoutMs: 120000 }
92	);
93	// stop(); // call to unsubscribe early
94	```
95
96	Common error classes and immediate recovery:
97
98	\| Error Class \| Typical Signal \| Immediate Recovery \|
99	\| --- \| --- \| --- \|
100	\| `VALIDATION_ERROR` \| `Invalid token decimals`, `Amount.parse(...)` failure \| Re-check token decimals/symbol, parse from known token preset, avoid mixing token types. \|
101	\| `UNDEPLOYED_ACCOUNT` \| `Account is not deployed` on `wallet.execute(...)` \| Run `wallet.ensureReady({ deploy: "if_needed" })` before `user_pays` writes. \|
102	\| `RPC_OR_NETWORK` \| timeout, 429, provider mismatch \| Retry with backoff, confirm `rpcUrl` and `chainId`, switch to stable RPC for production. \|
103	\| `TX_REVERTED` \| `preflight.ok === false` or reverted receipt \| Run `wallet.preflight({ calls })`, inspect reason, reduce batch size, verify call ordering. \|
104	\| `AUTH_OR_PERMISSION` \| Privy 401/403, invalid signature response \| Verify signer server auth, headers/body resolver, and trusted `serverUrl`. \|
105
106	See also:
107	- `skills/starkzap-sdk/references/*` for implementation-specific troubleshooting
108	- `skills/starkzap-sdk/scripts/*` for runnable diagnostic examples
109
110	## Core Workflows
111
112	### 1) Configure `StarkSDK`

People who liked this also viewed

6 picks

Type