847850277 / starknet.js-workshop-typescript

Tons of Typescript code examples, to use Starknet.js to interact with Starkware Starknet network (mainly on starknet-devnet-rs)

Starkware Starknet network ^0.13.1

Cairo Accounts and ERC20 Demo

Typescript code, using Starknet.js v6.6.6 and local Starknet-devnet-rs 0.3.0

If you want to implement the Starknet network in your DAPP, you can use starknet.js to interact with it.

These little scripts shows how to use and test very quickly your starknet.js code without any user interface.

Even if these codes are very small, it's a good guideline to always write them in Typescript.

Starknet mainnet and testnet are slow. To speed up the execution, we use Starknet-devnet-rs, that creates a local Starknet network.

🛠️ Installation 🛠️

copy this repo to your local disk. Use cd starknet.js-workshop-typescript to go to the root of the project.

If necessary :

• Install latest LTS version of node here
• Install Starknet-devnet-rs here

Run npm install in this directory.

This repo is configured to be able to perform debugging of your typescript code. Just CTRL+SHIFT+D, then click on the green arrow.

This script has been written with cairo v0.13.1, Starknet-devnet-rs v0.3.0, starknet.js v6.6.6. Due to fast iterations of Starknet and Cairo, these scripts will probably be quickly out-of-date.

The Account contract used in this workshop is made by OpenZeppelin, contract version 0.9.0.

🚀 Start the demo 🚀 🎆 ↘️ 💩

Open a console, and launch the devnet cargo run --release -- --seed 0

Open a second console, and launch the script :
npx ts-node src/starknet_jsNewAccount.ts

When you see that you have to fund your new wallet, it's automatic in devnet.
Faucet for devnet, if necessary :

curl -X POST http://127.0.0.1:5050/mint -d '{"address":"0x1234","amount":50000000000000000000,"lite":true}' -H "Content-Type:application/json"

or source ./src/scripts/mintWallet.sh

More easy : use npx ts-node src/starknet_jsExistingAccount.ts, using preexisting account #0 created automatically during Devnet-rs launch.

📜 scripts :

In the folder 'scripts', you can find many pedagogical codes :

Accounts :

• Create accounts
  • Create OZ account script2
  • Create ArgentX account script3
  • Create Ethereum account script15
  • Create Braavos v1.0.0 account script14
  • Create your abstracted account script10
• Connect account
  • Connect pre-deployed account (only on devnet) script1
  • Connect created account script8

Contracts :

• Declare contract script9
• Deploy contract script4
• Declare & deploy script5

Interactions

• Connect a contract script7
• Call
  • contract.nameFunction workshop
  • contract.call script11
• Invoke
  • without need of signature
    • contract.nameFunction workshop
    • contract.invoke script11
  • with a signature : account.execute workshop

Others :

You can find in this repo tons of other scripts. Dig in and find many useful examples of code.
To simplify the test of these scripts, take advantage to install the extension code runner. In the code window, right click, then run code.

Demo DAPPs :

Be able to create some scripts is a good first step. The next step is the creation of DAPPs (decentralized application) ; see my demo DAPP for Starknet.
I made also an Airdrop DAPP demo.

Explore the code to see how to communicate with the wallet extensions of your browser.

🤔 Questions?

Have a look in the starknet.js documentation.

Ask in #starknet-js channel in the Starknet Discord

Philippe. ROSTAN @ critical.devs.fr - Phil26#1686 on Discord

🙏 Inspiration :

This script is a fork of https://github.com/0xs34n/starknet.js-workshop