Skip to content
Draft
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
1 change: 1 addition & 0 deletions docs/content/developer/iota-hierarchies/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ teams:
- iotaledger/identity
tags:
- reference
- trust-framework
---

# Hierarchies
Expand Down
1 change: 1 addition & 0 deletions docs/content/developer/iota-identity/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ teams:
tags:
- reference
- identity
- trust-framework
---
# IOTA Identity

Expand Down
1 change: 1 addition & 0 deletions docs/content/developer/iota-notarization/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_label: Introduction
tags:
- reference
- notarization
- trust-framework
---
# IOTA Notarization

Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
57 changes: 57 additions & 0 deletions docs/content/developer/trust-framework-howto/index.mdx
Original file line number Diff line number Diff line change
@@ -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).
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions docs/content/sidebars/developer.js
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down Expand Up @@ -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',
Expand Down
13 changes: 13 additions & 0 deletions docs/content/sidebars/trust-framework-howto.js
Original file line number Diff line number Diff line change
@@ -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;
6 changes: 6 additions & 0 deletions docs/content/tags.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.