Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sdk): add sdk base create listing, offer & cancel order #203

Merged
merged 11 commits into from
Dec 8, 2023
Merged

Conversation

kwiss
Copy link
Contributor

@kwiss kwiss commented Dec 4, 2023

Description

New JS SDK Library for ArkChain Orderbook Interaction

This pull request introduces a new SDK library specifically designed for interacting with the ArkChain orderbook. This library is a comprehensive toolset enabling users to effectively engage with ArkChain's functionalities. The following outlines the key features and components included in this initial release:

Features

  • Account Creation (Burner Wallet): Facilitates the creation of new accounts, functioning as burner wallets for transactions.
  • Listing Creation: Provides the ability to create listings on the ArkChain orderbook.
  • Offer Creation: Enables the creation of offers within the orderbook environment.
  • Order Cancellation: Offers the functionality to cancel existing orders.
  • Fulfilling Listings: Introduces the capability to fulfill active listings in the orderbook.
  • Fulfilling Offers: Allows users to fulfill existing offers within the orderbook.

Example Scripts

  • A set of example scripts are included to demonstrate practical applications of the SDK functions, such as creating accounts, listings, offers, and more.

Testing

  • Comprehensive tests using Chai and Mocha have been added to validate the interaction with the ArkChain. These tests cover all the core features of the SDK, ensuring reliability and performance.

This SDK represents a foundational step in streamlining and simplifying interactions with the ArkChain orderbook, providing developers with the tools necessary for efficient and effective blockchain engagements.

What type of PR is this? (check all applicable)

  • 🍕 Feature (feat:)

Related Tickets & Documents

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

  • 📜 README.md
  • 📓 Documentation
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

PR Title and Description Guidelines:

  • Ensure your PR title follows semantic versioning standards. This helps automate releases and changelogs.
  • Use types like feat:, fix:, chore:, BREAKING CHANGE: etc. in your PR title.
  • Your PR title will be used as a commit message when merging. Make sure it adheres to Conventional Commits standards.

Closing Issues

@kwiss kwiss marked this pull request as draft December 4, 2023 09:44
@kwiss kwiss marked this pull request as ready for review December 6, 2023 11:58
@kwiss kwiss requested review from remiroyc, gershon and YohanTz December 7, 2023 17:00
@kwiss kwiss merged commit 296b1d9 into main Dec 8, 2023
5 checks passed
@kwiss kwiss deleted the feat/sdk branch December 8, 2023 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants