cBridge SDK

Обзор

cBridge SDK позволяет новым и существующим приложениям интегрироваться с богатым набором функций, доступных в cBridge, чтобы встроить в свои приложения функциональность передачи данных в приложении. Библиотеки и пакеты доступны и позволяют быстро реализовать функциональность в вашем dApp. cBridge SDK также позволяет настраивать пользовательский интерфейс и предоставлять пользователям нативные возможности передачи активов.

Кроме того, cBridge Transfer Web Widget предоставляет облегченную версию cBridge SDK, что упрощает интеграцию и позволяет включить передачу cBridge с полной поддержкой исходных файлов.

Рабочий процесс SDK

На следующем графике показана общая интеграция cBridge SDK в ваше приложение. В большинстве случаев вам нужно поддерживать только две функции (красные линии на графике):

1. Отправлять запросы на шлюз cBridge через cBridge SDK

2. Отправлять соответствующую транзакцию на чейне в контракт cBridge.

Установка

Настоятельно рекомендуется взаимодействовать со шлюзом cBridge с помощью grpc-web.

1. Все сообщения определены в protobuf, вместо enum значения 1 можно напрямую использовать значение перечисления, например Completed. Это помогает уменьшить количество ошибок, связанных со случайным отображением.

2. Внутри шлюза cBridge есть несколько пост-API, которым требуется сериализованный массив байтов (byteArray) в качестве ввода. Это требует определенных шагов для подготовки формата, принимающего информацию запроса. На случай, если вы предпочитаете RESTful API-запросы

3. Поскольку cBridge часто итерируется, лучший способ обновить все - использовать grpc. Вы всегда можете проверить последние сгенерированные файлы grpc и быть в курсе последних версий шлюза cBridge.

1. Установите grpc-web

1. Чтобы начать разработку с помощью cBridge SDK, каждому разработчику необходимо установить grpc-web - коммуникационный шлюз cBridge.

// Install via yarn
yarn add grpc-web

// Install via npm
npm install grpc-web

2. Скачайте клиент и контракт cBridge type-script

Загрузите автогенерируемые файлы protobuf (включая xxx_pb.d.ts, xxx_pb.js) в репо клиента cBridge typescript.

3. Импортируйте cBridge SDK в свои проекты

Импортируйте файл и сообщения, определяющие тип. Они могут быть использованы в вашем проекте. Ниже приведен фрагмент кода для использования клиента type-script в проекте JavaScript.

// import getTransferConfig request message
import {
GetTransferConfigsRequest
GetTransferConfigsResponse
}
from "../ts-proto/sgn/gateway/v1/gateway_pb";
// import grpc-web WebClient
import { WebClient }
from "../ts-proto/sgn/gateway/v1/GatewayServiceClientPb";
const request = new GetTransferConfigsRequest();
const client = new WebClient(`https://cbridge-prod2.celer.app/`, null, null);
const response = await client.getTransferConfigs(request, null);