@estar.games/xcastle-api-provider-sdk

Description

@estar.games/xcastle-api-provider-sdk is a Software Development Kit (SDK) designed for seamless interaction with the XCastle API. This package simplifies communication with the XCastle API, allowing developers to access and manage various resources such as staking, missions, raids, and more.

Features

• Easy Access to various XCastle API endpoints.
• Get Missions and Bosses seamlessly.
• View Marketplace items on sale.
• Generic GET and POST Requests for flexible API interactions.

Table of Contents

• Installation
• Usage
• Contributing
• Contact

Installation

npm install @estar.games/xcastle-api-provider-sdk

Or using Yarn

yarn add @estar.games/xcastle-api-provider-sdk

Usage

After installation, you can import and use the SDK in your TypeScript or JavaScript project. Below is a simple example of how to use the SDK:

import { ApiProvider } from '@estar.games/xcastle-api-provider-sdk';

const provider = new ApiProvider("https://xcastle-api.estar.games");

// Example: Get the list of Assets allowed for staking
provider.getStakingAllowedAssets()
  .then((assets: Asset[]) => {
    console.log('Assets allowed for staking:', assets);
  })
  .catch((error: any) => {
    console.error('Error fetching staking allowed Assets:', error);
  });

Contributing

Contributions are welcome! Please follow the steps below to contribute to the project

1. Fork this repository.

2. Create a new branch for your feature or bug fix

git checkout -b feature/new-feature

3. Make the necessary changes and commit them

git commit -m "Add new feature"

4. Push the branch to your forked repository

git push -u origin feature/new-feature

5. Open a Pull Request and describe your changes.

Contact

For questions or support, please contact developers at [email protected]!