IXO Blocksync - IXO Docs Hub

Blocksync provides real-time indexing and querying of IXO blockchain data through GraphQL, enabling efficient access to historical transactions, state changes, and entity relationships. It serves as a critical infrastructure component for building scalable applications on the IXO Spatial Web.

Overview

Real-time Indexing

Continuously processes and indexes blockchain events, transactions, and state changes

GraphQL API

Type-safe querying interface with support for complex relationships and filtering

Historical Data

Access to complete transaction history and state changes with efficient retrieval

Entity Relationships

Track connections between digital twins, claims, and verifications

Architecture

Core Components

Data Model

Query Layer

type Entity {
  id: ID!
  type: String!
  data: JSONObject!
  claims: [Claim!]
  verifications: [Verification!]
  transactions: [Transaction!]
  state: EntityState!
}

type Query {
  entity(id: ID!): Entity
  claims(filter: ClaimFilter): [Claim!]
  verifications(filter: VerificationFilter): [Verification!]
  transactions(filter: TransactionFilter): [Transaction!]
}

Features

Data Indexing

Event Processing

Real-time event capture
State transition tracking
Relationship mapping
Data transformation

Storage Optimization

Efficient indexing
Query optimization
Cache management
Data compression

Historical Data

Complete history
State snapshots
Change tracking
Audit trails

Query Capabilities

Entity Queries

query GetEntity {
  entity(id: "did:ixo:123") {
    id
    type
    data
    claims {
      id
      type
      status
    }
    verifications {
      id
      status
      verifier
    }
  }
}

Filtered Queries

query GetClaims {
  claims(
    filter: {
      type: "impact",
      status: "approved",
      fromDate: "2023-01-01"
    }
  ) {
    id
    type
    data
    evaluations {
      id
      status
      evaluator
    }
  }
}

Transaction History

query GetTransactions {
  transactions(
    filter: {
      entityId: "did:ixo:123",
      type: "state_change"
    }
  ) {
    id
    type
    timestamp
    changes {
      field
      oldValue
      newValue
    }
  }
}

Implementation Guide

Setup Connection

import { BlocksyncClient } from '@ixo/blocksync-client'

const client = new BlocksyncClient({
  endpoint: 'https://blocksync.ixo.earth/graphql',
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
})

Define Queries

const GET_ENTITY = gql`
  query GetEntity($id: ID!) {
    entity(id: $id) {
      id
      type
      data
      claims {
        id
        status
      }
    }
  }
`

Execute Queries

const result = await client.query({
  query: GET_ENTITY,
  variables: { id: 'did:ixo:123' }
})

Handle Results

const { data, errors } = result
if (errors) {
  console.error('Query failed:', errors)
  return
}

const entity = data.entity
// Process entity data

Best Practices

Query Optimization

Error Handling

Performance

Available Environments

Production

https://blocksync.ixo.earth/graphql

Testnet

https://testnet-blocksync.ixo.earth/graphql

Development

https://devnet-blocksync.ixo.earth/graphql

Developer Resources

GraphQL Schema

Complete API schema reference

Query Examples

Sample queries and mutations

Client SDK

Client libraries and tools

For technical support or questions about Blocksync, join our Developer Community or contact our Developer Relations Team.

On this page

Overview
Architecture
Features
Data Indexing
Query Capabilities
Implementation Guide
Best Practices
Available Environments
Developer Resources

Overview

Real-time Indexing

Continuously processes and indexes blockchain events, transactions, and state changes

GraphQL API

Type-safe querying interface with support for complex relationships and filtering

Historical Data

Access to complete transaction history and state changes with efficient retrieval

Entity Relationships

Track connections between digital twins, claims, and verifications

Architecture

Core Components

Data Model

Query Layer

type Entity {
  id: ID!
  type: String!
  data: JSONObject!
  claims: [Claim!]
  verifications: [Verification!]
  transactions: [Transaction!]
  state: EntityState!
}

type Query {
  entity(id: ID!): Entity
  claims(filter: ClaimFilter): [Claim!]
  verifications(filter: VerificationFilter): [Verification!]
  transactions(filter: TransactionFilter): [Transaction!]
}

Features

Data Indexing

Event Processing

Real-time event capture
State transition tracking
Relationship mapping
Data transformation

Storage Optimization

Efficient indexing
Query optimization
Cache management
Data compression

Historical Data

Complete history
State snapshots
Change tracking
Audit trails

Query Capabilities

Entity Queries

query GetEntity {
  entity(id: "did:ixo:123") {
    id
    type
    data
    claims {
      id
      type
      status
    }
    verifications {
      id
      status
      verifier
    }
  }
}

Filtered Queries

query GetClaims {
  claims(
    filter: {
      type: "impact",
      status: "approved",
      fromDate: "2023-01-01"
    }
  ) {
    id
    type
    data
    evaluations {
      id
      status
      evaluator
    }
  }
}

Transaction History

query GetTransactions {
  transactions(
    filter: {
      entityId: "did:ixo:123",
      type: "state_change"
    }
  ) {
    id
    type
    timestamp
    changes {
      field
      oldValue
      newValue
    }
  }
}

Implementation Guide

Setup Connection

import { BlocksyncClient } from '@ixo/blocksync-client'

const client = new BlocksyncClient({
  endpoint: 'https://blocksync.ixo.earth/graphql',
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
})

Define Queries

const GET_ENTITY = gql`
  query GetEntity($id: ID!) {
    entity(id: $id) {
      id
      type
      data
      claims {
        id
        status
      }
    }
  }
`

Execute Queries

const result = await client.query({
  query: GET_ENTITY,
  variables: { id: 'did:ixo:123' }
})

Handle Results

const { data, errors } = result
if (errors) {
  console.error('Query failed:', errors)
  return
}

const entity = data.entity
// Process entity data

Best Practices

Query Optimization

Error Handling

Performance

Available Environments

Production

https://blocksync.ixo.earth/graphql

Testnet

https://testnet-blocksync.ixo.earth/graphql

Development

https://devnet-blocksync.ixo.earth/graphql

Developer Resources

GraphQL Schema

Complete API schema reference

Query Examples

Sample queries and mutations

Client SDK

Client libraries and tools

For technical support or questions about Blocksync, join our Developer Community or contact our Developer Relations Team.

On this page

Overview
Architecture
Features
Data Indexing
Query Capabilities
Implementation Guide
Best Practices
Available Environments
Developer Resources

​Overview

Real-time Indexing

GraphQL API

Historical Data

Entity Relationships

​Architecture

​Features

​Data Indexing

Event Processing

Storage Optimization

Historical Data

​Query Capabilities

​Implementation Guide

​Best Practices

​Available Environments

Production

Testnet

Development

​Developer Resources

GraphQL Schema

Query Examples

Client SDK

​Overview

Real-time Indexing

GraphQL API

Historical Data

Entity Relationships

​Architecture

​Features

​Data Indexing

Event Processing

Storage Optimization

Historical Data

​Query Capabilities

​Implementation Guide

​Best Practices

​Available Environments

Production

Testnet

Development

​Developer Resources

GraphQL Schema

Query Examples

Client SDK

Overview

Architecture

Features

Data Indexing

Query Capabilities

Implementation Guide

Best Practices

Available Environments

Developer Resources

Overview

Architecture

Features

Data Indexing

Query Capabilities

Implementation Guide

Best Practices

Available Environments

Developer Resources