npm.io
1.3.1 • Published 4 years ago

niftyconnect-js

Licence
MIT
Version
1.3.1
Deps
5
Size
706 kB
Vulns
0
Weekly
0

The JavaScript SDK/Sample to interact with Niftyconnect contracts. It includes the following three methods.

  • makeOrder - Approve an order and optionally mark it for orderbook inclusion
  • cancelOrder - Cancel an order, preventing it from being matched
  • takeOrder - Atomically match two orders, ensuring validity of the match, and execute all associated state transitions
  • setRoyalty - Set percentage-based royalty fee by collection owner

You can find more detailed documentation in our Documentation pages.

Installation

$ npm i niftyconnect-js
# Or:
$ yarn add niftyconnect-js

Getting Started

It uses ethersjs and ethereum provider(provided by metamask) by default

Make fixed price order

  import { makeOrder } from 'niftyconnect-js'
  import moment from 'moment'

  const params = {
    nftAddress: 'xxxx', //The asset's contract address
    paymentToken:'xxxx', //payment token contract address
    listPrice:2,//
    listTime:moment(),
    expireTime:moment('xxxx'),
    tokenId: 1111,
    amount: 1,
    chainId:1,
    side: 1, // sell=1, buy=0
    saleKind: 0, //FixedPrice=0, TimedAuction = 1
    tokenStandard: 1, // erc1155=1, erc721=0
    orderType: 'Normal', //'Normal' | 'Collection' | 'Trait'
  }

  const tx = await makeOrder(params)

Contributing

Contributions to the Niftyconnect JavaScript SDK are welcome.