Skip to main content
Version: Next

Starknet.js API

Provider

The Provider API allows you to interact with the Starknet network, without signing transactions or messages.

Typically, these are read calls on the blockchain.

Guide is here.

Account

Account extends Provider and inherits all of its methods.

It also introduces new methods that allow Accounts to create and verify signatures with a custom Signer, declare and deploy Contracts and new Accounts.

This API is the primary way to interact with an account contract on Starknet.

Guide is here.

Contract

Contract's API manages interactions with a smart contract based on a supplied ABI. It issues call and invoke requests to Starknet and applies appropriate data transformations to represent Cairo types in JavaScript.

Contracts allow you to transform Cairo values, like Uint256 to BigNumber. It could also allow users to pass their own transformers, similar to JSON.parse.

Guide is here.

Signer

The Signer API allows you to sign transactions and messages, and also allows you to get the public key.

Utils

Util functions are provided so you can use various low level functions in your application:

elliptic curve

hash

num

encode

merkle

shortString

stark

uint256