From 2ad12cb659ef8d4db7b19ebc17bf04f9b5171416 Mon Sep 17 00:00:00 2001 From: Florian Pellissier <111426680+flopell@users.noreply.github.com> Date: Tue, 20 Aug 2024 09:06:52 +0200 Subject: [PATCH] docs(indexing): miscellaneous small docs improvements --- docs/indexing/reserved-attributes.md | 12 ++++++------ docs/indexing/substreams-integration.md | 2 +- testing/README.md | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/indexing/reserved-attributes.md b/docs/indexing/reserved-attributes.md index f1c7ea0..a65a7ea 100644 --- a/docs/indexing/reserved-attributes.md +++ b/docs/indexing/reserved-attributes.md @@ -1,10 +1,10 @@ # Reserved attribute names -Certain attribute names are reserved exclusively for specific purposes. Please use them only for their intended functions +Certain attribute names are reserved exclusively for specific purposes. Please use them only for their intended applications. ## Static Attributes -The following attributes names are reserved and must be given using `ProtocolComponent.static_att`. +The following attributes names are reserved and must be given using `ProtocolComponent.static_att`. These attributes MUST be immutable. If it can ever change, it should be given as a state attribute (see below) for this component id. - ### **pool_id** @@ -32,11 +32,11 @@ change: ChangeType::Creation.into(), The `manual_updates` static attribute determines whether the component update should be manually triggered using the `update_marker` state attribute. By default, updates occur automatically whenever there is a change in any of the required contracts. However, in scenarios where a contract undergoes frequent changes, automatic updates may not be desirable. For instance, a change in Balancer Vault storage should only trigger updates for the specific pools affected by the change, rather than for all pools indiscriminately. The `manual_updates` field helps to control and prevent unnecessary updates in such cases. -If it's set to `[1u8]`, updates on this component are only triggered by emitting an `update_marker` state attribute (described below). +If it's enable, updates on this component are only triggered by emitting an `update_marker` state attribute (described below). #### Type -This attribute value must be provided as bytes. +This attribute must be set to [1u8] to enable manual updates. #### Example Usage @@ -50,7 +50,7 @@ change: ChangeType::Creation.into(), ## State Attributes -The following attributes names are reserved and must be given using `EntityChanges`. +The following attributes names are reserved and must be given using `EntityChanges`. Unlike [Static Attributes](#static-attributes), state attributes are used for dynamic attributes and are allowed to change at anytime. - ### **stateless_contract_addr** @@ -127,7 +127,7 @@ change: ChangeType::Creation.into(), #### Description -The `balance_owner` field is used to specify the address of the account that owns the protocol component tokens, in cases where the tokens are not owned by the protocol component itself. This is particularly useful for protocols that use a vault, for example Balancer. +The `balance_owner` field is used to specify the address of the account that owns the protocol component tokens, in cases where the tokens are not owned by the protocol component itself or the component specifies multiple contract addresses. This is particularly useful for protocols that use a vault, for example Balancer. #### Type diff --git a/docs/indexing/substreams-integration.md b/docs/indexing/substreams-integration.md index 7f747d7..93efd85 100644 --- a/docs/indexing/substreams-integration.md +++ b/docs/indexing/substreams-integration.md @@ -20,7 +20,7 @@ So basically when processing a block we need to emit the block itself, all trans #### Models -The models below are used for communication between Substreams and our indexer, as well as between Substreams modules. +The models below are used for communication between Substreams and Tycho indexer, as well as between Substreams modules. Our indexer expects to receive a `BlockChanges` output from your Substreams package. diff --git a/testing/README.md b/testing/README.md index f760dde..49dd028 100644 --- a/testing/README.md +++ b/testing/README.md @@ -11,8 +11,7 @@ Additionally, it will also try to simulate some transactions using the `SwapAdap ## Prerequisites -- Latest version of our indexer, Tycho. Please contact us to obtain the latest version. Once acquired, place it in the - `/usr/local/bin/` directory. +- Latest version of our indexer, Tycho. Please contact us to obtain the latest version. Once acquired, place it in a directory that is included in your system’s PATH. - Access to PropellerHeads' private PyPI repository. Please contact us to obtain access. - Docker installed on your machine. - [Conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) @@ -48,6 +47,7 @@ The script to generate this file manually is available under `evm/scripts/buildR ### Step 2: Create python virtual environment for testing Run setup env script. It will create a conda virtual env and install all dependencies. +This script must be run from within the `propeller-protocol-lib/testing` directory. Please note that some dependencies require access to our private PyPI repository.