CLAUDE.md in settlemint/sdk runs 1,530 words across 57 headings.
Integrate SettleMint into your application with ease.
TypeScriptCovers
14 of the 20 section tags
In the order a file is read inHeadings
57 headings, in the order the file writes them
01CLAUDE.md
02Project Overview
03Technology Stack
04Essential Commands
05Development Workflow
06Setup
07Development
08Building
09Testing
10Code Quality
11Documentation
12Publishing
13Package Development
14Work on specific packages
15Run package scripts
16Architecture & Code Organization
17Repository Structure
18Key Architecture Patterns
19Development Guidelines
20TypeScript Conventions
21Code Style Rules
22API Design Principles
23Blockchain Best Practices
24Git Workflow
25Claude Code Best Practices
26Package-Specific Guidelines
27SDK CLI (@settlemint/sdk-cli)
28SDK JS (@settlemint/sdk-js)
29SDK Portal (@settlemint/sdk-portal)
30SDK Viem (@settlemint/sdk-viem)
31Testing Guidelines
32Environment Configuration
33Troubleshooting
34Common Issues
35Development Tips
36Before Creating a PR
37Project-Specific Notes
38Command Reference
39MCP Server Usage
40Linear (Project Management)
41Search for issues
42Get issue details
43Update issue with comment and/or status
44Create comment on issue
45List issue statuses to find stateId
46Sentry (Error Tracking)
47Find organizations you have access to
48Find issues in an organization
49Get detailed error information
50Update issue status
51Context7 (Documentation)
52Search for library documentation
53Get library docs
54DeepWiki (GitHub Documentation)
55Get repository documentation structure
56Read repository documentation
57Ask questions about a repository
Commands
23 commands this file writes down
Extracted from the file, verbatimbun install
bun install --frozen-lockfile
bun run dev
bun run dev:cli
bun run dev:portal
bun run build
bun run build:cli
bun run build:sdk
bun test
bun test:unit
bun test:e2e
bun test:coverage
bun run lint
bun run lint:fix
bun run format
bun run typecheck
bun run docs
bun run docs:build
bun run changeset
bun run version
bun run release
turbo run build --filter=@settlemint/sdk-cli
turbo run test --filter=@settlemint/sdk-*
The file
CLAUDE.md
First 160 of 391 lines1# CLAUDE.md
2
3This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4
5## Project Overview
6
7The SettleMint SDK is a comprehensive blockchain development toolkit and platform integration suite. It provides developers with tools to build, deploy, and manage blockchain applications using the SettleMint platform's infrastructure and services.
8
9### Technology Stack
10
11**Core Technologies**
12- Runtime: Bun (fast JavaScript runtime)
13- Package Manager: Bun workspaces with Turbo
14- Language: TypeScript (strict mode)
15- Code Quality: Biome for linting and formatting
16- Testing: Vitest for unit/integration tests
17- Documentation: TypeDoc
18- GraphQL: Apollo Client, GraphQL Code Generator
19- Blockchain: Viem, Ethers, Foundry, Hardhat support
20
21**Monorepo Structure**
22- sdk/ - All SDK packages (13 packages total)
23- test/ - End-to-end tests
24- docs/ - Documentation
25- scripts/ - Build and utility scripts
26- fixtures/ - Test fixtures
27
28**SDK Packages**
29- @settlemint/sdk-cli - Command-line interface
30- @settlemint/sdk-js - Core JavaScript SDK
31- @settlemint/sdk-portal - Smart contract portal API
32- @settlemint/sdk-viem - Ethereum interface (Viem)
33- @settlemint/sdk-blockscout - Blockchain explorer
34- @settlemint/sdk-eas - Ethereum Attestation Service
35- @settlemint/sdk-hasura - GraphQL/PostgreSQL
36- @settlemint/sdk-ipfs - Decentralized storage
37- @settlemint/sdk-minio - S3-compatible storage
38- @settlemint/sdk-thegraph - Blockchain indexing
39- @settlemint/sdk-next - Next.js components
40- @settlemint/sdk-mcp - Model Context Protocol
41- @settlemint/sdk-utils - Shared utilities
42
43**Key Features**
44- Multi-chain blockchain support
45- Smart contract deployment and verification
46- Platform service integration
47- Developer tooling and scaffolding
48- GraphQL API generation
49- TypeScript type generation
50- Comprehensive CLI tools
51- Example applications
52
53## Essential Commands
54
55### Development Workflow
56```bash
57# Setup
58bun install # Install dependencies (root)
59bun install --frozen-lockfile # CI-safe install
60
61# Development
62bun run dev # Start development (turbo)
63bun run dev:cli # Develop CLI package
64bun run dev:portal # Develop portal package
65
66# Building
67bun run build # Build all packages
68bun run build:cli # Build CLI package
69bun run build:sdk # Build SDK packages
70
71# Testing
72bun test # Run all tests
73bun test:unit # Run unit tests
74bun test:e2e # Run e2e tests
75bun test:coverage # Generate coverage report
76
77# Code Quality
78bun run lint # Run Biome linter
79bun run lint:fix # Fix linting issues
80bun run format # Format with Biome
81bun run typecheck # Run TypeScript checks
82
83# Documentation
84bun run docs # Generate TypeDoc docs
85bun run docs:build # Build documentation
86
87# Publishing
88bun run changeset # Create changeset
89bun run version # Version packages
90bun run release # Release packages
91```
92
93### Package Development
94```bash
95# Work on specific packages
96cd sdk/cli && bun run dev # CLI development
97cd sdk/js && bun test # Test JS SDK
98cd sdk/portal && bun build # Build portal
99
100# Run package scripts
101turbo run build --filter=@settlemint/sdk-cli
102turbo run test --filter=@settlemint/sdk-*
103```
104
105## Architecture & Code Organization
106
107### Repository Structure
108```
109/
110├── sdk/ # SDK packages (monorepo)
111│ ├── cli/ # CLI tool (@settlemint/sdk-cli)
112│ ├── js/ # Core SDK (@settlemint/sdk-js)
113│ ├── portal/ # Portal API (@settlemint/sdk-portal)
114│ ├── viem/ # Viem integration (@settlemint/sdk-viem)
115│ ├── blockscout/ # Explorer integration
116│ ├── eas/ # Attestation service
117│ ├── hasura/ # GraphQL/PostgreSQL
118│ ├── ipfs/ # IPFS integration
119│ ├── minio/ # S3 storage
120│ ├── thegraph/ # Subgraph integration
121│ ├── next/ # Next.js components
122│ ├── mcp/ # MCP interface
123│ └── utils/ # Shared utilities
124├── test/ # E2E tests
125├── docs/ # Documentation
126├── scripts/ # Build scripts
127├── fixtures/ # Test fixtures
128├── turbo.json # Turbo config
129├── biome.json # Biome config
130└── package.json # Root package
131```
132
133### Key Architecture Patterns
134
1351. **Monorepo Structure**
136 - Bun workspaces for package management
137 - Turbo for build orchestration
138 - Shared dependencies and tooling
139 - Independent package versioning
140
1412. **TypeScript-First Development**
142 - Strict TypeScript configuration
143 - Type generation for GraphQL
144 - Shared type definitions in utils
145 - Runtime validation with Zod
146
1473. **SDK Design Principles**
148 - Each package is independently usable
149 - Minimal dependencies between packages
150 - Consistent API design across packages
151 - Comprehensive TypeScript types
152
1534. **Platform Integration**
154 - GraphQL for API communication
155 - RESTful endpoints where appropriate
156 - WebSocket support for real-time data
157 - Authentication and authorization built-in
158
159## Development Guidelines
160
231 more lines are in the file. Read the raw file.
The rest of the repository
settlemint/sdk ships 8 other instruction files
.cursor/rules/git-workflow.mdc.cursor/rules/shadcn.mdc.cursor/rules/solidity.mdc.cursor/rules/bun.mdc.cursor/rules/commands.mdc.cursor/rules/mcp.mdc.cursor/rules/typescript.mdc.cursor/rules/commits.mdc
A row that is not a link is a file this repository ships that this app did not freeze a sheet for. It is listed because the corpus knows it exists, and it is not linked because there is nothing here to open.
This listing
Whoever runs settlemint/sdk can claim it
This is yours? Claim this config and we will write to you when the measurement moves. The check is one token placed where only you can place it, and there is no account and no password.