Skip to content

Commit

Permalink
document
Browse files Browse the repository at this point in the history
  • Loading branch information
@androolloyd @github-actions
androolloyd authored and github-actions[bot] committed Oct 9, 2023
1 parent 162b508 commit b64f898
Show file tree
Hide file tree
Showing 151 changed files with 19,012 additions and 12,373 deletions.
221 changes: 221 additions & 0 deletions 404.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
<!DOCTYPE HTML>
<html lang="en" class="light" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Page not found - </title>
<base href="/">


<!-- Custom HTML head -->

<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">

<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">

<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">

<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">

<!-- Custom theme stylesheets -->
<link rel="stylesheet" href="book.css">

</head>
<body class="sidebar-visible no-js">
<div id="body-container">
<!-- Provide site root to javascript -->
<script>
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>

<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');

if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}

if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>

<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('light')
html.classList.add(theme);
var body = document.querySelector('body');
body.classList.remove('no-js')
body.classList.add('js');
</script>

<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">

<!-- Hide / unhide sidebar before it is displayed -->
<script>
var body = document.querySelector('body');
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
body.classList.remove('sidebar-visible');
body.classList.add("sidebar-" + sidebar);
</script>

<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/custodians/index.html">❱ custodians</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/custodians/AAVEPoolCustodian.sol/interface.IPool.html">IPool</a></li><li class="chapter-item "><a href="src/custodians/AAVEPoolCustodian.sol/contract.AAVEPoolCustodian.html">AAVEPoolCustodian</a></li></ol></li><li class="chapter-item "><a href="src/enforcers/index.html">❱ enforcers</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/enforcers/CaveatEnforcer.sol/abstract.CaveatEnforcer.html">CaveatEnforcer</a></li><li class="chapter-item "><a href="src/enforcers/CollateralEnforcer.sol/contract.CollateralEnforcer.html">CollateralEnforcer</a></li><li class="chapter-item "><a href="src/enforcers/RateEnforcer.sol/contract.FixedRateEnforcer.html">FixedRateEnforcer</a></li><li class="chapter-item "><a href="src/enforcers/TermEnforcer.sol/contract.TermEnforcer.html">TermEnforcer</a></li></ol></li><li class="chapter-item "><a href="src/handlers/index.html">❱ handlers</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/handlers/AstariaV1SettlementHandler.sol/contract.AstariaV1SettlementHandler.html">AstariaV1SettlementHandler</a></li><li class="chapter-item "><a href="src/handlers/DutchAuctionHandler.sol/abstract.DutchAuctionHandler.html">DutchAuctionHandler</a></li><li class="chapter-item "><a href="src/handlers/EnglishAuctionHandler.sol/contract.EnglishAuctionHandler.html">EnglishAuctionHandler</a></li><li class="chapter-item "><a href="src/handlers/FixedTermDutchAuctionHandler.sol/contract.FixedTermDutchAuctionHandler.html">FixedTermDutchAuctionHandler</a></li><li class="chapter-item "><a href="src/handlers/SettlementHandler.sol/abstract.SettlementHandler.html">SettlementHandler</a></li></ol></li><li class="chapter-item "><a href="src/hh_helpers/index.html">❱ hh_helpers</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/hh_helpers/MockERC20.sol/contract.MockERC20.html">MockERC20</a></li><li class="chapter-item "><a href="src/hh_helpers/MockERC721.sol/contract.MockERC721.html">MockERC721</a></li></ol></li><li class="chapter-item "><a href="src/hooks/index.html">❱ hooks</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/hooks/AstariaV1SettlementHook.sol/contract.AstariaV1SettlementHook.html">AstariaV1SettlementHook</a></li><li class="chapter-item "><a href="src/hooks/BaseHook.sol/abstract.BaseHook.html">BaseHook</a></li><li class="chapter-item "><a href="src/hooks/BaseRecall.sol/abstract.BaseRecall.html">BaseRecall</a></li><li class="chapter-item "><a href="src/hooks/FixedTermHook.sol/contract.FixedTermHook.html">FixedTermHook</a></li><li class="chapter-item "><a href="src/hooks/SettlementHook.sol/abstract.SettlementHook.html">SettlementHook</a></li></ol></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/Lender.sol/abstract.Lender.html">Lender</a></li><li class="chapter-item "><a href="src/interfaces/TokenReceiverInterface.sol/interface.TokenReceiverInterface.html">TokenReceiverInterface</a></li></ol></li><li class="chapter-item "><a href="src/lib/index.html">❱ lib</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/lib/StarPortLib.sol/library.StarPortLib.html">StarPortLib</a></li></ol></li><li class="chapter-item "><a href="src/originators/index.html">❱ originators</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/originators/Originator.sol/abstract.Originator.html">Originator</a></li><li class="chapter-item "><a href="src/originators/UniqueOriginator.sol/contract.UniqueOriginator.html">UniqueOriginator</a></li></ol></li><li class="chapter-item "><a href="src/pricing/index.html">❱ pricing</a><a class="toggle"><div>❱</div></a></li><li><ol class="section"><li class="chapter-item "><a href="src/pricing/AstariaV1Pricing.sol/contract.AstariaV1Pricing.html">AstariaV1Pricing</a></li><li class="chapter-item "><a href="src/pricing/BasePricing.sol/abstract.BasePricing.html">BasePricing</a></li><li class="chapter-item "><a href="src/pricing/BaseRecallPricing.sol/abstract.BaseRecallPricing.html">BaseRecallPricing</a></li><li class="chapter-item "><a href="src/pricing/CompoundInterestPricing.sol/abstract.CompoundInterestPricing.html">CompoundInterestPricing</a></li><li class="chapter-item "><a href="src/pricing/Pricing.sol/abstract.Pricing.html">Pricing</a></li><li class="chapter-item "><a href="src/pricing/SimpleInterestPricing.sol/contract.SimpleInterestPricing.html">SimpleInterestPricing</a></li></ol></li><li class="chapter-item "><a href="src/ConduitHelper.sol/abstract.ConduitHelper.html">ConduitHelper</a></li><li class="chapter-item "><a href="src/Custodian.sol/interface.LoanSettledCallback.html">LoanSettledCallback</a></li><li class="chapter-item "><a href="src/Custodian.sol/contract.Custodian.html">Custodian</a></li><li class="chapter-item "><a href="src/LoanManager.sol/contract.LoanManager.html">LoanManager</a></li></ol>
</div>
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
</nav>

<!-- Track and set sidebar scroll position -->
<script>
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
</script>

<div id="page-wrapper" class="page-wrapper">

<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>

<h1 class="menu-title"></h1>

<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/AstariaXYZ/starport" title="Git repository" aria-label="Git repository">
<i id="git-repository-button" class="fa fa-github"></i>
</a>

</div>
</div>

<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>

<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>

<div id="content" class="content">
<main>
<h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->


<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">

</nav>

</div>




<script>
window.playground_copyable = true;
</script>


<script src="elasticlunr.min.js"></script>
<script src="mark.min.js"></script>
<script src="searcher.js"></script>

<script src="clipboard.min.js"></script>
<script src="highlight.js"></script>
<script src="book.js"></script>

<!-- Custom JS scripts -->
<script src="solidity.min.js"></script>


</div>
</body>
</html>
4 changes: 4 additions & 0 deletions FontAwesome/css/font-awesome.css
View file

Large diffs are not rendered by default.

Binary file added FontAwesome/fonts/FontAwesome.ttf
View file
Binary file not shown.
Binary file added FontAwesome/fonts/fontawesome-webfont.eot
View file
Binary file not shown.
Loading

0 comments on commit b64f898

Please sign in to comment.