diff --git a/docs/content/developer/iota-hierarchies/index.mdx b/docs/content/developer/iota-hierarchies/index.mdx index 1dbbfca495a..6e5188eefad 100644 --- a/docs/content/developer/iota-hierarchies/index.mdx +++ b/docs/content/developer/iota-hierarchies/index.mdx @@ -5,6 +5,7 @@ teams: - iotaledger/identity tags: - reference + - trust-framework --- # Hierarchies diff --git a/docs/content/developer/iota-identity/index.mdx b/docs/content/developer/iota-identity/index.mdx index e40ce924614..054af4c3bc3 100644 --- a/docs/content/developer/iota-identity/index.mdx +++ b/docs/content/developer/iota-identity/index.mdx @@ -7,6 +7,7 @@ teams: tags: - reference - identity + - trust-framework --- # IOTA Identity diff --git a/docs/content/developer/iota-notarization/index.mdx b/docs/content/developer/iota-notarization/index.mdx index 9bdbe01a29b..ba18ed07d4c 100644 --- a/docs/content/developer/iota-notarization/index.mdx +++ b/docs/content/developer/iota-notarization/index.mdx @@ -5,6 +5,7 @@ sidebar_label: Introduction tags: - reference - notarization + - trust-framework --- # IOTA Notarization diff --git a/docs/content/developer/trust-framework-howto/component-clients.mdx b/docs/content/developer/trust-framework-howto/component-clients.mdx new file mode 100644 index 00000000000..bf65c1fbb1e --- /dev/null +++ b/docs/content/developer/trust-framework-howto/component-clients.mdx @@ -0,0 +1,10 @@ +--- +title: Using Trust Framework Component Clients +sidebar_label: Component Clients +--- + +# Using Trust Framework Component Clients + +In most cases TF components provide a Move SC implementing the core business logic and client libraries for Rust and JS/TS +facilitating SC interaction for easier integration into your applications. For this purpose TF components provide so called +Component Clients that wrap the low-level Move SC calls into high-level functions. \ No newline at end of file diff --git a/docs/content/developer/trust-framework-howto/custom-transactions.mdx b/docs/content/developer/trust-framework-howto/custom-transactions.mdx new file mode 100644 index 00000000000..981846c87cf --- /dev/null +++ b/docs/content/developer/trust-framework-howto/custom-transactions.mdx @@ -0,0 +1,10 @@ +--- +title: Build Custom Transactions +sidebar_label: Custom Transactions +--- + +# Build Custom Transactions + +TF components provide a transaction builder allowing to create, manipulate or delete objects on the IOTA network in an as easy +as possible way. These transaction builders can also be used to create custom transactions that allow users to integrate +the component specific transaction with transactions of other components or even custom Move SC. \ No newline at end of file diff --git a/docs/content/developer/trust-framework-howto/gas-station-integration.mdx b/docs/content/developer/trust-framework-howto/gas-station-integration.mdx new file mode 100644 index 00000000000..6665e16388e --- /dev/null +++ b/docs/content/developer/trust-framework-howto/gas-station-integration.mdx @@ -0,0 +1,9 @@ +--- +title: Gas Station Integration +sidebar_label: Gas Station Integration +--- + +# Gas Station Integration + +The IOTA Gas Station simplifies user onboarding and enhances SC engagement by enabling businesses and developers to sponsor +transaction fees on the IOTA network. As a part of the IOTA Trust Framework, several components support the integration of the IOTA Gas Station. \ No newline at end of file diff --git a/docs/content/developer/trust-framework-howto/in-browser-usage.mdx b/docs/content/developer/trust-framework-howto/in-browser-usage.mdx new file mode 100644 index 00000000000..ea34deb85ab --- /dev/null +++ b/docs/content/developer/trust-framework-howto/in-browser-usage.mdx @@ -0,0 +1,8 @@ +--- +title: Use Trust Framework Components in the Browser +sidebar_label: In Bowser Usage +--- + +# Use Trust Framework Components in the Browser + +Most TF components provide a JS/TS client library that can be used in browser-based applications. \ No newline at end of file diff --git a/docs/content/developer/trust-framework-howto/index.mdx b/docs/content/developer/trust-framework-howto/index.mdx new file mode 100644 index 00000000000..9676cbd0a66 --- /dev/null +++ b/docs/content/developer/trust-framework-howto/index.mdx @@ -0,0 +1,57 @@ +--- +title: Trust Framework - How To +description: Explains cross component technics and general concepts of the IOTA Trust Framework. +sidebar_label: Overview +tags: + - trust-framework +--- +# Trust Framework - How To + +![Trust Framework - How To](/img/banner/banner_trust_framework.png) + +The IOTA Trust Framework (TF) uses several cross component technics and general concepts that are not specific to a single component. +This section and its sub-pages explain these technics and concepts in more detail: + +## Using the Trust Framework Component Clients + +In most cases TF components provide a Move SC implementing the core business logic and client libraries for Rust and JS/TS +facilitating SC interaction for easier integration into your applications. For this purpose TF components provide so called +Component Clients that wrap the low-level Move SC calls into high-level functions. + +Go to [Component Clients](/developer/trust-framework-howto/component-clients). + +## Build Custom Transactions + +TF components provide a transaction builder allowing to create, manipulate or delete objects on the IOTA network in an as easy +as possible way. These transaction builders can also be used to create custom transactions that allow users to integrate +the component specific transaction with transactions of other components or even custom Move SC. + +Go to [Custom Transactions](/developer/trust-framework-howto/custom-transactions). + +## Gas Station Integration + +The IOTA Gas Station simplifies user onboarding and enhances SC engagement by enabling businesses and developers to sponsor +transaction fees on the IOTA network. As a part of the IOTA Trust Framework, several components support the integration of the IOTA Gas Station. + +Go to [Gas Station Integration](/developer/trust-framework-howto/gas-station-integration). + +## Use Trust Framework Components in the Browser + +Most TF components provide a JS/TS client library that can be used in browser-based applications. + +Go to [In Browser Usage](/developer/trust-framework-howto/in-browser-usage). + +## Setup Environments for included Tests +TF components include integration and end-to-end tests that can be used to verify the correct setup of the component +and to understand its usage. These tests can be run against different environments like a local +network, the testnet or the mainnet. + +Go to [Test Environment Setup](/developer/trust-framework-howto/test-environment-setup). + +## Use IOTA Resource Locators (IRLs) with Trust Framework Components + +IOTA Resource Locators (IRLs) are a simple and flexible way to reference digital resources on the IOTA network. +TF components support IRLs to allows users to access and retrieve component specific on-chain data +in a chain-agnostic manner. + +Go to [Resource Locators](/developer/trust-framework-howto/resource-locators). diff --git a/docs/content/developer/trust-framework-howto/resource-locators.mdx b/docs/content/developer/trust-framework-howto/resource-locators.mdx new file mode 100644 index 00000000000..1f8bee6b4e8 --- /dev/null +++ b/docs/content/developer/trust-framework-howto/resource-locators.mdx @@ -0,0 +1,10 @@ +--- +title: Use IOTA Resource Locators (IRLs) with Trust Framework Components +sidebar_label: Resource Locators +--- + +# Use IOTA Resource Locators (IRLs) with Trust Framework Components + +IOTA Resource Locators (IRLs) are a simple and flexible way to reference digital resources on the IOTA network. +TF components support IRLs to allows users to access and retrieve component specific on-chain data +in a chain-agnostic manner. \ No newline at end of file diff --git a/docs/content/developer/trust-framework-howto/test-environment-setup.mdx b/docs/content/developer/trust-framework-howto/test-environment-setup.mdx new file mode 100644 index 00000000000..f06951a126a --- /dev/null +++ b/docs/content/developer/trust-framework-howto/test-environment-setup.mdx @@ -0,0 +1,10 @@ +--- +title: Setup Environments for included Tests +sidebar_label: Test Environment Setup +--- + +# Setup Environments for included Tests + +TF components include integration and end-to-end tests that can be used to verify the correct setup of the component +and to understand its usage. These tests can be run against different environments like a local +network, the testnet or the mainnet. \ No newline at end of file diff --git a/docs/content/sidebars/developer.js b/docs/content/sidebars/developer.js index 395e55e3825..1655ac5e212 100644 --- a/docs/content/sidebars/developer.js +++ b/docs/content/sidebars/developer.js @@ -4,6 +4,7 @@ const tsSDK = require('./ts-sdk'); const iotaEvm = require('./iota-evm'); +const trustFrameworkHowto = require("./trust-framework-howto"); const notarization = require("./notarization"); const hierarchies = require('./hierarchies'); const identity = require('./identity'); @@ -616,6 +617,12 @@ const developer = [ id: 'developer/iota-trust-framework', }, items: [ + { + type: 'category', + label: 'Trust Framework - How To', + collapsed: true, + items: trustFrameworkHowto, + }, { type: 'category', label: 'Identity', diff --git a/docs/content/sidebars/trust-framework-howto.js b/docs/content/sidebars/trust-framework-howto.js new file mode 100644 index 00000000000..49f13ef01d5 --- /dev/null +++ b/docs/content/sidebars/trust-framework-howto.js @@ -0,0 +1,13 @@ +// Copyright (c) 2025 IOTA Stiftung +// SPDX-License-Identifier: Apache-2.0 +const trust_framework_howto= [ + 'developer/trust-framework-howto/index', + 'developer/trust-framework-howto/component-clients', + 'developer/trust-framework-howto/custom-transactions', + 'developer/trust-framework-howto/gas-station-integration', + 'developer/trust-framework-howto/in-browser-usage', + 'developer/trust-framework-howto/test-environment-setup', + 'developer/trust-framework-howto/resource-locators', +]; + +module.exports = trust_framework_howto; \ No newline at end of file diff --git a/docs/content/tags.yml b/docs/content/tags.yml index 1dabe36f2df..e7dc4cb55c4 100644 --- a/docs/content/tags.yml +++ b/docs/content/tags.yml @@ -318,3 +318,9 @@ dynamic-notarization: locked-notarization: label: Locked Notarization description: Create a permanent, immutable record. + +# Trust Framework +trust-framework: + label: Trust Framework + description: IOTA Trust Framework offers ready-to-use building blocks easy to implement and scale. +