Rarible ImmutableX SDK

Rarible Immutable SDK enables easily interaction with ImmutableX layer 2 on Rarible Protocol.

Installation

yarn add @rarible/immutable-sdk @imtbl/imx-sdk @imtbl/imx-link-sdk

Usage

SDK is written in TypeScript. You can use typings to explore SDK possibilities.

Initialization

import { createImxSdk } from "@rarible/immutable-sdk"
import Web3 from "web3"
import { Web3Ethereum } from "@rarible/web3-ethereum"

const web = new Web3(ethereum)
const web3Ethereum = new Web3Ethereum({ web3: web })
const sdk = createImxSdk(web3Ethereum, "dev")

ethereum — Metamask browser instance (window.ethereum)

Create sell order

sdk.order.sell({
	takeAssetType: { assetClass: "ETH" },
	makeAssetType: {
		assetClass: "ERC721",
		contract,
		tokenId
	},
	amount: 1,
	price: "0.1",
	payouts: [{ account: Address, value: BigNumber }],
	originFees: [{ account: Address, value: BigNumber }]
})

Fill an order

sdk.order.buy({
	orderIds: [""],
	fee: [{ account: Address, value: BigNumber }]
})

Cancel an order

sdk.order.cancel({
	orderId: "12345",
})

Suggestions

You are welcome to suggest features and report bugs found!

Contributing

The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests" (PRs). This facilitates social contribution, easy testing, and peer review.

See more information on CONTRIBUTING.md.

License

Rarible Immutable SDK is available under the MIT License.

rarible / immutable-x-sdk