Environment Integration

Environment Requirements and Technology Stack

• Frontend Frameworks: React, Vue.js, Native HTML/JavaScript

• Development Requirements: Support for ES6+ syntax and modular development

Important Reminder: The relayx-api library must run in the RelayX container environment. Please ensure that the deployment environment meets this requirement.

Integration Methods

Install Dependencies

Install

npm install relayx-api

Import Library Files

ES Module import

import { RelayXClient } from "relayx-api";

Native JavaScript Project Integration

1

Include Script Files — UMD build

Download the UMD build file:

https://github.com/RelayX-Protocol/RelayX-API/blob/main/dist/relayx-api.umd.js

2

Include script in HTML

<script src="path/to/relayx-api.umd.js"></script>

API Usage Instructions

Create Instance

Create client instance

const relayx = new RelayXClient({timeout:30000});

Parameter description:

• Pass in a configuration object containing optional parameters

• timeout: API call timeout in milliseconds, default 30000 milliseconds

API Method Calls

Example API call

let result = await relayx.{cmd}(payload, sign);

Parameter description:

• cmd: The specific API interface method name

• payload: The parameter object for the interface call

• sign: API authentication signature object (optional parameter)

Return value: All API methods return Promise objects. It is recommended to use async/await syntax to handle asynchronous calls.