# `Cartouche.Receipt`
[🔗](https://github.com/zenhive/cartouche/blob/main/lib/cartouche/receipt.ex#L1)

Represents an Ethereum transaction receipt, which contains information
about the success or failure of an Ethereum transaction after it has
been included in a mined Ethereum block.

See `Cartouche.RPC.get_transaction_receipt` for getting receipts from
an Ethereum JSON-RPC host.

# `t`

```elixir
@type t() :: %Cartouche.Receipt{
  blob_gas_price: non_neg_integer() | nil,
  blob_gas_used: non_neg_integer() | nil,
  block_hash: <<_::256>>,
  block_number: integer(),
  contract_address: <<_::160>> | nil,
  cumulative_gas_used: integer(),
  effective_gas_price: integer(),
  from: <<_::160>>,
  gas_used: integer(),
  logs: [Cartouche.Receipt.Log.t()],
  logs_bloom: <<_::1024>>,
  status: integer(),
  to: <<_::160>> | nil,
  transaction_hash: <<_::256>>,
  transaction_index: integer(),
  type: integer()
}
```

# `deserialize`

```elixir
@spec deserialize(map()) :: t() | no_return()
```

Deserializes a transaction receipt as serialized by an Ethereum JSON-RPC response.

See also https://ethereum.org/en/developers/docs/apis/json-rpc#eth_gettransactionreceipt

## Examples

    iex> use Cartouche.Hex
    iex> %{
    ...>   "blockHash" => "0xa957d47df264a31badc3ae823e10ac1d444b098d9b73d204c40426e57f47e8c3",
    ...>   "blockNumber" => "0xeff35f",
    ...>   "contractAddress" => nil,
    ...>   "cumulativeGasUsed" => "0xa12515",
    ...>   "effectiveGasPrice" => "0x5a9c688d4",
    ...>   "from" => "0x6221a9c005f6e47eb398fd867784cacfdcfff4e7",
    ...>   "gasUsed" => "0xb4c8",
    ...>   "logs" => [%{
    ...>     "logIndex" => "0x1",
    ...>     "blockNumber" => "0x1b4",
    ...>     "blockHash" => "0xaa8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d",
    ...>     "transactionHash" =>  "0xaadf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf",
    ...>     "transactionIndex" => "0x0",
    ...>     "address" => "0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d",
    ...>     "data" => "0x0000000000000000000000000000000000000000000000000000000000000000",
    ...>     "topics" => [
    ...>       "0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5"
    ...>     ]
    ...>   }],
    ...>   "logsBloom" => "0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001",
    ...>   "status" => "0x1",
    ...>   "to" => "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
    ...>   "transactionHash" =>
    ...>     "0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5",
    ...>   "transactionIndex" => "0x66",
    ...>   "type" => "0x2"
    ...> }
    ...> |> Cartouche.Receipt.deserialize()
    %Cartouche.Receipt{
      transaction_hash: ~h[0x85d995eba9763907fdf35cd2034144dd9d53ce32cbec21349d4b12823c6860c5],
      transaction_index: 0x66,
      block_hash: ~h[0xa957d47df264a31badc3ae823e10ac1d444b098d9b73d204c40426e57f47e8c3],
      block_number: 0xeff35f,
      from: ~h[0x6221a9c005f6e47eb398fd867784cacfdcfff4e7],
      to: ~h[0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2],
      cumulative_gas_used: 0xa12515,
      effective_gas_price: 0x5a9c688d4,
      blob_gas_used: nil,
      blob_gas_price: nil,
      gas_used: 0xb4c8,
      contract_address: nil,
      logs: [
        %Cartouche.Receipt.Log{
          log_index: 1,
          block_number: 0x01b4,
          block_hash: ~h[0xaa8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcfdf829c5a142f1fccd7d],
          transaction_hash: ~h[0xaadf829c5a142f1fccd7d8216c5785ac562ff41e2dcfdf5785ac562ff41e2dcf],
          transaction_index: 0,
          address: ~h[0x16c5785ac562ff41e2dcfdf829c5a142f1fccd7d],
          data: ~h[0x0000000000000000000000000000000000000000000000000000000000000000],
          topics: [
            ~h[0x59ebeb90bc63057b6515673c3ecf9438e5058bca0f92585014eced636878c9a5]
          ]
        }
      ],
      logs_bloom: ~h[0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001],
      type: 0x02,
      status: 0x01,
    }

    iex> use Cartouche.Hex
    iex> %{
    ...>   "transactionHash" => "0xf9e69be4f1ae524854e14dc820c519d8f2b86e52c60e54448abf920d22fb6fe2",
    ...>   "transactionIndex" => "0x0",
    ...>   "blockHash" => "0x4bc3c26b1a599ced9876d9bf9a17c9bd58ec8b71a68e75335de7f2820e9336ca",
    ...>   "blockNumber" => "0xa01df4",
    ...>   "from" => "0xb03d1100c68e58aa1895f8c1f230c0851ff41851",
    ...>   "to" => "0x9d8ec03e9ddb71f04da9db1e38837aaac1782a97",
    ...>   "cumulativeGasUsed" => "0x365b2",
    ...>   "gasUsed" => "0x365b2",
    ...>   "contractAddress" => nil,
    ...>   "logs" => [
    ...>     %{
    ...>       "address" => "0x9d8ec03e9ddb71f04da9db1e38837aaac1782a97",
    ...>       "topics" => [
    ...>         "0x3ffe5de331422c5ec98e2d9ced07156f640bb51e235ef956e50263d4b28d3ae4",
    ...>         "0x0000000000000000000000002326aba712500ae3114b664aeb51dba2c2fb416d",
    ...>         "0x0000000000000000000000002326aba712500ae3114b664aeb51dba2c2fb416d"
    ...>       ],
    ...>       "data" =>
    ...>         "0x000000000000000000000000cb372382aa9a9e6f926714f4305afac4566f75380000000000000000000000000000000000000000000000000000000000000000",
    ...>       "blockHash" => "0x4bc3c26b1a599ced9876d9bf9a17c9bd58ec8b71a68e75335de7f2820e9336ca",
    ...>       "blockNumber" => "0xa01df4",
    ...>       "transactionHash" =>
    ...>         "0xf9e69be4f1ae524854e14dc820c519d8f2b86e52c60e54448abf920d22fb6fe2",
    ...>       "transactionIndex" => "0x0",
    ...>       "logIndex" => "0x0",
    ...>       "removed" => false
    ...>     },
    ...>     %{
    ...>       "address" => "0xcb372382aa9a9e6f926714f4305afac4566f7538",
    ...>       "topics" => [
    ...>         "0xe0d20d95fbbe7375f6edead77b5ce5c5b096e7dac85848c45c37a95eaf17fe62",
    ...>         "0x0000000000000000000000009d8ec03e9ddb71f04da9db1e38837aaac1782a97",
    ...>         "0x00000000000000000000000054f0a87eb5c8c8ba70243de1ac19e735b41b10a2",
    ...>         "0x0000000000000000000000000000000000000000000000000000000000000000"
    ...>       ],
    ...>       "data" => "0x0000000000000000000000000000000000000000000000000000000000000000",
    ...>       "blockHash" => "0x4bc3c26b1a599ced9876d9bf9a17c9bd58ec8b71a68e75335de7f2820e9336ca",
    ...>       "blockNumber" => "0xa01df4",
    ...>       "transactionHash" =>
    ...>         "0xf9e69be4f1ae524854e14dc820c519d8f2b86e52c60e54448abf920d22fb6fe2",
    ...>       "transactionIndex" => "0x0",
    ...>       "logIndex" => "0x1",
    ...>       "removed" => false
    ...>     },
    ...>     %{
    ...>       "address" => "0xcb372382aa9a9e6f926714f4305afac4566f7538",
    ...>       "topics" => ["0x0000000000000000000000000000000000000000000000000000000000000055"],
    ...>       "data" => "0x",
    ...>       "blockHash" => "0x4bc3c26b1a599ced9876d9bf9a17c9bd58ec8b71a68e75335de7f2820e9336ca",
    ...>       "blockNumber" => "0xa01df4",
    ...>       "transactionHash" =>
    ...>         "0xf9e69be4f1ae524854e14dc820c519d8f2b86e52c60e54448abf920d22fb6fe2",
    ...>       "transactionIndex" => "0x0",
    ...>       "logIndex" => "0x2",
    ...>       "removed" => false
    ...>     }
    ...>   ],
    ...>   "status" => "0x1",
    ...>   "logsBloom" =>
    ...>     "0x00800000000000000000000400000000000000000000000000000000000000000000000000000000000000000000002000200040000000000000000200001000000000000000000000000000000000000000000000000000000000000010000000008000020000004000000200000800000000000000000000220000000000000000000000000800000000000400000000000000000000000000000000000000000000040000000000008000008000000000000000000000000000000004000000800000000000004000000000000000000000000000000004080000000020000000000000000080000000000000000000000000000000000000000000000000",
    ...>   "type" => "0x0",
    ...>   "effectiveGasPrice" => "0x47868c0a",
    ...>   "deposit_nonce" => nil
    ...> }
    ...> |> Cartouche.Receipt.deserialize()
    %Cartouche.Receipt{
      transaction_hash: ~h[0xf9e69be4f1ae524854e14dc820c519d8f2b86e52c60e54448abf920d22fb6fe2],
      transaction_index: 0,
      block_hash: ~h[0x4bc3c26b1a599ced9876d9bf9a17c9bd58ec8b71a68e75335de7f2820e9336ca],
      block_number: 10493428,
      from: ~h[0xb03d1100c68e58aa1895f8c1f230c0851ff41851],
      to: ~h[0x9d8ec03e9ddb71f04da9db1e38837aaac1782a97],
      cumulative_gas_used: 222642,
      effective_gas_price: 1200000010,
      blob_gas_used: nil,
      blob_gas_price: nil,
      gas_used: 222642,
      contract_address: nil,
      logs: [
        %Cartouche.Receipt.Log{
          log_index: 0,
          block_number: 10493428,
          block_hash: ~h[0x4bc3c26b1a599ced9876d9bf9a17c9bd58ec8b71a68e75335de7f2820e9336ca],
          transaction_hash: ~h[0xf9e69be4f1ae524854e14dc820c519d8f2b86e52c60e54448abf920d22fb6fe2],
          transaction_index: 0,
          address: ~h[0x9d8ec03e9ddb71f04da9db1e38837aaac1782a97],
          data: ~h[0x000000000000000000000000cb372382aa9a9e6f926714f4305afac4566f75380000000000000000000000000000000000000000000000000000000000000000],
          topics: [
            ~h[0x3ffe5de331422c5ec98e2d9ced07156f640bb51e235ef956e50263d4b28d3ae4],
            ~h[0x0000000000000000000000002326aba712500ae3114b664aeb51dba2c2fb416d],
            ~h[0x0000000000000000000000002326aba712500ae3114b664aeb51dba2c2fb416d]
          ]
        },
        %Cartouche.Receipt.Log{
          log_index: 1,
          block_number: 10493428,
          block_hash: ~h[0x4bc3c26b1a599ced9876d9bf9a17c9bd58ec8b71a68e75335de7f2820e9336ca],
          transaction_hash: ~h[0xf9e69be4f1ae524854e14dc820c519d8f2b86e52c60e54448abf920d22fb6fe2],
          transaction_index: 0,
          address: ~h[0xcb372382aa9a9e6f926714f4305afac4566f7538],
          data: ~h[0x0000000000000000000000000000000000000000000000000000000000000000],
          topics: [
            ~h[0xe0d20d95fbbe7375f6edead77b5ce5c5b096e7dac85848c45c37a95eaf17fe62],
            ~h[0x0000000000000000000000009d8ec03e9ddb71f04da9db1e38837aaac1782a97],
            ~h[0x00000000000000000000000054f0a87eb5c8c8ba70243de1ac19e735b41b10a2],
            ~h[0x0000000000000000000000000000000000000000000000000000000000000000]
          ]
        },
        %Cartouche.Receipt.Log{
          log_index: 2,
          block_number: 10493428,
          block_hash: ~h[0x4bc3c26b1a599ced9876d9bf9a17c9bd58ec8b71a68e75335de7f2820e9336ca],
          transaction_hash: ~h[0xf9e69be4f1ae524854e14dc820c519d8f2b86e52c60e54448abf920d22fb6fe2],
          transaction_index: 0,
          address: ~h[0xcb372382aa9a9e6f926714f4305afac4566f7538],
          data: <<>>,
          topics: [
            ~h[0x0000000000000000000000000000000000000000000000000000000000000055]
          ]
        }
      ],
      logs_bloom: ~h[0x00800000000000000000000400000000000000000000000000000000000000000000000000000000000000000000002000200040000000000000000200001000000000000000000000000000000000000000000000000000000000000010000000008000020000004000000200000800000000000000000000220000000000000000000000000800000000000400000000000000000000000000000000000000000000040000000000008000008000000000000000000000000000000004000000800000000000004000000000000000000000000000000004080000000020000000000000000080000000000000000000000000000000000000000000000000],
      type: 0,
      status: 1
    }

---

*Consult [api-reference.md](api-reference.md) for complete listing*