Getting Started

Installation

# use the main branch

npm install starknet

# to use latest features (merges in develop branch)

npm install starknet@next

Running tests locally

Local tests rely on Starknet Devnet, a local testnet emulation.

Launch a Devnet instance and run:

npm run test # all tests
npm run test ./__tests__/contract.test.ts # just one test suite

Running docs locally

If you want to make changes to the documentation and see how it looks before making a PR:

cd www
npm install # install docusaurus
npm run start # fires up a local documentation site

Compiling Starknet contracts

Please check the Starknet documentation here to compile Starknet contracts.

Additional helpful resources can also be found at OpenZeppelin documentation site.

Interacting with contracts and accounts

For a basic overview on how to interact with contracts and accounts continue following this guide.

For some more extensive examples visit PhilippeR26's workshop.

Contracts used in the guides

You can find the compiled contracts used in these guides in the __mocks__ directory.