colossus-sdk-typescript
v1.0.4
Published
The ColossusClient SDK is a robust client library for interacting with the Colossus Staking API. It streamlines processes such as authentication, token generation, and managing transaction flows.
Downloads
9
Readme
ColossusClient SDK
The ColossusClient SDK is a robust client library for interacting with the Colossus Staking API. It streamlines processes such as authentication, token generation, and managing transaction flows.
Features
Easy generation of authentication tokens.
Creating and managing transaction flows.
Executing actions within transaction flows.
Built-in error handling for unauthorized access.
Installation
To install the ColossusClient SDK in your project, run the following command:
npm i colossus-sdk-typescript
Getting Started
Here's a quick guide on how to get started with the ColossusClient SDK.
Initialization
import ColossusClient from 'colossus-sdk-typescript';
const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://api.colossus.com';
const colossusClient = new ColossusClient(apiKey, baseUrl);
Generating an Authentication Token
Generate an authentication token using your parameters:
const tokenParams = {
// ... your token generation parameters ...
};
colossusClient.generateToken(tokenParams)
.then(response => console.log('Token generated:', response))
.catch(error => console.error('Error generating token:', error));
Creating a Transaction Flow
Create a new transaction flow:
const flowParams = {
// ... your flow parameters ...
};
colossusClient.createTxFlow(flowParams)
.then(flowResponse => console.log('Flow created:', flowResponse))
.catch(error => console.error('Error creating flow:', error));
Executing a Flow Action
Execute an action within a flow:
const flowId = 'FLOW_ID';
const actionParams = {
// ... your action parameters ...
};
colossusClient.executeFlowAction(flowId, actionParams)
.then(flowResponse => console.log('Flow action executed:', flowResponse))
.catch(error => console.error('Error executing flow action:', error));