README.md

⛔️ DEPRECATED

This repository is now deprecated.

The Direct Route service is no longer supported.

JS SDK of DirectRoute

What is Direct Route

NodeReal Direct Route is a permissionless, transparent service for efficient Direct Route extraction on EVM blockchains. It achieves following goals:

1. Transaction privacy. Transactions submitted through Direct Route can never be detected by others before they have been included in a block.
2. First-price sealed-bid auction. It allows users to privately communicate their bid and granular transaction order preference.
3. No paying for failed transactions. Losing bids are never included in a block, thus never exposed to the public and no need to pay any transaction fees.
4. Bundle transactions. Multiple transactions are submitted as a bundle, the bundle transactions are all successfully validated on chain in the same block or never included on chain at all.
5. Efficiency. Direct Route extraction is performed without causing unnecessary network or chain congestion.

Deposit coinbase contract

If you want to increase your Bundle Price, you can use this contract, which will transfer your provided BNB to the coinbase responsible for mining your bundle. please refer the sendBNBByBundleWithDepositCoinbaseDemo() in example.go.

1. mainnet: 0xB3BB00B9785f35D0BE13B2BD91C8e3742D9Ab03a
2. testnet: 0xE7febD44315508a1100E1a06701e7e0Ae5e325Bc

Installation

Node

npm install @node-real/web3

Yarn

yarn add @node-real/web3

npm run build

Usage

1. Init Client

// Init client
const Web3 = require('@node-real/web3');

var directRouteEndPoint = "https://api.nodereal.io/direct-route";
let web3 = new Web3(directRouteEndPoint);

2. Query suggested bundle price

const bundlePrice = await  directClient.eth.getBundlePrice();
var price = bundlePrice.minimalGasPrice;
if (price < bundlePrice.bundlePrice) {
    price = bundlePrice.bundlePrice;
}

3. Send bundle

const tx1 = {
    'from': account1,
    'to': account2,
    'gas': 23000,
    'gasPrice': price,
    'data': rpcClient.utils.toHex(data1),
    'chainId': 56,
};
const tx2 = {
    'from': account2,
    'to': account1,
    'gas': 23000,
    'gasPrice': price,
    'data': rpcClient.utils.toHex(data2),
    'chainId': 56,
};

const privateKey1 = '';
const privateKey2 = '';
const signedTx1 = await rpcClient.eth.accounts.signTransaction(tx1, privateKey1);
const signedTx2 = await rpcClient.eth.accounts.signTransaction(tx2, privateKey2);

var myDate = new Date();
const maxTime = Math.floor(myDate.getTime() / 1000) + 80;
const minTime = Math.floor(myDate.getTime() / 1000) + 20;

console.log(maxTime, minTime);

const bundleArgs = {
    'txs': [signedTx1.rawTransaction, signedTx2.rawTransaction],
    'minTimestamp': minTime,
    'maxTimestamp': maxTime,
    'revertingTxHashes': [signedTx2.transactionHash],
};
const bundleHash = await directClient.eth.sendBundle(bundleArgs);

After the bundle is successfully submitted, you may need wait at lest 3-60 seconds before the transaction been verified on chain

4. Query bundle

   const queryBundle = await directClient.eth.getBundleByHash(bundleHash);

5. Get Status of Validators

   var status = await directClient.eth.getValidatorStatus();

SDK example

1. getBundlePriceDemo. The bundle price is volatile according to the network congestion, the demo shows you how to get proper bundle price.
2. getValidatorsStatusDemo. The demo shows how to get status of Validators.
3. sendBUSDByBundleDemo. In this case, we use two accounts to send BUSD to each other, the second transaction is allowed to be failed, and the bundle should be verified on chain during [now+20 second, now+80 second]. This case shows you how to interact with smart contract through direct-route, and how to control the timing to be verified.
4. sendBNBByBundleWithDepositCoinbaseDemo(). In this case, we use two different accounts to send BNB to each other, and including deposit BNB to coinbase to increase Bundle Price the two transactions should be all successful or all failed.

If you want to try with above examples, what you need to do is just to replace the account address of account1 and account2 in bundle_example.js and private keys of privateKey1 and privateKey2.

Building

Requirements

• Node.js
• npm

sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm