substreams_unitest

edgelang

v0.0.0/8 downloads/Repository

Package ref

substreams-unitest@v0.0.0

Download .spkg

Run package

CLI

Run map_pairs from the command line.

substreams run substreams-unitest@v0.0.0 map_pairs --start-block -1

Authenticate by running substreams auth or directly on thegraph.market (see docs).

README

Uniswap V2 Substreams Example

Graph

graph TD;
  map_pairs[map: map_pairs]
  sf.ethereum.type.v1.Block[source: sf.ethereum.type.v1.Block] --> map_pairs
  store_tokens[store: store_tokens]
  map_pairs --> store_tokens
  store_pairs[store: store_pairs]
  map_pairs --> store_pairs
  map_reserves[map: map_reserves]
  sf.ethereum.type.v1.Block[source: sf.ethereum.type.v1.Block] --> map_reserves
  store_pairs --> map_reserves
  store_tokens --> map_reserves
  store_reserves[store: store_reserves]
  sf.substreams.v1.Clock[source: sf.substreams.v1.Clock] --> store_reserves
  map_reserves --> store_reserves
  store_pairs --> store_reserves
  ethtokens:map_tokens[map: ethtokens:map_tokens]
  sf.ethereum.type.v1.Block[source: sf.ethereum.type.v1.Block] --> ethtokens:map_tokens
  ethtokens:store_tokens[store: ethtokens:store_tokens]
  ethtokens:map_tokens --> ethtokens:store_tokens

Modules

Execution graph

7 modules

mapMain

map_pairs

from #10008355

Output

uniswap.types.v1.Pairs

Inputs

sf.ethereum.type.v1.Block

map

map_reserves

from #10008355

Output

uniswap.types.v1.Reserves

Inputs

sf.ethereum.type.v1.Block store_pairs store_tokens

store

store_pairs

from #10008355

Store value

proto:uniswap.types.v1.Pair

Update policy

set

Inputs

map_pairs

store

store_reserves

from #10008355

Store value

string

Update policy

set

Inputs

sf.substreams.v1.Clockmap_reserves store_pairs

store

store_tokens

from #10008355

Store value

proto:sf.ethereum.tokens.v1.Token

Update policy

set

Inputs

map_pairs

Show 2 dependencies

map

ethtokens:map_tokens

Output

sf.ethereum.tokens.v1.Tokens

Inputs

sf.ethereum.type.v1.Block

store

ethtokens:store_tokens

Store value

proto:sf.ethereum.tokens.v1.Token

Update policy

set

Inputs

ethtokens:map_tokens

Protobuf

Partial schema — 1 proto file could not be resolved.

sf/substreams/rpc/v2/service.proto

Maintainers: the .spkg does not embed every .proto it imports. Repack with substreams pack and publish a new version.

sf.ethereum.tokens.v1

Tokensmain

sf.ethereum.tokens.v1.Tokens

Token[]tokens = 1

Token

sf.ethereum.tokens.v1.Token

stringaddress = 1

stringname = 2

stringsymbol = 3

uint64decimals = 4

uniswap.types.v1

Pairsmain

uniswap.types.v1.Pairs

Pair[]pairs = 1

Reservesmain

uniswap.types.v1.Reserves

Reserve[]reserves = 1

Pair

uniswap.types.v1.Pair

uint64ordinal = 1

bytesaddress = 2

bytestoken0 = 3

bytestoken1 = 4

Reserve

uniswap.types.v1.Reserve

uint64ordinal = 1

bytespair = 2

stringreserve0 = 3

stringreserve1 = 4

stringtoken0_price = 5

stringtoken1_price = 6

Token

uniswap.types.v1.Token

bytesaddress = 1

stringsymbol = 2

stringname = 3

uint64decimals = 4

Tokens

uniswap.types.v1.Tokens

Token[]tokens = 1

Show 29 dependencies

sf.ethereum.substreams.v1

RpcCall

sf.ethereum.substreams.v1.RpcCall

bytesto_addr = 1

bytesmethod_signature = 2

RpcCalls

sf.ethereum.substreams.v1.RpcCalls

RpcCall[]calls = 1

RpcResponse

sf.ethereum.substreams.v1.RpcResponse

bytesraw = 1

boolfailed = 2

RpcResponses

sf.ethereum.substreams.v1.RpcResponses

RpcResponse[]responses = 1

sf.ethereum.type.v1

AccessTuple

sf.ethereum.type.v1.AccessTuple

AccessTuple represents a list of storage keys for a given contract's address and is used for AccessList construction.

bytesaddress = 1

bytes[]storage_keys = 2

AccountCreation

sf.ethereum.type.v1.AccountCreation

bytesaccount = 1

uint64ordinal = 2

BalanceChange

sf.ethereum.type.v1.BalanceChange

bytesaddress = 1

BigIntold_value = 2

BigIntnew_value = 3

BalanceChange.Reasonreason = 4

uint64ordinal = 5

BigInt

sf.ethereum.type.v1.BigInt

bytesbytes = 1

Block

sf.ethereum.type.v1.Block

int32ver = 1

byteshash = 2

uint64number = 3

uint64size = 4

BlockHeaderheader = 5

BlockHeader[]uncles = 6

TransactionTrace[]transaction_traces = 10

BalanceChange[]balance_changes = 11

CodeChange[]code_changes = 20

BlockHeader

sf.ethereum.type.v1.BlockHeader

bytesparent_hash = 1

bytesuncle_hash = 2

Uncle hash of the block, some refenrece it as sha3Uncles, but sha3`` is badly worded, so we prefer uncle_hash`

bytescoinbase = 3

bytesstate_root = 4

bytestransactions_root = 5

bytesreceipt_root = 6

byteslogs_bloom = 7

BigIntdifficulty = 8

uint64number = 9

uint64gas_limit = 10

uint64gas_used = 11

Timestamptimestamp = 12

bytesextra_data = 13

bytesmix_hash = 14

uint64nonce = 15

byteshash = 16

BigInttotal_difficulty = 17

Sum of all previous blocks difficulty including this block difficulty.

BigIntbase_fee_per_gas = 18

Base fee per gas according to EIP-1559 (e.g. London Fork) rules, only set if London is present/active on the chain.

BlockRef

sf.ethereum.type.v1.BlockRef

byteshash = 1

uint64number = 2

BlockWithRefs

sf.ethereum.type.v1.BlockWithRefs

BlockWithRefs is a lightweight block, with traces and transactions purged from the block within, and only. It is used in transports to pass block data around.

stringid = 1

Blockblock = 2

TransactionRefstransaction_trace_refs = 3

boolirreversible = 4

Call

sf.ethereum.type.v1.Call

uint32index = 1

uint32parent_index = 2

uint32depth = 3

CallTypecall_type = 4

bytescaller = 5

bytesaddress = 6

BigIntvalue = 7

uint64gas_limit = 8

uint64gas_consumed = 9

boolstatus_failed = 10

In Ethereum, a call can be either:

Successfull, execution passes without any problem encountered
Failed, execution failed, and remaining gas should be consumed
Reverted, execution failed, but only gas consumed so far is billed, remaining gas is refunded

When a call is either failed or reverted, the status_failed field below is set to true. If the status is reverted, then both status_failed and status_reverted are going to be set to true.

stringfailure_reason = 11

Populated when a call either failed or reverted, so when status_failed == true, see above for details about those flags.

boolstatus_reverted = 12

bytesreturn_data = 13

bytesinput = 14

boolexecuted_code = 15

boolsuicide = 16

map<string, string>keccak_preimages = 20

hex representation of the hash -> preimage

StorageChange[]storage_changes = 21

BalanceChange[]balance_changes = 22

NonceChange[]nonce_changes = 24

Log[]logs = 25

CodeChange[]code_changes = 26

GasChange[]gas_changes = 28

boolstate_reverted = 30

This field represents wheter or not the state changes performed by this call were correctly recorded by the blockchain.

On Ethereum, a transaction can record state changes even if some of its inner nested calls failed. This is problematic however since a call will invalidate all its state changes as well as all state changes performed by its child call. This means that even if a call has a status of SUCCESS, the chain might have reverted all the state changes it performed.

  Trx 1
   Call #1 <Failed>
     Call #2 <Execution Success>
     Call #3 <Execution Success>
     |--- Failure here
   Call #4

In the transaction above, while Call #2 and Call #3 would have the status EXECUTED

uint64begin_ordinal = 31

uint64end_ordinal = 32

AccountCreation[]account_creations = 33

CodeChange

sf.ethereum.type.v1.CodeChange

bytesaddress = 1

bytesold_hash = 2

bytesold_code = 3

bytesnew_hash = 4

bytesnew_code = 5

uint64ordinal = 6

GasChange

sf.ethereum.type.v1.GasChange

The gas change model represents the reason why some gas cost has occurred. The gas is computed per actual op codes. Doing them completely might prove overwhelming in most cases.

Hence, we only index some of them, those that are costy like all the calls one, log events, return data, etc.

uint64old_value = 1

uint64new_value = 2

GasChange.Reasonreason = 3

uint64ordinal = 4

HeaderOnlyBlock

sf.ethereum.type.v1.HeaderOnlyBlock

HeaderOnlyBlock is used to optimally unpack the [Block] structure (note the corresponding message number for the header field) while consuming less memory, when only the header is desired.

WARN: this is a client-side optimization pattern and should be moved in the consuming code.

BlockHeaderheader = 5

Log

sf.ethereum.type.v1.Log

bytesaddress = 1

bytes[]topics = 2

bytesdata = 3

uint32index = 4

Index is the index of the log relative to the transaction. This index is always populated regardless of the state revertion of the the call that emitted this log.

uint32blockIndex = 6

BlockIndex represents the index of the log relative to the Block.

An important notice is that this field will be 0 when the call that emitted the log has been reverted by the chain.

Currently, there is two locations where a Log can be obtained:

block.transaction_traces[].receipt.logs[]
block.transaction_traces[].calls[].logs[]

In the receipt case, the logs will be populated only when the call that emitted them has not been reverted by the chain and when in this position, the blockIndex is always populated correctly.

In the case of calls case, for call where stateReverted == true, the blockIndex value will always be 0.

uint64ordinal = 7

NonceChange

sf.ethereum.type.v1.NonceChange

bytesaddress = 1

uint64old_value = 2

uint64new_value = 3

uint64ordinal = 4

StorageChange

sf.ethereum.type.v1.StorageChange

bytesaddress = 1

byteskey = 2

bytesold_value = 3

bytesnew_value = 4

uint64ordinal = 5

TransactionReceipt

sf.ethereum.type.v1.TransactionReceipt

bytesstate_root = 1

consensus

uint64cumulative_gas_used = 2

byteslogs_bloom = 3

Log[]logs = 4

TransactionRefs

sf.ethereum.type.v1.TransactionRefs

bytes[]hashes = 1

TransactionTrace

sf.ethereum.type.v1.TransactionTrace

bytesto = 1

consensus

uint64nonce = 2

BigIntgas_price = 3

GasPrice represents the effective price that has been paid for each gas unit of this transaction. Over time, the Ethereum rules changes regarding GasPrice field here. Before London fork, the GasPrice was always set to the fixed gas price. After London fork, this value has different meaning depending on the transaction type (see Type field).

In cases where TransactionTrace.Type == TRX_TYPE_LEGACY || TRX_TYPE_ACCESS_LIST, then GasPrice has the same meaning as before the London fork.

In cases where TransactionTrace.Type == TRX_TYPE_DYNAMIC_FEE, then GasPrice is the effective gas price paid for the transaction which is equals to BlockHeader.BaseFeePerGas + TransactionTrace.

uint64gas_limit = 4

GasLimit is the maximum of gas unit the sender of the transaction is willing to consume when perform the EVM execution of the whole transaction

BigIntvalue = 5

Value is the amount of Ether transferred as part of this transaction.

bytesinput = 6

Input data the transaction will receive for execution of EVM.

bytesv = 7

V is the recovery ID value for the signature Y point.

bytesr = 8

R is the signature's X point on the elliptic curve (32 bytes).

bytess = 9

S is the signature's Y point on the elliptic curve (32 bytes).

uint64gas_used = 10

GasUsed is the total amount of gas unit used for the whole execution of the transaction.

BigIntmax_fee_per_gas = 11

MaxFeePerGas is the maximum fee per gas the user is willing to pay for the transaction gas used.

This will is populated only if TransactionTrace.Type == TRX_TYPE_DYNAMIC_FEE which is possible only if Londong fork is active on the chain.

TransactionTrace.Typetype = 12

Type represents the Ethereum transaction type, available only since EIP-2718 & EIP-2930 activation which happened on Berlin fork. The value is always set even for transaction before Berlin fork because those before the fork are still legacy transactions.

BigIntmax_priority_fee_per_gas = 13

MaxPriorityFeePerGas is priority fee per gas the user to pay in extra to the miner on top of the block's base fee.

This will is populated only if TransactionTrace.Type == TRX_TYPE_DYNAMIC_FEE which is possible only if Londong fork is active on the chain.

AccessTuple[]access_list = 14

AcccessList represents the storage access this transaction has agreed to do in which case those storage access cost less gas unit per access.

This will is populated only if TransactionTrace.Type == TRX_TYPE_ACCESS_LIST || TRX_TYPE_DYNAMIC_FEE which is possible only if Berlin (TRX_TYPE_ACCESS_LIST) nor London (TRX_TYPE_DYNAMIC_FEE) fork are active on the chain.

uint32index = 20