Documentation

Introduction

RelayLink provides blockchain development services and a managed platform for building on blockchain technology. This documentation covers the platform tooling, the indexed APIs and the infrastructure your team operates.

If you are evaluating us for a project, start with the services page or talk to an engineer. If you are already working with us, your technical lead will provision your environment and credentials.

Quickstart

Create a managed blockchain environment, deploy a contract and publish an indexed API in three commands:

# Install the RelayLink CLI
npm install -g @relaylink/cli

# Create a managed environment
relaylink init my-network --chain polygon

# Deploy contracts and publish indexed data
relaylink contracts deploy ./contracts
relaylink api publish --index events

The CLI writes a relaylink.json configuration file to your project. Commit it — it defines the environment, the contract set and the published APIs.

CLI Reference

The CLI is the primary interface for environment and contract management.

relaylink init <name> --chain <network>   # create an environment
relaylink env list                        # list environments
relaylink contracts build                 # compile contracts
relaylink contracts test                  # run the test suite
relaylink contracts deploy <path>         # deploy to the environment
relaylink contracts upgrade <name>        # upgrade behind a proxy
relaylink api publish --index <events>    # publish an indexed API
relaylink logs --env <name>               # stream environment logs

Contract Deployment

Contracts are compiled and tested locally, then deployed through a pipeline that records the version, the compiler settings and the deployment transaction.

// contracts/AccessRegistry.sol
pragma solidity ^0.8.24;

contract AccessRegistry {
    mapping(address => bool) public verified;

    event Verified(address indexed account);

    function verify(address account) external {
        verified[account] = true;
        emit Verified(account);
    }
}

Deployment output includes the contract address, the transaction hash and the ABI. Upgradeable contracts use an audited proxy pattern with a timelock and multi-signature approval.

Indexed APIs

Once an API is published, on-chain events and state are queryable over REST and GraphQL. Reads are served from the platform's indexer — no node round-trip per query.

# Query indexed events
curl "https://api.relaylink.io/v1/my-network/events?name=Verified&limit=10"

# Query current contract state
curl "https://api.relaylink.io/v1/my-network/contracts/AccessRegistry/state"

Responses are JSON, paginated with a cursor, and include the block number and transaction hash for every record so results can be verified on-chain.

Webhooks

Subscribe to on-chain events and receive signed HTTP callbacks when they occur.

POST https://api.relaylink.io/v1/my-network/webhooks
{
  "url": "https://your-app.example/webhooks/relaylink",
  "events": ["Verified"],
  "secret": "whsec_..."
}

Every delivery is signed with the webhook secret. Retries use exponential backoff for 24 hours, and failed deliveries are visible in the dashboard.

Node Infrastructure

Environments run on managed nodes with health monitoring, automatic failover and snapshot backups. Teams that prefer to operate their own nodes can use the platform's RPC gateway in front of their infrastructure.

Security Model

Access to environments is role-based. Signing keys are held in managed key storage and every deployment, upgrade and API change is recorded in an immutable audit log.

Support

Every engagement includes a named technical lead. Platform support is available by email and, for operations retainers, through an on-call escalation path.

Documentation questions and bug reports: support@relaylink.io