Package Logo
mantra_common
mantra-common@v0.1.0
Total Downloads
307
Published
1 months ago
Publisher
User Avatar streamingfast

Readme

mantra-common

Common Mantra Substreams modules to extract events and transactions with indexing This package inherits from the generic Cosmos Foundational Modules.

Usage

Usually, foundational modules are directly imported and used in other Substreams. All the official foundational modules are stored in substreams.dev.

specVersion: v0.1.0
package:
  name: my_project
  version: v0.1.0

imports:
  mantra: https://spkg.io/streamingfast/mantra-common-v0.1.0.spkg # Import the package from substreams.dev

modules:
  - name: my_events # Define your Substreams module
    use: mantra:filtered_events # Use the imported package
    initialBlock: 70000000

params:
  my_events: "(type:message && attr:action) || (type:wasm && attr:_contract_address)" # Pass the filter as parameter to the module

To run the Substreams:

substreams build
substreams auth
substreams gui

Modules

all_events (map)

Retrieves all the events in the Mantra blockchain without any filtering.

index_events (index)

The module create an index (a cache) to efficiently retrieve events by their type and/or attribute keys.

The module sets the keys corresponding to all event 'types' and 'attribute keys' in the block For example: type:coin_received, attr:action, attr:sender ...

The attribute values are never indexed because they have a high cardinality and would be too expensive to index.

filtered_events (map)

The module reads from all_events and applies a filter on the event types and attribute keys, only outputing the events that match the filter.

The filter is specificed in the parameters of the module.

...

params:
  filtered_events: "(type:rewards && attr:validator)"

filtered_event_groups (map)

The module reads from all_events and applies a filter on the event types and attribute keys, outputing all the events from transactions that have at least one event matching the filter.

params:
    filtered_event_groups: "type:rewards && attr:validator"

filtered_events_by_attribute_value (map)

The module reads from all_events and applies a filter on the event types, attribute keys and values, only outputing the events that match the filter.

NOTE: This module does not use the index created by index_events.

params:
    filtered_events_by_attribute_value: "type:rewards && attr:validator:mantravaloper18se5kq0z86pqfym8uuuqp77kyd788npj3wx7fc"

filtered_event_groups_by_attribute_value (map)

The module reads from all_events and applies a filter on the event types, attribute keys and values, outputing all the events from transactions that have at least one event matching the filter.

NOTE: This module does not use the index created by index_events.

params:
    filtered_event_groups_by_attribute_value: "type:rewards && attr:validator:mantravaloper18se5kq0z86pqfym8uuuqp77kyd788npj3wx7fc"

Documentation

Modules

Maps icon
Maps

map
all_events

e6789527fab90caa67cdf81b81c8ed8a0013cb3d
map all_events (
blocksf.cosmos.type.v2.Block
)  -> sf.substreams.cosmos.v1.EventList
substreams gui mantra-common@v0.1.0 all_events

map
filtered_events

81fef2aa7a17af5557fdea8a74d578ab88a643c9
Default param : (type:rewards && attr:validator)
substreams gui mantra-common@v0.1.0 filtered_events

map
filtered_event_groups

710499c1103e346484e0f6b36d2b6f134652497e
Default param : type:rewards && attr:validator
substreams gui mantra-common@v0.1.0 filtered_event_groups

map
filtered_events_by_attribute_value

f036f792461a106acea7eaf89f49f1066e9ab978
map filtered_events_by_attribute_value (
paramsstring
)  -> sf.substreams.cosmos.v1.EventList
Default param : type:rewards && attr:validator:mantravaloper18se5kq0z86pqfym8uuuqp77kyd788npj3wx7fc
substreams gui mantra-common@v0.1.0 filtered_events_by_attribute_value

map
filtered_event_groups_by_attribute_value

47482a15278f3a1dd201cbe12ce064351e38779f
map filtered_event_groups_by_attribute_value (
paramsstring
)  -> sf.substreams.cosmos.v1.EventList
Default param : type:rewards && attr:validator:mantravaloper18se5kq0z86pqfym8uuuqp77kyd788npj3wx7fc
substreams gui mantra-common@v0.1.0 filtered_event_groups_by_attribute_value

map
cosmos:all_events

e6789527fab90caa67cdf81b81c8ed8a0013cb3d

all_events reads from the sf.cosmos.type.v2.Block source and outputs a list of all events in the block. Some events are at the block level, others appear inside the transactions.

substreams gui mantra-common@v0.1.0 cosmos:all_events

map
cosmos:filtered_events

17008787b7608d3e2d1f3c117925355f8cc61e32
Default param : (type:rewards && attr:validator)
substreams gui mantra-common@v0.1.0 cosmos:filtered_events

map
cosmos:filtered_event_groups

0a533b349f076e2bb6b25aec9127fc248bbb50ac
Default param : type:rewards && attr:validator
substreams gui mantra-common@v0.1.0 cosmos:filtered_event_groups

map
cosmos:filtered_events_by_attribute_value

f036f792461a106acea7eaf89f49f1066e9ab978
map cosmos:filtered_events_by_attribute_value (
paramsstring
)  -> sf.substreams.cosmos.v1.EventList
Default param : type:rewards && attr:validator:mantravaloper18se5kq0z86pqfym8uuuqp77kyd788npj3wx7fc
substreams gui mantra-common@v0.1.0 cosmos:filtered_events_by_attribute_value

map
cosmos:filtered_event_groups_by_attribute_value

47482a15278f3a1dd201cbe12ce064351e38779f
map cosmos:filtered_event_groups_by_attribute_value (
paramsstring
)  -> sf.substreams.cosmos.v1.EventList
Default param : type:rewards && attr:validator:mantravaloper18se5kq0z86pqfym8uuuqp77kyd788npj3wx7fc
substreams gui mantra-common@v0.1.0 cosmos:filtered_event_groups_by_attribute_value
Block Indexes icon
Block Indexes

blockIndex
index_events

0d0e90210ce048a30e50747536bf611d6c2edc0e
substreams gui mantra-common@v0.1.0 index_events

blockIndex
cosmos:index_events

0d0e90210ce048a30e50747536bf611d6c2edc0e
substreams gui mantra-common@v0.1.0 cosmos:index_events
Protobuf

Protobuf Docs Explorer

sf.cosmos.type.v2
cosmos.gov.v1beta1
cosmos.msg.v1
injective.peggy.v1
injective.exchange.v1beta1
injective.wasmx.v1
cosmos_proto
injective.crypto.v1beta1.ethsecp256k1
cosmos.slashing.v1beta1
cosmos.upgrade.v1beta1
cosmos.tx.v1beta1
ibc.core.client.v1
cosmwasm.wasm.v1
gogoproto
cosmos.crypto.multisig.v1beta1
cosmos.tx.signing.v1beta1
cosmos.distribution.v1beta1
cosmos.base.v1beta1
cosmos.crisis.v1beta1
cosmos.evidence.v1beta1
ibc.core.channel.v1
injective.oracle.v1beta1
cosmos.authz.v1beta1
cosmos.bank.v1beta1
injective.auction.v1beta1
amino