> ## Documentation Index
> Fetch the complete documentation index at: https://docs.signalite.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Signalite Partner Docs

> Integrate sHLP into wallets, vault pages, and mobile apps using the Signalite API and SDK.

Signalite is a liquid yield product for sHLP. Partners integrate through the hosted API for state and action quotes, and through `@arc/shlp-sdk` for typed reads, readiness checks, and transaction sending.

<Warning>
  These docs describe the partner sandbox. They are not a public launch announcement, audit report, or legal product disclosure.
</Warning>

## What partners can build

<CardGroup cols={2}>
  <Card title="Deposit" icon="wallet" href="/guides/deposit">
    Quote deposits, approve USDC when needed, and submit vault deposit calldata.
  </Card>

  <Card title="Instant redeem" icon="zap" href="/guides/instant-redeem">
    Redeem from the available vault buffer when the requested exit fits current liquidity.
  </Card>

  <Card title="Queued redeem" icon="clock" href="/guides/queued-redeem">
    Request a larger redemption, track it through pending and claimable states, then claim USDC.
  </Card>

  <Card title="Activity and history" icon="activity" href="/guides/activity">
    Show user events, redeem lifecycle rows, vault history, and proof of backing from indexed API data.
  </Card>
</CardGroup>

## Integration surfaces

| Surface                                                     | Use                                                                             |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `https://shlp-web-production.up.railway.app/api/v1/*`       | Partner API for product state, health, activity, redeems, and action builders   |
| `https://shlp-web-production.up.railway.app/api/v1/openapi` | Canonical OpenAPI spec                                                          |
| `@arc/shlp-sdk`                                             | Typed TypeScript SDK for API reads, quotes, errors, readiness, and transactions |
| `/developers` in the app                                    | Live sandbox status and short operational quickstart                            |

## Core rule

Every partner app must call `/api/v1/health` before showing write actions.

Use `health.ready` and SDK readiness helpers as the source of truth. Do not infer deposit readiness from static config or UI copy.

<Steps>
  <Step title="Read health">
    Fetch `/api/v1/health` and block write actions if the relevant readiness flag is false.
  </Step>

  <Step title="Read product state">
    Fetch `/api/v1/vault`, `/api/v1/config`, and user-specific `/api/v1/position`.
  </Step>

  <Step title="Build action quote">
    Use an action endpoint such as `/api/v1/actions/deposit/quote`.
  </Step>

  <Step title="Send returned transactions">
    Send approval requirements first, then the primary transaction.
  </Step>
</Steps>

## Read next

* Start with the [quickstart](/quickstart).
* Learn the [product model](/concepts/product-model).
* Implement the [deposit flow](/guides/deposit).
* Review [release gates](/operations/release-gates) before partner demos.
