Getting Started
Installation​
# use the main branch
npm install starknet
# to use latest features (merges in develop branch)
npm install starknet@next
Running test locally​
With Devnet​
Get the Sequencer Devnet with Docker:
docker pull shardlabs/starknet-devnet:latest
docker run -p 5050:5050 shardlabs/starknet-devnet:latest --seed 0
Open a new console tab, go to your starknet.js directory, and run:
npm run test # all tests
npm run test ./__tests__/contract.test.ts # just one test suite
By default, defaultProvider tests will be run through the Sequencer.
If you want to run defaultProvider through the RPC run:
export TEST_RPC_URL = "http://127.0.0.1:5050/rpc"
# only RPC related tests:
npm run test ./__tests__/rpcProvider.test.ts
Running docs locally​
If you want to change 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 compiled_contracts directory.