Package Logo
mantra_common
mantra-common@v0.1.1
Total Downloads
362
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

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

map
filtered_events

afc9aef4f07d6f67eaebb905df9075aad7c35fdc
Default param : (type:rewards && attr:validator)
substreams gui mantra-common@v0.1.1 filtered_events

map
filtered_event_groups

16b758040c284d8a22a01a7ece1bee7ce98a5186
Default param : type:rewards && attr:validator
substreams gui mantra-common@v0.1.1 filtered_event_groups

map
filtered_events_by_attribute_value

a0c9151169201ec3072d6faf76910ddfc6523376
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.1 filtered_events_by_attribute_value

map
filtered_event_groups_by_attribute_value

2b127c4bde96997bd6e8998e52b6f31a251fd208
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.1 filtered_event_groups_by_attribute_value

map
cosmos:all_events

b24f0114dba246b557c98626b3682edcc82b4c47

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.1 cosmos:all_events

map
cosmos:filtered_events

789e4e1c8d63071bb476b79fc2e0dbbbf7d3daca
Default param : (type:rewards && attr:validator)
substreams gui mantra-common@v0.1.1 cosmos:filtered_events

map
cosmos:filtered_event_groups

a81bc4ee8195d3b4411ae565349c03f12381b344
Default param : type:rewards && attr:validator
substreams gui mantra-common@v0.1.1 cosmos:filtered_event_groups

map
cosmos:filtered_events_by_attribute_value

a0c9151169201ec3072d6faf76910ddfc6523376
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.1 cosmos:filtered_events_by_attribute_value

map
cosmos:filtered_event_groups_by_attribute_value

2b127c4bde96997bd6e8998e52b6f31a251fd208
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.1 cosmos:filtered_event_groups_by_attribute_value
Block Indexes icon
Block Indexes

blockIndex
index_events

c58e05630f6be72a75791baeadbafbdd865bed48
substreams gui mantra-common@v0.1.1 index_events

blockIndex
cosmos:index_events

c58e05630f6be72a75791baeadbafbdd865bed48
substreams gui mantra-common@v0.1.1 cosmos:index_events
Protobuf

Protobuf Docs Explorer

sf.cosmos.type.v2