@starkscan/sdk - npm Package Compare versions

Comparing version

0.0.1

0.0.2

+2

-2

package.json

		{
		"name": "@starkscan/sdk",
		"private": false,
		"version": "0.0.1",
		"description": "Stable placeholder for the Starkscan TypeScript SDK. Use @starkscan/sdk@alpha for the current beta.",
		"version": "0.0.2",
		"description": "Typed Starkscan API client for beta integrations. Stable latest is fail-closed; use @starkscan/sdk@alpha.",
		"license": "MIT",
		@@ -7,0 +7,0 @@ "type": "module",

+34

-18

README.md

		# @starkscan/sdk

		Stable channel placeholder for the Starkscan TypeScript SDK.
		Typed Starkscan API client for beta integrations.

		The production `latest` channel is not released yet. This package exists so
		`npm install @starkscan/sdk` fails closed instead of installing a moving alpha.
		> The npm `latest` channel is intentionally fail-closed until the stable SDK is
		> released. Install `@starkscan/sdk@alpha`, or pin an exact alpha version for
		> unattended agents and production services.

		## Current beta
		## Install

		Install the alpha channel explicitly:
		\| Use case \| Command \|
		\| --- \| --- \|
		\| Try the current beta \| `npm install @starkscan/sdk@alpha` \|
		\| Pin the smoked beta \| `npm install @starkscan/sdk@0.1.0-alpha.2` \|
		\| Stable channel \| `npm install @starkscan/sdk` installs a fail-closed placeholder; calling `createStarkscanClient()` throws upgrade guidance \|

		```bash
		npm install @starkscan/sdk@alpha
		```
		## First request

		For unattended agents or production services, pin an exact smoked version:

		```bash
		npm install @starkscan/sdk@0.1.0-alpha.2
		export STARKSCAN_BASE_URL="https://starkscan.co/api"
		export STARKSCAN_API_KEY="<store this in your shell or agent secret store>"
		export STARKSCAN_CHAIN="SN_MAIN"
		```

		## Minimal alpha usage

		```ts
		@@ -30,13 +31,28 @@ import { createStarkscanClient } from "@starkscan/sdk";
		baseUrl: process.env.STARKSCAN_BASE_URL ?? "https://starkscan.co/api",
		chainId: "SN_MAIN",
		chainId: process.env.STARKSCAN_CHAIN ?? "SN_MAIN",
		});

		const status = await starkscan.status();
		console.log(status.chainId, status.latestBlockNumber);
		console.log(status.chainId);
		```

		## Trust links
		## What this package is for

		- Build server-side integrations against certified Starkscan API routes.
		- Keep Starknet data access behind `X-Starkscan-Api-Key` and request IDs.
		- Give agents a typed client instead of hand-written fetch wrappers.

		## Trust model

		- `latest` fails closed by design until stable GA.
		- `alpha` is the beta channel; use exact pins for unattended jobs.
		- Package metadata links to public docs because the canonical engineering repo is private.
		- Package trust, release policy, and Socket/OpenSSF signals are documented at
		<https://starkscan.co/docs/build/package-trust>.

		## Links

		- SDK docs: <https://starkscan.co/docs/sdk/typescript>
		- API docs: <https://starkscan.co/docs/api>
		- Package trust: <https://starkscan.co/docs/build/package-trust>
		- SDK docs: <https://starkscan.co/docs/sdk/typescript>
		- npm alpha: <https://www.npmjs.com/package/@starkscan/sdk?activeTab=versions>
		- npm versions: <https://www.npmjs.com/package/@starkscan/sdk?activeTab=versions>

@starkscan/sdk - npm Package Compare versions

Improved metrics