Skip to content

Commit

Permalink
adding file html, styles.css and image.
Browse files Browse the repository at this point in the history
  • Loading branch information
@guilherme-barbosa-funttastic
guilherme-barbosa-funttastic committed May 9, 2024
1 parent 334b3af commit 9e526ca
Show file tree
Hide file tree
Showing 3 changed files with 202 additions and 129 deletions.
Binary file added partners/kujira/bot/telegram/image/supervisor.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
223 changes: 121 additions & 102 deletions partners/kujira/bot/telegram/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,115 +2,134 @@
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz" crossorigin="anonymous"></script>
<link rel="stylesheet" type="text/css" href="styles.css">


<title>Fun Telegram Bot Documentation</title>
</head>
<body>
<body class="container py-5">
<h1>Fun Telegram Bot Documentation</h1>
<p>This document is a documentation for the Funttastic Bot integrated on Telegram. The bot is able to do Market Making (MMing) using Kujira’s network (testnet and mainnet) and Hummingbot Gateway (HB Gateway).</p>
<p>A tutorial on how to setup your own bot is available <a href="https://www.funttastic.com/partners/kujira">here</a>.</p>
<p>This document is for the Funttastic Bot integrated on Telegram. The bot is capable of Market Making (MMing) using Kujira’s network (testnet and mainnet) and Hummingbot Gateway (HB Gateway).</p>
<p>A tutorial on how to set up your own bot is available <a href="https://www.funttastic.com/partners/kujira" class="link-primary">here</a>.</p>

<p>A <strong>Supervisor</strong> is an entity responsible to supervise all workers configured, collecting statistics globally.</p>

<p>The <strong>Worker</strong> is an entity to work in a specific market with a specific strategy.</p>
<section>
<h2>Supervisor</h2>
<p>The Supervisor is responsible for overseeing all configured workers, collecting statistics globally.</p>

<P>Here is the documentation explaining all aspects of the Supervisor’s summary on Telegram:</p>
<img src="image/supervisor.png" alt="supervisor">
<details>
<!-- 1. <Strategy name>: <Strategy version>: <Stragegy ID>:supervisor-->
<ul>
<li>2. Supervisor
<ul>
<li>2.1. Supervisor ID</li>
</ul>
</li>
<li>Workers
<ul>
<li>3.1. Allowed workers</li>
<li>3.2. Active workers</li>
<li>3.3. Stopped workers</li>
</ul>
</li>
<li>4. Profit and Loss (in US Dollars)
<ul>
<li> 4.1. Global or combined (from all workers) profit and loss
<ul>
<li>4.1.1. Global percentual profit and loss</li>
<li>4.1.2. Global profit and loss amount</li>
</ul>
</li>
<li>4.2.1 Workers
<ul>
<li>4.2.1.1. Worker’s percentual profit and loss</li>
<li>4.2.1.2. Worker’s profit and loss amount</li>
</ul>
</li>
</ul>
</li>
<li>5. Wallets (in US Dollars)
<ul>
<li>5.1. Wallet initial value</li>
<li>5.2. Wallet previous value</li>
<li>5.3. Wallet current value</li>
<li>5.4. Percentual current to initial wallet value change</li>
<li>5.5. Percentual current to previous wallet value change</li>
</ul>
</li>
<li>6. Balances (in US Dollars)
<ul>
<li>6.1. Total free/not used balance</li>
<li>6.2. Total balance amount locked in orders</li>
<li>6.3. Total unsettled balance amount (not free and not in orders)</li>
<li>6.4. Total balance (free + locked/orders + unsettled)</li>
</ul>
</li>
<li>7. Settings
<ul>
<li>7.1. Amount of time the worker waits to run again</li>
<li>7.2. Defines if the worker has to run only once or not (true/false)</li>
</ul>
</li>
</ul>
</details>
</section>

<h2>Supervisor</h2>
<p>Here is the documentation explaining all aspects of the Supervisor’s summary on Telegram:</p>
<ul>
<li><strong>Strategy name</strong>: <em>Strategy version</em>: <em>Strategy ID</em>:supervisor</li>
<li>Supervisor ID</li>
<li>Workers</li>
<li>Allowed workers</li>
<li>Active workers</li>
<li>Stopped workers</li>
<li>Profit and Loss (in US Dollars)</li>
<li>Global or combined (from all workers) profit and loss</li>
<li>Global percentual profit and loss</li>
<li>Global profit and loss amount</li>
<li>Wallets (in US Dollars)</li>
<li>Wallet initial value</li>
<li>Wallet previous value</li>
<li>Wallet current value</li>
<li>Percentual current to initial wallet value change</li>
<li>Percentual current to previous wallet value change</li>
<li>Balances (in US Dollars)</li>
<li>Total free/not used balance</li>
<li>Total balance amount locked in orders</li>
<li>Total unsettled balance amount (not free and not in orders)</li>
<li>Total balance (free + locked/orders + unsettled)</li>
<li>Settings</li>
<li>Amount of time the worker waits to run again</li>
<li>Defines if the worker has to run only once or not (true/false)</li>
</ul>
<section>
<h2>Worker</h2>
<p>Here is the documentation explaining all aspects of the Worker’s summary on Telegram:.</p>
<details>

<h2>Worker</h2>
<p>Here is the documentation explaining all aspects of the Worker’s summary on Telegram:</p>
<ul>
<li><strong>Strategy name</strong>: <em>Strategy version</em>: <em>Strategy ID</em>:worker:<em>Worker ID</em></li>
<li>Worker ID</li>
<li>Network</li>
<li>Market</li>
<li>Wallet ID</li>
<li>Profit and Loss (in US Dollars)</li>
<li>Percentage</li>
<li>Amount</li>
<li>Balances (in US Dollars)</li>
<li>Total (base + quote)</li>
<li>Total free/not used balance</li>
<li>Total balance amount locked in orders</li>
<li>Total unsettled balance amount (not free and not in orders)</li>
<li>Total balance (free + locked/orders + unsettled)</li>
<li>Tokens</li>
<li>Base token of the current market</li>
<li>Current base token price</li>
<li>Base token free/not used balance</li>
<li>Base token balance locked in sell orders</li>
<li>Base token unsettled balance (not free and not in order)</li>
<li>Base token total balance</li>
<li>Quote token of the current market</li>
<li>Current quote token price</li>
<li>Current quote token free/not used balance</li>
<li>Current quote token balance locked in sell orders</li>
<li>Current quote unsettled token (not free and not in order)</li>
<li>Current quote token total balance</li>
<li>Wallet (in US Dollars)</li>
<li>Wallet initial value</li>
<li>Wallet previous value</li>
<li>Wallet current value</li>
<li>Percentual current to initial wallet value change</li>
<li>Percentual current to previous wallet value change</li>
<li>Price</li>
<li>Price effectively used to place orders</li>
<li>Current price from the market or ticker (mainnet price)</li>
<li>Orders</li>
<li>Quantity of new orders created in this round</li>
<li>Quantity of new orders canceled in this round</li>
<li>Fees</li>
<li>Name of the native token</li>
<li>Total amount of fees paid when creating orders</li>
<li>Total amount of fees paid when canceling orders</li>
<li>Total amount of fees paid while withdrawing or settling the balances</li>
<li>List of newly created orders</li>
<li>List of currently untracked orders</li>
<li>List of orders canceled</li>
<li>List of all filled orders</li>
<li>Settings</li>
<li>Amount of time the worker waits to run again</li>
<li>Type of the order (limit or market)</li>
<li>Strategy to define the current market price (middle, ticker, last fill): SAP (simple average price), WAP (weighted average price), VWAP (volume weighted average price)</li>
</ul>
<ul>
<li>Worker’s ID</li>
<li>Network</li>
<li>Market</li>
<li>Wallet ID</li>
<li>Profit and Loss (in US Dollars)
<ul>
<li>Percentage</li>
<li>Amount</li>
</ul>
</li>
<li>Balances (in US Dollars)
<ul>
<li>Total (base + quote)</li>
<li>Total free/not used balance</li>
<li>Total balance amount locked in orders</li>
<li>Total unsettled balance amount (not free and not in orders)</li>
<li>Total balance (free + locked/orders + unsettled)</li>
</ul>
</li>
<li>Tokens
<ul>
<li>Base token of the current market</li>
<li>Current base token price</li>
<li>Base token free/not used balance</li>
<li>Base token balance locked in sell orders</li>
<li>Base token unsettled balance (not free and not in order)</li>
<li>Base token total balance</li>
<li>Quote token of the current market</li>
<li>Current quote token price</li>
<li>Current quote token free/not used balance</li>
<li>Current quote token balance locked in sell orders</li>
<li>Current quote unsettled token (not free and not in order)</li>
<li>Current quote token total balance</li>
</ul>
</li>
<li>Settings
<ul>
<li>Amount of time the worker waits to run again</li>
<li>Type of the order (limit or market)</li>
<li>Strategy to define the current market price (middle, ticker, last fill)</li>
<li>Strategy to define the current market middle price (SAP, WAP, VWAP): SAP (simple average price), WAP (weighted average price), VWAP (volume weighted average price)</li>
</ul>
</li>
</ul>
</details>
</section>

<script>
document.addEventListener('DOMContentLoaded', () => {
const summaries = document.querySelectorAll('.summary');
summaries.forEach(summary => {
summary.addEventListener('click', function() {
const details = this.nextElementSibling;
details.style.display = details.style.display === 'block' ? 'none' : 'block';
});
});
});
</script>
</body>
</html>
108 changes: 81 additions & 27 deletions partners/kujira/bot/telegram/styles.css
View file
Original file line number Diff line number Diff line change
@@ -1,49 +1,103 @@

body {
font-family: Arial, sans-serif;
line-height: 1.6;
margin: 0;
padding: 0 20px;
background: #f4f4f4;
color: #333;
background-color: #f8f9fa;
}

h1, h2 {
color: #0056b3;
img {
width: 80vw;
max-width: 100%;
height: auto;
display: block;
margin: auto auto 20px;
}

h1 {
margin-top: 0;

.container {
max-width: 800px;
margin: 0 auto;
padding: 0 15px;
}

h2 {
cursor: pointer;
padding: 10px;
background-color: #e9ecef;
border: 1px solid #ccc;
.heading {
text-align: center;
margin-bottom: 50px;
}

ul {
background: #fff;
border: 1px solid #ddd;
padding: 10px;
margin-top: 5px;
display: none;
.sub-heading {
font-size: 24px;
margin-top: 30px;
}

ul :hover {
background-color: #dfe2e6;
.btn-list {
list-style: none;
padding-left: 0;
}

li {
.btn-list li {
margin-bottom: 10px;
}

a {
color: #0056b3;
.btn {
display: inline-block;
padding: 5px 10px;
background-color: #007bff;
color: #fff;
text-decoration: none;
border-radius: 5px;
}

.prerequisites {
list-style-type: none;
padding-left: 0;
}

.prerequisites li {
margin-bottom: 10px;
}

.prerequisites ul {
margin-top: 10px;
padding-left: 20px;
}

.installation-image {
display: block;
max-width: 100%;
margin: 20px auto;
}

.details-heading {
font-size: 20px;
font-weight: bold;
margin-top: 20px;
cursor: pointer;
}

.details-heading:hover {
color: #007bff;
}

.details-heading::marker {
content: "▶";
}

.details-heading:focus {
outline: none;
}

code {
display: block;
padding: 10px;
background-color: #f8f9fa;
border-radius: 5px;
margin-top: 10px;
}

a:hover {
text-decoration: underline;
.footer {
text-align: center;
margin-top: 50px;
padding: 20px 0;
background-color: #007bff;
color: #fff;
}

0 comments on commit 9e526ca

Please sign in to comment.