Aller au contenu principal
XCS
Docs

Construire avec XCS

Intégrez le protocole v0.1 figé avec l’API REST, le SDK TypeScript et le CLI de référence.

Runtime

Configuration active

API
https://xcs.xrpl-commons.org
Profil réseau
XRPL
Testnet (network ID 1)

REST API

Interrogez les projections publiques et les preuves exactes sans indexer de claims.

OpenAPI

SDK

Validez, canonicalisez et préparez des transactions non signées dans votre application.

@xcs-protocol/sdk

CLI

Produisez et vérifiez les artefacts depuis un workflow local non custodial.

@xcs-protocol/cli

Quickstart

Vérifier une génération partagée

Collez un generationId partagé volontairement. Le parcours ne parcourt jamais les Credentials d’un compte et ne recherche aucun claim.

  1. Lire cette génération exacte et ses événements indexés.
  2. Charger le schéma exact référencé par son schemaUid.
  3. Demander les métadonnées avec resolvePayload:false et exiger le même generationId courant.
  4. Valider localement les octets canoniques, puis transmettre volontairement le payload au vérificateur sans résolution automatique.
Coordonnée exacte uniquement : aucune liste par issuer, sujet ou compte n’est appelée.

Catalogue REST v0.1

Les routes agrégées servent la découverte publique. Les routes Credential restent limitées à des coordonnées exactes partagées par l’utilisateur.

Découverte agrégée

Statistiques, schémas permissionless et activité de publication ; aucun catalogue de Credentials par compte.

  • GET /v1/networks
  • GET /v1/networks/:network/status
  • GET /v1/networks/:network/stats
  • GET /v1/networks/:network/schemas
  • GET /v1/networks/:network/search?q=
  • GET /v1/networks/:network/activity

Preuves exactes

UID, hash ou tuple complet requis. Les routes ne renvoient jamais les claims du payload.

  • GET /v1/networks/:network/schemas/:uid
  • GET /v1/networks/:network/schema-registrations/:transactionHash
  • GET /v1/networks/:network/credential-generations/:generationId
  • GET /v1/networks/:network/transactions/:transactionHash
  • GET /v1/networks/:network/credentials/:issuer/:subject/:schemaUid
  • GET /v1/networks/:network/credentials/:issuer/:subject/:schemaUid/events
  • GET /v1/networks/:network/credentials/:issuer/:subject/:schemaUid/events/:transactionHash
  • POST /v1/verify

Publication démo optionnelle

Disponibles uniquement si l’opérateur active le service de pinning par challenge.

  • POST /v1/pinning/challenges
  • POST /v1/pinning/pins

Il n’existe aucune route de feed sujet, de liste de Credentials par compte ou de recherche de claims. Un issuer visible dans la découverte n’est pas approuvé par Commons.

Comprendre le modèle de vérification