[!CAUTION]

This repository is no longer under maintenance and will be archived soon.

Thank you to all contributors and users who supported starknet.go over the years.

The codebase remains available in read-only mode for reference purposes.

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.
• declare transaction example to add a new contract on testnet.
• deploy contract UDC example to deploy an ERC20 token using UDC (Universal Deployer Contract) on testnet.
• paymaster example to learn how to interact with a paymaster and send transactions with it.
• typed data example to sign and verify a typed data.
• websocket example to learn how to subscribe to WebSocket methods.

RPC

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

| Method | Implemented (*) | | ------------------------------------------ | ------------------ | | starknetgetBlockWithReceipts | :heavycheck_mark: | | starknetgetBlockWithTxHashes | :heavycheck_mark: | | starknetgetBlockWithTxs | :heavycheck_mark: | | starknetgetStateUpdate | :heavycheck_mark: | | starknetgetStorageAt | :heavycheck_mark: | | starknetgetTransactionByHash | :heavycheck_mark: | | starknetgetTransactionByBlockIdAndIndex | :heavycheck_mark: | | starknetgetTransactionReceipt | :heavycheck_mark: | | starknetgetTransactionStatus | :heavycheck_mark: | | starknetgetClass | :heavycheck_mark: | | starknetgetClassHashAt | :heavycheck_mark: | | starknetgetClassAt | :heavycheck_mark: | | starknetgetBlockTransactionCount | :heavycheck_mark: | | starknetcall | :heavycheck_mark: | | starknetestimateFee | :heavycheck_mark: | | starknetestimateMessageFee | :heavycheck_mark: | | starknetblockNumber | :heavycheck_mark: | | starknetblockHashAndNumber | :heavycheck_mark: | | starknetchainId | :heavycheck_mark: | | starknetsyncing | :heavycheck_mark: | | starknetgetEvents | :heavycheck_mark: | | starknetgetNonce | :heavycheck_mark: | | starknetaddInvokeTransaction | :heavycheck_mark: | | starknetaddDeclareTransaction | :heavycheck_mark: | | starknetaddDeployAccountTransaction | :heavycheck_mark: | | starknettraceTransaction | :heavycheck_mark: | | starknetsimulateTransaction | :heavycheck_mark: | | starknetspecVersion | :heavycheck_mark: | | starknettraceBlockTransactions | :heavycheck_mark: | | starknetgetStorageProof | :heavycheck_mark: | | starknetgetMessagesStatus | :heavycheck_mark: | | starknetgetCompiledCasm | :heavycheck_mark: |

WebSocket Methods

| Method | Implemented (*) | | ------------------------------------------ | ------------------ | | starknetsubscribeEvents | :heavycheck_mark: | | starknetsubscribeNewHeads | :heavycheck_mark: | | starknetsubscribeNewTransactions | :heavycheck_mark: | | starknetsubscribeNewTransactionReceipts | :heavycheck_mark: |

Run Tests

go test -v ./...

Run RPC Tests

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

Run Benchmarks

go test -bench=.

📖 License

This project is licensed under the MIT license.

See LICENSE for more information.

Happy coding! 🎉

Contributors ✨

Thanks goes to these wonderful people