Specifications for Contract Address

Overview

This document outlines the technical specifications for setting up websites on xlm.sh using Key-Value Database.

Record Types

xlm.sh supports two types of records that can be set using Key-Value Database:

1. IPFS Records

• Uses the key ipfs
• Value must be a valid IPFS CID
• Examples:
  • bafybeifq2rzpqnqrsdupncmkmhs3ckxxjhuvdcbvydkgvch3ms24k5lo7q
  • QmPK1s3pNYLi9ERiq3BDxKa4XosgWwFRQUydHUtz4YgpqB

2. IPNS Records

• Uses the key ipns
• Supports two formats:
  1. IPNS Public Keys
     • Example: k51qzi5uqu5dlvj2baxnqndepeb86cbk3ng7n3i46uzyxzyqj2xjonzllnv0v8
  2. DNSLink
     • Format: domain name with valid DNSLink TXT record
     • Example: ipfs.web.example.com

Implementation

Using Key-Value Database

1. IPFS Record Setup:

Key: `ipfs`
Value: [Your IPFS CID]

2. IPNS Record Setup:

Key: `ipns`
Value: [Your IPNS key or DNSLink domain]

DNSLink Configuration

For DNSLink usage:

1. Create a TXT record with name _dnslink.{your-domain}
2. Set value to: dnslink=/ipfs/{your-CID}

Access Rules

1. Website Access:

   • Format: {soroban_domain}.xlm.sh

2. Record Precedence:

   • When both IPFS and IPNS records exist, IPFS takes priority

Domain Integration

To use a Soroban domain:

1. Register a domain on Soroban Domains
2. Set the domain's Address record to point to your Stellar Account ID
3. Website will be accessible via {your_domain}.xlm.sh

Notes

• Ensure proper formatting of CIDs and IPNS keys
• Subdomains are not supported