If you are not redirected, click here to view the developer guides.
+ + + EOF + + - name: ๐จ Apply Custom Styling + run: | + echo "๐จ Applying custom documentation styling..." + + # Check if custom CSS exists and is being used + if [ -f "docs-theme.css" ]; then + echo "โ Custom CSS file found" + + # Verify it's referenced in TypeDoc config + if grep -q "docs-theme.css" typedoc.json; then + echo "โ Custom CSS properly configured in TypeDoc" + else + echo "โ ๏ธ Custom CSS not referenced in typedoc.json" + fi + fi + + - name: ๐ Quality Validation + run: | + echo "๐ Running quality validation..." + + # File structure validation + test -f docs/index.html || { echo "โ Missing main index.html"; exit 1; } + test -d docs/functions || { echo "โ Missing functions directory"; exit 1; } + test -d docs/types || { echo "โ Missing types directory"; exit 1; } + + # Content validation + if ! grep -q "@starknet-io/types-js" docs/index.html; then + echo "โ Package name not found in documentation" + exit 1 + fi + + # Size validation + DOCS_SIZE=$(du -sm docs | cut -f1) + if [ "$DOCS_SIZE" -gt 50 ]; then + echo "โ ๏ธ Documentation size is large: ${DOCS_SIZE}MB" + else + echo "โ Documentation size acceptable: ${DOCS_SIZE}MB" + fi + + echo "โ Quality validation passed" + + - name: ๐ Generate Deployment Report + run: | + echo "๐ Generating deployment report..." + + cat > deployment-report.md << EOF + # ๐ Documentation Deployment Report + + **Deployment Date**: $(date -u +"%Y-%m-%d %H:%M:%S UTC") + **Environment**: ${{ github.event.inputs.environment }} + **Triggered by**: ${{ github.actor }} + **Branch**: ${{ github.ref_name }} + **Commit**: ${{ github.sha }} + + ## ๐ Statistics + - **Total HTML files**: $(find docs -name "*.html" | wc -l) + - **Total assets**: $(find docs/assets -type f 2>/dev/null | wc -l) + - **Documentation size**: $(du -sh docs | cut -f1) + - **Functions documented**: $(find docs/functions -name "*.html" 2>/dev/null | wc -l) + - **Types documented**: $(find docs/types -name "*.html" 2>/dev/null | wc -l) + + ## ๐ Integration Status + - **Guide links**: ${{ github.event.inputs.include_dev_guides == 'true' && 'โ Included' || 'โ Excluded' }} + - **Custom CSS**: $([ -f docs-theme.css ] && echo "โ Applied" || echo "โ Not found") + - **Search functionality**: $(grep -q "search" docs/index.html && echo "โ Available" || echo "โ Not available") + + ## ๐ Available Resources + - ๐ [Main Documentation](https://starknet-io.github.io/types-js/) + - ๐ [Developer Guides](https://github.com/starknet-io/types-js/tree/main/guides) + - ๐ [Performance Guide](https://github.com/starknet-io/types-js/blob/main/guides/PERFORMANCE_GUIDE.md) + - ๐ณ [Tree Shaking Guide](https://github.com/starknet-io/types-js/blob/main/guides/TREE_SHAKING_GUIDE.md) + - ๐ [Usage Guide](https://github.com/starknet-io/types-js/blob/main/guides/USAGE_GUIDE.md) + - ๐ [Migration Guide](https://github.com/starknet-io/types-js/blob/main/guides/MIGRATION_GUIDE.md) + EOF + + echo "๐ Deployment Report:" + cat deployment-report.md + + - name: ๐ Upload Documentation Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs + name: github-pages-manual + retention-days: 30 + + - name: ๐ Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + with: + artifact_name: github-pages-manual + + - name: โ Deployment Complete + run: | + echo "๐ Manual deployment completed successfully!" + echo "" + echo "๐ Deployment Details:" + echo " URL: ${{ steps.deployment.outputs.page_url }}" + echo " Environment: ${{ github.event.inputs.environment }}" + echo " Deployment ID: ${{ github.run_id }}" + echo "" + echo "๐ Quick Links:" + echo " โข Documentation: ${{ steps.deployment.outputs.page_url }}" + echo " โข Developer Guides: https://github.com/starknet-io/types-js/tree/main/guides" + echo " โข Repository: https://github.com/starknet-io/types-js" + echo "" + echo "โฑ๏ธ The documentation should be available within 5-10 minutes." + + - name: ๐ง Deployment Notification + if: always() + run: | + if [ "${{ job.status }}" = "success" ]; then + echo "โ Deployment notification: SUCCESS" + echo "Documentation deployed to: ${{ steps.deployment.outputs.page_url }}" + else + echo "โ Deployment notification: FAILED" + echo "Check the workflow logs for details: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" + fi \ No newline at end of file diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..d5f258e --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,300 @@ +name: ๐ Deploy Documentation to GitHub Pages + +on: + push: + branches: [ main ] + paths: + - 'src/**' + - 'guides/**' + - 'README.md' + - 'typedoc.json' + - 'tsconfig.docs.json' + - 'docs-theme.css' + - '.github/workflows/docs.yml' + pull_request: + branches: [ main ] + paths: + - 'src/**' + - 'guides/**' + - 'README.md' + - 'typedoc.json' + - 'tsconfig.docs.json' + - 'docs-theme.css' + workflow_dispatch: + inputs: + force_deploy: + description: 'Force deployment even on PR' + required: false + default: false + type: boolean + +# Security: Restrict permissions to minimum required +permissions: + contents: read + pages: write + id-token: write + +# Prevent concurrent deployments +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build documentation + build: + name: ๐ Build Documentation + runs-on: ubuntu-latest + timeout-minutes: 10 + + steps: + - name: ๐ฅ Checkout Repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 # Full history for git-based features + + - name: ๐ฆ Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + cache: 'npm' + registry-url: 'https://registry.npmjs.org' + + - name: ๐ง Install Dependencies + run: | + npm ci --prefer-offline --no-audit + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} + + - name: ๐๏ธ Build Package + run: | + npm run build + timeout-minutes: 5 + + - name: ๐ Generate Documentation + run: | + echo "๐๏ธ Generating TypeDoc documentation..." + npm run docs:generate + + echo "โ Documentation generated successfully" + echo "๐ Documentation structure:" + find docs -type f -name "*.html" | head -10 + + - name: ๐ Validate Documentation + run: | + # Check that essential files exist + test -f docs/index.html || { echo "โ Missing docs/index.html"; exit 1; } + test -f docs/.nojekyll || { echo "โ Missing docs/.nojekyll"; exit 1; } + + # Check guide links in documentation + if grep -q "Developer Guides" docs/index.html; then + echo "โ Guide links found in documentation" + else + echo "โ ๏ธ Guide links not found in documentation" + fi + + # Validate HTML structure + if command -v tidy >/dev/null 2>&1; then + tidy -q -e docs/index.html || echo "โ ๏ธ HTML validation warnings (non-critical)" + fi + + - name: ๐ Documentation Statistics + run: | + echo "๐ Documentation Statistics:" + echo "Total HTML files: $(find docs -name "*.html" | wc -l)" + echo "Total assets: $(find docs/assets -type f | wc -l)" + echo "Documentation size: $(du -sh docs | cut -f1)" + + echo "๐ Guide files:" + ls -la guides/ + + - name: ๐ง Setup Pages Configuration + run: | + # Ensure .nojekyll exists to disable Jekyll processing + touch docs/.nojekyll + + # Create custom 404 page if it doesn't exist + if [ ! -f docs/404.html ]; then + cat > docs/404.html << 'EOF' + + + + +The requested documentation page could not be found.
+You will be redirected to the main documentation in 5 seconds.
+
+ Available Resources:
+ โข API Documentation
+ โข Developer Guides
+ โข GitHub Repository
+
+
+ 
+
@@ -43,13 +46,19 @@
## Installation
+RPC 0.9 - Upcoming
+
+```bash
+npm i @starknet-io/types-js@beta
+```
+
RPC 0.8 - Latest
```bash
npm i @starknet-io/types-js
```
-RPC 0.7
+RPC 0.7 - Deprecated - deadline (28.07.2025)
```bash
npm i @starknet-io/types-js@0.7.10
@@ -95,16 +104,77 @@ MAJOR and MINOR version of this package follows [starknet-spec](https://github.c
Ex. Starknet types-js v0.7 == Starknet Spec v0.7
-## Devs Build
-
+## Testing
+
+This project maintains comprehensive test coverage with automated quality assurance:
+
+### ๐งช Test Scripts
+- **`npm test`** - Complete test suite: validation + type checking + Jest with coverage + verification
+- **`npm run test:develop`** - Development-friendly testing: lint + type-check + Jest with coverage
+
+### ๐ Coverage Reporting
+- **Self-Hosted Dynamic Badge** - Coverage badge generated and updated automatically by GitHub Actions
+- **No External Dependencies** - Badge works entirely within GitHub infrastructure
+- **Real-Time Updates** - Badge reflects actual test coverage from latest CI run
+- **Multiple Coverage Formats** - LCOV, JSON, and HTML coverage reports generated
+- **Automatic Badge Colors** - Green (100%), Yellow (70-89%), Red (<70%)
+
+### ๐ Coverage Areas
+- **Core Types & Guards** - FELT, Address, Storage validation functions
+- **API Components** - StarkNet JSON-RPC types and interfaces
+- **Wallet API** - Wallet integration and typed data structures
+- **Utilities** - Type-safe object manipulation and branded types
+- **Extensions** - Plugin architecture and validator system
+- **Integration** - Real-world usage patterns and package consumption
+
+### โ
Quality Assurance
+All tests pass with 100% coverage including:
+- Unit tests for all core functionality
+- Integration tests for real-world scenarios
+- Package consumption verification
+- TypeScript compilation validation
+- ESLint code quality checks
+
+## Development Scripts
+
+### ๐ฆ Build Scripts
+- **`npm run build`** - Main build command (cleans and builds all formats in parallel)
+- **`npm run build:cjs`** - Builds CommonJS module format (Node.js)
+- **`npm run build:esm`** - Builds ES Module format (modern bundlers with tree-shaking)
+- **`npm run build:types`** - Generates TypeScript declaration files (.d.ts)
+
+### ๐ Analysis & Debug Scripts
+- **`npm run build:analyze`** - Counts TypeScript processed files (compilation debugging)
+- **`npm run build:trace`** - Generates detailed TypeScript compilation trace
+- **`npm run analyze`** - Runs bundlesize check (ensures <10KB gzipped)
+
+### ๐งน Maintenance Scripts
+- **`npm run clean`** - Removes build artifacts (dist folder and trace files)
+- **`npm run format`** - Auto-formats all code files using Prettier
+
+### โ
Quality Assurance Scripts
+- **`npm run lint`** - Runs ESLint to check code quality and auto-fix issues
+- **`npm run ts:check`** - Type-checks code without emitting files
+- **`npm run validate`** - Comprehensive validation: lint + type-check + build (parallel)
+- **`npm run test:types`** - Type-checks test files specifically
+
+### ๐ Documentation Scripts
+- **`npm run docs:generate`** - Creates API documentation using TypeDoc
+- **`npm run docs:serve`** - Serves documentation locally on port 3000
+
+### ๐ฏ Recommended Usage
+**For development:**
```bash
-npm run build
+npm run validate # Before committing - checks everything
+npm run build # When you need fresh builds
+npm run format # To format code before committing
```
-## Devs Testing
-
+**For debugging:**
```bash
-npm run lint
+npm run build:analyze # Count compiled files
+npm run build:trace # Detailed compilation analysis
+npm run analyze # Check bundle sizes
```
## License
diff --git a/deploy-docs.sh b/deploy-docs.sh
new file mode 100755
index 0000000..31d2e66
--- /dev/null
+++ b/deploy-docs.sh
@@ -0,0 +1,312 @@
+#!/bin/bash
+
+# ๐ GitHub Pages Documentation Deployment Script
+# For @starknet-io/types-js
+#
+# Usage:
+# ./deploy-docs.sh # Deploy with defaults
+# ./deploy-docs.sh --setup # Initial GitHub Pages setup
+# ./deploy-docs.sh --manual # Manual deployment
+# ./deploy-docs.sh --preview # Preview mode (no deploy)
+
+set -e
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Configuration
+REPO="starknet-io/types-js"
+BRANCH="main"
+DOCS_DIR="docs"
+GITHUB_PAGES_URL="https://starknet-io.github.io/types-js"
+
+# Functions
+log_info() {
+ echo -e "${BLUE}โน๏ธ $1${NC}"
+}
+
+log_success() {
+ echo -e "${GREEN}โ
$1${NC}"
+}
+
+log_warning() {
+ echo -e "${YELLOW}โ ๏ธ $1${NC}"
+}
+
+log_error() {
+ echo -e "${RED}โ $1${NC}"
+}
+
+check_prerequisites() {
+ log_info "Checking prerequisites..."
+
+ # Check if we're in the right directory
+ if [ ! -f "package.json" ] || ! grep -q "@starknet-io/types-js" package.json; then
+ log_error "Not in the @starknet-io/types-js repository root"
+ exit 1
+ fi
+
+ # Check for required tools
+ command -v gh >/dev/null 2>&1 || { log_error "GitHub CLI (gh) is required but not installed"; exit 1; }
+ command -v npm >/dev/null 2>&1 || { log_error "npm is required but not installed"; exit 1; }
+ command -v git >/dev/null 2>&1 || { log_error "git is required but not installed"; exit 1; }
+
+ # Check git status
+ if [ -n "$(git status --porcelain)" ]; then
+ log_warning "Working directory has uncommitted changes"
+ read -p "Continue anyway? (y/N): " -n 1 -r
+ echo
+ if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+ log_info "Deployment cancelled"
+ exit 0
+ fi
+ fi
+
+ log_success "Prerequisites check passed"
+}
+
+setup_github_pages() {
+ log_info "Setting up GitHub Pages..."
+
+ # Enable GitHub Pages via API
+ log_info "Configuring GitHub Pages settings..."
+
+ # Check current Pages configuration
+ if gh api "repos/$REPO/pages" >/dev/null 2>&1; then
+ log_warning "GitHub Pages already configured"
+ gh api "repos/$REPO/pages" | jq -r '"Status: " + .status + " | URL: " + .html_url'
+ else
+ log_info "Enabling GitHub Pages..."
+
+ # Create Pages site
+ gh api \
+ --method POST \
+ -H "Accept: application/vnd.github+json" \
+ "/repos/$REPO/pages" \
+ -f source='{"branch":"main","path":"/docs"}' \
+ 2>/dev/null || {
+ log_warning "Could not enable via API, please enable manually:"
+ echo "1. Go to https://github.com/$REPO/settings/pages"
+ echo "2. Set Source to 'Deploy from a branch'"
+ echo "3. Select 'main' branch and '/docs' folder"
+ echo "4. Click 'Save'"
+ }
+ fi
+
+ log_success "GitHub Pages setup complete"
+}
+
+build_documentation() {
+ log_info "Building documentation..."
+
+ # Clean previous build
+ log_info "Cleaning previous build..."
+ npm run clean || true
+ rm -rf $DOCS_DIR/ || true
+
+ # Install dependencies
+ log_info "Installing dependencies..."
+ npm ci --prefer-offline --no-audit
+
+ # Build the package
+ log_info "Building TypeScript..."
+ npm run build
+
+ # Generate documentation
+ log_info "Generating TypeDoc documentation..."
+ npm run docs:generate
+
+ # Validate documentation
+ if [ ! -f "$DOCS_DIR/index.html" ]; then
+ log_error "Documentation generation failed - index.html not found"
+ exit 1
+ fi
+
+ # Statistics
+ local html_files=$(find $DOCS_DIR -name "*.html" | wc -l)
+ local total_size=$(du -sh $DOCS_DIR | cut -f1)
+
+ log_success "Documentation built successfully"
+ log_info "Statistics: $html_files HTML files, $total_size total size"
+
+ # Verify guide integration
+ if grep -q "Developer Guides" "$DOCS_DIR/index.html"; then
+ log_success "Guide links verified in documentation"
+ else
+ log_warning "Guide links not found in documentation"
+ fi
+}
+
+deploy_to_github_pages() {
+ log_info "Deploying to GitHub Pages..."
+
+ # Ensure we're on the right branch
+ if [ "$(git branch --show-current)" != "$BRANCH" ]; then
+ log_warning "Not on $BRANCH branch, switching..."
+ git checkout $BRANCH
+ fi
+
+ # Pull latest changes
+ log_info "Pulling latest changes..."
+ git pull origin $BRANCH
+
+ # Add documentation files
+ log_info "Adding documentation files to git..."
+ git add $DOCS_DIR/
+
+ # Check if there are changes to commit
+ if git diff --staged --quiet; then
+ log_info "No documentation changes to commit"
+ else
+ # Commit documentation
+ local commit_msg="docs: update TypeDoc documentation ๐
+
+- Regenerated API documentation
+- Updated guide links integration
+- Documentation size: $(du -sh $DOCS_DIR | cut -f1)
+- Generated: $(date -u +"%Y-%m-%d %H:%M UTC")
+
+๐ค Automated documentation deployment"
+
+ log_info "Committing documentation changes..."
+ git commit -m "$commit_msg"
+
+ # Push to GitHub
+ log_info "Pushing to GitHub..."
+ git push origin $BRANCH
+
+ log_success "Documentation pushed to GitHub"
+ fi
+
+ log_info "GitHub Pages will deploy automatically from the docs/ folder"
+ log_info "Deployment URL: $GITHUB_PAGES_URL"
+ log_info "Note: It may take 5-10 minutes for changes to be visible"
+}
+
+preview_documentation() {
+ log_info "Starting documentation preview..."
+
+ build_documentation
+
+ log_success "Documentation preview ready"
+ log_info "Starting local server..."
+ log_info "Open http://localhost:3000 in your browser"
+ log_info "Press Ctrl+C to stop the server"
+
+ npm run docs:serve
+}
+
+manual_deployment() {
+ log_info "Starting manual deployment..."
+
+ build_documentation
+
+ log_info "Manual deployment options:"
+ echo "1. Deploy via git push (recommended)"
+ echo "2. Deploy via GitHub Actions workflow"
+ echo "3. Cancel"
+
+ read -p "Choose option (1-3): " -n 1 -r
+ echo
+
+ case $REPLY in
+ 1)
+ deploy_to_github_pages
+ ;;
+ 2)
+ log_info "Triggering GitHub Actions deployment..."
+ gh workflow run docs.yml --ref $BRANCH
+ log_success "GitHub Actions workflow triggered"
+ log_info "Check status: gh run list --workflow=docs.yml"
+ ;;
+ 3)
+ log_info "Deployment cancelled"
+ exit 0
+ ;;
+ *)
+ log_error "Invalid option"
+ exit 1
+ ;;
+ esac
+}
+
+show_status() {
+ log_info "GitHub Pages Status:"
+
+ if gh api "repos/$REPO/pages" >/dev/null 2>&1; then
+ gh api "repos/$REPO/pages" | jq -r '
+ "๐ URL: " + .html_url + "\n" +
+ "๐ Status: " + .status + "\n" +
+ "๐ฟ Source: " + .source.branch + " branch, " + .source.path + " folder\n" +
+ "๐ HTTPS: " + (.https_enforced | tostring)
+ '
+
+ # Check if site is accessible
+ if curl -s -f "$GITHUB_PAGES_URL" >/dev/null; then
+ log_success "Documentation is accessible"
+ else
+ log_warning "Documentation may not be ready yet"
+ fi
+ else
+ log_warning "GitHub Pages not configured for this repository"
+ echo "Run: $0 --setup"
+ fi
+
+ # Show recent workflow runs
+ log_info "Recent documentation deployments:"
+ gh run list --workflow=docs.yml --limit=3 --json status,conclusion,createdAt,url | \
+ jq -r '.[] | "โข " + .status + " (" + .conclusion + ") - " + .createdAt + " - " + .url'
+}
+
+# Main script logic
+case "${1:-}" in
+ --setup)
+ check_prerequisites
+ setup_github_pages
+ ;;
+ --manual)
+ check_prerequisites
+ manual_deployment
+ ;;
+ --preview)
+ check_prerequisites
+ preview_documentation
+ ;;
+ --status)
+ show_status
+ ;;
+ --help|-h)
+ echo "๐ GitHub Pages Documentation Deployment"
+ echo ""
+ echo "Usage:"
+ echo " $0 # Default deployment"
+ echo " $0 --setup # Initial GitHub Pages setup"
+ echo " $0 --manual # Manual deployment with options"
+ echo " $0 --preview # Preview documentation locally"
+ echo " $0 --status # Show deployment status"
+ echo " $0 --help # Show this help"
+ echo ""
+ echo "Environment:"
+ echo " Repository: $REPO"
+ echo " Branch: $BRANCH"
+ echo " Documentation: $GITHUB_PAGES_URL"
+ ;;
+ "")
+ # Default deployment
+ check_prerequisites
+ build_documentation
+ deploy_to_github_pages
+ show_status
+ ;;
+ *)
+ log_error "Unknown option: $1"
+ echo "Use $0 --help for usage information"
+ exit 1
+ ;;
+esac
+
+log_success "Script completed successfully"
\ No newline at end of file
diff --git a/docs-theme.css b/docs-theme.css
new file mode 100644
index 0000000..e17f391
--- /dev/null
+++ b/docs-theme.css
@@ -0,0 +1,54 @@
+/* Custom TypeDoc theme for Starknet Types */
+
+:root {
+ --starknet-primary: #ff6b35;
+ --starknet-secondary: #0c0c4f;
+ --starknet-accent: #f0f8ff;
+}
+
+.tsd-page-title h1 {
+ color: var(--starknet-secondary);
+ border-bottom: 2px solid var(--starknet-primary);
+ padding-bottom: 0.5rem;
+}
+
+.tsd-navigation .tsd-accordion-summary {
+ color: var(--starknet-secondary);
+}
+
+.tsd-navigation .tsd-accordion-summary:hover {
+ background: var(--starknet-accent);
+}
+
+.tsd-signature-type {
+ color: var(--starknet-primary);
+ font-weight: 600;
+}
+
+.tsd-kind-icon {
+ background: var(--starknet-primary);
+}
+
+a {
+ color: var(--starknet-primary);
+}
+
+a:hover {
+ color: var(--starknet-secondary);
+}
+
+.tsd-panel-group {
+ margin-bottom: 2rem;
+}
+
+.tsd-comment {
+ font-size: 0.95em;
+ line-height: 1.6;
+}
+
+code {
+ background: var(--starknet-accent);
+ padding: 0.2em 0.4em;
+ border-radius: 4px;
+ font-size: 0.9em;
+}
\ No newline at end of file
diff --git a/docs/.nojekyll b/docs/.nojekyll
new file mode 100644
index 0000000..e2ac661
--- /dev/null
+++ b/docs/.nojekyll
@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
\ No newline at end of file
diff --git a/docs/CNAME b/docs/CNAME
new file mode 100644
index 0000000..364e09d
--- /dev/null
+++ b/docs/CNAME
@@ -0,0 +1,14 @@
+# GitHub Pages Custom Domain Configuration
+#
+# To use a custom domain for your documentation:
+# 1. Uncomment the line below and replace with your domain
+# 2. Configure DNS records:
+# - CNAME record: docs.yourdomain.com -> starknet-io.github.io
+# - Or A records for apex domain to GitHub Pages IPs
+# 3. Enable HTTPS in repository settings
+#
+# Example:
+# docs.starknet-types.io
+
+# For now, using default GitHub Pages domain:
+# https://starknet-io.github.io/types-js/
\ No newline at end of file
diff --git a/docs/assets/custom.css b/docs/assets/custom.css
new file mode 100644
index 0000000..e17f391
--- /dev/null
+++ b/docs/assets/custom.css
@@ -0,0 +1,54 @@
+/* Custom TypeDoc theme for Starknet Types */
+
+:root {
+ --starknet-primary: #ff6b35;
+ --starknet-secondary: #0c0c4f;
+ --starknet-accent: #f0f8ff;
+}
+
+.tsd-page-title h1 {
+ color: var(--starknet-secondary);
+ border-bottom: 2px solid var(--starknet-primary);
+ padding-bottom: 0.5rem;
+}
+
+.tsd-navigation .tsd-accordion-summary {
+ color: var(--starknet-secondary);
+}
+
+.tsd-navigation .tsd-accordion-summary:hover {
+ background: var(--starknet-accent);
+}
+
+.tsd-signature-type {
+ color: var(--starknet-primary);
+ font-weight: 600;
+}
+
+.tsd-kind-icon {
+ background: var(--starknet-primary);
+}
+
+a {
+ color: var(--starknet-primary);
+}
+
+a:hover {
+ color: var(--starknet-secondary);
+}
+
+.tsd-panel-group {
+ margin-bottom: 2rem;
+}
+
+.tsd-comment {
+ font-size: 0.95em;
+ line-height: 1.6;
+}
+
+code {
+ background: var(--starknet-accent);
+ padding: 0.2em 0.4em;
+ border-radius: 4px;
+ font-size: 0.9em;
+}
\ No newline at end of file
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
new file mode 100644
index 0000000..ba2fb55
--- /dev/null
+++ b/docs/assets/highlight.css
@@ -0,0 +1,64 @@
+:root {
+ --light-hl-0: #795E26;
+ --dark-hl-0: #DCDCAA;
+ --light-hl-1: #000000;
+ --dark-hl-1: #D4D4D4;
+ --light-hl-2: #A31515;
+ --dark-hl-2: #CE9178;
+ --light-hl-3: #008000;
+ --dark-hl-3: #6A9955;
+ --light-hl-4: #AF00DB;
+ --dark-hl-4: #C586C0;
+ --light-hl-5: #001080;
+ --dark-hl-5: #9CDCFE;
+ --light-code-background: #FFFFFF;
+ --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+ --hl-0: var(--light-hl-0);
+ --hl-1: var(--light-hl-1);
+ --hl-2: var(--light-hl-2);
+ --hl-3: var(--light-hl-3);
+ --hl-4: var(--light-hl-4);
+ --hl-5: var(--light-hl-5);
+ --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+ --hl-0: var(--dark-hl-0);
+ --hl-1: var(--dark-hl-1);
+ --hl-2: var(--dark-hl-2);
+ --hl-3: var(--dark-hl-3);
+ --hl-4: var(--dark-hl-4);
+ --hl-5: var(--dark-hl-5);
+ --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+ --hl-0: var(--light-hl-0);
+ --hl-1: var(--light-hl-1);
+ --hl-2: var(--light-hl-2);
+ --hl-3: var(--light-hl-3);
+ --hl-4: var(--light-hl-4);
+ --hl-5: var(--light-hl-5);
+ --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+ --hl-0: var(--dark-hl-0);
+ --hl-1: var(--dark-hl-1);
+ --hl-2: var(--dark-hl-2);
+ --hl-3: var(--dark-hl-3);
+ --hl-4: var(--dark-hl-4);
+ --hl-5: var(--dark-hl-5);
+ --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+pre, code { background: var(--code-background); }
diff --git a/docs/assets/icons.js b/docs/assets/icons.js
new file mode 100644
index 0000000..b79c9e8
--- /dev/null
+++ b/docs/assets/icons.js
@@ -0,0 +1,15 @@
+(function(svg) {
+ svg.innerHTML = `Validates if an array contains valid FELT signatures
+Array to validate
+Type predicate indicating if value is SIGNATURE
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+๐บ Starknet TypeScript types ๐ definitions for Starknet projects +
+ +RPC 0.9 - Upcoming
+npm i @starknet-io/types-js@beta
+RPC 0.8 - Latest
+npm i @starknet-io/types-js
+RPC 0.7 - Deprecated - deadline (28.07.2025)
+npm i @starknet-io/types-js@0.7.10
+// type import
import type { SomeApiType } from '@starknet-io/types-js';
// or entire namespace import
import { API } from '@starknet-io/types-js';
+// type import
import type { SomeWalletApiType } from '@starknet-io/types-js';
// or entire namespace import
import { WALLET_API } from '@starknet-io/types-js';
+// type import
import type { TypedData } from '@starknet-io/types-js';
+// namespace import
import { PAYMASTER_API } from '@starknet-io/types-js';
+MAJOR and MINOR version of this package follows starknet-spec semantic versioning. The PATCH version can diverge based on the bug fixes.
+Ex. Starknet types-js v0.7 == Starknet Spec v0.7
+npm run build - Main build command (cleans and builds all formats in parallel)npm run build:cjs - Builds CommonJS module format (Node.js)npm run build:esm - Builds ES Module format (modern bundlers with tree-shaking)npm run build:types - Generates TypeScript declaration files (.d.ts)npm run build:analyze - Counts TypeScript processed files (compilation debugging)npm run build:trace - Generates detailed TypeScript compilation tracenpm run analyze - Runs bundlesize check (ensures <10KB gzipped)npm run clean - Removes build artifacts (dist folder and trace files)npm run format - Auto-formats all code files using Prettiernpm run lint - Runs ESLint to check code quality and auto-fix issuesnpm run ts:check - Type-checks code without emitting filesnpm run validate - Comprehensive validation: lint + type-check + build (parallel)npm run test:types - Type-checks test files specificallynpm run docs:generate - Creates API documentation using TypeDocnpm run docs:serve - Serves documentation locally on port 3000For development:
+npm run validate # Before committing - checks everything
npm run build # When you need fresh builds
npm run format # To format code before committing
+For debugging:
+npm run build:analyze # Count compiled files
npm run build:trace # Detailed compilation analysis
npm run analyze # Check bundle sizes
+This repository is licensed under the MIT License, see LICENSE for more information.
+"More data about the compilation failure
+the execution trace up to the point of failure
+The index of the first transaction failing in a sequence of given transactions
+0
+the execution trace up to the point of failure
+SPEC: ACCOUNT_DEPLOYMENT_DATA
+Optional sigdataSPEC: DECLARE_TXN
+Optional class_The hash of the declare transaction
+The hash of the declared class
+INVOKE_TXN_V1
+Calls to invoke by the account
+EIP-3085:
+Optional rpc_Optional block_Optional native_Optional icon_Maps each RPC message type to its corresponding parameters and result type.
+Get permissions from the wallet.
+Optional params?: ApiVersionRequestAn array of permissions.
+Request active accounts from the wallet.
+Optional params?: RequestAccountsParameters & ApiVersionRequestOptional parameters for requesting accounts.
+An array of account addresses as strings.
+Watch an asset in the wallet.
+The parameters required to watch an asset.
+A boolean indicating if the operation was successful.
+Add a new Starknet chain to the wallet.
+The parameters required to add a new chain.
+A boolean indicating if the operation was successful.
+Switch the current Starknet chain in the wallet.
+The parameters required to switch chains.
+A boolean indicating if the operation was successful.
+Request the current chain ID from the wallet.
+Optional params?: ApiVersionRequestThe current Starknet chain ID.
+Get deployment data for a contract.
+Optional params?: ApiVersionRequestThe deployment data result.
+Add an invoke transaction to the wallet.
+The parameters required for the invoke transaction.
+The result of adding the invoke transaction.
+Add a declare transaction to the wallet.
+The parameters required for the declare transaction.
+The result of adding the declare transaction.
+Sign typed data using the wallet.
+The typed data to sign.
+An array of signatures as strings.
+Get the list of supported RPC specification versions.
+Optional params?: undefinedAn array of supported specification strings.
+Returns a list of wallet api versions compatible with the wallet. +Notice this might be different from Starknet JSON-RPC spec
+Optional params?: undefinedAn array of supported wallet api versions.
+The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field.
+Optional nameOptional versionOptional chainOptional revisionSPEC: TYPED_DATA +The complete typed data, with all the structs, domain data, primary type of the message, and the message itself.
+EIP-747:
+Optional symbol?: stringOptional decimals?: numberOptional image?: stringOptional name?: stringcommon definition
+common outputs
+A block identifier that can be either a block hash, block number, or a block tag
+0
+A block selector that can be either a block hash or block number
+A tag specifying a dynamic reference to a block.
+Tag l1_accepted refers to the latest Starknet block which was included in a state update on L1 and finalized by the consensus on L1.
+Tag latest refers to the latest Starknet block finalized by the consensus on L2.
+Tag pre_confirmed refers to the block which is currently being built by the block proposer in height latest + 1.
EBlockTag
+A block with full transactions and receipts
+A block with transaction hashes
+Starknet get compiled CASM result
+Array of 2-tuple of pc value and an array of hints to execute.
+Optional bytecode_a list of sizes of segments in the bytecode, each segment is hashed individually when computing the bytecode hash. +Integer
+Common properties shared by all transaction receipts
+Cairo v>=2 Contract ABI
+the (Cairo) enum name, including namespacing
+name of the enum variant. +type of the enum variant, including namespacing.
+enum variants
+the name of the (Cairo) type associated with the event
+the name of the struct member or enum variant
+the Cairo type of the member or variant, including namespacing
+the function's name
+the arguments name and type.
+the output type.
+the name of an impl containing contract entry points
+the name of the trait corresponding to this impl
+the (Cairo) struct name, including namespacing
+name of the struct member. +type of the struct member, including namespacing.
+struct members
+The definition of a StarkNet contract class
+structured error that can later be processed by wallets or sdks. +error frame or the error raised during execution
+structured error that can later be processed by wallets or sdks. +error frame or the error raised during execution
+The contract address for which the storage changed
+The changes in the storage of the contract
+Data availability mode. +Specifies a storage domain in Starknet. Each domain has different guarantees regarding availability
+A transaction receipt for a declare transaction
+A transaction trace for a declare transaction
+Optional validate_Optional fee_Optional state_Starknet 0.14 will not support this transaction
+Starknet 0.14 will not support this transaction
+Starknet 0.14 will not support this transaction
+A transaction receipt for a deploy account transaction
+A transaction trace for a deploy account transaction
+The trace of the constructor call
+Optional validate_Optional fee_Optional state_Starknet 0.14 will not support this transaction
+A transaction receipt for a deploy transaction
+"The offset of the entry point in the program"
+A unique identifier of the entry point (function) in the program
+represents a path to the highest non-zero descendant node
+an unsigned integer whose binary representation represents the path from the current node to its highest non-zero descendant (bounded by 2^251)
+the length of the path (bounded by 251)
+0
+the hash of the unique non-zero maximal-height descendant node
+Represents the type of an entry point.
+an ethereum address represented as 40 hex digits
+^0x[a-fA-F0-9]{40}$
+Starknet 0.14 will not support this transaction
+Returns matching events
+Optional continuation_Use this token in a subsequent query to obtain the next page. Should not appear if there are no more pages.
+Event ABI type
+Event name
+Optional from_Optional to_Optional address?: ADDRESSOptional keys?: EVENT_KEYSThe keys to filter over. +Per key (by position), designate the possible values to be matched for events to be returned. Empty array designates 'any' value.
+the resources consumed by the transaction
+l1 gas consumed by this transaction, used for l2-->l1 messages and state updates if blobs are not used. +integer
+0
+data gas consumed by this transaction, 0 if blobs are not used +integer
+0
+l2 gas consumed by this transaction, used for computation and calldata +Integer
+0
+Units in which the fee is given, can only be FRI
+The Ethereum gas consumption of the transaction, charged for L1->L2 messages and, depending on the block's DA_MODE, state diffs. +Prev. name gas_consumed
+The gas price (in wei or fri, depending on the tx version) that was used in the cost estimation. +Prev. name gas_price
+The L2 gas consumption of the transaction.
+The L2 gas price (in wei or fri, depending on the tx version) that was used in the cost estimation.
+The Ethereum data gas consumption of the transaction. +Prev. name data_gas_consumed
+The data gas price (in wei or fri, depending on the tx version) that was used in the cost estimation. +Prev. name data_gas_price
+The estimated fee for the transaction (in wei or fri, depending on the tx version), equals to l1_gas_consumedl1_gas_price + l1_data_gas_consumedl1_data_gas_price + l2_gas_consumed*l2_gas_price
+A field element. represented by at most 63 hex digits
+^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,62})$
+Function ABI type
+Function name
+Typed parameter
+Typed parameter
+Optional stateFunction state mutability
+Represents a function invocation along with its execution details.
+The address of the invoking contract. 0 for the root invocation
+The hash of the class being called
+The value returned from the function invocation
+The calls made by this invocation
+The events emitted in this invocation
+The messages sent by this invocation to L1
+Resources consumed by the call tree rooted at this given call (including the root)
+true if this inner call panicked
+the resources consumed by an inner call (does not account for state diffs since data is squashed across the transaction)
+l1 gas consumed by this transaction, used for l2-->l1 messages and state updates if blobs are not used
+0
+l2 gas consumed by this transaction, used for computation and calldata
+0
+A transaction receipt for an invoke transaction
+A transaction trace for an invoke transaction
+The trace of the execute call
+Optional validate_Optional fee_Optional state_Starknet 0.14 will not support this transaction
+Starknet 0.14 will not support this transaction
+Possible permutations of transaction. + BLOCK TYPE + TYPE OF TRANSACTION + EXECUTION (Reverted or not) + FINALITY (Rejected on not) Receipt do not have Rejected
+Ethereum l1_handler tx hash and status for L1 -> L2 messages sent by the l1 transaction
+l1_handler tx hash
+finality status of the L1 -> L2 messages sent by the l1 transaction
+the failure reason, only appears if finality_status is REJECTED
+Optional failure_The failure reason. Only appears if execution_status is REVERTED
A transaction receipt for an L1 handler transaction
+A transaction trace for an L1 handler transaction
+The trace of the L1 handler call
+Optional state_a node in the Merkle-Patricia tree, can be a leaf, binary node, or an edge node
+Message fee estimate
+Units in which the fee is given, can only be WEI
+A message sent from L1 to L2
+a node_hash -> node mapping of all the nodes in the union of the paths between the requested leaves and the root
+string representing an unsigned integer number in prefixed hexadecimal format
+"0x.."
+^0x[a-fA-F0-9]+$
+The block number of the block that the proposer is currently building. Note that this is a local view of the node, whose accuracy depends on its polling interval length.
+The time in which the block was created, encoded in Unix time
+The StarkNet identity of the sequencer submitting this block
+The price of l1 gas in the block
+The price of l2 gas in the block
+The price of l1 data gas in the block
+specifies whether the data of this block is published via blob data or calldata
+Semver of the current Starknet protocol
+Pre-confirmed block state update
+Data about reorganized blocks, starting and ending block number and hash
+Hash of the first known block of the orphaned chain
+Number of the first known block of the orphaned chain
+The last known block of the orphaned chain
+Number of the last known block of the orphaned chain
+The max amount and max price per unit of L1 gas used in this tx
+The max amount and max price per unit of L1 blob gas used in this tx
+The max amount and max price per unit of L2 gas used in this tx
+Optional continuation_The token returned from the previous query. If no token is provided the first page is returned.
+Chunk size
+Flags that indicate how to simulate a given transaction. By default, the sequencer behavior is replicated locally (enough funds are expected to be in the account, and the fee will be deducted from the balance before the simulation of the next transaction). To skip the fee charge, use the SKIP_FEE_CHARGE flag.
+The change in state applied in this block
+The transaction/block was accepted on Ethereum (L1)
+The transaction/block was accepted on L2 and included
+The transaction is a candidate for inclusion in the next block
+The transaction/block was written to the feeder gateway's storage by a sequencer
+The transaction was received by the sequencer
+The block was rejected and will not be included
+The transaction passed validation but failed during execution by the sequencer, and is included in a block as reverted
+The transaction was successfully executed
+A storage key. Represented as up to 62 hex digits, 3 bits, and 5 leading zeroes.
+^0x(0|[0-7]{1}[a-fA-F0-9]{0,62}$)
+Struct ABI type
+Struct name
+offset of this property within the struct
+0
+same as BLOCK_ID, but without 'pre_confirmed'
+An identifier for this subscription stream used to associate events with this subscription. +Integer
+An object describing the node synchronization status
+The nodes in the union of the paths from the contracts tree root to the requested leaves
+The nonce and class hash for each requested contract address, in the order in which they appear in the request. These values are needed to construct the associated leaf node
+A transaction trace including the execution details
+The execution status of the transaction
+The finality status of the transaction
+All possible transaction receipt types
+A transaction receipt with block information
+Represents the finality status of the transaction, including the case the txn is still in the mempool or failed validation during the block construction phase
+Transaction status result, including finality status and execution status
+Optional execution_Optional failure_The failure reason, only appears if execution_status is REVERTED
+The type of the transaction
+Parameter name
+Parameter type
+All Type Transaction Receipt
+All Type Transaction Receipt from pre confirmed block
+All Type Transaction Receipt from production block
+Server -> Client events over WebSockets
+New block headers subscription. +Creates a WebSocket stream which will fire events for new block headers.
+Optional block_The block to get notifications from, default is latest, limited to 1024 blocks back
+New events subscription. +Creates a WebSocket stream which will fire events for new Starknet events with applied filters.
+Optional from_Filter events by from_address which emitted the event
+Optional keys?: EVENT_KEYSOptional block_The block to get notifications from, default is latest, limited to 1024 blocks back
+New transaction status subscription. +Creates a WebSocket stream which at first fires an event with the current known transaction status, followed by events for every transaction status update
+New Pending Transactions subscription. +Creates a WebSocket stream which will fire events when a new pending transaction is added. While there is no mempool, this notifies of transactions in the pending block.
+Optional transaction_"Get all transaction details, and not only the hash. If not provided, only hash is returned. Default is false"
+Optional sender_Filter transactions to only receive notification from address list
+Close a previously opened ws stream, with the corresponding subscription id
+128 bit unsigned integers, represented by hex string of length at most 32 +"pattern": "^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,31})$"
+64 bit unsigned integers, represented by hex string of length at most 16 +"pattern": "^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,15})$"
+A contract address on Starknet (branded FELT)
+"0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7"
+Block number
+0
+Chain ID
+A field element represented by at most 63 hex digits
+^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,62})$
+"0x1234567890abcdef"
+"0x0"
+https://docs.starknet.io/documentation/architecture_and_concepts/Cryptography/hash-functions/
+The hash of a Starknet transaction
+User transaction
+Optional time_Execution parameters
+A unique identifier corresponding to an execute request to the paymaster
User transaction
+256 bit unsigned integers, represented by a hex string of length at most 64
+^0x(0|[a-fA-F1-9]{1}[a-fA-F0-9]{0,63})$
+Optional accounts: string[]Starknet Token +Details of an onchain Starknet ERC20 token
+Optional symbol?: TokenSymbolOptional decimals?: numberOptional image?: stringOptional name?: stringOptional chainId: ChainIdOptional accounts: string[]"A typed data object (in the sense of SNIP-12) which represents an outside execution payload, according to SNIP-9
+A padded felt represent 0x0 + (0-7) + (62 hex digits)
+^0x(0[0-7]{1}[a-fA-F0-9]{62}$)
+The transaction hash, as assigned in Starknet
+A Starknet RPC spec version, only two numbers are provided
+^[0-9]+\.[0-9]+$
+SPEC: STARKNET_TYPE
+A single type, as part of a struct. The type field can be any of the EIP-712 supported types.
+Note that the uint and int aliases like in Solidity, and fixed point numbers are not supported by the EIP-712
+standard.
Object containing timestamps corresponding to Execute After and Execute Before
ERC20 Token Symbol (min:1 char - max:6 chars)
+^[A-Za-z0-9]{1,6}$
+Const Represents the type of a function call.
+Readonly DELEGATE: "DELEGATE"Readonly LIBRARY_Readonly CALL: "CALL"Const Readonly PRE_Readonly ACCEPTED_Readonly ACCEPTED_Const A tag specifying a dynamic reference to a block.
+Readonly LATEST: "latest"Tag latest refers to the latest Starknet block finalized by the consensus on L2.
Readonly PRE_Tag pre_confirmed refers to the block which is currently being built by the block proposer in height latest + 1.
Readonly L1_Tag l1_accepted refers to the latest Starknet block which was included in a state update on L1 and finalized by the consensus on L1.
Const Readonly L1: 0Readonly L2: 1Const Readonly L1: "L1"Readonly L2: "L2"Const Readonly SKIP_Readonly SKIP_Const Readonly SUCCEEDED: "SUCCEEDED"Readonly REVERTED: "REVERTED"Const Readonly PRE_Readonly ACCEPTED_Readonly ACCEPTED_Const Readonly RECEIVED: "RECEIVED"Readonly CANDIDATE: "CANDIDATE"Readonly PRE_Readonly ACCEPTED_Readonly ACCEPTED_Const Readonly DECLARE: "DECLARE"Readonly DEPLOY: "DEPLOY"Readonly DEPLOY_Readonly INVOKE: "INVOKE"Readonly L1_Const V_ Transaction versions HexString +F_ Fee Transaction Versions HexString (2 ** 128 + TRANSACTION_VERSION)
+Readonly V0: "0x0"Starknet 0.14 will not support this transaction
+Readonly V1: "0x1"Starknet 0.14 will not support this transaction
+Readonly V2: "0x2"Starknet 0.14 will not support this transaction
+Readonly V3: "0x3"Readonly F0: "0x100000000000000000000000000000000"Starknet 0.14 will not support this transaction
+Readonly F1: "0x100000000000000000000000000000001"Starknet 0.14 will not support this transaction
+Readonly F2: "0x100000000000000000000000000000002"Starknet 0.14 will not support this transaction
+Readonly F3: "0x100000000000000000000000000000003"Const Readonly V0: "0x0"Readonly V1: "0x1"Readonly V2: "0x2"Readonly F0: "0x100000000000000000000000000000000"Readonly F1: "0x100000000000000000000000000000001"Readonly F2: "0x100000000000000000000000000000002"Starknet 0.14 will not support this transaction
+Const V3 Transaction Versions
+Readonly V3: "0x3"Readonly F3: "0x100000000000000000000000000000003"Const Readonly BLOB: "BLOB"Readonly CALLDATA: "CALLDATA"Const Readonly ACCOUNTS: "accounts"Const Readonly ACTIVE: "1"Readonly LEGACY: "0"
Assertion functions for runtime type checking
+