• Table of Contents
• Compile
• Starting the server
• Available endpoints
• GET Response for get NFTs for sale
• POST Request for notify NFT sell
• Data storage
• Configs (Optional)
• Contribution

cargo build --release

• Sample config file is available at config.yml. This file contains server configuration options (ip, port, etc..). This file should be modified when deploying server.

./target/release/energy_trading_api --config config.sample.yml

• Index/User management endpoint

The below example shows response example of GET request after getting information about NFT items for sell.

[
    {
        "metadata": {
            "owner_addr": "5HeU86WzssYJADnsyoPuBBVHXtbXi5hs3Cy3AT6cdmFUXBaA",
            "power_mw": 1.0,
            "price_pvse": 1
        },
        "storage_key": "5e8a19e3cd1b7c148b33880c479c02819a8dc5b2c03b70e90784d1e13305014605ee68f3e1f6ace547e5190191b46e33e2010000b8cdf6bb17b1d4fd3930f69805cb84ddae000000"
    },
    {
        "metadata": {
            "owner_addr": "5HeU86WzssYJADnsyoPuBBVHXtbXi5hs3Cy3AT6cdmFUXBaA",
            "power_mw": 1.0,
            "price_pvse": 1
        },
        "storage_key": "5e8a19e3cd1b7c148b33880c479c02819a8dc5b2c03b70e90784d1e13305014605ee68f3e1f6ace547e5190191b46e33e2010000e0b95d33f605e3191432da30759e96b357020000"
    },
    {
        "metadata": {
            "owner_addr": "5HeU86WzssYJADnsyoPuBBVHXtbXi5hs3Cy3AT6cdmFUXBaA",
            "power_mw": 3.0,
            "price_pvse": 3
        },
        "storage_key": "5e8a19e3cd1b7c148b33880c479c02819a8dc5b2c03b70e90784d1e13305014605ee68f3e1f6ace547e5190191b46e33e20100001f5567485266c630261fd69d4509f64f8a020000"
    }
]

The below example goes into json body of POST request while sending information about NFT sell.

{
  "storage_key": "<existing NFT storage_key>"
}

Under the hood we use subxt libraru to communicate with Westmint parachain. Information about available NFT items for sell is stored under data folder.

• data/fetched - information about NFTs which was fetched from Westming;
• data/processed - information about NFTs which was received by some endpoint using GET request;

Once endpoint get data using GET request - items from fetched folder will be moved to processed. Also we will not load NFT items to fetched folder if they have alredy been processed (exists in processed folder).

The configs folder has configurations to start the server as a service and nginx config to server this energy_trading_api server in reverse proxy mode.

• Start the energy_trading_api server as a service

1) copy the configs/energy_trading_api.service to /etc/systemd/system folder
2) systemctl enable energy_trading_api
3) systemctl start energy_trading_api

• Then you can copy the configs/nginx.vhost to /etc/nginx/sites-enabled to access the energy_trading_api server via nginx.

Feel free to make pull requests and make this better and/or contribute to its features.

Licensed under the Apache License, Version 2.0