Giter VIP home page Giter VIP logo

immutable-x-sdk's Introduction

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.

immutable-x-sdk's People

Contributors

dependabot[bot] avatar mazinden avatar nikolay-ryabinin-rarible avatar varuzam avatar vitalbadjo avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.