feat: rename

RSSNext · May 29, 2024 · ca48861 · ca48861
1 parent e174265
commit ca48861
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 589 deletions.
diff --git a/404.html b/404.html
@@ -90,7 +90,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item "><a href="index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">src</li><li class="chapter-item "><a href="src/interfaces/index.html">❱ interfaces</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/interfaces/IFollow.sol/interface.IFollow.html">IFollow</a></li></ol></li><li class="chapter-item "><a href="src/Follow.sol/contract.Follow.html">Follow</a></li></ol>
+                <ol class="chapter"><li class="chapter-item "><a href="index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">src</li><li class="chapter-item "><a href="src/PowerToken.sol/contract.PowerToken.html">PowerToken</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>

diff --git a/index.html b/index.html
@@ -89,7 +89,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item expanded "><a href="index.html" class="active">Home</a></li><li class="chapter-item affix "><li class="part-title">src</li><li class="chapter-item "><a href="src/interfaces/index.html">❱ interfaces</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/interfaces/IFollow.sol/interface.IFollow.html">IFollow</a></li></ol></li><li class="chapter-item "><a href="src/Follow.sol/contract.Follow.html">Follow</a></li></ol>
+                <ol class="chapter"><li class="chapter-item expanded "><a href="index.html" class="active">Home</a></li><li class="chapter-item affix "><li class="part-title">src</li><li class="chapter-item "><a href="src/PowerToken.sol/contract.PowerToken.html">PowerToken</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>
@@ -221,7 +221,7 @@ <h3 id="help"><a class="header" href="#help">Help</a></h3>
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
 
-                            <a rel="next prefetch" href="src/interfaces/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="src/PowerToken.sol/contract.PowerToken.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
 
@@ -232,7 +232,7 @@ <h3 id="help"><a class="header" href="#help">Help</a></h3>
 
             <nav class="nav-wide-wrapper" aria-label="Page navigation">
 
-                    <a rel="next prefetch" href="src/interfaces/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="src/PowerToken.sol/contract.PowerToken.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>

diff --git a/print.html b/print.html
@@ -90,7 +90,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item "><a href="index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">src</li><li class="chapter-item "><a href="src/interfaces/index.html">❱ interfaces</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/interfaces/IFollow.sol/interface.IFollow.html">IFollow</a></li></ol></li><li class="chapter-item "><a href="src/Follow.sol/contract.Follow.html">Follow</a></li></ol>
+                <ol class="chapter"><li class="chapter-item "><a href="index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">src</li><li class="chapter-item "><a href="src/PowerToken.sol/contract.PowerToken.html">PowerToken</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>
@@ -216,16 +216,18 @@ <h3 id="help"><a class="header" href="#help">Help</a></h3>
 $ anvil --help
 $ cast --help
 </code></pre>
-<div style="break-before: page; page-break-before: always;"></div><h1 id="contents"><a class="header" href="#contents">Contents</a></h1>
-<ul>
-<li><a href="src/interfaces/IFollow.sol/interface.IFollow.html">IFollow</a></li>
-</ul>
-<div style="break-before: page; page-break-before: always;"></div><h1 id="ifollow"><a class="header" href="#ifollow">IFollow</a></h1>
-<p><a href="https://github.com/RSSNext/follow-contracts/blob/a248da04bd0ab5b705fa9ba885cecd7285110972/src/interfaces/IFollow.sol">Git Source</a></p>
+<div style="break-before: page; page-break-before: always;"></div><h1 id="powertoken"><a class="header" href="#powertoken">PowerToken</a></h1>
+<p><a href="https://github.com/RSSNext/follow-contracts/blob/9b10b5dde4a39f8d3563aed64242b231d54904d7/src/PowerToken.sol">Git Source</a></p>
+<p><strong>Inherits:</strong>
+ERC20Upgradeable</p>
+<h2 id="state-variables"><a class="header" href="#state-variables">State Variables</a></h2>
+<h3 id="_pointsbalances"><a class="header" href="#_pointsbalances">_pointsBalances</a></h3>
+<pre><code class="language-solidity">mapping(bytes32 feedId =&gt; uint256) internal _pointsBalances;
+</code></pre>
 <h2 id="functions"><a class="header" href="#functions">Functions</a></h2>
 <h3 id="initialize"><a class="header" href="#initialize">initialize</a></h3>
 <p>Initializes the contract.</p>
-<pre><code class="language-solidity">function initialize(string calldata name_, string calldata symbol_) external;
+<pre><code class="language-solidity">function initialize(string calldata name_, string calldata symbol_) external initializer;
 </code></pre>
 <p><strong>Parameters</strong></p>
 <div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
@@ -234,22 +236,21 @@ <h3 id="initialize"><a class="header" href="#initialize">initialize</a></h3>
 </tbody></table>
 </div>
 <h3 id="mint"><a class="header" href="#mint">mint</a></h3>
-<p>Mints new tokens.</p>
+<p>Mints new token points.</p>
 <pre><code class="language-solidity">function mint(address to) external;
 </code></pre>
 <p><strong>Parameters</strong></p>
 <div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
 <tr><td><code>to</code></td><td><code>address</code></td><td>The account to receive the tokens.</td></tr>
 </tbody></table>
 </div>
-<h3 id="tip"><a class="header" href="#tip">tip</a></h3>
-<p>Tips the recipient feed.</p>
-<pre><code class="language-solidity">function tip(address from, uint256 amount, bytes32 feedId) external;
+<h3 id="transferpoints"><a class="header" href="#transferpoints">transferPoints</a></h3>
+<p>Transfers token points.</p>
+<pre><code class="language-solidity">function transferPoints(uint256 amount, bytes32 feedId) external;
 </code></pre>
 <p><strong>Parameters</strong></p>
 <div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
-<tr><td><code>from</code></td><td><code>address</code></td><td>The address who sends the tip.</td></tr>
-<tr><td><code>amount</code></td><td><code>uint256</code></td><td>The amount of the tip.</td></tr>
+<tr><td><code>amount</code></td><td><code>uint256</code></td><td>The amount token points to send.</td></tr>
 <tr><td><code>feedId</code></td><td><code>bytes32</code></td><td>The feed id.</td></tr>
 </tbody></table>
 </div>
@@ -262,50 +263,6 @@ <h3 id="withdraw"><a class="header" href="#withdraw">withdraw</a></h3>
 <tr><td><code>to</code></td><td><code>address</code></td><td>The address who receives the tokens.</td></tr>
 <tr><td><code>amount</code></td><td><code>uint256</code></td><td>The amount of the tokens.</td></tr>
 </tbody></table>
-</div><div style="break-before: page; page-break-before: always;"></div><h1 id="follow"><a class="header" href="#follow">Follow</a></h1>
-<p><a href="https://github.com/RSSNext/follow-contracts/blob/a248da04bd0ab5b705fa9ba885cecd7285110972/src/Follow.sol">Git Source</a></p>
-<p><strong>Inherits:</strong>
-<a href="src/Follow.sol//src/interfaces/IFollow.sol/interface.IFollow.html">IFollow</a>, ERC20Upgradeable</p>
-<h2 id="functions-1"><a class="header" href="#functions-1">Functions</a></h2>
-<h3 id="initialize-1"><a class="header" href="#initialize-1">initialize</a></h3>
-<p>Initializes the contract.</p>
-<pre><code class="language-solidity">function initialize(string calldata name_, string calldata symbol_) external initializer;
-</code></pre>
-<p><strong>Parameters</strong></p>
-<div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
-<tr><td><code>name_</code></td><td><code>string</code></td><td>The token name.</td></tr>
-<tr><td><code>symbol_</code></td><td><code>string</code></td><td>The token symbol.</td></tr>
-</tbody></table>
-</div>
-<h3 id="mint-1"><a class="header" href="#mint-1">mint</a></h3>
-<p>Mints new tokens.</p>
-<pre><code class="language-solidity">function mint(address to) external override;
-</code></pre>
-<p><strong>Parameters</strong></p>
-<div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
-<tr><td><code>to</code></td><td><code>address</code></td><td>The account to receive the tokens.</td></tr>
-</tbody></table>
-</div>
-<h3 id="tip-1"><a class="header" href="#tip-1">tip</a></h3>
-<p>Tips the recipient feed.</p>
-<pre><code class="language-solidity">function tip(address from, uint256 amount, bytes32 feedId) external override;
-</code></pre>
-<p><strong>Parameters</strong></p>
-<div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
-<tr><td><code>from</code></td><td><code>address</code></td><td>The address who sends the tip.</td></tr>
-<tr><td><code>amount</code></td><td><code>uint256</code></td><td>The amount of the tip.</td></tr>
-<tr><td><code>feedId</code></td><td><code>bytes32</code></td><td>The feed id.</td></tr>
-</tbody></table>
-</div>
-<h3 id="withdraw-1"><a class="header" href="#withdraw-1">withdraw</a></h3>
-<p>Withdraws tokens.</p>
-<pre><code class="language-solidity">function withdraw(address to, uint256 amount) external override;
-</code></pre>
-<p><strong>Parameters</strong></p>
-<div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
-<tr><td><code>to</code></td><td><code>address</code></td><td>The address who receives the tokens.</td></tr>
-<tr><td><code>amount</code></td><td><code>uint256</code></td><td>The amount of the tokens.</td></tr>
-</tbody></table>
 </div>
                     </main>
 

diff --git a/searchindex.js b/searchindex.js
diff --git a/searchindex.json b/searchindex.json
diff --git a/src/Follow.sol/contract.Follow.html → src/PowerToken.sol/contract.PowerToken.html b/src/Follow.sol/contract.Follow.html → src/PowerToken.sol/contract.PowerToken.html
@@ -3,7 +3,7 @@
     <head>
         <!-- Book generated using mdBook -->
         <meta charset="UTF-8">
-        <title>Follow</title>
+        <title>PowerToken</title>
 
 
         <!-- Custom HTML head -->
@@ -89,7 +89,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item "><a href="../../index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">src</li><li class="chapter-item "><a href="../../src/interfaces/index.html">❱ interfaces</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="../../src/interfaces/IFollow.sol/interface.IFollow.html">IFollow</a></li></ol></li><li class="chapter-item expanded "><a href="../../src/Follow.sol/contract.Follow.html" class="active">Follow</a></li></ol>
+                <ol class="chapter"><li class="chapter-item "><a href="../../index.html">Home</a></li><li class="chapter-item affix "><li class="part-title">src</li><li class="chapter-item expanded "><a href="../../src/PowerToken.sol/contract.PowerToken.html" class="active">PowerToken</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle">
                 <div class="sidebar-resize-indicator"></div>
@@ -177,10 +177,14 @@ <h1 class="menu-title"></h1>
 
                 <div id="content" class="content">
                     <main>
-                        <h1 id="follow"><a class="header" href="#follow">Follow</a></h1>
-<p><a href="https://github.com/RSSNext/follow-contracts/blob/a248da04bd0ab5b705fa9ba885cecd7285110972/src/Follow.sol">Git Source</a></p>
+                        <h1 id="powertoken"><a class="header" href="#powertoken">PowerToken</a></h1>
+<p><a href="https://github.com/RSSNext/follow-contracts/blob/9b10b5dde4a39f8d3563aed64242b231d54904d7/src/PowerToken.sol">Git Source</a></p>
 <p><strong>Inherits:</strong>
-<a href="/src/interfaces/IFollow.sol/interface.IFollow.html">IFollow</a>, ERC20Upgradeable</p>
+ERC20Upgradeable</p>
+<h2 id="state-variables"><a class="header" href="#state-variables">State Variables</a></h2>
+<h3 id="_pointsbalances"><a class="header" href="#_pointsbalances">_pointsBalances</a></h3>
+<pre><code class="language-solidity">mapping(bytes32 feedId =&gt; uint256) internal _pointsBalances;
+</code></pre>
 <h2 id="functions"><a class="header" href="#functions">Functions</a></h2>
 <h3 id="initialize"><a class="header" href="#initialize">initialize</a></h3>
 <p>Initializes the contract.</p>
@@ -193,28 +197,27 @@ <h3 id="initialize"><a class="header" href="#initialize">initialize</a></h3>
 </tbody></table>
 </div>
 <h3 id="mint"><a class="header" href="#mint">mint</a></h3>
-<p>Mints new tokens.</p>
-<pre><code class="language-solidity">function mint(address to) external override;
+<p>Mints new token points.</p>
+<pre><code class="language-solidity">function mint(address to) external;
 </code></pre>
 <p><strong>Parameters</strong></p>
 <div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
 <tr><td><code>to</code></td><td><code>address</code></td><td>The account to receive the tokens.</td></tr>
 </tbody></table>
 </div>
-<h3 id="tip"><a class="header" href="#tip">tip</a></h3>
-<p>Tips the recipient feed.</p>
-<pre><code class="language-solidity">function tip(address from, uint256 amount, bytes32 feedId) external override;
+<h3 id="transferpoints"><a class="header" href="#transferpoints">transferPoints</a></h3>
+<p>Transfers token points.</p>
+<pre><code class="language-solidity">function transferPoints(uint256 amount, bytes32 feedId) external;
 </code></pre>
 <p><strong>Parameters</strong></p>
 <div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
-<tr><td><code>from</code></td><td><code>address</code></td><td>The address who sends the tip.</td></tr>
-<tr><td><code>amount</code></td><td><code>uint256</code></td><td>The amount of the tip.</td></tr>
+<tr><td><code>amount</code></td><td><code>uint256</code></td><td>The amount token points to send.</td></tr>
 <tr><td><code>feedId</code></td><td><code>bytes32</code></td><td>The feed id.</td></tr>
 </tbody></table>
 </div>
 <h3 id="withdraw"><a class="header" href="#withdraw">withdraw</a></h3>
 <p>Withdraws tokens.</p>
-<pre><code class="language-solidity">function withdraw(address to, uint256 amount) external override;
+<pre><code class="language-solidity">function withdraw(address to, uint256 amount) external;
 </code></pre>
 <p><strong>Parameters</strong></p>
 <div class="table-wrapper"><table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody>
@@ -226,7 +229,7 @@ <h3 id="withdraw"><a class="header" href="#withdraw">withdraw</a></h3>
 
                     <nav class="nav-wrapper" aria-label="Page navigation">
                         <!-- Mobile navigation buttons -->
-                            <a rel="prev" href="../../src/interfaces/IFollow.sol/interface.IFollow.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                            <a rel="prev" href="../../index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>
 
@@ -237,7 +240,7 @@ <h3 id="withdraw"><a class="header" href="#withdraw">withdraw</a></h3>
             </div>
 
             <nav class="nav-wide-wrapper" aria-label="Page navigation">
-                    <a rel="prev" href="../../src/interfaces/IFollow.sol/interface.IFollow.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
+                    <a rel="prev" href="../../index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>