BasicPayments

Smart contract and basic service to solve payments in the Taller de Programacion 2' projects.

Installation

You can install the dependencies with npm through

npm ci

BasicPayments - Service

This is a minimum project that will serve as a guide to help students to do the rest of the integration

Start process

To start the process, after you installed the dependencies and deployed the smart contracts to kovan, you can run

npm start

keep in mind that you should have everything in config set before that.

Available endpoints

The following endpoints are available:

• Create wallet: POST /wallet - No body
• Get wallets: GET /wallet
• Get wallet: GET /wallet/:id:
• Deposit ethers into the Smart contract: POST /deposit - Body params: senderId(integer), amountInEthers(string)
• Get deposit receipt: GET /deposit/:txHash:

Usage example

$ http POST http://localhost:3000/wallet
HTTP/1.1 200 OK
Connection: keep-alive
Date: Sun, 08 Aug 2021 19:26:53 GMT
Keep-Alive: timeout=5
content-length: 145
content-type: application/json; charset=utf-8

{
    "address": "0x7E039A00fFFD8d8C898e77e52351c799C99D3a2D",
    "id": 1,
    "privateKey": "0x67bb00f89f7b50f9e2924e423d00889c627b9acdc20b738ce00ccdcf6e4b8da0"
}

$ http POST http://localhost:3000/wallet
HTTP/1.1 200 OK
Connection: keep-alive
Date: Sun, 08 Aug 2021 19:26:54 GMT
Keep-Alive: timeout=5
content-length: 145
content-type: application/json; charset=utf-8

{
    "address": "0x6698F9b4c67AeDAcd728297F2bF9eC15993398a4",
    "id": 2,
    "privateKey": "0x7d7b4134704871ea90bc417a9fb21d8e643e076bd67f1253189e75181258c500"
}

$ http POST http://localhost:3000/deposit senderId=1 amountInEthers='0.01'          
HTTP/1.1 200 OK
Connection: keep-alive
Date: Sun, 08 Aug 2021 19:27:38 GMT
Keep-Alive: timeout=5
content-length: 538
content-type: application/json; charset=utf-8

{
    "chainId": 4,
    "data": "0xd0e30db0",
    "from": "0x7E039A00fFFD8d8C898e77e52351c799C99D3a2D",
    "gasLimit": {
        "hex": "0xb044",
        "type": "BigNumber"
    },
    "gasPrice": {
        "hex": "0x3b9aca08",
        "type": "BigNumber"
    },
    "hash": "0x9f98447de34d3245ce1976956334336a6302befc4f204ac44a7cac0526caa82d",
    "nonce": 0,
    "r": "0xc78a2f0914988bb37e62c16ffb91ae0335d39fd3dc246fd0c269dbaf0b331589",
    "s": "0x423f245bcc46c872404b43c34fcb789cb0d3befdd44ec928b96bb25a5a887762",
    "to": "0x76b8DA0BB9b9981403586A574d10fA783f08Aa05",
    "type": null,
    "v": 44,
    "value": {
        "hex": "0x2386f26fc10000",
        "type": "BigNumber"
    }
}

$ http GET http://localhost:3000/deposit/0x9f98447de34d3245ce1976956334336a6302befc4f204ac44a7cac0526caa82d
HTTP/1.1 200 OK
Connection: keep-alive
Date: Sun, 08 Aug 2021 19:28:00 GMT
Keep-Alive: timeout=5
content-length: 121
content-type: application/json; charset=utf-8

{
    "amountSent": {
        "hex": "0x2386f26fc10000",
        "type": "BigNumber"
    },
    "senderAddress": "0x7E039A00fFFD8d8C898e77e52351c799C99D3a2D"
}

Usage

Testing

To run the tests, after you installed the dependencies, just run

npm t

Linting

To run the linter, after you installed the dependencies, just run

npm run lint

Coverage

To create a coverage report, after you installed the dependencies, just run

npm run coverage

Doc generation

To create the smart contract documentation, after you installed the dependencies, just run

npm run docgen

This will generate a browsable html file within the ./docs folder, to view it you can open it with any browser.

Deployment

To deploy the smart contracts just run

npm run deploy-kovan

npm run deploy-local

depending on the network you want to use.

Keep in mind that you have to set the ALCHEMY_API_KEY and MNEMONIC envvars(the .env file can be used for this).

To get the deployed contract address just look in the deployments/<network>/BasicPayments.json file.

More scripts

Other useful scripts can be found using

npm run