Merge pull request rarible#383 from rarible/PT-823/immutable_docs

Immutabex docs

docs/api-reference.md

@@ -37,11 +37,15 @@ The API interacts with different blockchain networks for different environments.
 * Tezos: mainnet
 * Flow: mainnet
 * Polygon: mainnet
+* Solana: mainnet-beta
+* Immutablex: mainnet
 
 **Testnet**:
 
 * Ethereum: rinkeby
 * Tezos: ithaca
 * Flow: devnet
 * Polygon: mumbai
+* Solana: devnet
+* Immutablex: ropsten
 

docs/features.md

@@ -1,20 +1,14 @@
----
-title: Rarible Protocol Features List
-description: Main Multichain Protocol supported features
----
-
 # Rarible Protocol Features List
 
 | **Multichain Protocol supported features** | Description |
 |----------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
 | **NFT API** (Items/Collections/Ownership/Activity/Users) | ETH POL TEZ FLOW SOL IMX |
 | Metadata | ETH POL TEZ FLOW SOL IMX |
+| **NFT** Liquidity Get Orders | ETH (Rarible, SeaPort, LooksRare, x2y2, Rarible Community Marketplaces) POL (Rarible) TEZ (Rarible, Objkt, HEN) FLOW (Rarible, NFT Storefront) SOLANA IMX (on-chain order book) |
 | **NFT** Liquidity Get Orders | ETH (Rarible, SeaPort, LooksRare, x2y2, Rarible Community Marketplaces) POL (Rarible) TEZ (Rarible, Objkt, HEN) FLOW (Rarible, NFT Storefront) SOLANA IMX (on-chain orderbook) |
 | **Rarible SDK** | |
 | Mint NFTs | ETH POL TEZ FLOW SOL |
 | Lazy Mint NFTs | ETH POL |
 | Execute order | ETH POL TEZ FLOW SOL IMX |
 | Bulk orders execute | ETH POL TEZ FLOW SOL IMX |
-| **Additional NFT collections** | **ETH** [CryptoPunks](https://www.larvalabs.com/cryptopunks) **FLOW** MotoGP, Evolution, Mugen ARt, Vault by CNN, Starly, Matrix World Voucher, Matrix World Flow Fest, VersusArt, DisruptArt, OneFootball, Jambb, Fanfare, Chainmonsters, Barter Yard Club, ClosedSrc **SOL** [Degenerate Ape Academy](https://marketplace.degenape.academy/explore/SOLANA:DSwfRF1jhhu6HpSuzaig1G19kzP73PfLZBPLofkw6fLD) |
-
-
+| **Additional NFT collections** | **ETH** [CryptoPunks](https://www.larvalabs.com/cryptopunks) **FLOW** MotoGP, Evolution, Mugen ARt, Vault by CNN, Starly, Matrix World Voucher, Matrix World Flow Fest, VersusArt, DisruptArt, OneFootball, Jambb, Fanfare, Chainmonsters, Barter Yard Club, ClosedSrc **SOL** [Degenerate Ape Academy](https://marketplace.degenape.academy/explore/SOLANA:DSwfRF1jhhu6HpSuzaig1G19kzP73PfLZBPLofkw6fLD) |

docs/getting-started/sdk-react-example.md

@@ -36,7 +36,7 @@ Our Example App will use some dependencies. To install them, run:
 yarn add @rarible/connector @rarible/connector-helper @rarible/connector-beacon @rarible/connector-fcl \
  @rarible/connector-fortmatic @rarible/connector-iframe @rarible/connector-mew \
  @rarible/connector-phantom @rarible/connector-portis @rarible/connector-solflare \
- @rarible/connector-torus @rarible/connector-walletconnect \
+ @rarible/connector-torus @rarible/connector-walletconnect @rarible/connector-immutablex-link \ 
  @rarible/connector-walletlink @rarible/sdk @rarible/types
 ```
 
@@ -64,7 +64,7 @@ Create the `src/connector` folder and `connectors-setup.ts` file there. It lists
  import { PhantomConnectionProvider } from "@rarible/connector-phantom"
  import { SolflareConnectionProvider } from "@rarible/connector-solflare"
  import type { IWalletAndAddress } from "@rarible/connector-helper"
- import { mapEthereumWallet, mapFlowWallet, mapSolanaWallet, mapTezosWallet } from "@rarible/connector-helper"
+ import { mapEthereumWallet, mapFlowWallet, mapSolanaWallet, mapTezosWallet, mapImmutableXWallet } from "@rarible/connector-helper"
  // import { FortmaticConnectionProvider } from "@rarible/connector-fortmatic"
  // import { PortisConnectionProvider } from "@rarible/connector-portis"
 
@@ -138,6 +138,15 @@ Create the `src/connector` folder and `connectors-setup.ts` file there. It lists
   }
   }
  }
+
+ function environmentToImmutableXEnv(environment: RaribleSdkEnvironment) {
+  switch (environment) {
+  case "prod":
+  return "prod"
+  default:
+  return "dev"
+  }
+ }
 
  const state: IConnectorStateProvider = {
   async getValue(): Promise<string | undefined> {
@@ -205,6 +214,10 @@ Create the `src/connector` folder and `connectors-setup.ts` file there. It lists
   const solflareConnect = mapSolanaWallet(new SolflareConnectionProvider({
   network: environment === "prod" ? "mainnet-beta" : "devnet"
   }))
+
+  const imxConnect = mapImmutableXWallet(new ImmutableXLinkConnectionProvider({
+  env: environmentToImmutableXEnv(environment),
+  }))
 
   // Providers required secrets
   // const fortmatic = mapEthereumWallet(new FortmaticConnectionProvider({ apiKey: "ENTER", ethNetwork: { chainId: 4, rpcUrl: "https://node-rinkeby.rarible.com" } }))
@@ -219,6 +232,7 @@ Create the `src/connector` folder and `connectors-setup.ts` file there. It lists
   .add(walletConnect)
   .add(phantomConnect)
   .add(solflareConnect)
+  .add(imxConnect)
   // .add(portis)
   // .add(fortmatic)
 

docs/getting-started/sellOrder_acceptBid.md

@@ -78,26 +78,26 @@ Available ones:
 
 ```typescript
 
-const tezosAddress = "TEZOS:KT18pVpRXKPY2c4U2yFEGSH3ZnhB2kL8kwXS";
-const flowAddress = "FLOW:A.7e60df042a9c0868.FlowToken";
+const tezosAddress = "TEZOS:KT18pVpRXKPY2c4U2yFEGSH3ZnhB2kL8kwXS"
+const flowAddress = "FLOW:A.7e60df042a9c0868.FlowToken"
 
 // ETH
 const currency: EthEthereumAssetType = {
  "@type": "ERC20",
- contract:
+ contract: toContractAddress(ethereumAddress)
 }
 
 // TEZOS
 const currency: TezosFTAssetType = {
- "@type": "TEZOS_FT";
- contract: toContractAddress(tezosAddress);
- tokenId?: 2321;
+ "@type": "TEZOS_FT",
+ contract: toContractAddress(tezosAddress),
+ tokenId: 2321
 }
 
 // FLOW
 const currency: FlowAssetTypeFt = {
  "@type": "FLOW_FT",
- contract: toContractAddress(flowAddress);
+ contract: toContractAddress(flowAddress)
 };
 ```
 

docs/overview/tokens-fees-royalties.md

@@ -22,7 +22,8 @@ Rarible Multichain Protocol various token types applicable for certain blockchai
  * [ERC-721](https://eips.ethereum.org/EIPS/eip-721)
  * [ERC-1155](https://eips.ethereum.org/EIPS/eip-1155)
  * Rarible user-owned contracts (ERC-721 and ERC-1155) — users deploy these contracts, only owners can mint in these
-
+* Immutablex
+ * [ERC-721](https://eips.ethereum.org/EIPS/eip-721)
 * [Flow standard tokens](https://github.com/onflow/flow-nft/blob/master/contracts/NonFungibleToken.cdc)
 * [FA2 (TZIP-012)](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-12/tzip-12.md) for Tezos
 * Cryptopunks

docs/reference/wallets.md

@@ -100,6 +100,18 @@ const raribleSdk = createRaribleSdk(undefined, "prod")
  const provider = in_memory_provider("edsk...", nodeUrl)
  const wallet = new TezosWallet(provider)
  ```
+
+* Immutablex
+
+ ```ts
+ import { ImxWallet } from "@rarible/immutable-wallet"
+ import { ImmutableXWallet } from "@rarible/sdk-wallet"
+
+ const imxConnectorWallet = new ImxWallet("dev")
+ await imxConnectorWallet.connect()
+ const wallet = new ImmutableXWallet(imxConnectorWallet)
+ ```
+
 
 ## Wallet Connector