rango-sdk-basic 0.0.12 → 0.0.13

package/README.md

@@ -3,14 +3,12 @@
 [![npm version](https://badge.fury.io/js/rango-sdk-basic.svg)](https://badge.fury.io/js/rango-sdk-basic)
 [![license](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/rango-exchange/rango-sdk/blob/master/LICENSE)
 
-
 This is the first phase of Rango SDK which only wraps Rest API calls. In the next phase, we will handle connecting to the wallet providers.
 
 > **WARNING:** The Rango SDK is still beta. Please use it on your own risk.
 
 > **WARNING:** The Rango SDK has not stabilized yet, and we might make some breaking changes.
 
-
 ## 2. Installation
 
 ```shell
@@ -23,117 +21,3 @@ Please checkout the examples' folder for sample usage of the SDK. We will add mo
 
 - [Documents](https://docs.rango.exchange/integration/overview)
 - [Examples](https://github.com/rango-exchange/rango-sdk/tree/master/examples/)
-
-
-## 4. Message Passing API
-
-When transferring tokens using Rango cross-chain API, you could pass a random message from the source chain to the destination and call your contract on the destination. In order to do so, you need to pass your contracts on source & destination chains plus an arbitrary hex message like this:
-
-### 4.1. SDK usage
-
-You should specify `sourceContract`, `destinationContract` and `imMessage` arguments in both `quote` and `swap` methods if you want to pass a message from the source contract to the destination. 
-
-```ts
-const quoteResponse = await rangoClient.quote({
-  from: {
-    "blockchain": "FANTOM",
-    "symbol": "FTM",
-    "address": null
-  },
-  to: {
-    "blockchain": "BSC",
-    "symbol": "BNB",
-    "address": null
-  },
-  amount: "100000000000000000000",
-  messagingProtocols: ['cbridge'],
-  sourceContract: "<source contract address>",
-  destinationContract: "<destination contract address>",
-  imMessage: "0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000007E8A8b130272430008eCa062419ACD8B423d339D" 
-})
-
-```
-
-As you can see in the code above, you could also limit `messagingProtocols` used to a custom list like `['cbridge']`. (Please note that as message is relayed alongside with token in a single transaction, if you limit messaging protocols to celer bridge, we use same bridge (cbridge) for transerring tokens. 
-Here is list of all available options for `messagingProtocols`: `cbridge`, (soon: `anyswap`, `axelar`, `layer0`)
-
-
-```ts
-const swapResponse = await rangoClient.swap({
-  from: {
-    "blockchain": "FANTOM",
-    "symbol": "FTM",
-    "address": null
-  },
-  to: {
-    "blockchain": "BSC",
-    "symbol": "BNB",
-    "address": null
-  },
-  amount: "100000000000000000000",
-  fromAddress: fromAddress,
-  toAddress: fromAddress,
-  disableEstimate: false,
-  referrerAddress: null,
-  referrerFee: null,
-  slippage: '1.0',
-  messagingProtocols: ['cbridge'],
-  sourceContract: "<source contract address>",
-  destinationContract: "<destination contract address>",
-  imMessage: "0x00000000000000000000000000000000000000000000000000000000000000010000000000000000000000007E8A8b130272430008eCa062419ACD8B423d339D"
-})
-
-if (!!swapResponse && !swapResponse.error && swapResponse.resultType === "OK" && swapResponse.tx?.type === TransactionType.EVM) {
-  const evmTx = swapResponse.tx as EvmTransaction
-  const value = evmTx.value
-  const txData = evmTx.value
-  console.log({value, txData})
-}
-```
-You need to use `value` and `txData` if you want to call your own contract. (not calling Rango directly from the client side)
-
-### 4.2. dApp Contracts
-
-Both dApp contracts on the source and destination chains should implemenet `IRangoMessageReceiver` interface. Rango will call `handleRangoMessage` function in case of `SUCCESS`, `REFUND_IN_SOURCE` or `REFUND_IN_DESTINATION`.
-```solidity
-interface IRangoMessageReceiver {
-    enum ProcessStatus { SUCCESS, REFUND_IN_SOURCE, REFUND_IN_DESTINATION }
-
-    function handleRangoMessage(
-        address _token,
-        uint _amount,
-        ProcessStatus _status,
-        bytes memory _message
-    ) external;
-}
-```
-
-And here is a sample dapp contract for the demo purpose. (The demo is very simple and you should consider adding security considerations yourself)
-
-https://gist.github.com/RanGojo/1066ed2bf1556be7c2def69dbe2b3cb9
-
-You need to deploy this contract on every chains needed and **ask us to white list them in Rango Contract**.
-
-Here are some sample transaction for this contracts in action for swapping Fantom.FTM to BSC.BNB and relaying custom message:
-
-- Inbound transaction:
-  https://ftmscan.com/tx/0x59a526e4376dc5b083b7876d47699b6c110fcba319c78553f3b8342674a68b3d
-
-- Outbound transaction:
-  https://bscscan.com/tx/0x8e91d7c3baf914cad8190bba4d608149d093d059ef769f9ca7a01a3d90a9c5e9
-
-Here is how dApp [call Rango](https://gist.github.com/RanGojo/1066ed2bf1556be7c2def69dbe2b3cb9#file-crosschainsampleapp-sol-L36) in the source chain:
-
-![source chain call](https://github.com/rango-exchange/rango-sdk/blob/basic-api/docs/mp_source_sample.png) 
-
-And here is how dApp could [handle Rango message](https://gist.github.com/RanGojo/1066ed2bf1556be7c2def69dbe2b3cb9#file-crosschainsampleapp-sol-L45):
-
-![destination/source message handler](https://github.com/rango-exchange/rango-sdk/blob/basic-api/docs/mp_handle_message.png) 
-
-We emit a sample event in destination for debug and here you could check  it:
-
-[emit NFTPurchaseStatus(m.assetId, m.buyer, PurchaseType.BOUGHT);](https://gist.github.com/RanGojo/1066ed2bf1556be7c2def69dbe2b3cb9#file-crosschainsampleapp-sol-L64)
-
-![sample event in destination](https://github.com/rango-exchange/rango-sdk/blob/basic-api/docs/mp_sample_event_in_destination.png) 
-
-

package/lib/index.d.ts

@@ -1,3 +1,3 @@
 export { RangoClient } from './services';
-export * from './types/utils/errors';
+export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,cAAc,sBAAsB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,cAAc,SAAS,CAAA"}

package/lib/index.js

@@ -17,5 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RangoClient = void 0;
 var services_1 = require("./services");
 Object.defineProperty(exports, "RangoClient", { enumerable: true, get: function () { return services_1.RangoClient; } });
-__exportStar(require("./types/utils/errors"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uCAAwC;AAA/B,uGAAA,WAAW,OAAA;AACpB,uDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uCAAwC;AAA/B,uGAAA,WAAW,OAAA;AACpB,0CAAuB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rango-sdk-basic",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "Rango Exchange Basic SDK for dApps",
   "main": "lib/index.js",
   "types": "lib",