Intents Connect SDK

An SDK for Intents Connect.

This SDK includes a client generated from OpenAPI specs of the Intents Connect API.

Installation

yarn add @aurora-is-near/intents-connect-sdk

Usage

Create the API client as follows:

import { createApiClient } from '@aurora-is-near/intents-connect-sdk';

const client = createIntentsConnectApiClient();

The generated API client object exposes functions for each API endpoint. Details of how to use these endpoints are documented against the available function names in the operations section, below.

Operations

The API client exposes the following functions:

• fetchExectution
• submitExectution
• FetchIntermediaryAccounts
• submitDigest
• depositSubmit

Each function can be called with an object containing the following properties:

params

An object containing properties that are mapped to named route parameters. For example, if you have the route /user/:name, then the name property should be passed in as params: { name: 'Alex' }.

query

An object containing a property for each query string parameter.

data

An object containing key-value to submit as the request body (i.e. for POST or PUT requests).

Configuration

The client can be configured with the following options, which are passed when calling createIntentsConnectApiClient:

onError

Called when an unexpected server-side error occurs (e.g. 500).

onClientError

Called when a client error occurs (e.g. 400 or 404).

onTimeoutError

Called when a request times out.

timeout

How long to wait before timing out a request.

Example

import { createApiClient } from '@aurora-is-near/intents-connect-sdk';
import { logger } from './my-logger';

const client = createIntentsConnectApiClient({
  onError: logger.error,
});

client.fetchExecution({
  params: {
    wallex: "0x123",
  },
  query: {
    status: "CREATED",
  },
});

Local development

If working on this package locally:

# Install dependencies
yarn install

# Lint
yarn lint

# Test
yarn test

Updating the API client

To generate a new version of the API client we currently copy the OpenAPI specification that can be exported from here into the swagger.yml file in this repository. We can then run the following command to generate a new version of the API client:

yarn generate