@gtcx/schemas

Schema definitions and validation for all GTCX protocol messages: TradePass identities, GeoTag locations, GCI scores, VaultMark custody, PvP settlement, and more.

Installation

pnpm add @gtcx/schemas

API

SchemaRegistry

Registry for SchemaDefinition objects. A pre-populated defaultRegistry is exported with all built-in protocol schemas.

import { defaultRegistry, validateById } from '@gtcx/schemas';

const result = validateById(defaultRegistry, 'tradepass.identity.v1', {
  did: 'did:gtcx:org_acme',
  type: 'organization',
  jurisdiction: 'US',
  createdAt: '2025-01-01T00:00:00Z',
  status: 'active',
});
// { valid: true, errors: [] }

validateSchema(schema, data, options?)

Validates data against a SchemaDefinition. Strict mode (default) rejects unknown fields.

import { validateSchema, TradePassDIDDocumentSchema } from '@gtcx/schemas';

const result = validateSchema(TradePassDIDDocumentSchema, payload);

Sub-module exports

Domain-specific schemas are available as sub-path imports:

• @gtcx/schemas/core -- primitives, common types, error codes
• @gtcx/schemas/identity -- TradePass DID and credential schemas
• @gtcx/schemas/assets -- asset identity and tokenization
• @gtcx/schemas/compliance -- GCI scoring and compliance rules
• @gtcx/schemas/location -- GeoTag location and proof schemas
• @gtcx/schemas/settlement -- PvP settlement instructions
• @gtcx/schemas/consensus -- consensus protocol messages
• @gtcx/schemas/config -- commodities and jurisdiction configs
• @gtcx/schemas/migrations -- schema migration versions

Built-in schema IDs

tradepass.identity.v1, tradepass.did-document.v1, geotag.location.v1, geotag.proof.v1, geotag.geotag.v1, network.message.envelope.v1, gci.score.v1, vaultmark.custody.v1, pvp.settlement.v1, and others.

Testing

pnpm vitest run packages/schemas/

License

BSL 1.1 -- converts to Apache 2.0 on January 1, 2030.