Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amilabs/crypto-exchanger
https://github.com/amilabs/crypto-exchanger
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/amilabs/crypto-exchanger
- Owner: amilabs
- License: apache-2.0
- Created: 2020-10-26T09:20:33.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-17T02:24:45.000Z (over 2 years ago)
- Last Synced: 2023-02-28T12:36:54.272Z (over 1 year ago)
- Language: JavaScript
- Size: 56.6 KB
- Stars: 22
- Watchers: 8
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Crypto exchanger example
This is a guide on how to implement easy ERC20 coins and Ethereum exchanger based on **[nodeJS client](https://github.com/amilabs/eth-bulk-monitor-client-nodejs)** for the **[Ethplorer Bulk API Monitor](https://docs.ethplorer.io/monitor)**.
## Steps
- Creating a new eth address and sending it to a user
- Watching this address for new ETH transactions of ERC20 transfers
- Sending tokens to your cold address with filling address by the current gas price.
- Sending ETH funds to your cold address
- Stoping watching for the address
- Notifying an administrator that funds were received
### Installation
```sh
$ mkdir exchnager
$ cd exchanger
$ npm init
$ npm i --save eth-bulk-monitor-client-nodejs
```
### Development
Requiring of a MonitorApp:
```
const { MonitorApp } = require('eth-bulk-monitor-client-nodejs');
```
Initialization of new MonitorApp object with your api key:
```sh
const monitorApp = new MonitorApp("apiKey");
```
Starting of the watching process and signing for new operations and transactions:
```sh
monitorApp.watch((data) => {
...
});
```
Creating a new ethereum address(easy to do with web3 library):
```sh
const newEthAddress = createNewEthAddress();
```
Adding new address to the watching:
```sh
monitorApp.monitor.addAddresses(newEthAddress);
```
Preparation is complete, from now we will get all transactions related to our address.
After the receiving callback from the watch function we should understand is it token transfer or ETH transaction:
```sh
monitorApp.watch((data) => {
if (data.data.contract){
// Here should be logic for a token transfer
...
}else{
// Here should be logic for a ETH transaction
...
}
});
```
For the token transfer we should deposit address with current gas price and only after that we able to send tokens to the cold address of your exchanger service.
```sh
if (data.data.contract){
depositNewAddressWithGas(newEthAddress);
sendTokensFromNewAddressToTheColdAddress(yourColdAddress, newEthAddress, data.value);
}
```
In the case of receiving ETH we can send it to your cold address directly.
```sh
}else{
sendEthToTheColdAddress(yourColdAddress, newEthAddress, data.value);
}
```
Don't forget to remove address from the watching if will not work with it in the future.
```sh
monitorApp.monitor.removeAddress(newEthAddress);
```
Call unwatch function if you want to stop watching process.
```sh
monitorApp.unwatch();
```
So, now we can notify admin that tokens or ETH was sent to your cold address and the user able to receive expected funds regarding current exchange rates.
```sh
notifyAdmin();
```
### Final code
```sh
const {MonitorApp} = require('eth-bulk-monitor-client-nodejs');
const monitorApp = new MonitorApp("apiKey");
monitorApp.watch((data) => {
if (data.data.contract){
depositNewAddressWithGas();
sendTokensFromNewAddressToTheColdAddress();
}else{
sendEthToTheColdAddress();
}
monitorApp.monitor.removeAddresses(newEthAddress);
monitorApp.unwatch();
notifyAdmin();
});
const newEthAddress = createNewEthAddress();
monitorApp.monitor.addAddresses(newEthAddress);
/*
The function which returns ethereum address.
This address should be sent to a user for deposit tokens or Ethereum
*/
function createNewEthAddress(){
// ...
}
/*
The function which will deposit the created address with gas.
We need it for sending received tokens from a user to the cold address of your exchanger service.
*/
function depositNewAddressWithGas(){
// ...
}
/*
The function which will send tokens from the created address to the cold address of your exchanger service.
*/
function sendTokensFromNewAddressToTheColdAddress(){
// ...
}
/*
The function which will send received ETH from a user to the cold address of your exchanger service.
*/
function sendEthToTheColdAddress(){
// ...
}
/*
Function for notifying the administrator of your exchanger service that tokens or ETH received on your cold address.
Now administrator able to send user expected resources regarding current exchange rate.
*/
function notifyAdmin(){
// ...
}
```
## Full version
A full example of a crypto exchanger service can be found here: [link](https://github.com/amilabs/crypto-exchanger/tree/main/example)