SDK

The SOCI4L SDK is currently in development and not yet published as a stable package. This page documents the intended direction so that we can keep implementation and documentation aligned as the SDK evolves.

Goals for the SDK

The SDK is planned to provide:

• Typed helpers for reading profile and wallet data from SOCI4L without manually calling HTTP endpoints.
• Utilities for working with SOCI4L concepts such as scores, tiers, slugs, and donation links.
• Lightweight client wrappers around public, read-only API routes (for example wallet summaries, public insights, and search).

Write operations that require signatures are expected to remain in the main app for now; the first versions of the SDK will focus on reading and composing data, not updating it.

Current status

As of now:

• There is no published NPM package for the SDK.
• There is no stable public API surface guaranteed for external developers.
• Internal utilities live directly in the codebase under lib/ and hooks/ and are closely tied to the app.

This means the SDK page is intentionally minimal. It should not be treated as an integration guide yet, but as a reminder of where we want the developer experience to go.

Future directions (subject to change)

Potential future capabilities of the SDK include:

• A small client library for public profile reads (get profile by address or slug, list links, read score and tier).
• Convenience methods for generating share links and donation deep links.
• Helpers for embedding public insights into external dashboards.

Until these features are implemented and stabilized, any external integration should rely on the documented public UI and manually inspected API routes, with the understanding that they may change between releases.