flip/optimism-models
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/optimism-models.git synced 2026-02-06 12:51:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

remove docs

Browse Source
This commit is contained in:
drethereum 2024-06-25 15:15:35 -06:00
parent 708f6f8e5a
commit 31debc6992
2 changed files with 0 additions and 442 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

359
models/doc_descriptions/olas/olas_columns_docs.md
View File

@ -1,359 +0,0 @@
{% docs olas_name %}
The registered name of the Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_description %}
The registered description of the Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_registry_id %}
The unique identifier associated with the registered Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_registry_type %}
The type of registered Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_trait_type %}
The trait type for the registered Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_trait_value %}
The trait value for the registered Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_token_uri_link %}
The metadata link for the registered Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_code_uri_link %}
The metadata link for the registered Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_image_link %}
The link to the image of the registered Unit (Agent, Component) or Service.
{% enddocs %}
{% docs olas_owner_address %}
The address of the owner.
{% enddocs %}
{% docs olas_token_address %}
The address of the token.
{% enddocs %}
{% docs olas_amount_unadj %}
The value of the asset, non-decimal adjusted.
{% enddocs %}
{% docs olas_amount %}
The value of the asset, decimal adjusted.
{% enddocs %}
{% docs olas_amount_usd %}
The value of the asset, denominated in USD where available.
{% enddocs %}
{% docs olas_lp_token_address %}
The address of the liquidity pool (LP) token.
{% enddocs %}
{% docs olas_lp_token_amount_unadj %}
The value of the liquidity pool (LP) token, non-decimal adjusted.
{% enddocs %}
{% docs olas_lp_token_amount %}
The value of the liquidity pool (LP) token, decimal adjusted.
{% enddocs %}
{% docs olas_product_id %}
The unique identifier of the corresponding product.
{% enddocs %}
{% docs olas_bond_id %}
The unique identifier of the bond.
{% enddocs %}
{% docs olas_maturity_timestamp %}
The maturity date and time of the bond.
{% enddocs %}
{% docs olas_is_redeemed %}
Boolean to indicate whether the bond has been redeemed or not.
{% enddocs %}
{% docs olas_account_address %}
The address of the account.
{% enddocs %}
{% docs olas_unlock_timestamp %}
The date and time that the asset unlocks for redemption.
{% enddocs %}
{% docs olas_donor_address %}
The address of the donor.
{% enddocs %}
{% docs olas_service_id %}
The unique identifier of the registered Service.
{% enddocs %}
{% docs olas_eth_amount_unadj %}
The value of the asset, non-decimal adjusted.
{% enddocs %}
{% docs olas_eth_amount %}
The value of the asset, decimal adjusted.
{% enddocs %}
{% docs olas_eth_amount_usd %}
The value of the asset, denominated in USD.
{% enddocs %}
{% docs olas_total_eth_unadj %}
The total value of the asset for the event, non-decimal adjusted.
{% enddocs %}
{% docs olas_total_eth %}
The total value of the asset for the event, decimal adjusted.
{% enddocs %}
{% docs olas_total_eth_usd %}
The total value of the asset for the event, denominated in USD.
{% enddocs %}
{% docs olas_multisig_address %}
The address of the multi-signature wallet, typically a GnosisSafe.
{% enddocs %}
{% docs olas_service_metadata_link %}
The link to the metadata for the registered Service.
{% enddocs %}
{% docs olas_unit_id %}
The unique identifier of the registered Unit.
{% enddocs %}
{% docs olas_u_type %}
The type of unit, in fixed number format.
{% enddocs %}
{% docs olas_unit_type %}
The type of unit, in human-readable format.
{% enddocs %}
{% docs olas_unit_hash %}
The hash of the unit.
{% enddocs %}
{% docs olas_unit_metadata_link %}
The link to the metadata for the registered Unit (Agent, Component).
{% enddocs %}
{% docs olas_lp_token_name %}
The name of the liquidity pool (LP) token.
{% enddocs %}
{% docs olas_source_chain %}
The source chain of the bridged liquidity pool (LP) token.
{% enddocs %}
{% docs olas_segmented_data %}
The raw emitted event log data, segmented into a variant column for further manual decoding and analysis.
{% enddocs %}
{% docs olas_request_id %}
The unique identifier of the request.
{% enddocs %}
{% docs olas_sender_address %}
The address of the sender.
{% enddocs %}
{% docs olas_prompt_link %}
The metadata link to the prompt.
{% enddocs %}
{% docs olas_delivery_link %}
The metadata link to the prompt response / delivery data.
{% enddocs %}
{% docs olas_token_symbol %}
The symbol of the token.
{% enddocs %}
{% docs olas_program_name %}
The name of the staking program.
{% enddocs %}
{% docs olas_reward_unadj %}
The value of the reward, non-decimal adjusted.
{% enddocs %}
{% docs olas_reward %}
The value of the reward, decimal adjusted.
{% enddocs %}
{% docs olas_epoch %}
The period or unit of time.
{% enddocs %}
{% docs olas_epoch_length %}
The length of the period or unit of time.
{% enddocs %}
{% docs olas_total_available_rewards_unadj %}
The total rewards available in the event, non-decimal adjusted.
{% enddocs %}
{% docs olas_total_available_rewards %}
The total rewards available in the event, decimal adjusted.
{% enddocs %}
{% docs olas_service_inactivity %}
The period in which the service is inactive.
{% enddocs %}
{% docs olas_nonces %}
The position of the event.
{% enddocs %}
{% docs olas_data_payload %}
The raw data emitted from the event.
{% enddocs %}
{% docs olas_metadata_link %}
A link to the request or delivery metadata.
{% enddocs %}
{% docs olas_staker_address %}
The address of the staker.
{% enddocs %}
{% docs olas_agent_ids %}
The unique identifier of the Agent, which is a fundamental component of a Service.
{% enddocs %}
{% docs olas_subcomponent_ids %}
The unique identifier of the sub-components that make up the Agent or Component.
{% enddocs %}

83
models/doc_descriptions/olas/olas_table_docs.md
View File

@ -1,83 +0,0 @@
{% docs olas_dim_registry_metadata_table_doc %}
This table contains dimensional metadata for the registry contracts, including details about the various Agent, Component and Service entities registered in the OLAS ecosystem. The metadata is sourced via contract reads on the tokenURI function, and typically direct to IPFS.
{% enddocs %}
{% docs olas_ez_service_registrations_table_doc %}
This convenience table contains fact-based records of service registrations within the OLAS protocol, capturing essential information about each registered service event and includes a join on the `dim_registry_metadata` table for additional details pertaining to each service_id, such as name and description.
{% enddocs %}
{% docs olas_fact_service_event_logs_table_doc %}
This fact-based table contains all emitted event logs related to registered services and service multisigs within the OLAS protocol. This is accomplished by joining all events where the transaction's `origin_to_address` = `multisig_address` to showcase the onchain interactions with each service. If a service does not have an associated multisig, it will not be included in this table.
{% enddocs %}
{% docs olas_ez_olas_bonding_table_doc %}
This convenience table tracks OLAS token bonding events and the amount of OLAS bonded, in addition to other related details. The Autonolas Tokenomics bonding mechanism enables users holding supported LP-pair assets to deposit them into the Autonolas depository smart contract. In return, they receive OLAS tokens at a discount relative to the price quoted on the relevant DEX after a vesting time. For more information, please visit Olas' [Official Documentation](https://docs.autonolas.network/protocol/tokenomics/#incentivizing-software-developers).
{% enddocs %}
{% docs olas_ez_olas_locking_table_doc %}
This convenience table captures the locking of OLAS tokens for Voting Escrow OLAS (veOLAS), including information on the amount locked and the duration of the lock-up periods.
{% enddocs %}
{% docs olas_ez_service_donations_table_doc %}
This convenience table records ETH donations made to services within the OLAS ecosystem, including the donor, recipient service, and amount donated, denominated in ETH and USD.
{% enddocs %}
{% docs olas_ez_unit_registrations_table_doc %}
This convenience table contains fact-based records of unit registrations (Agents and Components) within the OLAS protocol, capturing essential information about each registered unit event and includes a join on the `dim_registry_metadata` table for additional details pertaining to each unit_id, such as name and description.
{% enddocs %}
{% docs olas_fact_pol_transfers_table_doc %}
This fact-based table tracks Protocol Owned Liquidity (POL) transfers, recording the movement of LP tokens owned by the OLAS protocol (Treasury: `0xa0da53447c0f6c4987964d8463da7e6628b30f82`). For more information on the LP tokens being tracked, please visit Olas' [Bonding Documentation](https://bond.olas.network/).
{% enddocs %}
{% docs olas_ez_olas_staking_table_doc %}
This fact-based convenience table contains OLAS token staking events, including deposits (Stake), withdrawals (Unstake), and amount USD where available.
{% enddocs %}
{% docs olas_ez_service_staking_table_doc %}
This fact-based convenience table contains Service staking events, including epoch, owner and multisig addresses, the relevant staking program, and an additional join on the `dim_registry_metadata` table for details pertaining to each service_id, such as name and description.
{% enddocs %}
{% docs olas_fact_mech_activity_table_doc %}
This fact-based table contains all mech requests (prompts) and delivered data, including offchain metadata links to view the requests/responses to/from AI models. For more information, please visit Olas' [Official Mech Documentation](https://docs.autonolas.network/product/mechkit/).
{% enddocs %}
{% docs olas_ez_mech_activity_table_doc %}
This convenience table consolidates mech request and delivery activities within the OLAS protocol, combining request and delivery data (`prompt` and `deliver` links) into a unified set of records, emulating the format of the [AIMechs app](https://aimechs.autonolas.network/mech).
{% enddocs %}
{% docs olas_ez_service_checkpoints_table_doc %}
This fact-based convenience table contains decoded service Checkpoint events from various applicable staking contracts and programs, and includes a join on the `dim_registry_metadata` table for additional details pertaining to each service_id, such as name and description.
{% enddocs %}
{% docs olas_ez_service_evictions_table_doc %}
This fact-based convenience table contains decoded ServiceEvicted events on various applicable staking contracts and programs, and includes a join on the `dim_registry_metadata` table for additional details pertaining to each service_id, such as name and description.
{% enddocs %}