@starkscan/sdk - npm Package Compare versions

Comparing version

+2

index.d.ts

		export declare function createStarkscanClient(): never;
		export declare function stableChannelUnavailable(): never;

+10

index.js

		const message =
		"@starkscan/sdk stable channel is not released yet. Install @starkscan/sdk@alpha or pin an exact 0.1.0-alpha.x version.";

		export function createStarkscanClient() {
		throw new Error(message);
		}

		export function stableChannelUnavailable() {
		throw new Error(message);
		}

+21

LICENSE

		MIT License

		Copyright (c) 2026 Starkscan contributors

		Permission is hereby granted, free of charge, to any person obtaining a copy
		of this software and associated documentation files (the "Software"), to deal
		in the Software without restriction, including without limitation the rights
		to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
		copies of the Software, and to permit persons to whom the Software is
		furnished to do so, subject to the following conditions:

		The above copyright notice and this permission notice shall be included in all
		copies or substantial portions of the Software.

		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
		IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
		FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
		AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
		LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
		OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
		SOFTWARE.

+40

-7

package.json

		{
		"name": "@starkscan/sdk",
		"version": "0.0.0",
		"description": "Stable placeholder for the Starkscan SDK. Install @starkscan/sdk@alpha for the current beta.",
		"private": false,
		"version": "0.0.1",
		"description": "Stable placeholder for the Starkscan TypeScript SDK. Use @starkscan/sdk@alpha for the current beta.",
		"license": "MIT",
		"type": "module",
		"main": "./dist/index.js",
		"types": "./dist/index.d.ts",
		"sideEffects": false,
		"publishConfig": {
		"access": "public"
		},
		"homepage": "https://starkscan.co/docs/sdk/typescript",
		"bugs": {
		"url": "https://starkscan.co/docs/build/package-trust"
		},
		"repository": {
		"type": "git",
		"url": "https://github.com/starknet-innovation/mezcal",
		"directory": "webapp/packages/stable-placeholders/sdk"
		},
		"keywords": [
		"starkscan",
		"starknet",
		"block-explorer",
		"cairo",
		"web3",
		"api-client",
		"sdk",
		"typescript"
		],
		"files": [
		"index.js",
		"index.d.ts",
		"README.md",
		"dist"
		"LICENSE"
		],
		"publishConfig": {
		"access": "public"
		"main": "./index.js",
		"types": "./index.d.ts",
		"exports": {
		".": {
		"types": "./index.d.ts",
		"import": "./index.js"
		}
		},
		"engines": {
		"node": ">=18"
		}
		}

+33

-2

README.md

		# @starkscan/sdk

		The stable Starkscan SDK channel is not released yet.
		Stable channel placeholder for the Starkscan TypeScript SDK.

		Use the beta explicitly:
		The production `latest` channel is not released yet. This package exists so
		`npm install @starkscan/sdk` fails closed instead of installing a moving alpha.

		## Current beta

		Install the alpha channel explicitly:

		```bash
		@@ -11,1 +16,27 @@ npm install @starkscan/sdk@alpha

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

		```bash
		npm install @starkscan/sdk@0.1.0-alpha.2
		```

		## Minimal alpha usage

		```ts
		import { createStarkscanClient } from "@starkscan/sdk";

		const starkscan = createStarkscanClient({
		apiKey: process.env.STARKSCAN_API_KEY!,
		baseUrl: process.env.STARKSCAN_BASE_URL ?? "https://starkscan.co/api",
		chainId: "SN_MAIN",
		});

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

		## Trust links

		- 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>

-2

dist/index.d.ts

		export {};

-4

dist/index.js

		throw new Error(
		"The stable @starkscan/sdk channel is not released yet. Install the beta with: npm install @starkscan/sdk@alpha",
		);

New alerts