kirugan / starknet-go-book

Starknet Development with Go

A little guide book on Starknet Development with Go (golang)

Online

https://gostarknetbook.org

E-book

The e-book is avaiable in different formats.

• [PDF (todo)]
• [EPUB (todo)]
• [MOBI (todo)]

Languages

• English
• Russian (todo)

Contents

• Introduction
• Client
  • Setting up the Client
• Felts
  • Using felts
• Accounts
  • Account Balances
  • Generating New Public-Private Keys
  • Generating New Keystores
• Transactions
  • Querying Blocks
  • Querying Transactions
  • Transferring Tokens
  • Subscribing to New Blocks
  • Create Raw Transaction
  • Send Raw Transaction
• Smart Contracts
  • Smart Contract Compilation & ABI
  • Deploying a Smart Contract
  • Loading a Smart Contract
  • Querying a Smart Contract
  • Writing to a Smart Contract
  • Reading Smart Contract Bytecode
  • Querying an ERC20 Token Smart Contract
• Event Logs
  • Subscribing to Event Logs
  • Reading Event Logs
  • Reading ERC-20 Token Event Logs
• Signatures
  • Generating Signatures](en/signature-generate/README.md)
  • Verifying Signatures
• Testing
  • Faucets
• Utilities
  • Collection of Utility Functions
• Glossary
• Resources

Help & Support

We recommend checking out Starknets official online-communities web page, where you can get help and interact with Starknet communities all around the world. The Starknet documentation is also a great place to get a better understanding of how the Starknet blockchain functions.

Development

todo

Install dependencies:

make install

Run gitbook server:

make serve

Generating e-book in pdf, mobi, and epub format:

make ebooks

Visit http://localhost:4000

Gitbook issues

How to fix the following error:

if (cb) cb.apply(this, arguments)
                 ^

TypeError: cb.apply is not a function

Apply this fix

Contributing

Pull requests are welcome!

If making general content fixes:

• please double check for typos and cite any relevant sources in the comments.

If updating code examples:

• make sure to update both the code in the markdown files as well as the code in the code folder.

If wanting to add a new translation, follow these instructions:

1. Set up development environment
2. Add language to LANGS.md
3. Copy the the en directory and rename it with the 2 letter language code of the language you're translating to (e.g. zh)
4. Translate content
5. Set "root" to "./" in book.json if not already set

Thanks

This book takes heavy inspiration from the amazing ethereum-development-with-go-book. We highly recommend checking out this book if you're interested in learning how to interact with the Ethereum blockchain.

Todo.

License

Released under the CC0-1.0 license. © todo

starknet-go-book's Issues

Update clients intro readme

Update this https://github.com/kirugan/starknet-go-book/blob/main/en/client/README.md

Update main image

Update the belly of the beast from showing an Ethereum logo to a Starknet logo

Update intro readme

Update this https://github.com/kirugan/starknet-go-book/blob/main/en/README.md

create felts section

Update main README

Determine which sections to drop / add to the readme

Setting up the client section

Need to write content and code for how to connect to a client using starknet.go