Web3.js Plugin for Starknet

Web3.js libraries are being sunset on March 4th, 2025. For migration guides and more details please refer to Chainsafe blog

Web3.js plugin for Starknet developers.

RPC Methods

This plugin exposes the following RPC methods (type definitions can be found in src/types.ts):

starknet_call

public async call(
  transaction: CallRequest,
  blockNumber: BlockNumberOrTag
): Promise<HexString[]>

starknet_estimateFee

public async estimateFee(
  request: EstimateFeeRequest["request"],
  blockNumber: BlockNumberOrTag,
  simulationFlags?: EstimateFeeRequest["simulation_flags"]
): Promise<EstimateFeeResponse[]>

starknet_estimateMessageFee

public async estimateMessageFee(
  message: MsgFromL1,
  blockNumber: BlockNumberOrTag
): Promise<EstimateFeeResponse>

starknet_getNonce

public async getNonce(
  address: HexString,
  blockNumber: BlockNumberOrTag
): Promise<HexString>

starknet_getTransactionByBlockIdAndIndex

public async getTransactionByBlockIdAndIndex(
  index: number,
  blockNumber: BlockNumberOrTag
): Promise<TransactionWithHash>

starknet_getTransactionByHash

public async getTransactionByHash(
  transactionHash: HexString
): Promise<TransactionWithHash>

starknet_getTransactionReceipt

public async getTransactionReceipt(
  transactionHash: HexString
): Promise<TransactionReceipt>

starknet_getBlockTransactionCount

public async getBlockTransactionCount(
  blockNumber: BlockNumberOrTag
): Promise<number>

Additional Methods

getPendingTransactions

public async getPendingTransactions(): Promise<TransactionWithHash[]>

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT