Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Documentation #659

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 45 additions & 45 deletions .gas-snapshot

Large diffs are not rendered by default.

Empty file added docs/.nojekyll
Empty file.
3 changes: 3 additions & 0 deletions docs/accounts/erc4337.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ERC4337

Under construction
3 changes: 3 additions & 0 deletions docs/accounts/erc4337factory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ERC4337Factory

Under construction
3 changes: 3 additions & 0 deletions docs/accounts/erc6551.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ERC6551

Under construction
3 changes: 3 additions & 0 deletions docs/accounts/erc6551proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ERC6551Proxy

Under construction
3 changes: 3 additions & 0 deletions docs/accounts/receiver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Receiver

Under construction
149 changes: 149 additions & 0 deletions docs/assets/css/prism-theme.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
/* Generated with http://k88hudson.github.io/syntax-highlighting-theme-generator/www */
/* http://k88hudson.github.io/react-markdocs */
/**
* @author k88hudson
*
* Based on prism.js default theme for JavaScript, CSS and HTML
* Based on dabblet (http://dabblet.com)
* @author Lea Verou
*/
/*********************************************************
* General
*/
pre[class*="language-"],
code[class*="language-"] {
color: #555;
font-size: 13px;
text-shadow: none;
direction: ltr;
text-align: left;
white-space: pre;
word-spacing: normal;
word-break: normal;
line-height: 1.5;
-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;
-webkit-hyphens: none;
-moz-hyphens: none;
-ms-hyphens: none;
hyphens: none;
}
pre[class*="language-"]::selection,
code[class*="language-"]::selection,
pre[class*="language-"]::mozselection,
code[class*="language-"]::mozselection {
text-shadow: none;
background: #bbb;
}
@media print {
pre[class*="language-"],
code[class*="language-"] {
text-shadow: none;
}
}
pre[class*="language-"] {
padding: 1em;
margin: .5em 0;
overflow: auto;
background: #f2f2f2;
}
:not(pre) > code[class*="language-"] {
padding: .1em .3em;
border-radius: .3em;
color: #db4c69;
background: #f9f2f4;
}
/*********************************************************
* Tokens
*/
.namespace {
opacity: .7;
}
.token.keyword,
.token.comment {
font-style: italic;
}
.token.comment,
.token.prolog,
.token.doctype,
.token.cdata {
color: #888;
color: rgba(0,0,0,0.45);
}
.token.punctuation {
color: #666;
}
.token.property,
.token.tag,
.token.boolean,
.token.number,
.token.constant,
.token.symbol,
.token.deleted {
color: #598;
}
.token.selector,
.token.attr-name,
.token.builtin,
.token.inserted {
color: #853;
}
.token.char,
.token.string {
color: #763;
}
.token.operator,
.token.entity,
.token.url,
.language-css .token.string,
.style .token.string {
color: #788;
background: #f2f2f2;
}
.token.atrule,
.token.attr-value,
.token.keyword {
color: #369;
}
.token.function {
color: #345;
}
.token.regex,
.token.important,
.token.variable {
color: #598;
}
.token.important,
.token.bold {
font-weight: bold;
}
.token.italic {
font-style: italic;
}
.token.entity {
cursor: help;
}
/*********************************************************
* Line highlighting
*/
pre[data-line] {
position: relative;
}
pre[class*="language-"] > code[class*="language-"] {
position: relative;
z-index: 1;
}
.line-highlight {
position: absolute;
left: 0;
right: 0;
padding: inherit 0;
margin-top: 1em;
background: #f7ebc6;
box-shadow: inset 5px 0 0 #f7d87c;
z-index: 0;
pointer-events: none;
line-height: inherit;
white-space: pre;
}
21 changes: 21 additions & 0 deletions docs/assets/fontello/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Font license info


## Meteocons

Copyright (C) 2012 by Alessio Atzeni

Author: Alessio Atzeni
License: SIL (http://scripts.sil.org/OFL)
Homepage: http://www.alessioatzeni.com


## Font Awesome

Copyright (C) 2016 by Dave Gandy

Author: Dave Gandy
License: SIL ()
Homepage: http://fortawesome.github.com/Font-Awesome/


75 changes: 75 additions & 0 deletions docs/assets/fontello/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
This webfont is generated by https://fontello.com open source project.


================================================================================
Please, note, that you should obey original font licenses, used to make this
webfont pack. Details available in LICENSE.txt file.

- Usually, it's enough to publish content of LICENSE.txt file somewhere on your
site in "About" section.

- If your project is open-source, usually, it will be ok to make LICENSE.txt
file publicly available in your repository.

- Fonts, used in Fontello, don't require a clickable link on your site.
But any kind of additional authors crediting is welcome.
================================================================================


Comments on archive content
---------------------------

- /font/* - fonts in different formats

- /css/* - different kinds of css, for all situations. Should be ok with
twitter bootstrap. Also, you can skip <i> style and assign icon classes
directly to text elements, if you don't mind about IE7.

- demo.html - demo file, to show your webfont content

- LICENSE.txt - license info about source fonts, used to build your one.

- config.json - keeps your settings. You can import it back into fontello
anytime, to continue your work


Why so many CSS files ?
-----------------------

Because we like to fit all your needs :)

- basic file, <your_font_name>.css - is usually enough, it contains @font-face
and character code definitions

- *-ie7.css - if you need IE7 support, but still don't wish to put char codes
directly into html

- *-codes.css and *-ie7-codes.css - if you like to use your own @font-face
rules, but still wish to benefit from css generation. That can be very
convenient for automated asset build systems. When you need to update font -
no need to manually edit files, just override old version with archive
content. See fontello source code for examples.

- *-embedded.css - basic css file, but with embedded WOFF font, to avoid
CORS issues in Firefox and IE9+, when fonts are hosted on the separate domain.
We strongly recommend to resolve this issue by `Access-Control-Allow-Origin`
server headers. But if you ok with dirty hack - this file is for you. Note,
that data url moved to separate @font-face to avoid problems with <IE9, when
string is too long.

- animate.css - use it to get ideas about spinner rotation animation.


Attention for server setup
--------------------------

You MUST setup server to reply with proper `mime-types` for font files -
otherwise some browsers will fail to show fonts.

Usually, `apache` already has necessary settings, but `nginx` and other
webservers should be tuned. Here is list of mime types for our file extensions:

- `application/vnd.ms-fontobject` - eot
- `application/x-font-woff` - woff
- `application/x-font-ttf` - ttf
- `image/svg+xml` - svg
61 changes: 61 additions & 0 deletions docs/assets/fontello/css/fontello.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
@font-face {
font-family: 'fontello';
src: url('../font/fontello.eot?86458507');
src: url('../font/fontello.eot?86458507#iefix') format('embedded-opentype'),
url('../font/fontello.woff2?86458507') format('woff2'),
url('../font/fontello.woff?86458507') format('woff'),
url('../font/fontello.ttf?86458507') format('truetype'),
url('../font/fontello.svg?86458507#fontello') format('svg');
font-weight: normal;
font-style: normal;
}
/* Chrome hack: SVG is rendered more smooth in Windozze. 100% magic, uncomment if you need it. */
/* Note, that will break hinting! In other OS-es font will be not as sharp as it could be */
/*
@media screen and (-webkit-min-device-pixel-ratio:0) {
@font-face {
font-family: 'fontello';
src: url('../font/fontello.svg?86458507#fontello') format('svg');
}
}
*/
[class^="icon-"]:before, [class*=" icon-"]:before {
font-family: "fontello";
font-style: normal;
font-weight: normal;
speak: never;

display: inline-block;
text-decoration: inherit;
width: 1em;
margin-right: .2em;
text-align: center;
/* opacity: .8; */

/* For safety - reset parent styles, that can break glyph codes*/
font-variant: normal;
text-transform: none;

/* fix buttons height, for twitter bootstrap */
line-height: 1em;

/* Animation center compensation - margins should be symmetric */
/* remove if not needed */
margin-left: .2em;

/* you can be more comfortable with increased icons size */
/* font-size: 120%; */

/* Font smoothing. That was taken from TWBS */
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;

/* Uncomment for 3D effect */
/* text-shadow: 1px 1px 1px rgba(127, 127, 127, 0.3); */
}

.icon-eclipse:before { content: '\e800'; } /* '' */
.icon-sun:before { content: '\e801'; } /* '' */
.icon-moon:before { content: '\e802'; } /* '' */
.icon-x:before { content: '\e803'; } /* '' */
.icon-github:before { content: '\f09b'; } /* '' */
Binary file added docs/assets/fontello/font/fontello.eot
Binary file not shown.
20 changes: 20 additions & 0 deletions docs/assets/fontello/font/fontello.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/fontello/font/fontello.ttf
Binary file not shown.
Binary file added docs/assets/fontello/font/fontello.woff
Binary file not shown.
Binary file added docs/assets/fontello/font/fontello.woff2
Binary file not shown.
Binary file added docs/assets/img/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/img/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/auth/ownable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ownable

Under construction
3 changes: 3 additions & 0 deletions docs/auth/ownableroles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# OwnableRoles

Under construction
Loading