Graph Middleware

Enterprise Blockchain Data Infrastructure

Enterprise middleware transforms complex blockchain networks into business-ready data infrastructure, providing production-scale data indexing, high-performance API access, and real-time event monitoring. SettleMint's middleware solutions eliminate the complexity of building custom blockchain data layers, enabling enterprises to focus on business logic rather than infrastructure management.

How to add middleware

settlemint login

# Get the list of available middleware types
settlemint platform create middleware --help

# Create a middleware
settlemint platform create middleware <type> <n>

# Get information about the command and all available options
settlemint platform create middleware <type> --help

import { createSettleMintClient } from '@settlemint/sdk-js';

const client = createSettleMintClient({
  accessToken: 'your_access_token',
  instance: 'https://console.settlemint.com'
});

// Create middleware
const result = await client.middleware.create({
  applicationUniqueName: "your-app-unique-name",
  name: "my-middleware",
  type: "SHARED",
  interface: "HA_GRAPH", // Valid options: "HA_GRAPH" | "SMART_CONTRACT_PORTAL"
  blockchainNodeUniqueName: "your-node-unique-name",
  region: "EUROPE",  // Required
  provider: "GKE",   // Required
  size: "SMALL"      // Valid options: "SMALL" | "MEDIUM" | "LARGE"
});
console.log('Middleware created:', result);

Manage middleware

# List middlewares
settlemint platform list middlewares --application <app-name>

# Get middleware details
settlemint platform read middleware <middleware-name>

// List middlewares
await client.middleware.list("your-app-unique-name");

// Get middleware details
await client.middleware.read("middleware-unique-name");

The Graph - Production Blockchain Data Platform

The Graph middleware delivers enterprise-grade blockchain data indexing through production-ready subgraphs. Deploy this solution when your enterprise requires:

Using the graph sdk

import { createTheGraphClient } from "@settlemint/sdk-thegraph";

const { client: graphClient, graphql } = createTheGraphClient({
  instances: JSON.parse(
    process.env.SETTLEMINT_THEGRAPH_SUBGRAPHS_ENDPOINTS || "[]"
  ),
  accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!,
  subgraphName: "your-subgraph",
});

Enterprise Graph Protocol Implementation

The Graph powers SettleMint's enterprise blockchain data infrastructure, providing production-scale indexing for all EVM-compatible chains including Ethereum, Hyperledger Besu, Polygon, Avalanche, and custom enterprise networks. This battle-tested protocol handles billions of blockchain events daily across global enterprises.

Subgraph Architecture

SettleMint provides enterprise-ready subgraph modules that eliminate months of development time:

When the middleware is deployed, follow these steps to start using it:

Define and deploy a subgraph

Navigate to the smart contract set which you want to index, go the details and open the IDE. Here you will define the subgraph to set the indexing specifications, and deploy it so it can be loaded into the middleware. There are instructions included in the IDE to help you.

Subgraph raw configuration

Inside the root you will find a file called subgraph.config.json that contains the raw configuration of the subgraph. The important section is the datasources section.

• Name - here we defined the smart contracts with their name (the name of the artifact created in the 'deployments' folder when running the deploy task)
• Address & Startblock - You will notice the startblock and address to be 0. You must fill these in when your contract has been deployed. The block number and the address can be found in the deployment folder, under ignition.
• Module - In the modules array all the indexing modules to activate for this smart contract.

About the indexing modules

We provide two libraries of indexing modules: one by the OpenZeppelin team for all the common smart contracts in their smart contract library, and one by the SettleMint team to extend the capabilities of the OpenZeppelin one, and to provide indexing of the specific SettleMint smart contract sets.

The OpenZeppelin set contains the following indexing modules:

• accesscontrol
• erc1155
• erc1967upgrade
• erc20
• erc721
• governor
• ownable
• pausable
• timelock
• voting

The SettleMint set contains the following indexing modules:

• erc721ipfs: to extend the ERC-721 from OpenZeppelin to index IPFS metadata of your ERC-721 tokens
• crowdsale/vestingvault/vestingwallet: to index and expose all the data for the crowdsale contract set
• forwarder: for the ERC-20 Meta transactions forwarder data
• statemachinemetadata: to index IPFS metadata for state machines

These are available in the subgraph folder in your IDE. You can create your own modules for any other data you want to index, or for custom smart contracts not part of the default sets. And you can modify the existing ones if you want to index things a bit different.

Write your own indexing module

You can also write your own custom indexing module for smart contracts that are not part of the default sets.

Follow these steps to create a custom indexing module:

• Primitives to generate a GraphQL schema: subgraph/datasource/x.gql.json - In order to allow composability, the schema are not defined in the GraphQL format but rather in a dedicated JSON format which is can be assembled and compiled to GraphQL.
• Template to generate a subgraph manifest: subgraph/datasource/x.yaml - This file lists all the events that the datasources should listen to, and links that to the corresponding indexing logic.
• Indexing logic: subgraph/datasources/x.ts and (optionally) subgraph/fetch/x.ts - This is the core logic that processes the events to index the onchain activity.

To learn more, check it out on Github.

Start your subgraph

The following tasks need to be run in this sequence:

• bunx settlemint scs subgraph codegen - Generates the AssemblyScript types for your contracts ABI.
• bunx settlemint scs subgraph build - Compiles the WASM files based on the outputs generated by bunx settlemint scs subgraph codegen.
• bunx settlemint scs subgraph deploy - Deploys the WASM files to IPFS and updates the middleware to start or update the indexing.

The indexing of your smart contracts has now started. This can take a while, but once done you can query the middleware for your data in seconds using the GraphQL API. You can find the endpoint in the Connect-tab.