https://github.com/motleylabs/mtly-nightmarket

An easy to use TypeScript API for interacting with the nightmarket.io marketplace contract.
https://github.com/motleylabs/mtly-nightmarket

Last synced: 3 months ago
JSON representation

An easy to use TypeScript API for interacting with the nightmarket.io marketplace contract.

• Host: GitHub
• URL: https://github.com/motleylabs/mtly-nightmarket
• Owner: motleylabs
• License: apache-2.0
• Created: 2023-05-17T05:32:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-14T18:07:18.000Z (4 months ago)
• Last Synced: 2024-09-15T03:37:14.995Z (4 months ago)
• Language: TypeScript
• Homepage: https://motleylabs.github.io/mtly-nightmarket/
• Size: 533 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - motleylabs/mtly-nightmarket - An easy to use TypeScript API for interacting with the nightmarket.io marketplace contract. (TypeScript)

README

        
# @motleylabs/mtly-nightmarket

[![npm][npm-image]][npm-url]

[![npm-downloads][npm-downloads-image]][npm-url]

[npm-downloads-image]: https://img.shields.io/npm/dm/@motleylabs/mtly-nightmarket.svg?style=flat

[npm-image]: https://img.shields.io/npm/v/@motleylabs/mtly-nightmarket.svg?style=flat

[npm-url]: https://www.npmjs.com/package/@motleylabs/mtly-nightmarket

An easy to use TypeScript API for interacting with the [nightmarket.io](https://nightmarket.io) marketplace contract.

This API is used by the [Night Market front end](https://github.com/motleylabs/nightmarket-oss).

## Contributing

We welcome contributions to Night Market from the community -- please open a pull request!

Feel free to join the [Motley DAO Discord](https://discord.gg/motleydao) to talk to the team and other community members.

All contributions are automatically licensed under the [Apache 2.0](LICENSE) license.

## Installation

You can install the package with [NPM](https://www.npmjs.com/package/@motleylabs/mtly-nightmarket) or using [Yarn](https://yarnpkg.com/package/@motleylabs/mtly-nightmarket).

### Using NPM

```bash

npm install @motleylabs/mtly-nightmarket

```

### Using Yarn

```bash

yarn add @motleylabs/mtly-nightmarket

```

#### Beta channel

The `beta` branch is available by using the `@motleylabs/mtly-nightmarket@beta` package.

## Getting Started

All marketplace actions are implemented as functions of the [`NightmarketClient`](https://motleylabs.github.io/mtly-nightmarket/classes/NightmarketClient.html). 

Each action returns the instructions to add to a Solana Web3.js [`VersionedTransaction`](https://solana-labs.github.io/solana-web3.js/classes/VersionedTransaction.html).

Example usge of the API can be found in the [`examples`](examples/) directory.