Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: view updated truf.network brand and logo #41

Merged
merged 1 commit into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TRUF Network Docs
# truf.network Docs

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including

Expand Down
12 changes: 6 additions & 6 deletions about-truf-network.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: "About TRUF Network"
description: "An overview of the TRUF Network's mission, token, and infrastructure."
title: "About truf.network"
description: "An overview of the truf.network's mission, token, and infrastructure."
---

The TRUF Network is a decentralized platform that delivers real-time, independent economic and financial data on-chain. By leveraging blockchain technology, it ensures transparency and accuracy in financial metrics, facilitating the tokenization of real-world assets (RWAs). This approach enables seamless integration of real-time data into decentralized finance (DeFi) applications, fostering innovation and trust within the financial ecosystem.
The truf.network is a decentralized platform that delivers real-time, independent economic and financial data on-chain. By leveraging blockchain technology, it ensures transparency and accuracy in financial metrics, facilitating the tokenization of real-world assets (RWAs). This approach enables seamless integration of real-time data into decentralized finance (DeFi) applications, fostering innovation and trust within the financial ecosystem.

At the core of the TRUF Network is the TRUF token, an ERC-20 compatible token on the Ethereum blockchain. The TRUF token serves multiple functions:
At the core of the truf.network is the TRUF token, an ERC-20 compatible token on the Ethereum blockchain. The TRUF token serves multiple functions:

1. **Data Provider Node Operation**: Data providers stake TRUF tokens to operate nodes within the network, ensuring their commitment and alignment with the protocol's objectives.

2. **Data Provision and Consumption**: Users pay TRUF tokens to access data on the network, incentivizing data providers and contributors.

3. **Governance**: Token holders can participate in governance by staking and locking their tokens, allowing them to influence the protocol's future development.

The TRUF Network's infrastructure supports the integration of real-time economic data into DeFi applications, enabling the creation of innovative financial instruments and markets. By providing accurate and up-to-date information, the network enhances liquidity within digital markets and bridges the gap between traditional financial assets and DeFi technology.
The truf.network's infrastructure supports the integration of real-time economic data into DeFi applications, enabling the creation of innovative financial instruments and markets. By providing accurate and up-to-date information, the network enhances liquidity within digital markets and bridges the gap between traditional financial assets and DeFi technology.

In summary, the TRUF Network is dedicated to redefining the future of financial data by offering a decentralized, transparent, and real-time platform for economic metrics, thereby driving the tokenization of real-world assets and fostering innovation in the financial sector.
In summary, the truf.network is dedicated to redefining the future of financial data by offering a decentralized, transparent, and real-time platform for economic metrics, thereby driving the tokenization of real-world assets and fostering innovation in the financial sector.
6 changes: 3 additions & 3 deletions authentication-authorization.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Authentication and Authorization"
description: "Understanding the processes of authentication and authorization within the TRUF Network."
description: "Understanding the processes of authentication and authorization within the truf.network."
---

**Roles and Permissions**

- **Data Providers**: Entities that supply data to the network. They are responsible for ensuring the accuracy and reliability of the data they provide.

- **Data Consumers**: Users or applications that access and utilize the data available on the TRUF Network.
- **Data Consumers**: Users or applications that access and utilize the data available on the truf.network.

For detailed information on obtaining API keys, managing roles, and understanding the TRUF Network's security protocols, please refer to the official [Truflation Whitepaper](https://whitepaper.truflation.com/).
For detailed information on obtaining API keys, managing roles, and understanding the truf.network's security protocols, please refer to the official [Truflation Whitepaper](https://whitepaper.truflation.com/).
18 changes: 9 additions & 9 deletions billing.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: "Billing"
description: "Understand the billing structure and pricing plans for accessing TRUF Network services."
description: "Understand the billing structure and pricing plans for accessing truf.network services."
---

The TRUF Network offers a range of pricing plans to cater to different user needs, from individual investors to large enterprises. Below is an overview of the available plans:
The truf.network offers a range of pricing plans to cater to different user needs, from individual investors to large enterprises. Below is an overview of the available plans:

## Pricing Plans

| Plan | Monthly Cost | Annual Cost (20% Discount) | Features |
|---------------|--------------|----------------------------|----------------------------------------------------------------------------------------------|
| **Basic** | $19.99 | $191.88 | - Unlimited access to core data<br />- Up to 3 years of historical data<br />- Weekly newsletter |
| **Pro** | $888.00 | $8,388.00 | - All Basic features<br />- Access to 50+ subcategories<br />- Up to 5 years of historical data |
| **Enterprise**| Contact Sales| Contact Sales | - Customized data sets<br />- Up to 15 years of historical data<br />- Dedicated support |
| Plan | Monthly Cost | Annual Cost (20% Discount) | Features |
| -------------- | ------------- | -------------------------- | ------------------------------------------------------------------------------------------------ |
| **Basic** | $19.99 | $191.88 | - Unlimited access to core data<br />- Up to 3 years of historical data<br />- Weekly newsletter |
| **Pro** | $888.00 | $8,388.00 | - All Basic features<br />- Access to 50+ subcategories<br />- Up to 5 years of historical data |
| **Enterprise** | Contact Sales | Contact Sales | - Customized data sets<br />- Up to 15 years of historical data<br />- Dedicated support |

*Note: Paying with cryptocurrency offers an additional 20% discount.*
_Note: Paying with cryptocurrency offers an additional 20% discount._

For detailed information on each plan, visit the [Truflation Pricing Page](https://truflation.com/pricing).

Expand All @@ -38,4 +38,4 @@ For more details, refer to the [Truflation Pricing Page](https://truflation.com/
## Contact

Whether you're looking to integrate real-time data feeds, access comprehensive index solutions, or leverage our powerful API for your business needs, our sales team is here to help.
Feel free to fill the [Contact Form](https://truflation.com/contact).
Feel free to fill the [Contact Form](https://truflation.com/contact).
9 changes: 5 additions & 4 deletions bounties-overview.mdx
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
---
title: "Bounty Board"
description: "Explore bounties and get rewarded for contributing to the Truf Network development."
description: "Explore bounties and get rewarded for contributing to the truf.network development."
---

# Developer Bounties Overview

The [**Truf Network Developer Bounties Marketplace**](https://github.com/orgs/trufnetwork/projects/2) is a platform where data consumers can request new data streams and developers can actively contribute to building the Truf Network ecosystem.
The [**truf.network Developer Bounties Marketplace**](https://github.com/orgs/trufnetwork/projects/2) is a platform where data consumers can request new data streams and developers can actively contribute to building the truf.network ecosystem.

## Key Objectives

- **For Data Consumers:** Submit data stream requests to shape the future of Truf Network’s ecosystem.
- **For Data Consumers:** Submit data stream requests to shape the future of truf.network’s ecosystem.
- **For Developers:** Participate in fulfilling critical data needs by building data streams or adapters.

## How It Works

1. Data consumers submit their requests with specific requirements, sources, and offered compensation.
2. Developers can browse the bounty board, pick tasks, and start building.
3. Both parties collaborate through the Truf Network’s GitHub and development tools.
3. Both parties collaborate through the truf.network’s GitHub and development tools.

Explore the individual guides for more details:

- [Data Consumer Guide](./data-consumer-guide)
- [Data Provider Guide](./data-provider-guide)
6 changes: 4 additions & 2 deletions bug-report.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Bug Reporting Guide
description: Instructions for reporting bugs in the TRUF Network.
description: Instructions for reporting bugs in the truf.network.
---

If you find a bug in the **TRUF Network (TN)** or its related components, please report it in the centralized GitHub Discussions space for bug reports.
If you find a bug in the **truf.network (TN)** or its related components, please report it in the centralized GitHub Discussions space for bug reports.

👉 **[Report a Bug Here](https://github.com/trufnetwork/node/discussions/categories/bug-reports)**

Expand All @@ -14,6 +14,7 @@ If you find a bug in the **TRUF Network (TN)** or its related components, please
1. Go to the [Bug Reports Category](https://github.com/trufnetwork/node/discussions/categories/bug-reports).
2. Open a new discussion and describe the bug clearly.
3. Provide relevant details such as:

- **Version/Commit**: The version or commit hash you’re using if applicable.
- **Operating System**: e.g., Ubuntu 20.04, macOS 13.0.
- **Expected Behavior**: What you expected to happen.
Expand Down Expand Up @@ -44,4 +45,5 @@ For guidance, you can look at the existing bug report template used across repos
---

## Submit Your Report Here:

👉 **[Centralized Bug Reports Space](https://github.com/trufnetwork/node/discussions/categories/bug-reports)**
18 changes: 15 additions & 3 deletions changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: "Changelog"
description: "Summary of changes made to the TRUF Network project."
description: "Summary of changes made to the truf.network project."
---

**TRUF Network Changelog Summary**
**truf.network Changelog Summary**

**v1.1.11** (Released on November 19, 2024)

- **Testing Enhancements:** Implemented tests for composed contracts with start dates.
- **Performance Improvements:** Increased KGW read timeout and synchronized contracts with dynamic weights.
- **Documentation Updates:** Added SDK section to the documentation.
Expand All @@ -14,59 +15,70 @@ description: "Summary of changes made to the TRUF Network project."
- **Consensus Updates:** Updated Kwil to enhance consensus mechanisms.

**v1.1.10** (Released on October 9, 2024)

- **State Synchronization:** Enabled StateSync on TSN servers and introduced snapshot options for new node synchronization.
- **Build Optimizations:** Disabled CGO in releases and adjusted gateway configurations for improved stability.
- **Testing Enhancements:** Added system contract and common contract logic tests.
- **Observability Improvements:** Integrated journald and Docker logs with Vector, and connected logs/metrics to Grafana Cloud.
- **Documentation Updates:** Included a status page in the README.

**v1.1.9** (Released on September 17, 2024)

- **Bug Fixes:** Addressed issues with array element assignments, duplicate date handling in contracts, and test failures.
- **State Synchronization:** Added StateSync functionality to enhance network reliability.

**v1.1.8** (Released on September 10, 2024)

- **Benchmarking Tools:** Introduced a comprehensive benchmark suite with binary and result integration.
- **Build Enhancements:** Compiled benchmark test binaries and implemented launch templates for benchmarking.
- **Contract Optimizations:** Improved contract performance and added relevant tests.
- **Deployment Fixes:** Resolved issues causing testnet downtime.

**v1.1.7** (Released on August 22, 2024)

- **Domain Support:** Updated configurations to support new domains alongside existing ones.
- **Documentation Updates:** Revised staging URLs in the README and removed outdated domain configurations.

**v1.1.6** (Released on August 15, 2024)

- **Metrics Integration:** Enabled local gateway metrics and integrated observability tools.
- **Build Enhancements:** Utilized TSN-operator genesis files and adjusted release packages naming conventions.
- **Continuous Integration:** Released TSN binaries via GitHub releases and implemented deployment stacks with predefined configurations.

**v1.1.5** (Released on August 7, 2024)

- **Code Refactoring:** Refined index change retrieval processes.
- **Documentation Updates:** Clarified system contract terminology.
- **Bug Fixes:** Addressed issues related to metadata insertion and database timeouts.
- **Build Enhancements:** Restored node configurations and replaced in-built database ID generators.

**v1.1.4** (Released on July 23, 2024)

- **Build Updates:** Upgraded Kwil-DB to the preview version and resolved deployment issues affecting multiple nodes.
- **System Contract Fixes:** Addressed timeouts and ensured correct external addresses for TSN nodes.

**v1.1.3** (Released on July 17, 2024)

- **Access Control Fixes:** Resolved issues with reading from private composed streams and direct stream calls.
- **Deployment Enhancements:** Improved resilience of TSN-DB Docker services and addressed consensus errors.
- **Build Updates:** Aligned with stable main versions and fixed build failures due to missing imports.

**v1.1.2** (Released on July 6, 2024)

- **Query Enhancements:** Improved data fetching for composed streams and addressed timeout issues.
- **Metrics Integration:** Enabled local viewing of TSN metrics.
- **Bug Fixes:** Corrected output values and ensured graceful deployment failure handling.
- **Documentation Updates:** Provided examples for using the indexer to obtain TSN metrics.

**v1.1.0** (Released on June 27, 2024)

- **Permission Controls:** Introduced composition permissions and wallet write access.
- **System Contracts:** Deployed system contracts and exposed them for data providers.
- **Documentation Updates:** Removed outdated information from the README.
- **Performance Improvements:** Enhanced query efficiency and upgraded node sizes.

**v1.0.0** (Released on June 12, 2024)

- **Continuous Integration:** Implemented acceptance tests and created Dockerfiles for streamlined deployments.
- **Staging Environment:** Provided a staging server with automated deployment on main branch pushes.
- **Whitelist Extensions:** Added whitelist parameters to primitive schemas and setup configurations.
Expand All @@ -77,4 +89,4 @@ description: "Summary of changes made to the TRUF Network project."
- **Taxonomy Definitions:** Defined and described taxonomies for composed streams.
- **Query Optimizations:** Enhanced query mechanisms for dates with available past data.
- **Documentation Updates:** Added common terminology documents and updated pull request templates.
- **Continuous Integration:** Ensured compliance with Conventional Commits specifications.
- **Continuous Integration:** Ensured compliance with Conventional Commits specifications.
9 changes: 5 additions & 4 deletions data-consumer-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
---
title: "New Data Request"
description: "Request new data stream to be added to Truf Network."
description: "Request new data stream to be added to truf.network."
---

# Data Consumer Guide

Shape the Truf Network by submitting a **New Data Stream Request**.
Shape the truf.network by submitting a **New Data Stream Request**.

## How to Submit a Request

1. Visit the [New Data Stream Request form](https://github.com/trufnetwork/adapters/issues/new?template=new-data-stream-request.md).
2. Fill out the following details:

- **Requirements:** Describe the expected outcome of the data request.
- **Preferred Data Providers:** Name preferred data providers (or leave N/A if no preference).
- **Start Date:** Specify a starting date for the data (or leave N/A if no preference).
- **Update Frequency:** Indicate the data update frequency from the provider and desired update frequency on TRUF Network (or leave N/A if no preference).
- **Update Frequency:** Indicate the data update frequency from the provider and desired update frequency on truf.network (or leave N/A if no preference).
- **Compensation:** Specify the reward in TRUF tokens or other currencies.

## Example Request
Expand All @@ -26,4 +27,4 @@ Shape the Truf Network by submitting a **New Data Stream Request**.
- **Update Frequency:** Daily updates.
- **Compensation:** $800 + 500 TRUF tokens.

Submit your request today and contribute to Truf Network’s growth!
Submit your request today and contribute to truf.network’s growth!
9 changes: 5 additions & 4 deletions data-provider-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
---
title: "New Data Offer"
description: "Propose to add your own data to Truf Network."
description: "Propose to add your own data to truf.network."
---

# Data Provider Guide

Extend your reach to Truf Network consumers by submitting a **New Data Consumption Offer**.
Extend your reach to truf.network consumers by submitting a **New Data Consumption Offer**.

## How to Submit an Offer

1. Visit the [New Data Consumption Offer form](https://github.com/trufnetwork/adapters/issues/new?template=new-data-consumption-offer.md).
2. Provide the following information:
- **Rationale:** A short description of your data and how it contributes to Truf Network.

- **Rationale:** A short description of your data and how it contributes to truf.network.
- **Sample Data:** Attach a sample of your data in CSV or JSON format.
- **Documentation:** Provide relevant documentation, including API docs or other helpful resources.
- **Compensation:** Specify the reward in TRUF tokens or other currencies for developers enabling your stream.
Expand All @@ -24,4 +25,4 @@ Extend your reach to Truf Network consumers by submitting a **New Data Consumpti
- **Documentation:** API docs with endpoints for data retrieval.
- **Compensation:** $1,200 + 1,000 TRUF tokens.

Submit your data consumption offer and empower developers on Truf Network!
Submit your data consumption offer and empower developers on truf.network!
Loading