Skip to main content
Research Preview — The SDK is under active development.

SDK overview

The Astral SDK is the official TypeScript client for the Astral Protocol. It provides a unified interface for working with location attestations, multi-factor location proofs, and verifiable geospatial computations.

Design philosophy

  • Namespaced API: Clear separation between location, compute, stamps, proofs, and plugin operations
  • Workflow-oriented: Distinct offchain and onchain workflows for location attestations
  • Plugin-extensible: Register location proof plugins; collect signals, create location stamps, and compose multifactor location evidence bundles
  • Multidimensional verification: No single “confidence score” — applications apply their own weighting to a CredibilityVector
  • Type-safe: Full TypeScript support with comprehensive types
  • Batteries included: Handles signing, encoding, EAS integration, and plugin orchestration

Package structure

Quick start

Configuration

Module architecture

Key concepts

Namespaced modules

Clear separation: location.offchain.*, location.onchain.*, compute.*, stamps.*, proofs.*, and plugins.*

Flexible inputs

Accept UIDs, raw GeoJSON, or attestation objects interchangeably.

Delegated attestations

SDK handles the delegated attestation pattern — you pay gas, Astral is attester.

Plugin extensibility

Register proof-of-location plugins for multifactor evidence collection and verification.

Pages

Installation

Install and configure the SDK

Location module

Offchain and onchain attestation workflows

Stamps module

Evidence collection and stamp creation

Location proofs

Proof construction and multidimensional verification

Plugins

Plugin system and registry

Compute module

Geospatial computation methods

EAS integration

Ethereum Attestation Service integration

Migration guide

Migrate from v0.1.x to v0.2.0