Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
bb19398
feat: add aws secret manager docs (#245) (#246)
gyan-sharma Mar 26, 2025
7db9358
Converted to sentence case
gyan-sharma Mar 26, 2025
2df92f0
added logo to supported chains
gyan-sharma Mar 26, 2025
516022a
fix add node - custom services - create app pages
saeeddawod Mar 26, 2025
4d67894
pk section fixed
saeeddawod Mar 26, 2025
0c3e06a
eas guide fix
saeeddawod Mar 26, 2025
4c89369
re fix create app and custom services
saeeddawod Mar 26, 2025
602b014
fix: missing networks
bl0up Mar 26, 2025
d49e527
deploy a smart contract fixed
saeeddawod Mar 26, 2025
d28b94d
fix: confusion between evm & fabric
bl0up Mar 26, 2025
2ca960b
fix: confusion between evm & fabric
bl0up Mar 26, 2025
d53ba33
fix: confusion between evm & fabric
bl0up Mar 26, 2025
cfe7f84
fix: chaincode is not a language
bl0up Mar 26, 2025
efff7de
code studio and portal api fixed
saeeddawod Mar 26, 2025
dad37e0
fix: same text for SDK & CLI
bl0up Mar 26, 2025
7e26b56
fix: separation between fabric and evm networks
bl0up Mar 26, 2025
f087100
fix off chain db & graph pages
saeeddawod Mar 26, 2025
999851a
fix: no cap to optimistic rollup
bl0up Mar 26, 2025
da9955f
fix: add fabric nodes
bl0up Mar 26, 2025
edd8e28
rm deployment wizard section and fix cap issues
saeeddawod Mar 26, 2025
e0889c6
fix hedera section
saeeddawod Mar 26, 2025
7dda768
added tools from hedera eco system
saeeddawod Mar 26, 2025
b898328
hedera clean up
saeeddawod Mar 26, 2025
8d6cb01
added sitemap
gyan-sharma Mar 27, 2025
0a99b15
Small Caps fix
gyan-sharma Mar 27, 2025
7985319
l1 l2
gyan-sharma Mar 27, 2025
15002aa
added logos
gyan-sharma Mar 27, 2025
717e6bb
fix: merge
bl0up Mar 27, 2025
43cffbd
Sentence case updates
gyan-sharma Mar 27, 2025
fd4617a
Update script to include exception list
gyan-sharma Mar 27, 2025
5d1a949
Fix: standardize capitalization in Hedera introduction document
saeeddawod Mar 27, 2025
6841f86
Merge fix/dev-branch-building-with-settlemint into dev
saeeddawod Mar 27, 2025
2e9c979
generate robots.txt
gyan-sharma Mar 27, 2025
ee7e2fb
settlemint to SettleMint
gyan-sharma Mar 27, 2025
d2699be
fix: missing networks (#250)
bl0up Mar 27, 2025
5bf5f7a
removed keywords from bottom of pages
gyan-sharma Mar 27, 2025
d6de574
fabric IDE remove hardhat reference
gyan-sharma Mar 27, 2025
037fbb6
added meta files in supported networks
gyan-sharma Mar 27, 2025
28dd859
Merge branch 'main' into dev
SaeeDawod Mar 27, 2025
7c43960
fix bun
gyan-sharma Mar 27, 2025
f3e1100
delete robots generation file
gyan-sharma Mar 27, 2025
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 .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
.contentlayer
.content-collections
.source
.docusaurus

# test & build
/coverage
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,11 @@
<a href="https://github.com/settlemint/docs/issues">Issues</a>
<br />
</div>


To generate sitemap

```
bun add -d globby prettier
```

2 changes: 1 addition & 1 deletion bun.lock
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@

"@types/estree": ["@types/estree@1.0.6", "", {}, "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw=="],

"@types/estree-jsx": ["@types/estree-jsx@1.0.5", "", { "dependencies": { "@types/estree": "*" } }, "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSdkuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg=="],
"@types/estree-jsx": ["@types/estree-jsx@1.0.5", "", { "dependencies": { "@types/estree": "*" } }, "sha512-52CcUVNFyfb1A2ALocQw/Dd1BQFNmSDKuC3BkZ6iqhdMfQz7JWOFRuJFloOzjk+6WijU56m9oKXFAXc7o3Towg=="],

"@types/geojson": ["@types/geojson@7946.0.16", "", {}, "sha512-6C8nqWur3j98U6+lXDfTUWIfgvZU+EumvpHKcYjujKH7woYyLj2sUmff0tRhrqM7BohUw7Pz3ZB1jj2gW9Fvmg=="],

Expand Down
137 changes: 83 additions & 54 deletions content/docs/about-settlemint/introduction.mdx

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Asset Tokenization Kit
title: "Asset tokenization kit"
description: Build your digital assets platform in minutes
---

Expand All @@ -11,10 +11,10 @@ import { Card } from "fumadocs-ui/components/card";
The **SettleMint Asset Tokenization Kit** is a complete development toolkit and reference application for launching digital asset platforms quickly and securely. It eliminates the usual complexity of building from scratch by offering a pre-integrated stack of smart contracts, backend services, and a web-based user interface. Whether issuing stablecoins, tokenized securities, or loyalty points, the kit equips developers with all the core components needed to move from idea to prototype in days.


![Asset Tokenization Kit](../../../img/application-kits/asset-tokenization-dashboard.webp)
![Asset Tokenization Kit](../../../img/application-kits/atk-dashboard.png)


## Core Components
## Core components

The kit’s foundation lies in **battle-tested smart contract templates** that follow standards like ERC-20. These templates are extensible and suitable for multiple asset classes:

Expand All @@ -33,7 +33,7 @@ Because the backend and frontend layers are already wired together, teams can fo

---

## Compliance and Security
## Compliance and security

Compliance is not an add-on but an embedded principle in the kit’s architecture. It is built to align with enterprise-grade regulatory expectations, supporting both internal governance and external obligations.

Expand All @@ -49,7 +49,7 @@ It also supports alignment with evolving regulations such as **Europe’s MiCA**

---

## Operational Monitoring
## Operational monitoring

Institutions need visibility into their asset operations, and the kit offers this out of the box.

Expand All @@ -63,29 +63,31 @@ This monitoring framework helps organizations maintain transparency and enforce

---

## Developer Enablement
## Developer enablement

Developers are not left to glue components together manually. The Asset Tokenization Kit ensures all layers work in harmony and offers powerful tools to accelerate custom development.

### Integrated Tools
### Integrated tools
- **SettleMint SDK and CLI** to scaffold, manage, and deploy projects
- **Web-based IDE** for instant cloud development
- **Local dev compatibility** with Git access for use with any code editor

### Pre-Built Blockchain Integrations
### Pre-built blockchain integrations
- **IPFS** for decentralized document and metadata storage
- **The Graph** for indexing on-chain data
- **Hasura** for GraphQL API access to blockchain data

### External Connectivity
### External connectivity
- REST and GraphQL APIs to connect with CRMs, core banking systems, and reporting platforms
- Hooks and webhooks to automate workflows or trigger third-party actions

![Asset Tokenization Kit APIs](../../../img/application-kits/atk-apis.png)

This results in a developer experience where the focus is on building business-specific logic, not plumbing infrastructure.

---

## Deployment and Automation
## Deployment and automation

Launching environments with the kit is straightforward and scalable. Most setup steps are automated and repeatable across development, testing, and production.

Expand All @@ -98,7 +100,7 @@ With minimal DevOps overhead, organizations will maintain faster iteration cycle

---

## Speed and Efficiency Gains
## Speed and efficiency gains

Adopting the kit significantly reduces project timelines and developer workload. Organizations will benefit from:

Expand All @@ -111,7 +113,7 @@ Development teams no longer need to reinvent the wheel, and product teams can va

---

## Customization and Extensibility
## Customization and extensibility

Unlike rigid SaaS platforms, the kit offers complete flexibility. Every component is open and editable:

Expand All @@ -124,7 +126,7 @@ This extensibility ensures that the kit remains relevant as use cases evolve, ma

---

## Ideal Use Cases
## Ideal use cases

The Asset Tokenization Kit is well-suited for:

Expand All @@ -137,7 +139,7 @@ Its flexibility and compliance-focused design allow it to operate in diverse ind

---

## Getting Started
## Getting started

To begin using the kit:

Expand All @@ -146,11 +148,13 @@ To begin using the kit:
3. **Launch the Web IDE** or integrate into your local development environment
4. **Review documentation and API references** to begin customizing the application

![Asset Tokenization Kit Code](../../../img/application-kits/atk-code.png)

Comprehensive guides, code samples, and pre-configured environments are available to reduce onboarding time for development teams.

---

## Ongoing Support and Roadmap
## Ongoing support and roadmap

- The kit is **actively maintained** and updated to meet new technical and regulatory requirements
- **Support channels** are available for both developer troubleshooting and enterprise onboarding
Expand Down
22 changes: 11 additions & 11 deletions content/docs/application-kits/asset-tokenization/contracts/bond.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Bond
title: "Bond"
description: Secure, Collateralized Fixed-Income Digital Asset
---

Expand All @@ -12,15 +12,15 @@ maintaining investor confidence. It provides institutions with robust
functionalities, including yield distribution, maturity management, asset
redemption, comprehensive access controls, and compliance mechanisms.

## Why Digital Bonds?
## Why digital bonds?

Digital bonds integrate the reliability of traditional financial instruments
with the flexibility and efficiency of blockchain technology. For banks and
financial institutions, digital bonds offer streamlined issuance, reduced
operational costs, improved transparency, and enhanced compliance and auditing
capabilities.

### Enterprise Applications:
### Enterprise applications:

- **Institutional Investments:** Secure, auditable fixed-income investments with
clear, blockchain-based issuance and redemption.
Expand All @@ -31,26 +31,26 @@ capabilities.
- **Liquidity Management:** Enhance liquidity management by easily redeeming
bonds and distributing yields.

## Contract Features and Capabilities
## Contract features and capabilities

### Collateralized Bond Issuance
### Collateralized bond issuance

- Bonds are issued with a fixed face value backed by an underlying ERC20 asset,
ensuring secure and transparent value retention.

### Maturity and Redemption
### Maturity and redemption

- Bonds have a defined maturity date after which holders can redeem tokens for
underlying assets, providing predictable liquidity and return.
- Redemption can only occur post-maturity, ensuring controlled and predictable
lifecycle management.

### Yield Distribution
### Yield distribution

- Supports regular yield distributions to token holders, leveraging built-in
yield mechanisms to automate periodic payments, simplifying asset management.

### Comprehensive Access Control
### Comprehensive access control

- **Supply Management Role:** Authority to mint tokens, manage supply, and
oversee collateral to ensure compliance with financial regulations.
Expand All @@ -59,20 +59,20 @@ capabilities.
- **Admin Role:** Controls key functionalities like pausing transfers and token
operations during regulatory actions or emergencies.

### Security and Regulatory Compliance
### Security and regulatory compliance

- **Pause and Unpause Functionality:** Allows controlled suspension of token
transfers, ensuring compliance and response capabilities in critical
situations.
- **Blocklist Functionality:** Facilitates user blocking/unblocking for AML/KYC
compliance.

### Meta-Transaction Support
### Meta-transaction support

- Implements ERC2771, enabling third-party payment of gas fees, improving
accessibility and ease-of-use for institutional stakeholders.

### Transparent Yield Distribution and Auditing
### Transparent yield distribution and auditing

- Integrated historical balance tracking ensures clear and transparent yield
calculations and distributions.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: CryptoCurrency
title: "Cryptocurrency"
description: Reliable and Customizable Digital Asset
---

Expand All @@ -12,14 +12,14 @@ built-in support for meta-transactions, ensuring security, usability, and
compliance. With features tailored for institutional-grade management, it
simplifies digital asset issuance, administration, and operational oversight.

## Why Use Digital Tokens?
## Why use digital tokens?

Digital tokens like CryptoCurrency empower enterprises and financial
institutions by providing efficient, transparent, and secure asset management
solutions. They streamline transactions, enhance compliance, and reduce costs
associated with traditional financial processes.

### Enterprise Applications:
### Enterprise applications:

- **Institutional Asset Management:** Efficiently manage and track institutional
funds.
Expand All @@ -30,36 +30,36 @@ associated with traditional financial processes.
- **Supply Chain Finance:** Facilitate smooth payments and settlements across
supply chain networks.

## Contract Features and Capabilities
## Contract features and capabilities

### Minting and Supply Management
### Minting and supply management

- Authorized roles control token issuance, allowing enterprises precise
management of token supply in compliance with financial regulations.
- Tokens can be minted dynamically, enabling flexibility in response to
operational demands.

### Robust Role-Based Controls
### Robust role-based controls

- **Supply Management Role:** Manages token minting, providing secure control
over asset issuance.
- **Admin Role:** Has comprehensive governance capabilities, including emergency
interventions, administrative operations, and token security oversight.

### Security and Regulatory Compliance
### Security and regulatory compliance

- Built-in access control ensures only authorized personnel perform critical
operations, significantly enhancing security and regulatory adherence.
- Supports safe withdrawal of mistakenly sent ERC20 tokens, safeguarding asset
integrity.

### Meta-Transaction Capability
### Meta-transaction capability

- Integrates ERC2771 to allow transactions to be relayed by third parties,
significantly improving accessibility and user experience by enabling gasless
transactions for end-users.

### Customizable Token Parameters
### Customizable token parameters

- Token details such as decimals, initial supply, and token naming are
configurable at deployment, offering adaptability to diverse enterprise
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Equity
title: "Equity"
description: Institutional-Grade Digital Equity Management
---

Expand All @@ -11,14 +11,14 @@ institutional investors, this contract facilitates secure, transparent equity
issuance with advanced governance features, including voting rights, role-based
administration, compliance mechanisms, and support for meta-transactions.

## Why Digital Equity Tokens?
## Why digital equity tokens?

Digital Equity Tokens modernize traditional equity management by combining
blockchain transparency with stringent institutional requirements. They
streamline equity administration, enhance governance through digital voting, and
significantly simplify regulatory compliance and reporting.

### Enterprise Applications:
### Enterprise applications:

- **Equity Issuance and Management:** Digitally issue and manage different
equity classes and categories efficiently.
Expand All @@ -29,15 +29,15 @@ significantly simplify regulatory compliance and reporting.
- **Institutional Transparency:** Enhance transparency and auditability of
equity holdings and transfers.

## Contract Features and Capabilities
## Contract features and capabilities

### Voting and Governance
### Voting and governance

- Implements advanced voting mechanisms via ERC20Votes, enabling digital
shareholder voting and governance participation.
- Transparent tracking of voting power ensures accurate governance outcomes.

### Robust Role-Based Access Control
### Robust role-based access control

- **Supply Management Role:** Authorized roles manage equity token issuance,
ensuring secure and compliant control over the equity supply.
Expand All @@ -46,20 +46,20 @@ significantly simplify regulatory compliance and reporting.
- **Administrator Role:** Holds comprehensive operational oversight, including
emergency pausing and critical token security actions.

### Security and Compliance
### Security and compliance

- **Pause Functionality:** Allows administrators to suspend operations during
audits, regulatory interventions, or emergencies.
- **Blocklist Capability:** Supports regulatory compliance with built-in
mechanisms to manage and restrict token access for specific users.

### Meta-Transaction Support
### Meta-transaction support

- Implements ERC2771 to facilitate transactions via third-party relayers,
enabling user-friendly, gasless transactions essential for institutional
users.

### Customizable Equity Classes and Categories
### Customizable equity classes and categories

- Equity types and categories (e.g., Common, Preferred, Series A, Seed) can be
clearly defined at deployment, providing flexibility aligned with enterprise
Expand Down
Loading