Support RPC 0.4.0

.gitignore

@@ -48,6 +48,7 @@ venv
 # Exclude account temp files
 lib/src/test/resources/*account
 lib/src/test/resources/compiled*
+integration_tests.env
 
 # Exclude native builds outputs
 crypto/pedersen/crypto-cpp

README.md

@@ -220,21 +220,45 @@ var account2 = new StandardAccount(provider2, accountAddress2, privateKey2);
 ### Hooks
 Run
 ```
-./gradlew addKtlintFormatGitPreCommitHook
-./gradlew addKtlintCheckGitPreCommitHook
+./gradlew installKotlinterPrePushHook
 ```
 
 ## Running tests
 
-Running tests requires to have both cairo-lang and starknet-devnet installed.
-These are distributed as python packages. Run
+### Prerequisites
+Running tests requires to have both `cairo-lang` and `starknet-devnet` installed.
+These are distributed as python packages. To install required dependencies, run:
 
 ```shell
 pip install -r requirements.txt
 ```
+### Regular Tests
+Use the following command to run tests:
+```shell
+./gradlew :lib:test
+```
 
-to install required dependencies.
+### Integration Tests
+Running tests for integration network requires a valid configuration. It can be set using environmental variables in your system or IDE, or by sourcing an `.env` file. 
+Refer to the example config found in [integration_tests.env.example](integration_tests.env.example).
+Please note that while there are publicly accessible gateway URLs, you will additionally need a `RPC node URL` and an `account address` (along with its `private key`), to run these tests.
 
+Integration tests are disabled by default. To enable them, you can set the env variable: 
+```env
+INTEGRATION_TEST_MODE=non_gas
+```
+Some of integration tests require gas and are disabled by default. If you want to run them as well, you can set:
+```env 
+INTEGRATION_TEST_MODE=all
+```
+Please be aware that in that case your integration account address must have a pre-existing balance as these tests will consume some funds.
+
+Alternatively, you can use flag to specify whether to run integration and gas tests:
+```shell
+./gradlew :lib:test -PintegrationTestMode=non_gas
+./gradlew :lib:test -PintegrationTestMode=all
+```
+Flag takes precendece over the env variable if both are set.
 
 ### 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: 

integration_tests.env.example

@@ -0,0 +1,6 @@
+INTEGRATION_TEST_MODE=disabled
+INTEGRATION_RPC_URL=http://example-node-url.com/rpc
+INTEGRATION_GATEWAY_URL=http://example.com/gateway
+INTEGRATION_FEEDER_GATEWAY_URL=http://example.com/feeder_gateway
+INTEGRATION_PRIVATE_KEY=0x123456789
+INTEGRATION_ACCOUNT_ADDRESS=0x123456789123456789123456789123456789123456789123456789123456789

lib/build.gradle.kts

@@ -101,6 +101,12 @@ tasks.test {
     val poseidonPath = file("${rootDir}/crypto/poseidon/build/bindings").absolutePath
 
     systemProperty("java.library.path", "$libsSharedPath:$pedersenPath:$poseidonPath")
+    systemProperty(
+        "integrationTestMode",
+            project.findProperty("integrationTestMode")
+                ?: System.getenv("INTEGRATION_TEST_MODE")
+                ?: "disabled",
+    )
 
     maxParallelForks = (Runtime.getRuntime().availableProcessors() / 2).takeIf { it > 0 } ?: 1
 

lib/src/main/kotlin/com/swmansion/starknet/data/serializers/JsonRpcGetBlockWithTransactionsPolymorphicSerializer.kt

@@ -9,9 +9,12 @@ import kotlinx.serialization.json.JsonElement
 import kotlinx.serialization.json.jsonObject
 
 internal object JsonRpcGetBlockWithTransactionsPolymorphicSerializer : JsonContentPolymorphicSerializer<GetBlockWithTransactionsResponse>(GetBlockWithTransactionsResponse::class) {
-    override fun selectDeserializer(element: JsonElement): DeserializationStrategy<out GetBlockWithTransactionsResponse> =
-        when (element.jsonObject["status"]) {
-            null -> PendingBlockWithTransactionsResponse.serializer()
-            else -> BlockWithTransactionsResponse.serializer()
+    override fun selectDeserializer(element: JsonElement): DeserializationStrategy<out GetBlockWithTransactionsResponse> {
+        val isPendingBlock = listOf("block_hash", "block_number", "new_root").any { it !in element.jsonObject }
+
+        return when (isPendingBlock) {
+            true -> PendingBlockWithTransactionsResponse.serializer()
+            false -> BlockWithTransactionsResponse.serializer()
         }
+    }
 }

lib/src/main/kotlin/com/swmansion/starknet/data/serializers/JsonRpcTransactionReceiptPolymorphicSerializer.kt

@@ -9,15 +9,22 @@ internal object JsonRpcTransactionReceiptPolymorphicSerializer :
     JsonContentPolymorphicSerializer<TransactionReceipt>(TransactionReceipt::class) {
     override fun selectDeserializer(element: JsonElement): DeserializationStrategy<out TransactionReceipt> {
         val jsonElement = element.jsonObject
-        val isPending = "status" !in jsonElement
-        return if (isPending) selectPendingDeserializer(jsonElement) else selectDeserializer(jsonElement)
+        val isPendingTransactionReceipt = listOf("block_hash", "block_number").any { it !in jsonElement }
+
+        return when (isPendingTransactionReceipt) {
+            true -> selectPendingDeserializer(jsonElement)
+            false -> selectDeserializer(jsonElement)
+        }
     }
 
-    private fun selectPendingDeserializer(element: JsonObject): DeserializationStrategy<out TransactionReceipt> =
-        when {
-            "contract_address" in element -> PendingRpcDeployTransactionReceipt.serializer()
-            else -> PendingRpcTransactionReceipt.serializer()
+    private fun selectPendingDeserializer(element: JsonObject): DeserializationStrategy<out TransactionReceipt> {
+        val isDeployTransactionReceipt = "contract_address" in element
+
+        return when (isDeployTransactionReceipt) {
+            true -> PendingRpcDeployTransactionReceipt.serializer()
+            false -> PendingRpcTransactionReceipt.serializer()
         }
+    }
 
     private fun selectDeserializer(element: JsonObject): DeserializationStrategy<out TransactionReceipt> =
         when (element["type"]?.jsonPrimitive?.content) {

lib/src/main/kotlin/com/swmansion/starknet/data/serializers/TransactionPolymorphicSerializer.kt

@@ -27,8 +27,9 @@ internal object TransactionPolymorphicSerializer : JsonContentPolymorphicSeriali
 
     private fun selectDeclareDeserializer(element: JsonElement): DeserializationStrategy<out DeclareTransaction> =
         when (element.jsonObject["version"]?.jsonPrimitive?.content) {
+            Felt.ZERO.hexString() -> DeclareTransactionV0.serializer()
             Felt.ONE.hexString() -> DeclareTransactionV1.serializer()
             Felt(2).hexString() -> DeclareTransactionV2.serializer()
-            else -> throw IllegalArgumentException("Invalid invoke transaction version '${element.jsonObject["version"]?.jsonPrimitive?.content}'")
+            else -> throw IllegalArgumentException("Invalid declare transaction version '${element.jsonObject["version"]?.jsonPrimitive?.content}'")
         }
 }

lib/src/main/kotlin/com/swmansion/starknet/data/types/Messages.kt

@@ -1,51 +1,46 @@
 package com.swmansion.starknet.data.types
 
 import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.JsonNames
 
 @OptIn(ExperimentalSerializationApi::class)
 @Serializable
-data class GatewayMessageL2ToL1(
-    @JsonNames("to_address")
-    val toAddress: Felt,
-
-    @JsonNames("payload")
-    val payload: List<Felt>,
-)
-
-@OptIn(ExperimentalSerializationApi::class)
-@Serializable
-data class GatewayMessageL1ToL2(
-    @JsonNames("from_address")
-    val fromAddress: Felt,
-
-    @JsonNames("payload")
-    val payload: List<Felt>,
-)
-
-@OptIn(ExperimentalSerializationApi::class)
-@Serializable
-data class RpcMessageL2ToL1(
+data class MessageL2ToL1(
     @JsonNames("from_address")
+    @SerialName("from_address")
     val fromAddress: Felt,
 
     @JsonNames("to_address")
+    @SerialName("to_address")
     val toAddress: Felt,
 
     @JsonNames("payload")
+    @SerialName("payload")
     val payload: List<Felt>,
 )
 
 @OptIn(ExperimentalSerializationApi::class)
 @Serializable
-data class RpcMessageL1ToL2(
+data class MessageL1ToL2(
     @JsonNames("from_address")
+    @SerialName("from_address")
     val fromAddress: Felt,
 
     @JsonNames("to_address")
+    @SerialName("to_address")
     val toAddress: Felt,
 
+    @JsonNames("selector", "entry_point_selector")
+    @SerialName("entry_point_selector")
+    val selector: Felt,
+
+    @JsonNames("nonce")
+    @SerialName("nonce")
+    val nonce: Felt? = null,
+
     @JsonNames("payload")
+    @SerialName("payload")
     val payload: List<Felt>,
 )

lib/src/main/kotlin/com/swmansion/starknet/data/types/Payloads.kt

@@ -58,10 +58,7 @@ data class EstimateTransactionFeePayload(
 @Serializable
 data class EstimateMessageFeePayload(
     @SerialName("message")
-    val message: Call,
-
-    @SerialName("sender_address")
-    val senderAddress: Felt,
+    val message: MessageL1ToL2,
 
     @SerialName("block_id")
     override val blockId: BlockId,

lib/src/main/kotlin/com/swmansion/starknet/data/types/Responses.kt

@@ -135,6 +135,8 @@ data class BlockWithTransactionsResponse(
     @SerialName("status")
     val status: BlockStatus,
 
+    // Block header
+
     @SerialName("parent_hash")
     override val parentHash: Felt,
 
@@ -147,35 +149,46 @@ data class BlockWithTransactionsResponse(
     @SerialName("new_root")
     val newRoot: Felt,
 
+    @SerialName("timestamp")
+    override val timestamp: Int,
+
+    @SerialName("sequencer_address")
+    override val sequencerAddress: Felt,
+
+    // Block body
+
     @SerialName("transactions")
     override val transactions: List<
         @Serializable(with = TransactionPolymorphicSerializer::class)
         Transaction,
         >,
 
-    @SerialName("timestamp")
-    override val timestamp: Int,
-
-    @SerialName("sequencer_address")
-    override val sequencerAddress: Felt,
 ) : GetBlockWithTransactionsResponse()
 
 @Serializable
 data class PendingBlockWithTransactionsResponse(
-    @SerialName("parent_hash")
-    override val parentHash: Felt,
+    // Not in RPC schema
+    @SerialName("status")
+    val status: BlockStatus = BlockStatus.PENDING,
+
+    // Block body
 
     @SerialName("transactions")
     override val transactions: List<
         @Serializable(with = TransactionPolymorphicSerializer::class)
         Transaction,
         >,
 
+    // Block info
+
     @SerialName("timestamp")
     override val timestamp: Int,
 
     @SerialName("sequencer_address")
     override val sequencerAddress: Felt,
+
+    @SerialName("parent_hash")
+    override val parentHash: Felt,
 ) : GetBlockWithTransactionsResponse()
 
 @Serializable

lib/src/main/kotlin/com/swmansion/starknet/data/types/transactions/SimulatedTransaction.kt

@@ -5,7 +5,7 @@ import com.swmansion.starknet.data.types.Calldata
 import com.swmansion.starknet.data.types.EstimateFeeResponse
 import com.swmansion.starknet.data.types.EventContent
 import com.swmansion.starknet.data.types.Felt
-import com.swmansion.starknet.data.types.RpcMessageL2ToL1
+import com.swmansion.starknet.data.types.MessageL2ToL1
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
@@ -61,7 +61,7 @@ data class FunctionInvocation(
     val events: List<EventContent>?,
 
     @SerialName("messages")
-    val messages: List<RpcMessageL2ToL1>?,
+    val messages: List<MessageL2ToL1>?,
 )
 
 @Serializable