diff --git a/README.md b/README.md index 6903b08..61b8491 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/about-truf-network.mdx b/about-truf-network.mdx index 6d4a621..0fc7310 100644 --- a/about-truf-network.mdx +++ b/about-truf-network.mdx @@ -1,11 +1,11 @@ --- -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. @@ -13,6 +13,6 @@ At the core of the TRUF Network is the TRUF token, an ERC-20 compatible token on 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. \ No newline at end of file +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. diff --git a/authentication-authorization.mdx b/authentication-authorization.mdx index 3ec5036..70b2b87 100644 --- a/authentication-authorization.mdx +++ b/authentication-authorization.mdx @@ -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/). \ No newline at end of file +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/). diff --git a/billing.mdx b/billing.mdx index 45bdd15..386482e 100644 --- a/billing.mdx +++ b/billing.mdx @@ -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
- Up to 3 years of historical data
- Weekly newsletter | -| **Pro** | $888.00 | $8,388.00 | - All Basic features
- Access to 50+ subcategories
- Up to 5 years of historical data | -| **Enterprise**| Contact Sales| Contact Sales | - Customized data sets
- Up to 15 years of historical data
- Dedicated support | +| Plan | Monthly Cost | Annual Cost (20% Discount) | Features | +| -------------- | ------------- | -------------------------- | ------------------------------------------------------------------------------------------------ | +| **Basic** | $19.99 | $191.88 | - Unlimited access to core data
- Up to 3 years of historical data
- Weekly newsletter | +| **Pro** | $888.00 | $8,388.00 | - All Basic features
- Access to 50+ subcategories
- Up to 5 years of historical data | +| **Enterprise** | Contact Sales | Contact Sales | - Customized data sets
- Up to 15 years of historical data
- 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). @@ -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). \ No newline at end of file +Feel free to fill the [Contact Form](https://truflation.com/contact). diff --git a/bounties-overview.mdx b/bounties-overview.mdx index 1d92dfd..7322c28 100644 --- a/bounties-overview.mdx +++ b/bounties-overview.mdx @@ -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) diff --git a/bug-report.mdx b/bug-report.mdx index 7cb7ee0..0e1069c 100644 --- a/bug-report.mdx +++ b/bug-report.mdx @@ -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)** @@ -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. @@ -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)** diff --git a/changelog.mdx b/changelog.mdx index 564c78f..060b2c2 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -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. @@ -14,6 +15,7 @@ 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. @@ -21,52 +23,62 @@ description: "Summary of changes made to the TRUF Network project." - **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. @@ -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. \ No newline at end of file +- **Continuous Integration:** Ensured compliance with Conventional Commits specifications. diff --git a/data-consumer-guide.mdx b/data-consumer-guide.mdx index daa024d..7db617d 100644 --- a/data-consumer-guide.mdx +++ b/data-consumer-guide.mdx @@ -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 @@ -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! \ No newline at end of file +Submit your request today and contribute to truf.network’s growth! diff --git a/data-provider-guide.mdx b/data-provider-guide.mdx index a8fe04f..e2db445 100644 --- a/data-provider-guide.mdx +++ b/data-provider-guide.mdx @@ -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. @@ -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! \ No newline at end of file +Submit your data consumption offer and empower developers on truf.network! diff --git a/data-types.mdx b/data-types.mdx index 40172ea..b9eb455 100644 --- a/data-types.mdx +++ b/data-types.mdx @@ -1,9 +1,9 @@ --- title: "Data Types" -description: "Overview of the various data types provided by the TRUF Network." +description: "Overview of the various data types provided by the truf.network." --- -Truf Network provides real-time economic data, including custom indexes like inflation rates, asset prices, and other economic indicators. +truf.network provides real-time economic data, including custom indexes like inflation rates, asset prices, and other economic indicators. ## 1. Real-Time Economic Data @@ -15,4 +15,4 @@ Truf Network provides real-time economic data, including custom indexes like inf - **Asset Prices**: Current valuations of various assets, including commodities, stocks, and cryptocurrencies, providing insights into market trends and investment opportunities. - **Economic Indicators**: Comprehensive data sets covering various economic indicators facilitating macroeconomic analysis and forecasting. -By providing these comprehensive data types, the TRUF Network serves as a vital resource for developers, researchers, and financial professionals seeking reliable and timely economic information. +By providing these comprehensive data types, the truf.network serves as a vital resource for developers, researchers, and financial professionals seeking reliable and timely economic information. diff --git a/developer-guide.mdx b/developer-guide.mdx index ba61a29..a3c2f9e 100644 --- a/developer-guide.mdx +++ b/developer-guide.mdx @@ -1,9 +1,9 @@ --- title: "Setup Local Development" -description: "Set up a local development environment for the TRUF Network." +description: "Set up a local development environment for the truf.network." --- -To set up a local development environment for the TRUF Network, follow these steps: +To set up a local development environment for the truf.network, follow these steps: **Prerequisites** @@ -19,7 +19,7 @@ Ensure the following tools are installed on your system: You can build and run the TRUF-Node using Docker Compose or manually. -*Using Docker Compose (Recommended)* +_Using Docker Compose (Recommended)_ 1. Clone the TSN repository: @@ -36,7 +36,7 @@ task compose This command builds and starts the TRUF-Node in Docker containers with pre-seeded data. -*Manual Build and Run* +_Manual Build and Run_ 1. **Build the Binary**: @@ -73,8 +73,8 @@ kwil-cli configure Provide the following values when prompted: - **Kwil RPC URL**: `http://localhost:8484` -- **Kwil Chain ID**: *(leave blank)* -- **Private Key**: *(any Ethereum private key)* +- **Kwil Chain ID**: _(leave blank)_ +- **Private Key**: _(any Ethereum private key)_ For testing purposes, you can use the private key `0000000000000000000000000000000000000000000000000000000000000001`. @@ -116,7 +116,7 @@ task get-genesis The system contract stores accepted streams by TSN governance and serves as an entry point for queries. -*Fetching Records via System Contract* +_Fetching Records via System Contract_ To fetch records: @@ -142,4 +142,4 @@ For more details on metrics configuration, refer to the files in the `deployment - [Truflation Website](https://truflation.com) - [Truflation Whitepaper](https://whitepaper.truflation.com) -For further assistance, join our [Discord community](https://discord.com/invite/5AMCBYxfW4) or open an issue on our [GitHub repository](https://github.com/trufnetwork/truf-network/issues). \ No newline at end of file +For further assistance, join our [Discord community](https://discord.com/invite/5AMCBYxfW4) or open an issue on our [GitHub repository](https://github.com/trufnetwork/truf-network/issues). diff --git a/favicon.svg b/favicon.svg index 7f77f32..8ed787e 100644 --- a/favicon.svg +++ b/favicon.svg @@ -1,12 +1,5 @@ - - - - - - - - - - - + + + + diff --git a/home.mdx b/home.mdx index 9762005..50c23b3 100644 --- a/home.mdx +++ b/home.mdx @@ -1,6 +1,6 @@ --- title: Home -description: "Welcome to TRUF Network Docs" +description: "Welcome to truf.network Docs" --- @@ -25,33 +25,29 @@ description: "Welcome to TRUF Network Docs" iconType="solid" href="https://github.com/orgs/trufnetwork/discussions" > - - - - - + + + + + diff --git a/how-to-consume.mdx b/how-to-consume.mdx index 57243c0..c93ccfc 100644 --- a/how-to-consume.mdx +++ b/how-to-consume.mdx @@ -1,22 +1,24 @@ --- title: "How to Consume" -description: "Learn how to interact with the TRUF Network using SDKs and API endpoints." +description: "Learn how to interact with the truf.network using SDKs and API endpoints." --- -The TRUF Network provides multiple ways to consume its data. Developers can integrate with the network using SDKs, direct API calls, or predefined API endpoints. Here's how to get started: +The truf.network provides multiple ways to consume its data. Developers can integrate with the network using SDKs, direct API calls, or predefined API endpoints. Here's how to get started: ## 1. SDKs -The TRUF Network offers SDKs for various programming languages, simplifying integration with its services. +The truf.network offers SDKs for various programming languages, simplifying integration with its services. - **Installation**: To get started, install the SDK for your language. For example, in Go: + ```bash go get github.com/trufnetwork/sdk-go ``` - **Usage**: -Use the SDK to interact with the network. Example in Go: + Use the SDK to interact with the network. Example in Go: + ```go package main @@ -68,4 +70,4 @@ func main() { } ``` -For more details, refer to the [SDK Documentation](https://github.com/trufnetwork/sdk-go). \ No newline at end of file +For more details, refer to the [SDK Documentation](https://github.com/trufnetwork/sdk-go). diff --git a/images/partners/opengraph.png b/images/partners/opengraph.png new file mode 100644 index 0000000..5f597ff Binary files /dev/null and b/images/partners/opengraph.png differ diff --git a/incentive-system.mdx b/incentive-system.mdx index 16a613d..44880a9 100644 --- a/incentive-system.mdx +++ b/incentive-system.mdx @@ -1,17 +1,18 @@ --- title: "Incentive System" -description: "Overview of the incentive mechanisms within the TRUF Network." +description: "Overview of the incentive mechanisms within the truf.network." --- # Incentive System -The TRUF Network employs a robust incentive system to ensure data integrity, encourage active participation, and maintain network security. This system is primarily driven by the TRUF token, which serves multiple functions within the ecosystem. +The truf.network employs a robust incentive system to ensure data integrity, encourage active participation, and maintain network security. This system is primarily driven by the TRUF token, which serves multiple functions within the ecosystem. ## 1. Node Operator Incentives -Node operators are crucial for maintaining the decentralized infrastructure of the TRUF Network. Their responsibilities include ensuring data validity, availability, and the computation and distribution of indexes. To align incentives and ensure commitment, node operators are required to stake TRUF tokens in the Governance Portal. This staking mechanism not only secures the network but also grants operators governance rights, allowing them to participate in protocol decision-making processes. +Node operators are crucial for maintaining the decentralized infrastructure of the truf.network. Their responsibilities include ensuring data validity, availability, and the computation and distribution of indexes. To align incentives and ensure commitment, node operators are required to stake TRUF tokens in the Governance Portal. This staking mechanism not only secures the network but also grants operators governance rights, allowing them to participate in protocol decision-making processes. **Key Points:** + - **Staking**: Node operators must stake TRUF tokens to participate in the network. - **Rewards**: Operators earn rewards for their services, which are distributed in TRUF tokens. - **Slashing**: Failure to meet availability or performance requirements can result in slashing of staked tokens, incentivizing consistent and reliable operation. @@ -21,15 +22,17 @@ Node operators are crucial for maintaining the decentralized infrastructure of t Data providers supply the network with accurate and timely data. To join the network, they are required to stake TRUF tokens, ensuring their commitment to data quality. This staking mechanism aligns their incentives with the network's goals, promoting the provision of high-quality, accurate data. Rewards are earned for good performance, while penalties are levied for poor or incorrect data, thus enhancing the system's integrity. **Key Points:** + - **Staking**: Data providers stake TRUF tokens to participate in the network. - **Rewards**: Providers receive TRUF tokens as compensation for supplying accurate data. - **Penalties**: Providing inaccurate data can lead to penalties, including slashing of staked tokens. ## 3. Governance Participation -TRUF token holders can actively participate in the governance of the TRUF Network. By staking and locking their tokens for designated periods, users receive Vote-Escrow TRUF tokens (veTRUF), which grant voting rights in various protocol decision-making proposals. This mechanism ensures that stakeholders have a say in the network's development and direction. +TRUF token holders can actively participate in the governance of the truf.network. By staking and locking their tokens for designated periods, users receive Vote-Escrow TRUF tokens (veTRUF), which grant voting rights in various protocol decision-making proposals. This mechanism ensures that stakeholders have a say in the network's development and direction. **Key Points:** + - **Staking for Governance**: Token holders can stake TRUF tokens to receive veTRUF tokens. - **Voting Rights**: veTRUF tokens grant holders the ability to vote on protocol proposals. - **Influence**: Active participation in governance allows stakeholders to influence the network's future. @@ -39,9 +42,9 @@ TRUF token holders can actively participate in the governance of the TRUF Networ End users, including DeFi, TradFi, and B2B customers, pay for Truflation data streams using TRUF tokens or, in some cases, stablecoins. This payment model ensures a continuous demand for TRUF tokens, aligning the interests of data consumers with the network's economic model. **Key Points:** + - **Payment**: Users pay for data access using TRUF tokens or stablecoins. - **Demand**: This creates a consistent demand for TRUF tokens within the ecosystem. - **Alignment**: Aligns the interests of data consumers with the network's economic model. -By implementing this multifaceted incentive system, the TRUF Network fosters a secure, reliable, and participatory environment for all stakeholders, ensuring the long-term sustainability and success of the ecosystem. - +By implementing this multifaceted incentive system, the truf.network fosters a secure, reliable, and participatory environment for all stakeholders, ensuring the long-term sustainability and success of the ecosystem. diff --git a/logo/dark.svg b/logo/dark.svg deleted file mode 100644 index 8abf82c..0000000 --- a/logo/dark.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/logo/light.svg b/logo/light.svg deleted file mode 100644 index 5fea19d..0000000 --- a/logo/light.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/logo/logo-dark.svg b/logo/logo-dark.svg new file mode 100644 index 0000000..bc0550e --- /dev/null +++ b/logo/logo-dark.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/logo/logo-light.svg b/logo/logo-light.svg new file mode 100644 index 0000000..2a85735 --- /dev/null +++ b/logo/logo-light.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/mint.json b/mint.json index 7137cc5..7450688 100644 --- a/mint.json +++ b/mint.json @@ -1,9 +1,9 @@ { "$schema": "https://mintlify.com/schema.json", - "name": "TRUF Network", + "name": "truf.network", "logo": { - "dark": "/logo/dark.svg", - "light": "/logo/light.svg" + "dark": "/logo/logo-dark.svg", + "light": "/logo/logo-light.svg" }, "favicon": "/favicon.svg", "colors": { diff --git a/node-operator-guide.mdx b/node-operator-guide.mdx index fe65005..04bd17f 100644 --- a/node-operator-guide.mdx +++ b/node-operator-guide.mdx @@ -10,12 +10,15 @@ This guide will walk you through the process of setting up and running a Truflat Before you begin, ensure you have the following: 1. **Kwil-admin**: Used to generate the initial configuration file. + - Download from the [latest GitHub release](https://github.com/kwilteam/kwil-db/releases) 2. **Docker**: Required for running the PostgreSQL image. + - Install from [Docker's official website](https://docs.docker.com/get-docker/) 3. **TSN Binaries**: Necessary for node deployment. + - Download from the [latest GitHub release](https://github.com/trufnetwork/truf-node/releases) ## Setup Steps @@ -110,4 +113,4 @@ When setting up your node, refer to these files for network-specific parameters For further assistance, join our [Discord community](https://discord.com/invite/5AMCBYxfW4) or open an issue on our [GitHub repository](https://github.com/trufnetwork/truf-node-operator/issues). -Welcome to the Truf Network! Your participation helps build a more robust and decentralized data infrastructure. \ No newline at end of file +Welcome to the truf.network! Your participation helps build a more robust and decentralized data infrastructure. diff --git a/node-upgrade.mdx b/node-upgrade.mdx index 98fafd5..e83231f 100644 --- a/node-upgrade.mdx +++ b/node-upgrade.mdx @@ -1,9 +1,9 @@ --- title: "Node Upgrade" -description: "Step-by-step guide to upgrading your node in the TRUF Network." +description: "Step-by-step guide to upgrading your node in the truf.network." --- -Keeping your node up-to-date is crucial for maintaining network security and performance. Follow this guide to upgrade your node in the TRUF Network. +Keeping your node up-to-date is crucial for maintaining network security and performance. Follow this guide to upgrade your node in the truf.network. ## 1. Backup Existing Data @@ -20,7 +20,7 @@ Keeping your node up-to-date is crucial for maintaining network security and per - **New Container**: Create a new PostgreSQL container using the latest Docker image from Kwil: `kwildb/postgres:16.5-1`. - **Shared Memory Size**: Set the shared memory size to `2g` using the `--shm-size` parameter. Adjust this value if necessary. -*Note: An existing container cannot be updated; you must stop the existing container and create a new one.* +_Note: An existing container cannot be updated; you must stop the existing container and create a new one._ ## 4. Remove Specific Directories @@ -38,6 +38,7 @@ In the `config.toml` file located in the `tsn` directory: - **Enable State Sync**: Set `enable = true` in the `[chain.statesync]` section. - **Snapshot Directory**: Set `snapshot_dir` to the appropriate path, e.g., `/data/tsn-root/rcvdSnaps`. - **RPC Servers**: Set `rpc_servers` to the following: + ``` http://staging.node-1.tsn.truflation.com:26657,http://3.92.83.167:26657 ``` @@ -71,4 +72,4 @@ curl -s http://127.0.0.1:26657/abci_info Ensure the `last_block_app_hash` matches the expected value. -For detailed information and advanced configurations, refer to the [TRUF Network Whitepaper](https://whitepaper.truflation.com/). \ No newline at end of file +For detailed information and advanced configurations, refer to the [truf.network Whitepaper](https://whitepaper.truflation.com/). diff --git a/privacy-policy.mdx b/privacy-policy.mdx index 0cf9a85..3bc2ee0 100644 --- a/privacy-policy.mdx +++ b/privacy-policy.mdx @@ -3,7 +3,7 @@ title: "Privacy Policy" description: "Learn how Tru Labs Inc. processes your personal information and your data protection rights." --- -This Privacy Policy sets out how Tru Labs Inc., and its affiliates and subsidiaries ("Truf Network", "truf.network”, "we", "us", "our") processes personally identifiable information (“Personal Information”) that we gather when you are accessing or using the Services provided through our website https://truf.network and the Company’s Platform, it also describes your data protection rights, including the right to object to some of the processing which we carry out. This Privacy Policy does not however cover the use of cookies by any third parties, and we are not responsible for their privacy policies and practices. Please be aware that cookies placed by third parties may continue to track your activities online even after you have left our Services. Your use of truf.network’s Services is at all times subject to our Terms of Service, which incorporates this Privacy Policy. Any terms we use in this Privacy Policy without defining them have the definitions given to them in our Terms of Service. +This Privacy Policy sets out how Tru Labs Inc., and its affiliates and subsidiaries ("truf.network", "truf.network”, "we", "us", "our") processes personally identifiable information (“Personal Information”) that we gather when you are accessing or using the Services provided through our website https://truf.network and the Company’s Platform, it also describes your data protection rights, including the right to object to some of the processing which we carry out. This Privacy Policy does not however cover the use of cookies by any third parties, and we are not responsible for their privacy policies and practices. Please be aware that cookies placed by third parties may continue to track your activities online even after you have left our Services. Your use of truf.network’s Services is at all times subject to our Terms of Service, which incorporates this Privacy Policy. Any terms we use in this Privacy Policy without defining them have the definitions given to them in our Terms of Service. By using or accessing our website and/or the Services in any manner, you acknowledge that you accept the practices and policies outlined in this Privacy Policy, and you hereby consent that we will collect, use, and share your information in the ways described herein. @@ -72,7 +72,7 @@ If you have any questions or concerns regarding this Privacy Policies, please se --- -Powered by TRUF Network +Powered by truf.network [Twitter](https://twitter.com/trufnetwork) diff --git a/sdks.mdx b/sdks.mdx index c524853..19f2926 100644 --- a/sdks.mdx +++ b/sdks.mdx @@ -1,23 +1,23 @@ --- -title: "TRUF Network SDKs" -description: "Learn how to interact with the TRUF Network using SDKs." +title: "truf.network SDKs" +description: "Learn how to interact with the truf.network using SDKs." --- -The TRUF Network offers SDKs in Go and TypeScript/JavaScript to facilitate seamless integration with its decentralized platform for economic data streams. +The truf.network offers SDKs in Go and TypeScript/JavaScript to facilitate seamless integration with its decentralized platform for economic data streams. --- ### What is a `streamID`? -A `streamID` is an identifier used in the TRUF Network (TN) to identify the deployed contract. It is a unique string generated from a descriptive name, such as an English name, to ensure easy reference and management of data streams. +A `streamID` is an identifier used in the truf.network (TN) to identify the deployed contract. It is a unique string generated from a descriptive name, such as an English name, to ensure easy reference and management of data streams. --- ### Go SDK -The Go SDK provides tools to publish, compose, and consume economic data streams within the TRUF Network. It supports operations on primitive streams and composed streams. +The Go SDK provides tools to publish, compose, and consume economic data streams within the truf.network. It supports operations on primitive streams and composed streams. -*Installation:* +_Installation:_ Ensure you have Go 1.20 or later installed. To install the SDK, run: @@ -25,7 +25,7 @@ Ensure you have Go 1.20 or later installed. To install the SDK, run: go get github.com/trufnetwork/sdk-go ``` -*Example Usage:* +_Example Usage:_ ```go package main @@ -85,7 +85,7 @@ For comprehensive examples and usage patterns, refer to the test files in the SD The TypeScript/JavaScript SDK offers similar capabilities as the Go SDK, with implementations tailored for both Node.js and browser environments. -*Installation:* +_Installation:_ Ensure you have Node.js 18 or later installed. To install the SDK, run: @@ -93,15 +93,15 @@ Ensure you have Node.js 18 or later installed. To install the SDK, run: npm install @trufnetwork/truf-node-sdk-js ``` -*Example Usage:* +_Example Usage:_ ```javascript import { NodeTSNClient, StreamId } from "@trufnetwork/truf-node-sdk-js"; // Initialize client const client = new NodeTSNClient({ - privateKey: "", - providerUrl: "https://staging.tsn.truflation.com", + privateKey: "", + providerUrl: "https://staging.tsn.truflation.com", }); // Load an existing stream @@ -110,12 +110,12 @@ const stream = await client.loadPrimitiveStream(streamId); // Read data from the stream const records = await stream.getRecord({ - dateFrom: "2023-01-01", - dateTo: "2023-01-31", + dateFrom: "2023-01-01", + dateTo: "2023-01-31", }); -records.forEach(record => { - console.log(record.dateValue, record.value.toString()); +records.forEach((record) => { + console.log(record.dateValue, record.value.toString()); }); ``` @@ -128,4 +128,4 @@ For detailed examples and usage patterns, refer to the test files in the SDK rep - [Truflation Whitepaper](https://whitepaper.truflation.com/) - [TSN-SDK Documentation](https://github.com/trufnetwork/sdk-go) -For support or questions, please open an issue in the respective SDK repository or contact our support team. \ No newline at end of file +For support or questions, please open an issue in the respective SDK repository or contact our support team. diff --git a/terms-of-service.mdx b/terms-of-service.mdx index 43f71aa..e745099 100644 --- a/terms-of-service.mdx +++ b/terms-of-service.mdx @@ -3,15 +3,15 @@ title: "Terms of Service" description: "These terms of service govern your use of our Company’s Platform and Services." --- -These terms of service, together with any documents and additional terms they incorporate by reference (the “Agreement” or these “Terms”, as amended, supplemented or modified from time to time) are entered into between Tru Labs Inc. (a company registered in the Panama) or any of its current or future subsidiaries, affiliates, successors or assigns (collectively, “Truf Network”, “Company”, “we”, “us” and “our” ) and you or the company or other legal entity that you represent (“you” or “your”). +These terms of service, together with any documents and additional terms they incorporate by reference (the “Agreement” or these “Terms”, as amended, supplemented or modified from time to time) are entered into between Tru Labs Inc. (a company registered in the Panama) or any of its current or future subsidiaries, affiliates, successors or assigns (collectively, “truf.network”, “Company”, “we”, “us” and “our” ) and you or the company or other legal entity that you represent (“you” or “your”). -Please read these Terms carefully as they govern your use of our Company’s Platform as well as our Services (both defined below). These Terms also contain important information about your legal rights and obligations, our disclaimers and limitations of liability for Truf Network and third parties, and a submission to arbitration in case of any dispute. If you do not agree to any of these Terms, you must not access or use our Company’s Platform and Services. Please refer to our Privacy Policy for information about how we collect, use, share and otherwise process information about you. +Please read these Terms carefully as they govern your use of our Company’s Platform as well as our Services (both defined below). These Terms also contain important information about your legal rights and obligations, our disclaimers and limitations of liability for truf.network and third parties, and a submission to arbitration in case of any dispute. If you do not agree to any of these Terms, you must not access or use our Company’s Platform and Services. Please refer to our Privacy Policy for information about how we collect, use, share and otherwise process information about you. You are solely responsible for determining whether the use of any of the Services under this Agreement is legal in your jurisdiction, and you shall not use the Services (defined below) should such use be illegal in your jurisdiction. If you are uncertain, please seek independent legal advice. ## Your Acceptance of These Terms and Any Modifications Thereto -By accessing and using our websites at https://truf.network/, https://docs.truf.network, https://truflation.com, https://governance.truflation.com and any content contained therein (including but not limited to data, series, indices, research, or other analyses) (collectively, the “Services”), whether it be through the internet, our mobile application(s), application programming interfaces and any associated websites (collectively, the “Company’s Platform”), you acknowledge that you have read, understood and hereby agree to always comply with: (a) all of the terms and conditions contained in this Agreement, as well as (b) the personal data and privacy policy adopted by Truf Network from time to time (the “Privacy Policy”) which is available at https://docs.truf.network/privacy-policy/. You further acknowledge when using certain Services on the Company’s Platform, you may be subject to additional terms and conditions applicable to such Services, all of which form an integral part of this Agreement. +By accessing and using our websites at https://truf.network/, https://docs.truf.network, https://truflation.com, https://governance.truflation.com and any content contained therein (including but not limited to data, series, indices, research, or other analyses) (collectively, the “Services”), whether it be through the internet, our mobile application(s), application programming interfaces and any associated websites (collectively, the “Company’s Platform”), you acknowledge that you have read, understood and hereby agree to always comply with: (a) all of the terms and conditions contained in this Agreement, as well as (b) the personal data and privacy policy adopted by truf.network from time to time (the “Privacy Policy”) which is available at https://docs.truf.network/privacy-policy/. You further acknowledge when using certain Services on the Company’s Platform, you may be subject to additional terms and conditions applicable to such Services, all of which form an integral part of this Agreement. We reserve the right to amend or modify this Agreement at our sole discretion at any time and without any notice to you. We therefore encourage you to frequently review the Terms at https://truf.network/terms-of-service/ to ensure you understand the latest terms and conditions that apply to your access and use of the Services. @@ -30,21 +30,21 @@ You hereby represent, warrant and agree that you: ## Licence of Use -Subject to your full compliance with this Agreement, excluding any open source software or third-party software that our websites and Services incorporates, as between you and Truf Network, we hereby grants you with a limited, personal, non-exclusive, revocable, non-transferable and non-sub-licensable licence to use our websites and the Services. All rights not expressly granted to you are reserved by Truf Network, its respective third-party licensor or owners, if any. +Subject to your full compliance with this Agreement, excluding any open source software or third-party software that our websites and Services incorporates, as between you and truf.network, we hereby grants you with a limited, personal, non-exclusive, revocable, non-transferable and non-sub-licensable licence to use our websites and the Services. All rights not expressly granted to you are reserved by truf.network, its respective third-party licensor or owners, if any. -We provide our websites and Services strictly for general informational purposes and you agree to use the content related to the Services solely for personal use. You further agree not to copy, reproduce, edit, transmit, distribute, sell, license, reverse engineer, modify, alter, publish, display or participate in the transfer or sale of, create derivative works from, create any index, enhance, provide access to or in any other way exploit any of the content related to the Services in any manner, including for example any purpose competitive to Truf Network or any commercial purpose, in whole or in part. In case the right to use or access to the websites or the Services is given to a corporate entity, it shall ensure that only its authorised directors, members, officers, employees are allowed to use or access the Services in accordance with these Terms. To request permission to use any content from the Company’s Platform other than as expressly permitted under these Terms, please contact info@truflation.com. +We provide our websites and Services strictly for general informational purposes and you agree to use the content related to the Services solely for personal use. You further agree not to copy, reproduce, edit, transmit, distribute, sell, license, reverse engineer, modify, alter, publish, display or participate in the transfer or sale of, create derivative works from, create any index, enhance, provide access to or in any other way exploit any of the content related to the Services in any manner, including for example any purpose competitive to truf.network or any commercial purpose, in whole or in part. In case the right to use or access to the websites or the Services is given to a corporate entity, it shall ensure that only its authorised directors, members, officers, employees are allowed to use or access the Services in accordance with these Terms. To request permission to use any content from the Company’s Platform other than as expressly permitted under these Terms, please contact info@truflation.com. Some Services offered by us may require payment and to be paid upfront in accordance with the terms and conditions of separate statements of work to be entered into with us. ## Intellectual Property -The trademarks, trade names, service marks, identifying marks, designs and logos of Truf Network and others used on the Company’s Platform (hereinafter the "Trademarks") are the property of Truf Network and its respective third-party licensors or owners. All contents including software code (whether binary, assembly, source, object, HTML or otherwise), applications, text, images, graphics, data, files, prices, trades, charts, graphs, video and audio materials used on the Company’s Platform is the property of Truf Network and is protected by copyright, patent, trademark and any other applicable laws, unless otherwise specified. +The trademarks, trade names, service marks, identifying marks, designs and logos of truf.network and others used on the Company’s Platform (hereinafter the "Trademarks") are the property of truf.network and its respective third-party licensors or owners. All contents including software code (whether binary, assembly, source, object, HTML or otherwise), applications, text, images, graphics, data, files, prices, trades, charts, graphs, video and audio materials used on the Company’s Platform is the property of truf.network and is protected by copyright, patent, trademark and any other applicable laws, unless otherwise specified. -The Trademarks and other content on the Company’s Platform should not be copied, reproduced, modified, republished, uploaded, posted, transmitted, scraped, collected or distributed in any form or by any means, no matter manual or automated, without prior written consent of Truf Network. The use of any content from the Company’s Platform on any other site or application or a networked computer environment for any other purpose is strictly prohibited. Any such unauthorized use may violate copyright, patent, trademark and any other applicable laws and could result in criminal or civil penalties. +The Trademarks and other content on the Company’s Platform should not be copied, reproduced, modified, republished, uploaded, posted, transmitted, scraped, collected or distributed in any form or by any means, no matter manual or automated, without prior written consent of truf.network. The use of any content from the Company’s Platform on any other site or application or a networked computer environment for any other purpose is strictly prohibited. Any such unauthorized use may violate copyright, patent, trademark and any other applicable laws and could result in criminal or civil penalties. ## Changes; Suspension; Termination -We may, at our sole discretion, from time to time and with or without prior notice to you, modify, suspend or disable, temporarily or permanently, the Services offered by Truf Network, in whole or in part, for any reason whatsoever, including, without limitation, as a result of a security incident. +We may, at our sole discretion, from time to time and with or without prior notice to you, modify, suspend or disable, temporarily or permanently, the Services offered by truf.network, in whole or in part, for any reason whatsoever, including, without limitation, as a result of a security incident. We will not be liable for any losses suffered by you resulting from any modification to any Services or from any suspension or termination, for any reason, of your access to all or any portion of the Company’s Platform or the Services. @@ -52,7 +52,7 @@ All of these terms will survive any termination of your access to the websites o ## Electronic Communications -You agree and consent to receive electronically all communications, agreements, documents, notices and disclosures (collectively, "Communications") that we provide in connection with the Services. We may provide these Communications to you by posting them on the Company’s Platform, emailing them to you at your email addresses provided to us, and/or through other electronic communications such as text messages or mobile push notifications, and you expressly agree that such Communications shall be deemed to have been received by you as if Truf Network has delivered them based on the latest contact information on your profile. +You agree and consent to receive electronically all communications, agreements, documents, notices and disclosures (collectively, "Communications") that we provide in connection with the Services. We may provide these Communications to you by posting them on the Company’s Platform, emailing them to you at your email addresses provided to us, and/or through other electronic communications such as text messages or mobile push notifications, and you expressly agree that such Communications shall be deemed to have been received by you as if truf.network has delivered them based on the latest contact information on your profile. You are responsible for keeping your contact details (including your email address and telephone number) up to date on your profile in order to receive any Communications we may send to you. @@ -64,14 +64,14 @@ Any delay or failure by us to exercise our rights and/or remedies under this Agr ## Privacy -We will not sell or otherwise distribute your information to organizations outside of Truf Network and any of its affiliates or its or their respective directors, members, officers, employees, agents, representatives, suppliers, service providers, partners or licensors (“Truf Network Parties”) without your written permission. +We will not sell or otherwise distribute your information to organizations outside of truf.network and any of its affiliates or its or their respective directors, members, officers, employees, agents, representatives, suppliers, service providers, partners or licensors (“truf.network Parties”) without your written permission. -Any other communication or material you transmit to the Company’s Platform, including questions, comments, feedback and/or suggestions, will only be used by Truf Network to respond to you directly. +Any other communication or material you transmit to the Company’s Platform, including questions, comments, feedback and/or suggestions, will only be used by truf.network to respond to you directly. ## General Disclaimer -- Our websites, dashboard and the Services are provided “as is” and Truf Network hereby disclaims all warranties, expressed or implied, including without limitation any implied warranties of merchantability, fitness for a particular purpose, or non-infringement of intellectual property or other violation of rights. -- Truf Network also does not warrant or make any representations concerning the accuracy, completeness, currency, availability, quality, usefulness, or reliability of any Services, the Company’s Platform, or any use thereof. You are solely responsible for your use of the Services, including any decisions or other actions taken (or not taken) in connection therewith. Past performance is not indicative of future performance. You further hereby acknowledge: +- Our websites, dashboard and the Services are provided “as is” and truf.network hereby disclaims all warranties, expressed or implied, including without limitation any implied warranties of merchantability, fitness for a particular purpose, or non-infringement of intellectual property or other violation of rights. +- truf.network also does not warrant or make any representations concerning the accuracy, completeness, currency, availability, quality, usefulness, or reliability of any Services, the Company’s Platform, or any use thereof. You are solely responsible for your use of the Services, including any decisions or other actions taken (or not taken) in connection therewith. Past performance is not indicative of future performance. You further hereby acknowledge: - The Services are intended to serve as an analytical tool that users might consult in connection with estimating official inflation trends and changes in real exchange rates for select economies. Our series are an estimation based only on certain data points that may change from time to time, are not exhaustive, and are not guaranteed to be accurate or appropriate for your use. - Our analyses are based on observations of historic data that may not be indicative of future performance or trends. - We do not revise previously published estimates, even if an error is discovered or a change in methodology is applied. @@ -79,19 +79,19 @@ Any other communication or material you transmit to the Company’s Platform, in ## Limitation of Liability -In no event shall Truf Network be liable for any incidental, consequential or other damages (including, without limitation, damages for loss of data or profit, or due to business interruption) arising out of or related to the websites, dashboard, the Services, or the use or inability to use the Company’s Platform or any Services, even if advised of the possibility of such damages. +In no event shall truf.network be liable for any incidental, consequential or other damages (including, without limitation, damages for loss of data or profit, or due to business interruption) arising out of or related to the websites, dashboard, the Services, or the use or inability to use the Company’s Platform or any Services, even if advised of the possibility of such damages. ## Indemnification -You agree to indemnify, defend, and hold the Truf Network Parties harmless from and against all losses, expenses, damages and costs, including reasonable attorneys’ fees, arising out of or relating to your violation of these Terms or applicable laws, your infringement or misappropriation of rights of any other person or entity, or any activity related to your access to the Company’s Platform or the Services or anyone using your account information, as applicable. +You agree to indemnify, defend, and hold the truf.network Parties harmless from and against all losses, expenses, damages and costs, including reasonable attorneys’ fees, arising out of or relating to your violation of these Terms or applicable laws, your infringement or misappropriation of rights of any other person or entity, or any activity related to your access to the Company’s Platform or the Services or anyone using your account information, as applicable. -If you are obligated to indemnify any Truf Network Parties, we (or the applicable Truf Network Parties) will have the right, in their sole discretion, to control any action or proceeding and to determine whether Truf Network wishes to settle, and if so, on what terms. +If you are obligated to indemnify any truf.network Parties, we (or the applicable truf.network Parties) will have the right, in their sole discretion, to control any action or proceeding and to determine whether truf.network wishes to settle, and if so, on what terms. ## Third-Party Websites and Services The Company’s Platform may provide links for accessing certain websites operated by third parties that provide third-party services. These linked sites are solely for your convenience and not based on any affiliation with these third parties. -Even if such third party is affiliated with Truf Network, we have no control over these linked sites, all of which have separate, independent terms and privacy practices. Truf Network disclaims all warranties related to such linked sites or any third-party services offered in connection therewith. You acknowledge sole responsibility for and assume all risk arising from your use of any linked sites and/or third-party services. +Even if such third party is affiliated with truf.network, we have no control over these linked sites, all of which have separate, independent terms and privacy practices. truf.network disclaims all warranties related to such linked sites or any third-party services offered in connection therewith. You acknowledge sole responsibility for and assume all risk arising from your use of any linked sites and/or third-party services. ## Governing Law @@ -107,13 +107,13 @@ You also agree and understand that entering into this Agreement constitutes a wa ## Relationship -You agree that no joint venture, agency, partnership, or employment relationship exists between you and Truf Network and/or its affiliates as a result of these Terms or use of the Services. +You agree that no joint venture, agency, partnership, or employment relationship exists between you and truf.network and/or its affiliates as a result of these Terms or use of the Services. ## Assignment -Truf Network may assign or transfer to any third party (including, without limitation, to any other legal entity that is an affiliate of Truf Network) any of Truf Network’s rights and obligations under the Agreement without your consent or the need to provide you with any prior notice of such assignment or transfer and you irrevocably consent to any such assignment or transfer by Truf Network. +truf.network may assign or transfer to any third party (including, without limitation, to any other legal entity that is an affiliate of truf.network) any of truf.network’s rights and obligations under the Agreement without your consent or the need to provide you with any prior notice of such assignment or transfer and you irrevocably consent to any such assignment or transfer by truf.network. -You may not however transfer any rights or obligations you may have under this Agreement unless Truf Network has provided written consent to the assignment. +You may not however transfer any rights or obligations you may have under this Agreement unless truf.network has provided written consent to the assignment. ## Enforceability @@ -121,6 +121,6 @@ If any term of this Agreement is unlawful or unenforceable under any applicable ## Entire Agreement -This Agreement (including documents incorporated by reference herein) comprise the entire understanding and agreement between you and Truf Network as to the subject matter hereof, and it supersedes any and all prior discussions, agreements and understandings of any kind (including without limitation any prior versions of this Agreement), and every nature between and among you and Truf Network. +This Agreement (including documents incorporated by reference herein) comprise the entire understanding and agreement between you and truf.network as to the subject matter hereof, and it supersedes any and all prior discussions, agreements and understandings of any kind (including without limitation any prior versions of this Agreement), and every nature between and among you and truf.network. If you have any questions, comments, or concerns regarding these Terms or the Services, please contact us at info@truflation.com. diff --git a/troubleshooting-channels.mdx b/troubleshooting-channels.mdx index f8f0811..5726c04 100644 --- a/troubleshooting-channels.mdx +++ b/troubleshooting-channels.mdx @@ -1,13 +1,13 @@ --- title: "Troubleshooting Channels" -description: "Resources and support channels for addressing issues within the TRUF Network." +description: "Resources and support channels for addressing issues within the truf.network." --- -If you encounter issues while operating within the TRUF Network, several support channels are available to assist you: +If you encounter issues while operating within the truf.network, several support channels are available to assist you: ## 1. Official Documentation -- **TRUF Network Whitepaper**: Provides comprehensive information about the network's architecture and protocols. Access it [here](https://whitepaper.truflation.com/). +- **truf.network Whitepaper**: Provides comprehensive information about the network's architecture and protocols. Access it [here](https://whitepaper.truflation.com/). ## 2. Community Forums @@ -30,4 +30,3 @@ If you encounter issues while operating within the TRUF Network, several support - **FAQ Section**: Review the [FAQ](https://whitepaper.truflation.com/faq) for answers to common questions. When seeking support, provide detailed information about the issue, including error messages and steps to reproduce the problem. This will facilitate a quicker resolution. - diff --git a/writing-adapters.mdx b/writing-adapters.mdx index 66ccec5..0e98f97 100644 --- a/writing-adapters.mdx +++ b/writing-adapters.mdx @@ -1,9 +1,10 @@ --- title: Adapter Writing Guide -description: This guide provides a step-by-step approach to creating adapters for the Truf Network (TN). Adapters facilitate the ingestion of data from various sources into TN, leveraging the SDK and Prefect for efficient data management. +description: This guide provides a step-by-step approach to creating adapters for the truf.network (TN). Adapters facilitate the ingestion of data from various sources into TN, leveraging the SDK and Prefect for efficient data management. --- > **Note**: While adapters use a Python Framework, it's also possible to push data from other languages like Go or JavaScript. Refer to the respective SDKs for more information: +> > - [Golang SDK](https://github.com/trufnetwork/truf-node-sdk-go) > - [JavaScript SDK](https://github.com/trufnetwork/truf-node-sdk-js) @@ -19,19 +20,23 @@ description: This guide provides a step-by-step approach to creating adapters fo ## Setting Up the Development Environment 1. **Clone the Repository**: + ```bash git clone https://github.com/trufnetwork/adapters.git cd adapters ``` 2. **Configure Environment Variables**: + - Duplicate the `.env.example` file and rename it to `.env`. - Update the environment variables in the `.env` file as needed. 3. **Launch Services with Docker Compose**: + ```bash docker compose up -d ``` + This command initializes the necessary services in the background. ## Understanding Reusable Tasks @@ -56,10 +61,10 @@ The repository offers several reusable tasks to facilitate data ingestion into T ## Developing a Custom Adapter (Python Example) 1. **Define the Data Source**: -Identify the source and format of the data you intend to ingest. + Identify the source and format of the data you intend to ingest. 2. **Create a Prefect Flow**: -Develop a Prefect flow to manage the data ingestion process. For example: + Develop a Prefect flow to manage the data ingestion process. For example: ```python from prefect import flow @@ -75,7 +80,7 @@ def custom_adapter_flow(): ``` 3. **Execute the Flow**: -Run the flow to perform the data ingestion. + Run the flow to perform the data ingestion. ```bash python path/to/your_flow.py