commonMain.dev.icerock.moko.web3.entity.TransactionReceipt.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of web3 Show documentation

Add description

There is a newer version: 0.18.4-ktor2_ionspinbignum

/*
 * Copyright 2020 IceRock MAG Inc. Use of this source code is governed by the Apache 2.0 license.
 */

@file:UseSerializers(BigIntegerSerializer::class)

package dev.icerock.moko.web3.entity

import com.ionspin.kotlin.bignum.integer.BigInteger
import dev.icerock.moko.web3.BlockHash
import dev.icerock.moko.web3.TransactionHash
import dev.icerock.moko.web3.WalletAddress
import dev.icerock.moko.web3.serializer.BigIntegerSerializer
import kotlinx.serialization.*

@Serializable
data class TransactionReceipt(
    /** 32 Bytes - hash of the block where this transaction was in **/
    @SerialName("blockHash")
    private val _blockHash: String,
    /** 20 Bytes - address of the sender **/
    @SerialName("from")
    private val _from: String,
    /** 20 Bytes - address of the receiver. Null when the transaction is a contract creation transaction **/
    @SerialName("to")
    private val _to: String?,
    /** 32 Bytes - hash of the transaction **/
    @SerialName("transactionHash")
    private val _transactionHash: String,
    /** block number where this transaction was in **/
    val blockNumber: BigInteger,
    /** 20 Bytes - the contract address created, if the transaction was a contract creation, otherwise - null **/
    val contractAddress: String?,
    /** the total amount of gas used when this transaction was executed in the block **/
    val cumulativeGasUsed: BigInteger,
    /** the amount of gas used by this specific transaction alone **/
    val gasUsed: BigInteger,
    /** Array of log objects, which this transaction generated **/
    val logs: List,
    /** 256 Bytes - Bloom filter for light clients to quickly retrieve related logs **/
    val logsBloom: String,
    /** either 1 (success) or 0 (failure) **/
    val status: Status,
    /** integer of the transactions index position in the block **/
    val transactionIndex: BigInteger,
    /** The transaction type: 0x0 for Legacy transactions, 0x1 for Access List transactions, 0x2 for 1559 Transactions **/
    val type: BigInteger,
    /** optional, didn't document, found in rinkeby response **/
    val effectiveGasPrice: BigInteger? = null
) {
    @Transient
    val receiverAddress: WalletAddress? = this._to?.let { WalletAddress(it) }

    @Transient
    val senderAddress: WalletAddress = WalletAddress(this._from)

    @Transient
    val txHash: TransactionHash = TransactionHash(this._transactionHash)

    @Transient
    val blockHash: BlockHash = BlockHash(this._blockHash)

    @Serializable
    enum class Status {
        @SerialName("0x1")
        SUCCESS,

        @SerialName("0x0")
        FAILURE
    }

    @Serializable
    enum class Type {
        @SerialName("0x0")
        Legacy,

        @SerialName("0x1")
        AccessList,

        @SerialName("0x2")
        EIP1559
    }
}