Skip to content

Latest commit

 

History

History
380 lines (272 loc) · 6.48 KB

README.md

File metadata and controls

380 lines (272 loc) · 6.48 KB
Raw

Binance Crypto Wallet + NFT

Setting Up :

Step 1: Download the repository using the command:

 git clone -b wallet_nft "https://github.com/Arjun-Pradeep/safeCryptoWallet.git"

Step 2: Change the current working directory to "safeCryptoWallet" :

 cd safeCryptoWallet

Step 3: Install the dependecies :

 npm i --save

Step 4: Load environment variables from .env file

MNEMONIC=""
PASSPHRASE=""
API_KEY=""
PROVIDER=""
WEBSOCKET_URL=""
PRIVATE_KEY=""
BNB_API_KEY=""
MARKETPLACE_ADDRESS=""
NFT_ADDRESS=""

Step 5: Install redis :

 sudo apt-get install redis

Step 6: Install pm2 [daemon process manager] :

    npm install pm2@latest -g

Step 7: Compile the smart contracts :

 npx hardhat compile

Step 8: Run redis service [/home Folder] :

   pm2 start redis-server

Step 9: Setup a database in server [MongoDB]:

Create a file - database.js [HOME directory] :
conn = new Mongo();

dbName = "wallets";

db = conn.getDB(dbName);

db.createUser(
{
user: "cryptoInsider",
pwd: "VB<z6LXP.[f/+c3+",
roles: [ {role:"readWrite", db:dbName} ]
}
);

// ACCOUNTS
printjson(
 db.createCollection("accounts")
 )

// WALLETS
printjson(
 db.createCollection("wallets")
)

// TRANSACTIONS
printjson(
 db.createCollection("transactions")
)

// TOKENS
printjson(
 db.createCollection("tokens")
)

// SETTINGS
printjson(
 db.createCollection("settings")
)

// NFTS
printjson(
 db.createCollection("nfts")
)

// UNIQUE
db.accounts.createIndex({"email":1},{ unique: true } );

// INITIALLY CREATE A ADMIN RECORD
printjson(
db.accounts.insert({
  name: "John",
  email: "[email protected]",
  adminLevel: "0"
},{
  upsert: true
},
{ unique: true })
)

// UNIQUE
db.settings.createIndex({marketplace_address:1},{ unique: true } );

// SETTINGS
printjson(
db.settings.insert({
  marketplace_address:"0x487e5a79E03545279Cb662115a4Be91D1136cA75",
  nft_address:"0x0920adAAd74e243Bc4AD4A878A7Ded9b0AF91187"
},{
  upsert: true
})
)

// UNIQUE
db.tokens.createIndex({"address":1},{ unique: true } );

// INITIALLY CREATE A SETTINGS
printjson(
db.tokens.insert({
    status: true,
    name: "Bank of BIT ETH",
    symbol: "BOBE",
    address: "0x5F5f52DFdB123af72aBc43ab36c191e05c9E5904",
    decimal: "15",
    blockchain: "binance"
},{
  upsert: true
})
)

// GET COLLECTIONS
printjson(
db.getCollectionNames()
)
Open mongo terminal :
   mongo
Execute the database.js in mongo terminal :
   load('database.js')
Ensure mongodb is running

Step 5: Update the database credentials in '/safeCryptoWallet/config/config.js':

    db: {
        host: "localhost",
        port: "27017",
        userName: "DB_USERNAME",
        password: "DB_PASSWORD",
        dbName: "DB_NAME"
    }

Step 6: Execute the crons :

pm2 start crons/startSendCrypto.js --name sendCron
pm2 start crons/receiveTransaction.js --name receiveCron

Step 7: Start the Application :

 pm2 start bin/www --name wallet

Endpoints :

POSTMAN Collections : https://www.getpostman.com/collections/2a30700cdcec9e9e1f37

For every API call, Need to set "x-api-key" in the header

Wallet :

Create wallet account for a user [ /wallet/createWallet ] [ POST ]:

CREATE WALLET

Body Parameters :

-> email : String

-> password : String

Login to the wallet account of the user [ /wallet/login ] [ POST ]:

CREATE WALLET

Body Parameters :

-> email : String

-> password : String

Retrieve account details of a user [ /wallet/user ] [ GET ] [ JWT AUTH ]:

USER

Query Parameters :

-> email : String

Retrieve transaction history w.r.t user [ /wallet/transactionHistory ] [ GET ] JWT AUTH ]:

TRANSACTION HISTORY

Query Parameters :

-> email : String

Validate the transaction [ /wallet/validateTransaction ] [ POST ] [ JWT AUTH ]:

VALIDATE

Body Parameters :

-> email : String
-> crypto : String // 'BNB' or 'BOBE'
-> receiver : String
-> amount : String

Crypto transaction [ /wallet/send ] [ POST ] [ JWT AUTH ]:

SEND

Body Parameters :

-> email : String
-> crypto : String // 'BNB' or 'BOBE'
-> receiver : String
-> amount : String

NFT :

Upload the image file [ /nft/uploadFile ] [ POST ]:

UPLOAD FILE

Body Parameters [Form-data] :

-> file : Image File
-> name : String
-> description : String

Create a new NFT [ /nft/createToken ] [ POST ] [ JWT AUTH ]:

CREATE TOKEN

Body Parameters :

-> email : String
-> uri : String
-> name : String
-> description : String
-> image : String

Create a new market item [ /nft/createItem ] [ POST ] [ JWT AUTH ]:

CREATE ITEM

Body Parameters :

-> email : String
-> uri : String
-> name : String
-> description : String
-> image : String

Create a market sale [ /nft/marketSale ] [ POST ] [ JWT AUTH ]:

MARKET SALE

Body Parameters :

-> email : String
-> tokenId : String
-> auctionPrice : String

Fetch all the tokens created by the user [ /nft/fetchTokens ] [ GET ] [ JWT AUTH ]:

FETCH TOKENS

Query Parameters :

-> email : String

Fetch all the listed market items [ /nft/marketItems ] [ GET ] [ JWT AUTH ]:

MARKET ITEMS

Query Parameters :

-> email : String

Fetch all the owned market items by the user [ /nft/ownedItems ] [ GET ] [ JWT AUTH ]:

OWNED ITEMS

Query Parameters :

-> email : String

Fetch all the created market items [SOLD & NOT SOLD] by the user [ /nft/createdItems ] [ GET ] [ JWT AUTH ]:

CREATED ITEMS

Query Parameters :

-> email : String

Fetch the metadata [ /nft/metaData ] [ GET ]:

METADATA

Query Parameters :

-> url : String

Swagger Documentation :

http://localhost:3000/api-docs/

SWAGGER DEMO SWAGGER AUTH