☕
starknet jvm
☕
StarkNet SDK for JVM languages:
- Java
- Kotlin
- Scala
- Clojure
- Groovy
Table of contents
Documentation
Documentation is provided in two formats:
Example usages
Making synchronous requests
import com.swmansion.starknet.account.Account;
import com.swmansion.starknet.account.StandardAccount;
import com.swmansion.starknet.data.types.BlockTag;
import com.swmansion.starknet.data.types.Felt;
import com.swmansion.starknet.provider.Provider;
import com.swmansion.starknet.provider.Request;
import com.swmansion.starknet.provider.gateway.GatewayProvider;
public class Main {
public static void main(String[] args) {
// Create a provider for interacting with StarkNet
Provider provider = GatewayProvider.makeTestnetClient();
// Create an account interface
Felt accountAddress = Felt.fromHex("0x13241455");
Felt privateKey = Felt.fromHex("0x425125");
Account account = new StandardAccount(provider, accountAddress, privateKey);
// Make a request
Felt contractAddress = Felt.fromHex("0x42362362436");
Felt storageKey = Felt.fromHex("0x13241253414");
Request<Felt> request = account.getStorageAt(contractAddress, storageKey, BlockTag.LATEST);
Felt response = request.send();
System.out.println(response);
}
}
Making asynchronous requests
import com.swmansion.starknet.account.Account;
import com.swmansion.starknet.account.StandardAccount;
import com.swmansion.starknet.data.types.BlockTag;
import com.swmansion.starknet.data.types.Felt;
import com.swmansion.starknet.provider.Provider;
import com.swmansion.starknet.provider.Request;
import com.swmansion.starknet.provider.gateway.GatewayProvider;
import java.util.concurrent.CompletableFuture;
public class Main {
public static void main(String[] args) {
// Create a provider for interacting with StarkNet
Provider provider = GatewayProvider.makeTestnetClient();
// Create an account interface
Felt accountAddress = Felt.fromHex("0x13241455");
Felt privateKey = Felt.fromHex("0x425125");
Account account = new StandardAccount(provider, accountAddress, privateKey);
// Make a request
Felt contractAddress = Felt.fromHex("0x42362362436");
Felt storageKey = Felt.fromHex("0x13241253414");
Request<Felt> request = account.getStorageAt(contractAddress, storageKey, BlockTag.LATEST);
CompletableFuture<Felt> response = request.sendAsync();
response.thenAccept(System.out::println);
}
}
Development
Hooks
Run
./gradlew addKtlintFormatGitPreCommitHook
./gradlew addKtlintCheckGitPreCommitHook
Ensuring idiomatic Java code
We want this library to be used by both kotlin & java users. In order to ensure a nice API for java always follow those rules:
- When using file level functions use
@file:JvmName(NAME)to ensure a nice name withoutKtsuffix. - When using a companion object mark every property/function with
@JvmStatic. This way they are accessible as static from the class. Without itClass.INSTANCEwould have to be used. - When defining an immutable constant use
@field:JvmField. This makes them static properties without getters/setters in java. - If you are not sure how something would work in java just create a new java class, import your code and check yourself.
Building documentation
Documentation is written in Kdoc format and markdown and is generated using Dokka. Execute following commands from /lib to build docs.
./gradlew dokkaHtmlto build kotlin format docs./gradlew dokkaHtmlJavato build java format docs
Generated documentation can be found in their respective folders inside /build/dokka.
8 Nov 2, 2022
28 Nov 14, 2022
10 Dec 30, 2021
1 Dec 8, 2021
60 Dec 18, 2022
24 Aug 20, 2022
2 Dec 14, 2022
4 Aug 6, 2022
14 Nov 15, 2022
2 May 8, 2022
83 Oct 30, 2022
4 May 10, 2022
8 Jul 12, 2022
522 Jan 3, 2023
8 Dec 3, 2021
2 Nov 8, 2021
1 Sep 2, 2022
1k Dec 30, 2022