https://github.com/Fibrous-Finance/limit-order-sdk

The Fibrous Limit Order feature is designed to offer users a decentralized trading experience familiar to them.
https://github.com/Fibrous-Finance/limit-order-sdk

defi fibrousfinance finance limit-order starknet

Last synced: 15 days ago
JSON representation

The Fibrous Limit Order feature is designed to offer users a decentralized trading experience familiar to them.

• Host: GitHub
• URL: https://github.com/Fibrous-Finance/limit-order-sdk
• Owner: Fibrous-Finance
• License: mit
• Created: 2024-02-19T17:51:42.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-17T22:18:29.000Z (9 months ago)
• Last Synced: 2024-11-17T12:16:56.166Z (25 days ago)
• Topics: defi, fibrousfinance, finance, limit-order, starknet
• Language: TypeScript
• Homepage: https://fibrous.finance/
• Size: 235 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Contributing: docs/CONTRIBUTING.md

Awesome Lists containing this project

• awesome-starknet - Fibrous Limit Order SDK - Fibrous Limit Order SDK. (Open-source projects)

README

        


  

    

  



# Fibrous Finance Limit Order SDK (v0.1.3)

The Fibrous Finance Limit Order SDK is a JavaScript library that provides tools and functionalities for interacting with the Fibrous Finance Limit Order protocol. It allows developers to programmatically access and utilize various features of the protocol, such as retrieving orders, placing orders, canceling orders, and more.

## Table of Contents

-  [Installation](#installation)

-  [Usage](https://github.com/Fibrous-Finance/limit-order-sdk/blob/main/examples/readme.md)

   -  [getOrders](https://github.com/Fibrous-Finance/limit-order-sdk/blob/main/examples/src/getOrders.ts)

   -  [getNonce](https://github.com/Fibrous-Finance/limit-order-sdk/blob/main/examples/src/getNonce.ts)

   -  [getRemainingAmount](https://github.com/Fibrous-Finance/limit-order-sdk/blob/main/examples/src/getRemainingAmount.ts)

   -  [signMessage](https://github.com/Fibrous-Finance/limit-order-sdk/blob/main/examples/src/signMessage.ts)

   -  [placeOrder](https://github.com/Fibrous-Finance/limit-order-sdk/blob/main/examples/src/placeOrder.ts)

   -  [fillOrder](https://github.com/Fibrous-Finance/limit-order-sdk/blob/main/examples/src/fillOrder.ts)

## Installation

```bash

# NPM

npm install @fibrous/limit-order-sdk

# Yarn

yarn add @fibrous/limit-order-sdk

# PNPM

pnpm add @fibrous/limit-order-sdk

```

## Documentation

The complete documentation for the Fibrous Finance Limit Order SDK can be found [here](https://docs.fibrous.finance/fibrous-solutions/fibrous-limit-order).

## Contributing

Contributions to the Fibrous Finance Limit Order SDK are welcome! If you find any issues or have suggestions for improvement, feel free to open an issue or submit a pull request.

## License

This project is licensed under the MIT License.