Skip to content

Latest commit

 

History

History
91 lines (60 loc) · 3.6 KB

README.md

File metadata and controls

91 lines (60 loc) · 3.6 KB

Ixian-ExplorerClient

Ixian-ExplorerClient is a console-based software designed to expose a RESTful API. This API includes comprehensive functionality from the Ixian-Core local API with request forwarding to the Ixian Explorer API. This projects aims to provide a low overhead way of interacting with the Ixian blockchain without requiring a full node.

Features

  • Local Ixian API: Expose local functionalities of the Ixian-Core.
  • Proxy for Ixian Explorer API: Forward requests to the official Ixian Explorer API.
  • Lightweight and Console-Based: Designed for minimal system overhead and easy deployment.
  • RESTful API: Provides a simple, HTTP-based interface for integration with other tools or services.

Requirements

  • Ixian Explorer API key
  • .NET SDK (version 8.0 or higher)

Usage

  1. Clone the repository:

    git clone https://github.com/yourusername/Ixian-ExplorerClient.git
cd Ixian-ExplorerClient

  2. Restore dependencies and build the project:

    dotnet restore
dotnet build --configuration Release

  3. Run the software:

    cd IxianExplorerClient/bin/Release/net8.0/
./IxianExplorerClient --apikey YOURAPIKEY

Accessing the API

Once the Ixian-ExplorerClient is running, the API will be available at http://localhost:8001. You can use tools like curl, Postman, or your preferred HTTP client to interact with it.

API Documentation

  • Ixian Local API: Refer to the Ixian Local API Documentation Ixian Core Generic API Commands section for details on available endpoints and their usage.
  • Ixian Explorer API: The API adheres to the OpenAPI specification. You can find the OpenAPI YAML file in this repository at docs/explorer-api.yaml.

Ixian-ExplorerClient automatically attaches the API KEY to all requests forwarded to the Explorer API.

Usage

Below are some example use cases for the Ixian-ExplorerClient API. For more commands and optional parameters check the API Documentation section above.

Get all addresses and balances for the currently loaded wallet

curl http://localhost:8001/mywallet

Fetching address details such as amount, lastblock and txcount for a specific address

curl http://localhost:8001/addresses/16LUmwUnU9M4Wn92nrvCStj83LDCRwvAaSio6Xtb3yvqqqCCz

Fetch recent transactions for a specific address

curl http://localhost:8001/addresses/16LUmwUnU9M4Wn92nrvCStj83LDCRwvAaSio6Xtb3yvqqqCCz/recent

Configuration

Configuration is done via the command line by providing the following parameters:

  • --apikey: Required. Specifies the Explorer API key.
  • --apiurl: Optional. Specifies a custom Explorer API URL. Default is https://explorer.ixian.io/api/v1
  • -w: Optional. Specifies a different wallet name when the software starts. Default is ixian.wal

Alternatively, the API key can be hardcoded by modifying the Meta/Config.cs file and supplying the explorerAPIKey with the proper value.

Get in touch / Contributing

If you feel like you can contribute to the project, or have questions or comments, you can get in touch with the team through Discord: https://discord.gg/pdJNVhv

Pull requests

If you would like to send an improvement or bugfix to this repository, but without permanently joining the team, follow these approximate steps:

  1. Fork this repository
  2. Create a branch (preferably with a name that describes the change)
  3. Create commits (the commit messages should contain some information on what and why was changed)
  4. Create a pull request to this repository for review and inclusion.