🐺 Starknet TypeScript types 🚀 definitions for Starknet projects

Installation

RPC 0.10.3 - beta (stable not yet released)

npm version	Spec
npm i @starknet-io/[email protected]	rc3 - latest beta
npm i @starknet-io/[email protected]	rc2
npm i @starknet-io/[email protected]	rc1
npm i @starknet-io/[email protected]	rc0

RPC 0.10.2 - latest (Starknet 0.14.2)

npm i @starknet-io/[email protected]

RPC 0.10.0 - (Starknet 0.14.1)

npm i @starknet-io/[email protected]

RPC 0.9 - (Starknet 0.14)

npm i @starknet-io/[email protected]

RPC 0.8 - old (Starknet 0.13)

npm i @starknet-io/[email protected]

Types

API Starknet JSON RPC Specification

// type import
import type { SomeApiType } from '@starknet-io/types-js';
// or entire namespace import
import { API } from '@starknet-io/types-js';

Wallet API Wallet JSON RPC Specification

// type import
import type { SomeWalletApiType } from '@starknet-io/types-js';
// or entire namespace import
import { WALLET_API } from '@starknet-io/types-js';

SNIPs StarkNet Improvement Proposals

• SNIP-12 Hashing and signing typed structured data - /src/wallet-api/typedData.ts

// type import
import type { TypedData } from '@starknet-io/types-js';

• SNIP-29 Applicative paymaster API standard

// namespace import
import { PAYMASTER_API } from '@starknet-io/types-js';

Versioning

MAJOR and MINOR version of this package follows starknet-spec semantic versioning. The PATCH version can diverge based on the bug fixes.

Ex. Starknet types-js v0.10 == Starknet Spec v0.10

To prevent auto update of the minor, meaning significant RPC JSON specification change use fixed or patch range ex. ~0.9.0

Devs Build

npm run build

Devs Testing

npm run lint

License

This repository is licensed under the MIT License, see LICENSE for more information.