@goblinsax/goblink-sdk NPM

Goblink-SDK

Overview

The Goblink-SDK acts as a bridge between the GoblinSax Analytical Backend and supported Execution Layers. This SDK provides specific functions for creating, modifying, or deleting NFT Loan Offers on the supported Execution Layers. By standardizing the data input for these functions, it simplifies interaction with the supported partner protocols.

Installation

The Goblink-SDK is available as an npm package. You can install it by running the following command:

npm install @goblinsax/goblink-sdk

To work directly on the codebase, follow these steps: 1. Clone the repository to your local machine. 2. Run npm install to install the necessary modules. 3. Rename the .env-example file to .env and provide the required data. 4. Build the project using npm build. 5. Start the project using npm start.

If you're a developer working on the codebase, run npm start:dev in a separate terminal window to enable automatic rebuilding with nodemon on code changes.

Usage

The /examples folder contains code snippets demonstrating how to use the Goblink-SDK. After initializing an instance of the Goblink-SDK, you can make function calls such as goblinkSDK.sendNftfiOffer() and pass the necessary parameters.

Contributing

We welcome your contributions! Feel free to open issues on this GitHub repository to share your ideas or report any bugs. You can also join our Discord community to discuss desired changes or improvements. As this project is in the early stages of development, your feedback is valuable and will help us enhance the SDK.

Current Limitations

The Goblink-SDK is an evolving project, and new features will be gradually introduced. Stay updated by checking the release notes for information on the latest enhancements.