Skip to content

Commit

Permalink
Added more UML diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
aritroCoder committed Dec 11, 2023
1 parent 6048087 commit d54be30
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ The main components of the solution are:
- **Proxy backend server:** As Metamask Snaps operate in a sandboxed environment, they are not able to make requests to external APIs. Thus, we have created a proxy backend server that acts as a bridge between the snap and the external APIs. The snap makes requests to the proxy server, which then forwards the request to the external API and returns the response back to the snap. The proxy server is built using Node.js and Express.js in Typescript. It also acts as the interface between the snap and the forecasting engine. The proxy server uses the cutting-edge [aptos-ts-sdk](https://github.com/aptos-labs/aptos-ts-sdk) to interact with the Aptos blockchain. The proxy server performs important functionalities like faucet funding, coin transfer, transaction history, account balance etc. It also provides the snap with real time APT to USD conversion rates by making requests to multiple coin feeds (discussed below).

Snap and the proxy server interact with each other as explained in the below UML diagram:
![Snaptos UML](./assets/Aptos-UML.png)

![Snaptos UML](./assets/Aptos-UML.svg)

- **BiLSTM Forecasting Model:** The forecasting engine is built using a Bidirectional LSTM(Long Short Term Memory) model, which is trained on historical data to predict future Aptos price movements. We have trained the model on more than 500 continuous data points which we scraped ourselves from the internet through multiple sources/price feeds. The different data feeds we used are:
- Binance: https://www.binance.com/api/v3/ticker/price?symbol=APTUSDT
Expand Down
Binary file removed assets/Aptos-UML.png
Binary file not shown.
Loading

0 comments on commit d54be30

Please sign in to comment.