Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leionion/fractal-ordinal-market-amm
This is an Automatic market maker for Ordinal Marketplace built on the Fractal Bitcoin network. Users can list their ordinals on this market, and buyers can purchase or place orders for listed ordinals based on ordinal theory within the Fractal ecosystem.
https://github.com/leionion/fractal-ordinal-market-amm
amm automatic bitcoin fractal fractalbitcoin maker market ordinal
Last synced: 2 months ago
JSON representation
This is an Automatic market maker for Ordinal Marketplace built on the Fractal Bitcoin network. Users can list their ordinals on this market, and buyers can purchase or place orders for listed ordinals based on ordinal theory within the Fractal ecosystem.
- Host: GitHub
- URL: https://github.com/leionion/fractal-ordinal-market-amm
- Owner: leionion
- Created: 2024-09-20T23:23:38.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-22T07:15:27.000Z (2 months ago)
- Last Synced: 2024-10-23T10:26:26.325Z (2 months ago)
- Topics: amm, automatic, bitcoin, fractal, fractalbitcoin, maker, market, ordinal
- Language: TypeScript
- Homepage:
- Size: 95.7 KB
- Stars: 5
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fractal-ordinal-market-AMM
This is an Automatic market maker for Ordinal Marketplace built on the Fractal Bitcoin network. Users can list their ordinals on this market, and buyers can purchase or place orders for listed ordinals based on ordinal theory within the Fractal ecosystem.
## Overview
- **Network:** Fractal Bitcoin
- **Functionality:** Listing, purchasing, and managing ordinals based on ordinal theory
- **Documentation:** Swagger integrated for API documentation
## Setup and Configuration
### Prerequisites
- Ensure Node.js is installed.
- Create an `.env` file using `.env.example` as a reference.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/leionion/fractal-ordinal-market-AMM.git
cd fractal-ordinal-market-AMM
```
2. Install project dependencies:
```bash
npm install
```
3. Configure environment variables in `.env`:
```plaintext
NETWORKTYPE=TESTNET
PORT=3000
MONGODB_URI=mongodb://localhost:27017/fractal-ordinal-market-AMM
```
4. Launch the server:
```bash
npm start
```
## Application Usage
Once the server is started, access the server on the specified port (default: 3000). The API documentation is available via Swagger UI at `http://localhost:3000/api-docs`.
## API Endpoints
### Listing Management
- **Create Listing**: `/api/create-listing`
Method: `POST`
Functionality: Lists ordinals for sale on Fractal network; responds with a Partially Signed Bitcoin Transaction (PSBT).
- **Save Listing**: `/api/save-listing`
Method: `POST`
Functionality: Saves a signed PSBT in the listings database.
- **Relist**: `/relist`
Method: `POST`
Functionality: Updates listing price with a new PSBT requiring the seller's signature.
- **Confirm Relist**: `/confirm-relist`
Method: `POST`
Functionality: Confirms updated price with a signed PSBT.
- **Delist**: `/delist`
Method: `POST`
Functionality: Removes ordinals from listing and returns them to the seller.
### Offer Management
- **Create Offer**: `/api/create-offer`
Method: `POST`
Functionality: Creates a transaction for purchasing ordinals; includes a platform fee upon success.
- **Submit Offer**: `/api/submit-offer`
Method: `POST`
Functionality: Completes a purchase with a signed PSBT, incurring a 1% platform fee on the seller.
## MongoDB Schema
- Integrated MongoDB schema design to support listing and offer operations, ensuring efficient database interactions.
## Contact Info
This is initial Version. I just published initial version for basic functionality for automatic market maker model backend.
If you need more technical support and development inquires, you can contact below.
- **Twitter:** [@chain_sats](https://x.com/chain_sats/)
- **Telegram:** [@inscNix](https://t.me/inscNix/)