README.md

Get the gopher Starkpilled

starknet.go will get your golang backends and WASM frontends to Starknet easily. With simple abstractions for the Starknet RPC, account management and common operations on the wallets. The package has excellent documentation for a smooth 0 to 1 experience.

🌟 Features

• Seamless interaction with the Starknet RPC
• Tight integration with Juno
• Account management: Deploy accounts easily
• Good concurrency support

Getting Started

• library documentation available at pkg.go.dev.
• simple call example to make a contract call to a testnet contract.
• deploy account example to deploy a new account contract on testnet.
• invoke transaction example to add a new invoke transaction on testnet.
• deploy contract UDC example to deploy an ERC20 token using UDC (Universal Deployer Contract) on testnet.

Run Examples

starknet simpleCall

cd examples/simpleCall
go run main.go

Check here for more details

starknet deployAccount

cd examples/deployAccount
go run main.go

Check here for more details

starknet invokeTransaction

cd examples/simpleInvoke
go run main.go

Check here for more details

starknet deployContractUDC

cd examples/deployContractUDC
go run main.go

Check here for more details.

Check here for some FAQ answered by these examples.

RPC

starknet.go RPC implements the Starknet RPC v0.7.1 spec

Method	Implemented (*)
starknet_getBlockWithReceipts	✔️
starknet_getBlockWithTxHashes	✔️
starknet_getBlockWithTxs	✔️
starknet_getStateUpdate	✔️
starknet_getStorageAt	✔️
starknet_getTransactionByHash	✔️
starknet_getTransactionByBlockIdAndIndex	✔️
starknet_getTransactionReceipt	✔️
starknet_getTransactionStatus	✔️
starknet_getClass	✔️
starknet_getClassHashAt	✔️
starknet_getClassAt	✔️
starknet_getBlockTransactionCount	✔️
starknet_call	✔️
starknet_estimateFee	✔️
starknet_estimateMessageFee	✔️
starknet_blockNumber	✔️
starknet_blockHashAndNumber	✔️
starknet_chainId	✔️
starknet_syncing	✔️
starknet_getEvents	✔️
starknet_getNonce	✔️
starknet_addInvokeTransaction	✔️
starknet_addDeclareTransaction	✔️
starknet_addDeployAccountTransaction	✔️
starknet_traceTransaction	✔️
starknet_simulateTransaction	✔️
starknet_specVersion	✔️
starknet_traceBlockTransactions	✔️

Run Tests

go test -v ./...

Run RPC Tests

go test -v ./rpc -env [mainnet|devnet|testnet|mock]

Run Benchmarks

go test -bench=.

Compatibility and stability

🤝 Contribute

We're always looking for passionate developers to join our community and contribute to starknet.go. Check out our contributing guide for more information on how to get started.

📖 License

This project is licensed under the MIT license.

See LICENSE for more information.

Happy coding! 🎉

Contributors ✨

Thanks goes to these wonderful people (emoji key):

drspacemn 💻	Gregory Guillou 💻	Tarrence van As 💻	Alex Sumner 💻	Yun 💻	Zoraiz Mahmood 💻	Lucas @ StarkWare 💻
Coburn 💻	Larko 💻	oxlime 💻	Blaž Hrastnik 💻	Florian 💻	greged93 💻	Jean-Sébastien Ney 💻
Kristijan Rebernisak 💻	Rian Hughes 💻	Carmen Irene Cabrera Rodríguez 💻	Josh Klopfenstein 💻	Antonio Quental 📖	Jelilat Anofiu 💻	Jorik Schellekens 📖
Akashneelesh 💡	Fico 💻	Bitcoinnoobie 💻	stranger80 💻	omahs 📖

This project follows the all-contributors specification. Contributions of any kind welcome!