open-index/open-npm huggingface dataset:
npm package: @ssts-org/client
Description: TypeScript client for Security Token Program
Author: SSTS Foundation
Latest version: 0.1.0

# `@ssts-org/client`

TypeScript client for the Solana Security Token Standard (SSTS) core program.

This package is generated from the SSTS IDL.

## Installation

```bash
npm install @ssts-org/client
```

## What it includes

- instruction builders/parsers (e.g. `getInitializeMintInstruction`)
- account codecs
- generated instruction/account/type constants
- core program metadata (`SECURITY_TOKEN_PROGRAM_PROGRAM_ADDRESS`, discriminators)

## Program IDs

Load program IDs from your cluster config/environment.
Do not hardcode them in app code.

## Usage (minimal instruction build)

```ts
import { address } from "@solana/kit";
import * as ssts from "@ssts-org/client";

const securityProgramId = address(process.env.SECURITY_TOKEN_PROGRAM_ID!);

const ix = ssts.getPauseInstruction(
  {
    mint: "<MINT_ADDRESS>" as any,
    verificationConfig: "<VERIFICATION_CONFIG_PDA>" as any,
    pauseAuthority: "<PAUSE_AUTHORITY_PDA>" as any,
    mintAccount: "<MINT_ADDRESS>" as any,
  },
  { programAddress: securityProgramId },
);
```

## Usage (instruction introspection helper)

```ts
import * as ssts from "@ssts-org/client";

const kind = ssts.identifySecurityTokenProgramInstruction(ix.data);
if (kind === ssts.SecurityTokenProgramInstruction.Transfer) {
  // transfer-specific handling
}
```

## API surface

The root export re-exports all generated modules:

- `accounts`
- `instructions`
- `errors`
- `programs`
- `types`

## Release notes for maintainers

- Regenerate client after core IDL/instruction/account changes.
- Run `npm run clean && npm run build` before publish.