forked from DECA/DAOTask
Compare commits
7 Commits
| Author | SHA1 | Date |
|---|---|---|
David E. Perez Negron R.
|
c032bedf5a | |
|
David E. Perez Negron R.
|
ae5dbf9aa3 | |
|
David E. Perez Negron R.
|
24bdafa367 | |
|
David E. Perez Negron R.
|
6c1dbde9bf | |
|
David E. Perez Negron R.
|
7886af15ff | |
itzelot01
|
9760bf198f | |
|
itzelot01
|
c219511196 |
|
|
@ -0,0 +1,445 @@
|
||||||
|
# GNU Free Documentation License
|
||||||
|
|
||||||
|
Version 1.3, 3 November 2008
|
||||||
|
|
||||||
|
Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation,
|
||||||
|
Inc. <https://fsf.org/>
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
## 0. PREAMBLE
|
||||||
|
|
||||||
|
The purpose of this License is to make a manual, textbook, or other
|
||||||
|
functional and useful document "free" in the sense of freedom: to
|
||||||
|
assure everyone the effective freedom to copy and redistribute it,
|
||||||
|
with or without modifying it, either commercially or noncommercially.
|
||||||
|
Secondarily, this License preserves for the author and publisher a way
|
||||||
|
to get credit for their work, while not being considered responsible
|
||||||
|
for modifications made by others.
|
||||||
|
|
||||||
|
This License is a kind of "copyleft", which means that derivative
|
||||||
|
works of the document must themselves be free in the same sense. It
|
||||||
|
complements the GNU General Public License, which is a copyleft
|
||||||
|
license designed for free software.
|
||||||
|
|
||||||
|
We have designed this License in order to use it for manuals for free
|
||||||
|
software, because free software needs free documentation: a free
|
||||||
|
program should come with manuals providing the same freedoms that the
|
||||||
|
software does. But this License is not limited to software manuals; it
|
||||||
|
can be used for any textual work, regardless of subject matter or
|
||||||
|
whether it is published as a printed book. We recommend this License
|
||||||
|
principally for works whose purpose is instruction or reference.
|
||||||
|
|
||||||
|
## 1. APPLICABILITY AND DEFINITIONS
|
||||||
|
|
||||||
|
This License applies to any manual or other work, in any medium, that
|
||||||
|
contains a notice placed by the copyright holder saying it can be
|
||||||
|
distributed under the terms of this License. Such a notice grants a
|
||||||
|
world-wide, royalty-free license, unlimited in duration, to use that
|
||||||
|
work under the conditions stated herein. The "Document", below, refers
|
||||||
|
to any such manual or work. Any member of the public is a licensee,
|
||||||
|
and is addressed as "you". You accept the license if you copy, modify
|
||||||
|
or distribute the work in a way requiring permission under copyright
|
||||||
|
law.
|
||||||
|
|
||||||
|
A "Modified Version" of the Document means any work containing the
|
||||||
|
Document or a portion of it, either copied verbatim, or with
|
||||||
|
modifications and/or translated into another language.
|
||||||
|
|
||||||
|
A "Secondary Section" is a named appendix or a front-matter section of
|
||||||
|
the Document that deals exclusively with the relationship of the
|
||||||
|
publishers or authors of the Document to the Document's overall
|
||||||
|
subject (or to related matters) and contains nothing that could fall
|
||||||
|
directly within that overall subject. (Thus, if the Document is in
|
||||||
|
part a textbook of mathematics, a Secondary Section may not explain
|
||||||
|
any mathematics.) The relationship could be a matter of historical
|
||||||
|
connection with the subject or with related matters, or of legal,
|
||||||
|
commercial, philosophical, ethical or political position regarding
|
||||||
|
them.
|
||||||
|
|
||||||
|
The "Invariant Sections" are certain Secondary Sections whose titles
|
||||||
|
are designated, as being those of Invariant Sections, in the notice
|
||||||
|
that says that the Document is released under this License. If a
|
||||||
|
section does not fit the above definition of Secondary then it is not
|
||||||
|
allowed to be designated as Invariant. The Document may contain zero
|
||||||
|
Invariant Sections. If the Document does not identify any Invariant
|
||||||
|
Sections then there are none.
|
||||||
|
|
||||||
|
The "Cover Texts" are certain short passages of text that are listed,
|
||||||
|
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
|
||||||
|
the Document is released under this License. A Front-Cover Text may be
|
||||||
|
at most 5 words, and a Back-Cover Text may be at most 25 words.
|
||||||
|
|
||||||
|
A "Transparent" copy of the Document means a machine-readable copy,
|
||||||
|
represented in a format whose specification is available to the
|
||||||
|
general public, that is suitable for revising the document
|
||||||
|
straightforwardly with generic text editors or (for images composed of
|
||||||
|
pixels) generic paint programs or (for drawings) some widely available
|
||||||
|
drawing editor, and that is suitable for input to text formatters or
|
||||||
|
for automatic translation to a variety of formats suitable for input
|
||||||
|
to text formatters. A copy made in an otherwise Transparent file
|
||||||
|
format whose markup, or absence of markup, has been arranged to thwart
|
||||||
|
or discourage subsequent modification by readers is not Transparent.
|
||||||
|
An image format is not Transparent if used for any substantial amount
|
||||||
|
of text. A copy that is not "Transparent" is called "Opaque".
|
||||||
|
|
||||||
|
Examples of suitable formats for Transparent copies include plain
|
||||||
|
ASCII without markup, Texinfo input format, LaTeX input format, SGML
|
||||||
|
or XML using a publicly available DTD, and standard-conforming simple
|
||||||
|
HTML, PostScript or PDF designed for human modification. Examples of
|
||||||
|
transparent image formats include PNG, XCF and JPG. Opaque formats
|
||||||
|
include proprietary formats that can be read and edited only by
|
||||||
|
proprietary word processors, SGML or XML for which the DTD and/or
|
||||||
|
processing tools are not generally available, and the
|
||||||
|
machine-generated HTML, PostScript or PDF produced by some word
|
||||||
|
processors for output purposes only.
|
||||||
|
|
||||||
|
The "Title Page" means, for a printed book, the title page itself,
|
||||||
|
plus such following pages as are needed to hold, legibly, the material
|
||||||
|
this License requires to appear in the title page. For works in
|
||||||
|
formats which do not have any title page as such, "Title Page" means
|
||||||
|
the text near the most prominent appearance of the work's title,
|
||||||
|
preceding the beginning of the body of the text.
|
||||||
|
|
||||||
|
The "publisher" means any person or entity that distributes copies of
|
||||||
|
the Document to the public.
|
||||||
|
|
||||||
|
A section "Entitled XYZ" means a named subunit of the Document whose
|
||||||
|
title either is precisely XYZ or contains XYZ in parentheses following
|
||||||
|
text that translates XYZ in another language. (Here XYZ stands for a
|
||||||
|
specific section name mentioned below, such as "Acknowledgements",
|
||||||
|
"Dedications", "Endorsements", or "History".) To "Preserve the Title"
|
||||||
|
of such a section when you modify the Document means that it remains a
|
||||||
|
section "Entitled XYZ" according to this definition.
|
||||||
|
|
||||||
|
The Document may include Warranty Disclaimers next to the notice which
|
||||||
|
states that this License applies to the Document. These Warranty
|
||||||
|
Disclaimers are considered to be included by reference in this
|
||||||
|
License, but only as regards disclaiming warranties: any other
|
||||||
|
implication that these Warranty Disclaimers may have is void and has
|
||||||
|
no effect on the meaning of this License.
|
||||||
|
|
||||||
|
## 2. VERBATIM COPYING
|
||||||
|
|
||||||
|
You may copy and distribute the Document in any medium, either
|
||||||
|
commercially or noncommercially, provided that this License, the
|
||||||
|
copyright notices, and the license notice saying this License applies
|
||||||
|
to the Document are reproduced in all copies, and that you add no
|
||||||
|
other conditions whatsoever to those of this License. You may not use
|
||||||
|
technical measures to obstruct or control the reading or further
|
||||||
|
copying of the copies you make or distribute. However, you may accept
|
||||||
|
compensation in exchange for copies. If you distribute a large enough
|
||||||
|
number of copies you must also follow the conditions in section 3.
|
||||||
|
|
||||||
|
You may also lend copies, under the same conditions stated above, and
|
||||||
|
you may publicly display copies.
|
||||||
|
|
||||||
|
## 3. COPYING IN QUANTITY
|
||||||
|
|
||||||
|
If you publish printed copies (or copies in media that commonly have
|
||||||
|
printed covers) of the Document, numbering more than 100, and the
|
||||||
|
Document's license notice requires Cover Texts, you must enclose the
|
||||||
|
copies in covers that carry, clearly and legibly, all these Cover
|
||||||
|
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
|
||||||
|
the back cover. Both covers must also clearly and legibly identify you
|
||||||
|
as the publisher of these copies. The front cover must present the
|
||||||
|
full title with all words of the title equally prominent and visible.
|
||||||
|
You may add other material on the covers in addition. Copying with
|
||||||
|
changes limited to the covers, as long as they preserve the title of
|
||||||
|
the Document and satisfy these conditions, can be treated as verbatim
|
||||||
|
copying in other respects.
|
||||||
|
|
||||||
|
If the required texts for either cover are too voluminous to fit
|
||||||
|
legibly, you should put the first ones listed (as many as fit
|
||||||
|
reasonably) on the actual cover, and continue the rest onto adjacent
|
||||||
|
pages.
|
||||||
|
|
||||||
|
If you publish or distribute Opaque copies of the Document numbering
|
||||||
|
more than 100, you must either include a machine-readable Transparent
|
||||||
|
copy along with each Opaque copy, or state in or with each Opaque copy
|
||||||
|
a computer-network location from which the general network-using
|
||||||
|
public has access to download using public-standard network protocols
|
||||||
|
a complete Transparent copy of the Document, free of added material.
|
||||||
|
If you use the latter option, you must take reasonably prudent steps,
|
||||||
|
when you begin distribution of Opaque copies in quantity, to ensure
|
||||||
|
that this Transparent copy will remain thus accessible at the stated
|
||||||
|
location until at least one year after the last time you distribute an
|
||||||
|
Opaque copy (directly or through your agents or retailers) of that
|
||||||
|
edition to the public.
|
||||||
|
|
||||||
|
It is requested, but not required, that you contact the authors of the
|
||||||
|
Document well before redistributing any large number of copies, to
|
||||||
|
give them a chance to provide you with an updated version of the
|
||||||
|
Document.
|
||||||
|
|
||||||
|
## 4. MODIFICATIONS
|
||||||
|
|
||||||
|
You may copy and distribute a Modified Version of the Document under
|
||||||
|
the conditions of sections 2 and 3 above, provided that you release
|
||||||
|
the Modified Version under precisely this License, with the Modified
|
||||||
|
Version filling the role of the Document, thus licensing distribution
|
||||||
|
and modification of the Modified Version to whoever possesses a copy
|
||||||
|
of it. In addition, you must do these things in the Modified Version:
|
||||||
|
|
||||||
|
- A. Use in the Title Page (and on the covers, if any) a title
|
||||||
|
distinct from that of the Document, and from those of previous
|
||||||
|
versions (which should, if there were any, be listed in the
|
||||||
|
History section of the Document). You may use the same title as a
|
||||||
|
previous version if the original publisher of that version
|
||||||
|
gives permission.
|
||||||
|
- B. List on the Title Page, as authors, one or more persons or
|
||||||
|
entities responsible for authorship of the modifications in the
|
||||||
|
Modified Version, together with at least five of the principal
|
||||||
|
authors of the Document (all of its principal authors, if it has
|
||||||
|
fewer than five), unless they release you from this requirement.
|
||||||
|
- C. State on the Title page the name of the publisher of the
|
||||||
|
Modified Version, as the publisher.
|
||||||
|
- D. Preserve all the copyright notices of the Document.
|
||||||
|
- E. Add an appropriate copyright notice for your modifications
|
||||||
|
adjacent to the other copyright notices.
|
||||||
|
- F. Include, immediately after the copyright notices, a license
|
||||||
|
notice giving the public permission to use the Modified Version
|
||||||
|
under the terms of this License, in the form shown in the
|
||||||
|
Addendum below.
|
||||||
|
- G. Preserve in that license notice the full lists of Invariant
|
||||||
|
Sections and required Cover Texts given in the Document's
|
||||||
|
license notice.
|
||||||
|
- H. Include an unaltered copy of this License.
|
||||||
|
- I. Preserve the section Entitled "History", Preserve its Title,
|
||||||
|
and add to it an item stating at least the title, year, new
|
||||||
|
authors, and publisher of the Modified Version as given on the
|
||||||
|
Title Page. If there is no section Entitled "History" in the
|
||||||
|
Document, create one stating the title, year, authors, and
|
||||||
|
publisher of the Document as given on its Title Page, then add an
|
||||||
|
item describing the Modified Version as stated in the
|
||||||
|
previous sentence.
|
||||||
|
- J. Preserve the network location, if any, given in the Document
|
||||||
|
for public access to a Transparent copy of the Document, and
|
||||||
|
likewise the network locations given in the Document for previous
|
||||||
|
versions it was based on. These may be placed in the "History"
|
||||||
|
section. You may omit a network location for a work that was
|
||||||
|
published at least four years before the Document itself, or if
|
||||||
|
the original publisher of the version it refers to
|
||||||
|
gives permission.
|
||||||
|
- K. For any section Entitled "Acknowledgements" or "Dedications",
|
||||||
|
Preserve the Title of the section, and preserve in the section all
|
||||||
|
the substance and tone of each of the contributor acknowledgements
|
||||||
|
and/or dedications given therein.
|
||||||
|
- L. Preserve all the Invariant Sections of the Document, unaltered
|
||||||
|
in their text and in their titles. Section numbers or the
|
||||||
|
equivalent are not considered part of the section titles.
|
||||||
|
- M. Delete any section Entitled "Endorsements". Such a section may
|
||||||
|
not be included in the Modified Version.
|
||||||
|
- N. Do not retitle any existing section to be Entitled
|
||||||
|
"Endorsements" or to conflict in title with any Invariant Section.
|
||||||
|
- O. Preserve any Warranty Disclaimers.
|
||||||
|
|
||||||
|
If the Modified Version includes new front-matter sections or
|
||||||
|
appendices that qualify as Secondary Sections and contain no material
|
||||||
|
copied from the Document, you may at your option designate some or all
|
||||||
|
of these sections as invariant. To do this, add their titles to the
|
||||||
|
list of Invariant Sections in the Modified Version's license notice.
|
||||||
|
These titles must be distinct from any other section titles.
|
||||||
|
|
||||||
|
You may add a section Entitled "Endorsements", provided it contains
|
||||||
|
nothing but endorsements of your Modified Version by various
|
||||||
|
parties—for example, statements of peer review or that the text has
|
||||||
|
been approved by an organization as the authoritative definition of a
|
||||||
|
standard.
|
||||||
|
|
||||||
|
You may add a passage of up to five words as a Front-Cover Text, and a
|
||||||
|
passage of up to 25 words as a Back-Cover Text, to the end of the list
|
||||||
|
of Cover Texts in the Modified Version. Only one passage of
|
||||||
|
Front-Cover Text and one of Back-Cover Text may be added by (or
|
||||||
|
through arrangements made by) any one entity. If the Document already
|
||||||
|
includes a cover text for the same cover, previously added by you or
|
||||||
|
by arrangement made by the same entity you are acting on behalf of,
|
||||||
|
you may not add another; but you may replace the old one, on explicit
|
||||||
|
permission from the previous publisher that added the old one.
|
||||||
|
|
||||||
|
The author(s) and publisher(s) of the Document do not by this License
|
||||||
|
give permission to use their names for publicity for or to assert or
|
||||||
|
imply endorsement of any Modified Version.
|
||||||
|
|
||||||
|
## 5. COMBINING DOCUMENTS
|
||||||
|
|
||||||
|
You may combine the Document with other documents released under this
|
||||||
|
License, under the terms defined in section 4 above for modified
|
||||||
|
versions, provided that you include in the combination all of the
|
||||||
|
Invariant Sections of all of the original documents, unmodified, and
|
||||||
|
list them all as Invariant Sections of your combined work in its
|
||||||
|
license notice, and that you preserve all their Warranty Disclaimers.
|
||||||
|
|
||||||
|
The combined work need only contain one copy of this License, and
|
||||||
|
multiple identical Invariant Sections may be replaced with a single
|
||||||
|
copy. If there are multiple Invariant Sections with the same name but
|
||||||
|
different contents, make the title of each such section unique by
|
||||||
|
adding at the end of it, in parentheses, the name of the original
|
||||||
|
author or publisher of that section if known, or else a unique number.
|
||||||
|
Make the same adjustment to the section titles in the list of
|
||||||
|
Invariant Sections in the license notice of the combined work.
|
||||||
|
|
||||||
|
In the combination, you must combine any sections Entitled "History"
|
||||||
|
in the various original documents, forming one section Entitled
|
||||||
|
"History"; likewise combine any sections Entitled "Acknowledgements",
|
||||||
|
and any sections Entitled "Dedications". You must delete all sections
|
||||||
|
Entitled "Endorsements".
|
||||||
|
|
||||||
|
## 6. COLLECTIONS OF DOCUMENTS
|
||||||
|
|
||||||
|
You may make a collection consisting of the Document and other
|
||||||
|
documents released under this License, and replace the individual
|
||||||
|
copies of this License in the various documents with a single copy
|
||||||
|
that is included in the collection, provided that you follow the rules
|
||||||
|
of this License for verbatim copying of each of the documents in all
|
||||||
|
other respects.
|
||||||
|
|
||||||
|
You may extract a single document from such a collection, and
|
||||||
|
distribute it individually under this License, provided you insert a
|
||||||
|
copy of this License into the extracted document, and follow this
|
||||||
|
License in all other respects regarding verbatim copying of that
|
||||||
|
document.
|
||||||
|
|
||||||
|
## 7. AGGREGATION WITH INDEPENDENT WORKS
|
||||||
|
|
||||||
|
A compilation of the Document or its derivatives with other separate
|
||||||
|
and independent documents or works, in or on a volume of a storage or
|
||||||
|
distribution medium, is called an "aggregate" if the copyright
|
||||||
|
resulting from the compilation is not used to limit the legal rights
|
||||||
|
of the compilation's users beyond what the individual works permit.
|
||||||
|
When the Document is included in an aggregate, this License does not
|
||||||
|
apply to the other works in the aggregate which are not themselves
|
||||||
|
derivative works of the Document.
|
||||||
|
|
||||||
|
If the Cover Text requirement of section 3 is applicable to these
|
||||||
|
copies of the Document, then if the Document is less than one half of
|
||||||
|
the entire aggregate, the Document's Cover Texts may be placed on
|
||||||
|
covers that bracket the Document within the aggregate, or the
|
||||||
|
electronic equivalent of covers if the Document is in electronic form.
|
||||||
|
Otherwise they must appear on printed covers that bracket the whole
|
||||||
|
aggregate.
|
||||||
|
|
||||||
|
## 8. TRANSLATION
|
||||||
|
|
||||||
|
Translation is considered a kind of modification, so you may
|
||||||
|
distribute translations of the Document under the terms of section 4.
|
||||||
|
Replacing Invariant Sections with translations requires special
|
||||||
|
permission from their copyright holders, but you may include
|
||||||
|
translations of some or all Invariant Sections in addition to the
|
||||||
|
original versions of these Invariant Sections. You may include a
|
||||||
|
translation of this License, and all the license notices in the
|
||||||
|
Document, and any Warranty Disclaimers, provided that you also include
|
||||||
|
the original English version of this License and the original versions
|
||||||
|
of those notices and disclaimers. In case of a disagreement between
|
||||||
|
the translation and the original version of this License or a notice
|
||||||
|
or disclaimer, the original version will prevail.
|
||||||
|
|
||||||
|
If a section in the Document is Entitled "Acknowledgements",
|
||||||
|
"Dedications", or "History", the requirement (section 4) to Preserve
|
||||||
|
its Title (section 1) will typically require changing the actual
|
||||||
|
title.
|
||||||
|
|
||||||
|
## 9. TERMINATION
|
||||||
|
|
||||||
|
You may not copy, modify, sublicense, or distribute the Document
|
||||||
|
except as expressly provided under this License. Any attempt otherwise
|
||||||
|
to copy, modify, sublicense, or distribute it is void, and will
|
||||||
|
automatically terminate your rights under this License.
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your license
|
||||||
|
from a particular copyright holder is reinstated (a) provisionally,
|
||||||
|
unless and until the copyright holder explicitly and finally
|
||||||
|
terminates your license, and (b) permanently, if the copyright holder
|
||||||
|
fails to notify you of the violation by some reasonable means prior to
|
||||||
|
60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, receipt of a copy of some or all of the same material does
|
||||||
|
not give you any rights to use it.
|
||||||
|
|
||||||
|
## 10. FUTURE REVISIONS OF THIS LICENSE
|
||||||
|
|
||||||
|
The Free Software Foundation may publish new, revised versions of the
|
||||||
|
GNU Free Documentation License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in
|
||||||
|
detail to address new problems or concerns. See
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Each version of the License is given a distinguishing version number.
|
||||||
|
If the Document specifies that a particular numbered version of this
|
||||||
|
License "or any later version" applies to it, you have the option of
|
||||||
|
following the terms and conditions either of that specified version or
|
||||||
|
of any later version that has been published (not as a draft) by the
|
||||||
|
Free Software Foundation. If the Document does not specify a version
|
||||||
|
number of this License, you may choose any version ever published (not
|
||||||
|
as a draft) by the Free Software Foundation. If the Document specifies
|
||||||
|
that a proxy can decide which future versions of this License can be
|
||||||
|
used, that proxy's public statement of acceptance of a version
|
||||||
|
permanently authorizes you to choose that version for the Document.
|
||||||
|
|
||||||
|
## 11. RELICENSING
|
||||||
|
|
||||||
|
"Massive Multiauthor Collaboration Site" (or "MMC Site") means any
|
||||||
|
World Wide Web server that publishes copyrightable works and also
|
||||||
|
provides prominent facilities for anybody to edit those works. A
|
||||||
|
public wiki that anybody can edit is an example of such a server. A
|
||||||
|
"Massive Multiauthor Collaboration" (or "MMC") contained in the site
|
||||||
|
means any set of copyrightable works thus published on the MMC site.
|
||||||
|
|
||||||
|
"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
|
||||||
|
license published by Creative Commons Corporation, a not-for-profit
|
||||||
|
corporation with a principal place of business in San Francisco,
|
||||||
|
California, as well as future copyleft versions of that license
|
||||||
|
published by that same organization.
|
||||||
|
|
||||||
|
"Incorporate" means to publish or republish a Document, in whole or in
|
||||||
|
part, as part of another Document.
|
||||||
|
|
||||||
|
An MMC is "eligible for relicensing" if it is licensed under this
|
||||||
|
License, and if all works that were first published under this License
|
||||||
|
somewhere other than this MMC, and subsequently incorporated in whole
|
||||||
|
or in part into the MMC, (1) had no cover texts or invariant sections,
|
||||||
|
and (2) were thus incorporated prior to November 1, 2008.
|
||||||
|
|
||||||
|
The operator of an MMC Site may republish an MMC contained in the site
|
||||||
|
under CC-BY-SA on the same site at any time before August 1, 2009,
|
||||||
|
provided the MMC is eligible for relicensing.
|
||||||
|
|
||||||
|
## ADDENDUM: How to use this License for your documents
|
||||||
|
|
||||||
|
To use this License in a document you have written, include a copy of
|
||||||
|
the License in the document and put the following copyright and
|
||||||
|
license notices just after the title page:
|
||||||
|
|
||||||
|
Copyright (C) 2024 DECENTRALIZED CLIMATE FOUNDATION A.C.
|
||||||
|
Permission is granted to copy, distribute and/or modify this document
|
||||||
|
under the terms of the GNU Free Documentation License, Version 1.3
|
||||||
|
or any later version published by the Free Software Foundation;
|
||||||
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||||
|
A copy of the license is included in the section entitled "GNU
|
||||||
|
Free Documentation License".
|
||||||
|
|
||||||
|
If you have Invariant Sections, Front-Cover Texts and Back-Cover
|
||||||
|
Texts, replace the "with … Texts." line with this:
|
||||||
|
|
||||||
|
with the Invariant Sections being LIST THEIR TITLES, with the
|
||||||
|
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
|
||||||
|
|
||||||
|
If you have Invariant Sections without Cover Texts, or some other
|
||||||
|
combination of the three, merge those two alternatives to suit the
|
||||||
|
situation.
|
||||||
|
|
||||||
|
If your document contains nontrivial examples of program code, we
|
||||||
|
recommend releasing these examples in parallel under your choice of
|
||||||
|
free software license, such as the GNU General Public License, to
|
||||||
|
permit their use in free software.
|
||||||
129
README.md
129
README.md
|
|
@ -1,84 +1,109 @@
|
||||||
# DECA Architecture
|
# DECA Architecture
|
||||||
|
|
||||||
## Abstract
|
## Abstract
|
||||||
|
|
||||||
The project development will be done modularly and will be splitted into
|
The project development will be done modularly and will be splitted into
|
||||||
multiple subprojects which require the proper research and development.The
|
multiple subprojects which require the proper research and development.The
|
||||||
Goal is to develop all the architecture require for the [DECA Protocol](https://docs.google.com/presentation/d/1H4V5X0X-9jnulwmmQBKk7PiStqKoPh_t_h7F0R3kLw0/edit#slide=id.p)
|
Goal is to develop all the architecture require for the [DECA Protocol](https://docs.google.com/presentation/d/1H4V5X0X-9jnulwmmQBKk7PiStqKoPh_t_h7F0R3kLw0/edit#slide=id.p)
|
||||||
|
|
||||||
## Project Overview
|
## Project Overview
|
||||||
|
|
||||||
### General Diagrams
|
### General Development
|
||||||
|
> Note1: Testing should be developed for each smart contract
|
||||||
|
> Note2: Each Module requires its technical specification and references.
|
||||||
|
|
||||||
|
- [ ] [Module 1: Decentralized infrastructure](#module-1:-decentralized-infrastructure)
|
||||||
|
- [ ] [Module 2: R&D Decentralizable Architecture](#module-2:-r&d-decentralizable-architecture)
|
||||||
|
- [ ] [Module 3: Decentralized Carbon Credits Backlog 2.0](#module-3:-Decentralized-carbon-credits-backlog-2.0)
|
||||||
|
- [ ] Module 4: ERC1155 or ERC404 Development and testing (cctokens, DECA2, SBT)
|
||||||
|
- [ ] Module 5: R&D DECA DAO (Vaults, ranking/quadratic voting, whitelist, etc)
|
||||||
|
- [ ] Module 6: R&D Upgradeable Tokenomics Ultrasound Model (Research and Dev)
|
||||||
|
- [ ] Module 7: R&D Liquidity Pools DEFI Connector
|
||||||
|
- [ ] Module 8: R&D Lending DEFI Connector
|
||||||
|
- [ ] Module 9: Security and Testing
|
||||||
|
- [ ] Module 10: Rebranding and Technical Marketing.
|
||||||
|
|
||||||
### Development
|
|
||||||
|
|
||||||
- [ ] Module 0: Modify tunk to be IPFS compatible (Possibly use CAR)
|
|
||||||
- [ ] Module 1: YEW DAPP that connects to HELIA (Typescript)
|
|
||||||
- [ ] Module 2: YEW DAPP that connects to the DECA Contract using Ethers-web3
|
|
||||||
- [ ] Module 3: YEW DAPP that includes and updated version of OrbitDB and extracts data from Ethers-Web3(Depends on 1,2)
|
|
||||||
- [ ] Module 4: Fleek YEW integration with Docker (for the IPNS/DNS and CI/CD).
|
|
||||||
- [ ] Module 7: ERC1155 Development and testing (cctokens, DECA2, SBt)
|
|
||||||
- [ ] Module 8: DAO (Vaults, ranking/quadratic voting, whitelist, etc)
|
|
||||||
- [ ] Module 9: Liquidity Pools DeFi
|
|
||||||
- [ ] Module 10: Lending DeFi
|
|
||||||
- [ ] Module 11: Integration(requires from 1-8)
|
|
||||||
|
|
||||||
### Research
|
|
||||||
|
|
||||||
- [ ] Module 5: Architecture specifications for DECA Protocol (R&D, Class Diagrams).
|
|
||||||
- [ ] Module 6: Tokenomics Ultrasound Model (Research and Dev)
|
|
||||||
|
|
||||||
### Security Testing
|
|
||||||
|
|
||||||
- [ ] Module 11: Security Audit
|
|
||||||
|
|
||||||
### Future R&D
|
### Future R&D
|
||||||
- [ ] Use Cases.
|
|
||||||
- [ ] Payto DAO (SmartWallet)
|
* Use Cases List (Awesome DECA).
|
||||||
- [ ] Zero Knowledge Proof Carbon Offset (Privacy and Fungibility).
|
* Payto DAO (SmartWallet)
|
||||||
|
* Bounty Program
|
||||||
|
* Zero Knowledge Proof Carbon Offset (Privacy and Fungibility).
|
||||||
|
|
||||||
|
## Modules Description
|
||||||
|
|
||||||
|
### Module 1: Decentralized infrastructure
|
||||||
|
|
||||||
|
This module its al related to the DECA Decentralized infrastructure model, from
|
||||||
|
physical to session layer how to accomplish an easy to deploy and support the
|
||||||
|
decentralization of the project by using technologies such as IPFS (Gateways,
|
||||||
|
nodes and cluster), docker/incus images, alternative networks such as tor, i2p
|
||||||
|
and using blockchain contract to ensure security of nodes listing.
|
||||||
|
|
||||||
|
[Module 1 Specification](./module1/module1.md)
|
||||||
|
|
||||||
|
### Module 2: R&D Decentralizable Architecture
|
||||||
|
|
||||||
|
This module is the presentation and aplication layers it comprise the whole
|
||||||
|
development toolset and technologies that DECA will use for its dapps
|
||||||
|
development (CI/CD, Helia, OrbitDB, Ethers, frameworks, and others) the goal is
|
||||||
|
to have a decentralizable base architecture.
|
||||||
|
|
||||||
|
[Module 2 Specification](./module2/module2.md)
|
||||||
|
|
||||||
|
#### Module 2 alternative WASM and Rust Research
|
||||||
|
|
||||||
|
[Module 2 alt. WASM+RUST](./module2/module2-rust.md)
|
||||||
|
|
||||||
|
|
||||||
## Module Description
|
### Module 3 Decentralized Carbon Credits Backlog 2.0
|
||||||
|
|
||||||
### Module 0
|
Module 3 is an upgrade of the Decentralized Carbon Credits Backlog,
|
||||||
|
by using ipfs helia, orbitdb, ethers and a smart contract to verify carbon
|
||||||
|
credits approved/verified by the DAO.
|
||||||
|
|
||||||
This module is to ensure that the trunk build website (yew mostly)
|
[Module 3 Specification](./module3/module3.md)
|
||||||
builds a decentralizable website and assets. Consider using CAR
|
|
||||||
management for the assets.
|
|
||||||
|
|
||||||
[Module 0 Specification](./module0.md)
|
### Module 4: ERC1155 or ERC404 Development and testing (cctokens, DECA2, SBT)
|
||||||
|
|
||||||
### Module 1
|
### Module 5: R&D DECA DAO (Vaults, ranking/quadratic voting, whitelist, etc)
|
||||||
|
|
||||||
This module will ensure that the website and its assets runs in a HELIA instance.
|
### Module 6: R&D Upgradeable Tokenomics Ultrasound Model (Research and Dev)
|
||||||
This will add seeds and thus network speed to the content distribution. All the
|
|
||||||
assets should be integrated in the project so that it does not depend on centralized
|
|
||||||
systems. This module is important to ensure frontend decentralization.
|
|
||||||
|
|
||||||
[Module 1 Specification](./module1.md)
|
### Module 7: R&D Liquidity Pools DEFI Connector
|
||||||
|
|
||||||
### Module 2
|
### Module 8: R&D Lending DEFI Connector
|
||||||
|
|
||||||
This module will include its own ethers wasm implementation, so that it connects
|
### Module 9: Security and Testing
|
||||||
to the Ethereum blockchain and perform some testing operations. The Goal is to
|
|
||||||
ensure the ethers connector can be decentralized and included in the project code.
|
|
||||||
This module is important to ensure comunication with the smart contracts in a
|
|
||||||
decentralized way.
|
|
||||||
|
|
||||||
[Module 2 Specification](./module2.md)
|
### Module 10: Rebranding and Technical Marketing.
|
||||||
|
|
||||||
### Module 7
|
Module 10 handles websites, user tools, and social networks management with
|
||||||
|
automated technical marketing as RSS push events from website blog, articles
|
||||||
|
and git commits. Community building is the most important goal of this module
|
||||||
|
and weekly calls, education and brainstorming will be the DECA approach to
|
||||||
|
creating a stronger, and better-informed community.
|
||||||
|
|
||||||
|
> Note: The modules will not be organized in a sequential order necesarily but
|
||||||
> dig1. Shows the front end DAPP architecture for SBT
|
the design should consider the other implementations based on the General
|
||||||
|
Diagrams and Use Cases Examples.
|
||||||
|
|
||||||
### Module N
|
[Module 10 Specification](./module10/module10.md)
|
||||||
|
|
||||||
|
## General Diagrams and Use Cases
|
||||||
|
|
||||||
|
## [LICENSE](./LICENSE.md)
|
||||||
|
|
||||||
> Important Note: all modules should be tested in a decentralized environment
|
```
|
||||||
|
Copyright (C) 2024 DECENTRALIZED CLIMATE FOUNDATION A.C.
|
||||||
|
Permission is granted to copy, distribute and/or modify this document
|
||||||
|
under the terms of the GNU Free Documentation License, Version 1.3
|
||||||
|
or any later version published by the Free Software Foundation;
|
||||||
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||||
|
A copy of the license is included in the section entitled "GNU
|
||||||
|
Free Documentation License".
|
||||||
|
```
|
||||||
|
|
||||||
## References
|
## References
|
||||||
[^1]: https://github.com/web3-storage/ipfs-car
|
|
||||||
[^2]: https://ipld.io/specs/transport/car/
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,16 +1,20 @@
|
||||||
| Done | Date | Time | ID | Depends | Project | SubProject | Task | p1r0 | Itzel | Resources | Discussion | Proof | Published |
|
| Done | Date | Time | ID | Depends | Project | SubProject | Task | p1r0 | Help | Resources | Discussion | Proof | Published |
|
||||||
|------|------|------|------|---------|-----------|------------|----------------------------------------------|------|-------|----------------------------------------------------|---------------------------------------------------------------------|-------|-----------|
|
|------|------|------|------|---------|------------- |------------|----------------------------------------------|------|-------|----------------------------------------------------|---------------------------------------------------------------------|-------|-----------|
|
||||||
| | | | NFT1 | | NFTs DAPP | BackEnd | Understanding Foundry | x | x | https://www.youtube.com/watch?v=aBiMC8t-53k | https://forum.deca.eco/-41/project-proposal-dev1-deca-nfts-giveaway | | |
|
|
||||||
| | | | NFT2 | | NFTs DAPP | FrontEnd | Integrate DCO2_IPFS with YEW/Bootstrap | | x | https://dev.to/pancy/build-a-decentralized-app-on-ipfs-using-webassembly-46a4 | https://forum.deca.eco/-41/project-proposal-dev1-deca-nfts-giveaway | | |
|
|
||||||
| | | | RES1 | | RESEARCH | IPFS | Docker Setup for Fleek.co | x | | https://docs.fleek.co/hosting/site-deployment/ | | | |
|
| | | | RES1 | | RESEARCH | IPFS | Docker Setup for Fleek.co | x | | https://docs.fleek.co/hosting/site-deployment/ | | | |
|
||||||
| | | | NFT3 | | NFTs DAPP | BackEnd | Smart Contract Creating ERC721 & testing | x | x | https://docs.openzeppelin.com/contracts/5.x/erc721 | https://forum.deca.eco/-41/project-proposal-dev1-deca-nfts-giveaway | | |
|
| | | | NFT1 | | NFTs DAPP | BackEnd | Smart Contract Creating ERC721 & testing | x | x | https://docs.openzeppelin.com/contracts/5.x/erc721 | https://forum.deca.eco/-41/project-proposal-dev1-deca-nfts-giveaway | | |
|
||||||
| | | | NFT4 | | NFTs DAPP | Recurrent | Integrate DCO2_IPFS Version with ipfs HELIA | | | https://github.com/ipfs/helia | | | |
|
| | | | RES2 | | RESEARCH | Tools | Update SocialN for publications & tools | x | | | | | |
|
||||||
| | | | RES2 | | RESEARCH | Tools | Update SocialN for publications & tools | | | | | | |
|
| | | | RES3 | | RESEARCH | Tools | Create a basic Rust CLI to OpenAI Assistant | x | | https://github.com/64bit/async-openai/tree/main/examples/assistants/src | | | |
|
||||||
| | | | NFT5 | NFT3 | NFTs DAPP | BackEnd | AA(Airdrop and Auction) Contract | | | https://forum.deca.eco/-41/project-proposal-dev1-deca-nfts-giveaway | https://forum.deca.eco/-41/project-proposal-dev1-deca-nfts-giveaway| | |
|
| | | | DES1 | | DECASEARCH-1.5| Ethers-js | Create an Angular DAPP to get the CC Address | x | x | | | | |
|
||||||
| | | | NFT6 |NFT2,NFT4| NFTs DAPP | FrontEnd | Convert JS and NFTs to Rust structures | | | | | | |
|
| | | | DES2 | | DECASEARCH-1.5| WEB3Connect| Add wallet connector to web3-inject | x | x | | | | |
|
||||||
| | | | RES3 | | RESEARCH | Tools | Create a basic Rust CLI to OpenAI Assistant | | | https://github.com/64bit/async-openai/tree/main/examples/assistants/src | | | |
|
| | | | DES2 | | DECASEARCH-1.5| HELIA | Helia Create a node on the browser | x | x | | | | |
|
||||||
| | | | NFT7 |NFT3,NFT4| NFTs DAPP | FrontEnd | Ethers(rs or js) Integrations and test branch| | | https://github.com/gakonst/ethers-rs | | | |
|
| | | | DES3 | | DECASEARCH-1.5| OrbitDB | Retrive the OrbitDB database from CC address| x | x | | | | |
|
||||||
| | | | | | | | | | | | | | |
|
| | | | DES4 | | DECASEARCH-1.5| SEARCH | add and updated version of the DECASearch | x | x | | | | |
|
||||||
| | | | | | | | | | | | | | |
|
| | | | DES5 | | DECASEARCH-1.5| Registry | Develop a for carbon credits registry system | x | x | | | | |
|
||||||
|
| | | | DCA1 | | DECA2 | DECA-Votes | Wrap DECA ERC20 for Vote proposals with OPenZ| x | x | | | | |
|
||||||
|
| | | | DCA2 | | DECA2 | DECA-DAO | Create a quadratic proposal to approve Carbon| x | x | | | | |
|
||||||
|
| | | | BCK1 | | BACKLOG-1.5 | HELIA | Create an updated BACKLOG | x | x | | | | |
|
||||||
|
| | | | BCK2 | | BACKLOG-1.5 | Ethers-js | Create an updated BACKLOG | x | x | | | | |
|
||||||
|
| | | | BCK3 | | BACKLOG-1.5 | REGISTRY | Create the UPDATE Registry | x | x | | | | |
|
||||||
|
| | | | DCS1 | | DOCs | DOCs | CI: Make Relative Script u | x | x | | https://git.decentralizedscience.org/DECA/docs/issues/4 | | |
|
||||||
| | | | | | | | | | | | | | |
|
| | | | | | | | | | | | | | |
|
||||||
| | | | | | | | | | | | | | |
|
| | | | | | | | | | | | | | |
|
||||||
|
|
|
||||||
31
module0.md
31
module0.md
|
|
@ -1,31 +0,0 @@
|
||||||
# Module 0 Specification
|
|
||||||
|
|
||||||
## Goal
|
|
||||||
|
|
||||||
This module is to ensure that the trunk build website (yew mostly)
|
|
||||||
builds a decentralizable website and assets. Consider using CAR
|
|
||||||
management for the assets.
|
|
||||||
|
|
||||||
|
|
||||||
## ToDo
|
|
||||||
- [ ] Research CAR
|
|
||||||
- [ ] Detect and Report issue (Update this specification)
|
|
||||||
- [ ] Research and test possible solutions.
|
|
||||||
- [ ] Implement solution to achieve the goal.
|
|
||||||
|
|
||||||
## Report
|
|
||||||
|
|
||||||
### CAR Specification
|
|
||||||
* [CAR library](https://github.com/web3-storage/ipfs-car)[^1]
|
|
||||||
* [CAR Reference](https://ipld.io/specs/transport/car/)[^2]
|
|
||||||
|
|
||||||
### Trunk found issues
|
|
||||||
|
|
||||||
### Possible solutions
|
|
||||||
|
|
||||||
## Notes and further developments.
|
|
||||||
|
|
||||||
## References
|
|
||||||
|
|
||||||
[^1]: https://github.com/web3-storage/ipfs-car
|
|
||||||
[^2]: https://ipld.io/specs/transport/car/
|
|
||||||
93
module1.md
93
module1.md
|
|
@ -1,93 +0,0 @@
|
||||||
# Module 1 Specification
|
|
||||||
|
|
||||||
## Goal
|
|
||||||
|
|
||||||
This module will ensure that the website and its assets runs in a HELIA instance.
|
|
||||||
This will add seeds and thus network speed to the content distribution. All the
|
|
||||||
assets should be integrated in the project so that it does not depend on centralized
|
|
||||||
systems. This module is important to ensure frontend decentralization.
|
|
||||||
|
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
- [ ] Module 0
|
|
||||||
|
|
||||||
## ToDo
|
|
||||||
|
|
||||||
- [ ] Research HELIA.
|
|
||||||
- [ ] How to solve the website hashing paradigm.
|
|
||||||
- [ ] Detect and Report issue (Update this specification).
|
|
||||||
- [ ] Research and test possible solutions.
|
|
||||||
- [ ] Implement solution to achieve the goal.
|
|
||||||
|
|
||||||
## Report
|
|
||||||
|
|
||||||
* Upon doing research on helia, we found that some of the methods on implementing JavaScript on Rust with callback and using yew have problems with the
|
|
||||||
imports of Helia.
|
|
||||||
The following are issues found with the different methods:
|
|
||||||
1. With web-pack: While trying to import Helia's libraries on a previosly working app using callback to implement JavaScript on a yew template, we
|
|
||||||
stumbled upon an error in which we couldn't install the Helia library due to there being too many packages.
|
|
||||||
Possible solutions implemented:
|
|
||||||
- Importing Helia from the import link instead of installing the library, though one of the problems with this solution is that you can't do imports
|
|
||||||
and at the same time export a function with the JS callback on Rust. It was necessary to first import the Helia library and then use it for the export function.
|
|
||||||
- Adding the import links to the index.html like script modules.
|
|
||||||
|
|
||||||
2. After not finding a concrete solution that would help us with the import, I decided to follow the yew tutorial drive through libraries that was very well
|
|
||||||
documented but a little outdated since it was using yew version 12. Now the problem was the it had two errors that wouldn't let me run the app.
|
|
||||||
Specific errors found:
|
|
||||||
* error [E0433]: failed to resolve: unresolved import (a function from the wasm-bindgen.rs that comes from the version of wasm-bindgen that you installed).
|
|
||||||
* error [E0425]: cannot find the function 'wasm_bindgen_initialized' in this scope (also coming from wasm-bindgen.rs).
|
|
||||||
|
|
||||||
|
|
||||||
Possible solutions implemented:
|
|
||||||
|
|
||||||
- Updating to the newest version of wasm_bindgen.
|
|
||||||
- Trying to change the imports of wasm_bindgen.
|
|
||||||
- Adding the dependency to de Cargo.toml file.
|
|
||||||
> None of these solutions worked
|
|
||||||
|
|
||||||
3. Currently using the yew-interop to asynchronously Load CSS or Javascript libraries which allows you to import libraries from links and also implements
|
|
||||||
JavaScript scripts to Rust.
|
|
||||||
Using the example provided in the examples GitHub repository to know how to have the correct structure and succesfully import everything necessary for the app.
|
|
||||||
|
|
||||||
### HELIA Specification
|
|
||||||
* [Helia library](https://github.com/ipfs/helia)[^1]
|
|
||||||
* [Helia Examples](https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-webpack)[^2]
|
|
||||||
* [Helia Example by Phind](https://www.phind.com/search?cache=v6nzolbm7xl10xvhgfih6bvz)[^3]
|
|
||||||
|
|
||||||
### Hashing paradigm
|
|
||||||
|
|
||||||
To have a self decentralized website we need to add a hash to the code this hash
|
|
||||||
known as CID is generated based on all the assets hashed data, so it makes a
|
|
||||||
paradigm problem to add the hash if its not know previously in the code, because
|
|
||||||
if we add it to the code of the site, the project hash will change.
|
|
||||||
|
|
||||||
### Possible solutions
|
|
||||||
|
|
||||||
1. Using SmartContract: Use a smart contract with an IPNS and a ENS
|
|
||||||
(Ethereum Name Service NFT) which points to an IPNS that will be updated by the
|
|
||||||
project developer. This gives us the flexibility to update, and security that
|
|
||||||
the blockchain offers. This can also be an alternative to avoid MITM and other
|
|
||||||
security issues.
|
|
||||||
|
|
||||||
* Pros: ToDo
|
|
||||||
|
|
||||||
* Cons: ToDo
|
|
||||||
2.
|
|
||||||
|
|
||||||
## Notes and further developments.
|
|
||||||
|
|
||||||
1. Make the ENS Updateable by a DAO and a smart wallet.
|
|
||||||
|
|
||||||
## References
|
|
||||||
|
|
||||||
[^1]: https://github.com/ipfs/helia
|
|
||||||
[^2]: https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-webpack
|
|
||||||
[^3]: https://dev.to/davidedelpapa/yew-tutorial-05-drive-through-libraries-2gj5
|
|
||||||
[^4]: https://github.com/Madoshakalaka/yew-interop
|
|
||||||
[^5]: https://github.com/Madoshakalaka/yew-interop/tree/master/example
|
|
||||||
[^6]: https://rustwasm.github.io/wasm-bindgen/examples/import-js.html
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
# Module 1 Specification
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
This module is related to the DECA Decentralized infrastructure model, from
|
||||||
|
physical to session layer how to accomplish an easy to deploy and support the
|
||||||
|
decentralization of the project by using technologies such as IPFS (Gateways,
|
||||||
|
nodes and cluster), docker/incus images, alternative networks such as tor, i2p
|
||||||
|
and using blockchain contract to ensure security of nodes listing.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
## Subprojects
|
||||||
|
- [x] [Decentralized Science Git](https://git.decentralizedscience.org)
|
||||||
|
- [x] [Decentralized Science Kubo Gateway](https://gateway.decentralizedscience.org)
|
||||||
|
- [ ] Libp2p bootstrap config through dapp_indexer
|
||||||
|
- [ ] Incus Config
|
||||||
|
- [ ] Docker Config
|
||||||
|
- [ ] R&T DNSLink, fleek and mDNS
|
||||||
|
|
||||||
|
## Development Reports and Repositories
|
||||||
|
|
||||||
|
### Decentralized Science Git.
|
||||||
|
|
||||||
|
Suproject Goal:
|
||||||
|
|
||||||
|
[Decentralized Science Git](https://git.decentralizedscience.org)[^1]
|
||||||
|
|
||||||
|
|
||||||
|
### Decentralized Science Kubo Gateway
|
||||||
|
|
||||||
|
Suproject Goal:
|
||||||
|
|
||||||
|
- [ ] Research and test possible solutions.
|
||||||
|
- [ ] Implement solution to achieve the goal.
|
||||||
|
|
||||||
|
### Libp2p bootstrap config through dapp_indexer
|
||||||
|
|
||||||
|
|
||||||
|
### Incus Config
|
||||||
|
|
||||||
|
|
||||||
|
### Docker Config
|
||||||
|
|
||||||
|
|
||||||
|
### R&T DNSLink and mDNS
|
||||||
|
|
||||||
|
[distributed bootstrapping with IPNS](https://github.com/libp2p/notes/issues/24)
|
||||||
|
|
||||||
|
## Notes and further developments.
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
[^1]: https://git.decentralizedscience.org
|
||||||
|
|
@ -0,0 +1,124 @@
|
||||||
|
# Module 10 Specification
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
Module 10 handles websites, user tools, and social networks management with
|
||||||
|
automated technical marketing as RSS push events from website blog, articles
|
||||||
|
and git commits. Community building is the most important goal of this module
|
||||||
|
and weekly calls, education, hackathons and brainstorming will be the DECA
|
||||||
|
approach to creating a stronger, and better-informed community.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- [x] Module 1
|
||||||
|
|
||||||
|
## Subprojects
|
||||||
|
|
||||||
|
- [ ] Refactor DECA Website: using [lume](https://lume.land/)
|
||||||
|
- [ ] Update DECADocs
|
||||||
|
- [ ] Create DAOTasks Website
|
||||||
|
- [ ] Fix Email isses and link them to the systems.
|
||||||
|
- [ ] Migrate Forum to a Lemmy Instance.
|
||||||
|
- [ ] Link RSS to social networks.
|
||||||
|
- [ ] DECA LLM.
|
||||||
|
- [ ] R&D Rebranding.
|
||||||
|
|
||||||
|
Where:
|
||||||
|
|
||||||
|
> R: Research
|
||||||
|
|
||||||
|
> D: Develop
|
||||||
|
|
||||||
|
> T: Test
|
||||||
|
|
||||||
|
## Development Reports and Repositories
|
||||||
|
|
||||||
|
### DECA WEBSITE
|
||||||
|
|
||||||
|
- [x] Deno + [lume](https://lume.land/) test [^1]
|
||||||
|
- [x] Decentralize test
|
||||||
|
- [x] [T: DSCI gateway with nginx](https://gateway.decentralizedscience.org)
|
||||||
|
- [ ] Decentralize with fleek for CI/CD
|
||||||
|
- [ ] [Pin IPNS in DSCI gateway](https://gateway.decentralizedscience.org)
|
||||||
|
- [x] Create repo and issues to consider the first release
|
||||||
|
- [ ] Release and Deploy first version.
|
||||||
|
|
||||||
|
Full information at the [DECA WEBSITE repository](https://git.decentralizedscience.org/DECA/deca.eco/src/branch/develop)
|
||||||
|
|
||||||
|
### Update DECADocs
|
||||||
|
|
||||||
|
from DAOTasks and Papers Documentation.
|
||||||
|
- [ ] Solve decentralization issues with rustdocs (permalinks, rootfolder and fleek)
|
||||||
|
- [ ] If it cannot be solved migrate to [lume theme](https://lume.land/themes/) (lumedocs or wiki)
|
||||||
|
- [ ] Decentralize with fleek for CI/CD
|
||||||
|
- [ ] [Pin IPNS in DSCI gateway](https://gateway.decentralizedscience.org)
|
||||||
|
- [ ] Create repo and issues to consider the first release
|
||||||
|
- [ ] Release and Deploy first version.
|
||||||
|
- [ ] Link to DECA WEBSITE.
|
||||||
|
|
||||||
|
|
||||||
|
Full information at the [DECADocs Repository](https://git.decentralizedscience.org/DECA/docs/src/branch/develop)
|
||||||
|
|
||||||
|
### Create DAOTask Website.
|
||||||
|
|
||||||
|
> Depends on DECA WEBSITE and LUME
|
||||||
|
|
||||||
|
- [ ] Fleek integration if DECA WEBSITE deploys easier consider a lume documentation instance.
|
||||||
|
- [ ] Cleanup and merge DAOTasks with DOCs so that merge only includes links to repositories and
|
||||||
|
basic checkup list like this one.
|
||||||
|
- [ ] Decentralize with fleek for CI/CD
|
||||||
|
- [ ] [Pin IPNS in DSCI gateway](https://gateway.decentralizedscience.org)
|
||||||
|
- [ ] Link to DECA WEBSITE.
|
||||||
|
|
||||||
|
Full information at the [DaoTasks Repository](https://git.decentralizedscience.org/DECA/DAOTask/src/branch/develop)
|
||||||
|
|
||||||
|
### Fix email issues
|
||||||
|
|
||||||
|
Migrate infrastructure and setup email for services such as:
|
||||||
|
|
||||||
|
- [x] DSCI Git
|
||||||
|
- [x] forum or lemmy instance. (we will migrate to lemmy)
|
||||||
|
- [ ] (Optional) NSI nextcloud
|
||||||
|
|
||||||
|
### Migrate Forum to a Lemmy Instance
|
||||||
|
|
||||||
|
- [ ] Deploy and test a [Lemmy Instance](https://join-lemmy.org/docs/administration/from_scratch.html).
|
||||||
|
- [ ] Deploy and test a [Lemmy Instance](https://join-lemmy.org/docs/administration/from_scratch.html).
|
||||||
|
- [ ] Check the most important post from [the DECA forum](https://forum.deca.eco)
|
||||||
|
- [ ] Migrate them to documentation or Lemmy.
|
||||||
|
|
||||||
|
### Link RSS to social networks.
|
||||||
|
|
||||||
|
> Note Rss updates will be created from git and blog posts.
|
||||||
|
|
||||||
|
- [x] Recover or Create a new Twitter account. UPDATE: new twitter account is @decatokens
|
||||||
|
- [x] Link RSS to missing telegram channels. UPDATE: using make.com
|
||||||
|
- [ ] Link twitter to RSS Updates.
|
||||||
|
- [ ] Link Discord to RSS Updates.
|
||||||
|
- [ ] Link Mirror.xyz to Blog RSS.
|
||||||
|
|
||||||
|
### DECA LLM
|
||||||
|
|
||||||
|
- [ ] Use Documentation for LLM Training.
|
||||||
|
- [ ] Bot as FAQ for channels.
|
||||||
|
- [ ] Help on DECA Tech publications and charts.
|
||||||
|
|
||||||
|
### Rebranding
|
||||||
|
|
||||||
|
> Help Wanted
|
||||||
|
|
||||||
|
- [x] Logo Update black and white png
|
||||||
|
- [ ] Brand document
|
||||||
|
|
||||||
|
## Notes and further developments.
|
||||||
|
|
||||||
|
> Most of Module 10 work will be great to have some external help and add bounties
|
||||||
|
to it. Yet it might require the DAOTasks and the integration with the DAO and
|
||||||
|
Lemmy for debate. This will be developed gradually while testing its modules.
|
||||||
|
|
||||||
|
1. Link the Daotask to run onchain or at least linked to the snapshot.org this
|
||||||
|
might require the development of a web3 component using lit and ethers.
|
||||||
|
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
[^1]: https://lume.land/
|
||||||
38
module2.md
38
module2.md
|
|
@ -1,38 +0,0 @@
|
||||||
# Module 2 Specification
|
|
||||||
|
|
||||||
## Goal
|
|
||||||
|
|
||||||
This module will include its own ethers wasm implementation, so that it connects
|
|
||||||
to the Ethereum blockchain and perform some testing operations. The Goal is to
|
|
||||||
ensure the ethers connector can be decentralized and included in the project code.
|
|
||||||
This module is important to ensure comunication with the smart contracts in a
|
|
||||||
decentralized way.
|
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
- [ ] Module 0
|
|
||||||
- [ ] Module 1
|
|
||||||
|
|
||||||
## ToDo
|
|
||||||
- [ ] Basic understading YEW
|
|
||||||
- [ ] Basic understading Ethers-rs(similar sintax to ethers-web)
|
|
||||||
- [ ] Fork main chain
|
|
||||||
- [ ] Create a base project to interact with DECA Smart Contract
|
|
||||||
- [ ] Create some general access to functions for th DECA Smart Contract
|
|
||||||
|
|
||||||
## Report
|
|
||||||
|
|
||||||
### ethers-web Specification
|
|
||||||
* [Ethers-web library](https://github.com/quay-rs/ethers-web/tree/main)[^1]
|
|
||||||
* [Ethers-rs docs](https://docs.rs/ethers/latest/ethers/index.html)[^2]
|
|
||||||
|
|
||||||
|
|
||||||
## Notes and further developments.
|
|
||||||
|
|
||||||
> Note1: Ethers-rs will be depercated in favor of [alloy](https://github.com/alloy-rs/)[^3] (yet alloy is not
|
|
||||||
production ready).
|
|
||||||
|
|
||||||
## References
|
|
||||||
|
|
||||||
[^1]: https://github.com/quay-rs/ethers-web/tree/main
|
|
||||||
[^2]: https://docs.rs/ethers/latest/ethers/index.html
|
|
||||||
[^3]: https://github.com/alloy-rs/
|
|
||||||
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
|
@ -0,0 +1,105 @@
|
||||||
|
# Module 2 Specification
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
This module is the presentation and aplication layers it comprise the whole
|
||||||
|
development toolset and technologies that DECA will use for its dapps
|
||||||
|
development (CI/CD, Helia, OrbitDB, Ethers, frameworks, and others) the goal is
|
||||||
|
to have a decentralizable base architecture.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- [x] Module 1
|
||||||
|
|
||||||
|
## Subprojects
|
||||||
|
|
||||||
|
- [ ] Lume R&D
|
||||||
|
- [ ] Lit R&D
|
||||||
|
- [ ] HELIA R&D
|
||||||
|
- [ ] OrbitDB R&D
|
||||||
|
- [ ] WASM R&D
|
||||||
|
- [ ] Decentralizable Assets Bundler
|
||||||
|
- [ ] Ethers R&D
|
||||||
|
- [ ] Dapp Indexer D&T
|
||||||
|
- [ ] Final DAPP Framework
|
||||||
|
|
||||||
|
> Where:
|
||||||
|
> R: Research
|
||||||
|
> D: Develop
|
||||||
|
> T: Test
|
||||||
|
|
||||||
|
## Development Reports and Repositories
|
||||||
|
|
||||||
|
### Lume R&D
|
||||||
|
|
||||||
|
- [ ] Deno + lume
|
||||||
|
|
||||||
|
### Lit R&D
|
||||||
|
|
||||||
|
- [ ] Lit Compositor
|
||||||
|
|
||||||
|
### HELIA R&D
|
||||||
|
|
||||||
|
The usage of Helia for the dapp will ensure that web clients become their own
|
||||||
|
dapp node instance which will share assets and thus network speed and further
|
||||||
|
decentralization.
|
||||||
|
|
||||||
|
* [Helia library](https://github.com/ipfs/helia)[^1]
|
||||||
|
* [Helia Examples](https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-webpack)[^2]
|
||||||
|
* [Helia Example by Phind](https://www.phind.com/search?cache=v6nzolbm7xl10xvhgfih6bvz)[^3]
|
||||||
|
|
||||||
|
#### Libp2p
|
||||||
|
|
||||||
|
Helia now requires libp2p for handling the peers, and networking
|
||||||
|
thus it is important to have some references and tests.
|
||||||
|
|
||||||
|
### OrbitDB R&D
|
||||||
|
|
||||||
|
### WASM
|
||||||
|
|
||||||
|
- [ ] Ethereum Markets tracker wasm
|
||||||
|
|
||||||
|
|
||||||
|
### Decentralizable Assets Bundler
|
||||||
|
|
||||||
|
### Ethers R&D
|
||||||
|
|
||||||
|
ethers connects to the Ethereum blockchain and perform some verification operations.
|
||||||
|
This module is important to ensure frontend/assets decentralization and
|
||||||
|
decentralized comunication with the smart contracts.
|
||||||
|
|
||||||
|
#### Ethers-js
|
||||||
|
|
||||||
|
#### Ethers-rs
|
||||||
|
|
||||||
|
#### Ethers-web
|
||||||
|
|
||||||
|
### Dapp Indexer D&T:
|
||||||
|
> CID Hashing paradox
|
||||||
|
|
||||||
|
To have a self decentralized website we need to add a hash to the code this hash
|
||||||
|
known as CID is generated based on all the assets hashed data, so it makes a
|
||||||
|
paradox problem to add the hash if its not know previously in the code, because
|
||||||
|
if we add it to the code of the site, the project hash will change.
|
||||||
|
|
||||||
|
#### Possible solutions
|
||||||
|
|
||||||
|
Using SmartContract assets indexer: Use a smart contract with an IPNS and a ENS
|
||||||
|
(Ethereum Name Service NFT) which points to an IPNS that will be updated by the
|
||||||
|
project developer. This gives us the flexibility to update, and security that
|
||||||
|
the blockchain offers. This can also be an alternative to avoid MITM and other
|
||||||
|
security issues.
|
||||||
|
|
||||||
|
All the assets should be integrated in the dapp indexer so that it provides
|
||||||
|
blockchain security to the dapp and the helia instance and it does not depends
|
||||||
|
on centralized systems.
|
||||||
|
|
||||||
|
### Final DAPP Framework
|
||||||
|
|
||||||
|
## Notes and further developments.
|
||||||
|
|
||||||
|
1. Make the ENS Updateable by a DAO and a smart wallet.
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
[^1]: https://github.com/ipfs/helia
|
||||||
|
[^2]: https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-webpack
|
||||||
|
|
@ -0,0 +1,113 @@
|
||||||
|
# Alternative to Module 1 R&D in Rust and WASM
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
the Car and Trunk R&D to ensure that the trunk build website (yew mostly)
|
||||||
|
builds a decentralizable website and assets. Consider using CAR
|
||||||
|
management for the assets.
|
||||||
|
|
||||||
|
HELIA R&D will ensure that the website and its assets runs in a HELIA instance.
|
||||||
|
This will add seeds and thus network speed to the content distribution. All the
|
||||||
|
assets should be integrated in the project so that it does not depend on centralized
|
||||||
|
systems. This module is important to ensure frontend decentralization.
|
||||||
|
|
||||||
|
|
||||||
|
Ethers-web with ethers-rs and wasm implementation, so that it connects
|
||||||
|
to the Ethereum blockchain and perform some testing operations. The Goal is to
|
||||||
|
ensure the ethers connector can be decentralized and included in the project code.
|
||||||
|
This module is important to ensure comunication with the smart contracts in a
|
||||||
|
decentralized way.
|
||||||
|
|
||||||
|
## RUST/WASM Architecture Diagram
|
||||||
|
|
||||||
|
|
||||||
|
> dig1. Shows the front end DAPP architecture for SBT
|
||||||
|
|
||||||
|
|
||||||
|
## ToDo
|
||||||
|
- [ ] Research CAR
|
||||||
|
- [ ] Detect and Report issue (Update this specification)
|
||||||
|
- [ ] Research and test possible solutions.
|
||||||
|
- [ ] Implement solution to achieve the goal.
|
||||||
|
|
||||||
|
- [ ] Research HELIA
|
||||||
|
- [ ] How to solve the website hashing paradigm
|
||||||
|
- [ ] Detect and Report issue (Update this specification)
|
||||||
|
- [ ] Research and test possible solutions.
|
||||||
|
- [ ] Implement solution to achieve the goal.
|
||||||
|
|
||||||
|
- [ ] Basic understading YEW
|
||||||
|
- [ ] Basic understading Ethers-rs(similar sintax to ethers-web)
|
||||||
|
- [ ] Fork main chain
|
||||||
|
- [ ] Create a base project to interact with DECA Smart Contract
|
||||||
|
- [ ] Create some general access to functions for th DECA Smart Contract
|
||||||
|
|
||||||
|
## CAR Specification
|
||||||
|
* [CAR library](https://github.com/web3-storage/ipfs-car)[^1]
|
||||||
|
* [CAR Reference](https://ipld.io/specs/transport/car/)[^2]
|
||||||
|
|
||||||
|
### Trunk found issues
|
||||||
|
Trunk Creates the instances based a proyect path, we require something such as
|
||||||
|
[make relative](https://github.com/tmcw/make-relative)[^3] for IPFS support.
|
||||||
|
[posible solution](https://github.com/trunk-rs/trunk/issues/151)
|
||||||
|
|
||||||
|
### Possible solutions
|
||||||
|
|
||||||
|
Fork and Rewrite Trunk.
|
||||||
|
|
||||||
|
### Cargo References
|
||||||
|
[^1]: https://github.com/web3-storage/ipfs-car
|
||||||
|
[^2]: https://ipld.io/specs/transport/car/
|
||||||
|
[^3]: https://github.com/tmcw/make-relative
|
||||||
|
|
||||||
|
|
||||||
|
## HELIA Specification
|
||||||
|
* [Helia library](https://github.com/ipfs/helia)[^4]
|
||||||
|
* [Helia Examples](https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-webpack)[^5]
|
||||||
|
* [Helia Example by Phind](https://www.phind.com/search?cache=v6nzolbm7xl10xvhgfih6bvz)[^6]
|
||||||
|
|
||||||
|
### Hashing paradigm
|
||||||
|
|
||||||
|
To have a self decentralized website we need to add a hash to the code this hash
|
||||||
|
known as CID is generated based on all the assets hashed data, so it makes a
|
||||||
|
paradigm problem to add the hash if its not know previously in the code, because
|
||||||
|
if we add it to the code of the site, the project hash will change.
|
||||||
|
|
||||||
|
### Possible solutions
|
||||||
|
|
||||||
|
1. Using SmartContract: Use a smart contract with an IPNS and a ENS
|
||||||
|
(Ethereum Name Service NFT) which points to an IPNS that will be updated by the
|
||||||
|
project developer. This gives us the flexibility to update, and security that
|
||||||
|
the blockchain offers. This can also be an alternative to avoid MITM and other
|
||||||
|
security issues.
|
||||||
|
|
||||||
|
* Pros: ToDo
|
||||||
|
|
||||||
|
* Cons: ToDo
|
||||||
|
|
||||||
|
### Notes and further developments.
|
||||||
|
|
||||||
|
1. Make the ENS Updateable by a DAO and a smart wallet.
|
||||||
|
|
||||||
|
### HELIA References
|
||||||
|
|
||||||
|
[^4]: https://github.com/ipfs/helia
|
||||||
|
[^5]: https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-webpack
|
||||||
|
[^6]: https://www.phind.com/search?cache=v6nzolbm7xl10xvhgfih6bvz
|
||||||
|
|
||||||
|
## ETHERS-WEB Specification
|
||||||
|
* [Alloy-rs library](https://github.com/tmcw/make-relative)[^7]
|
||||||
|
* [Ethers-web library](https://github.com/quay-rs/ethers-web/tree/main)[^8]
|
||||||
|
* [Ethers-rs docs](https://docs.rs/ethers/latest/ethers/index.html)[^9]
|
||||||
|
|
||||||
|
|
||||||
|
### Notes and further developments.
|
||||||
|
|
||||||
|
> Note1: Ethers-rs will be depercated in favor of [alloy](https://github.com/alloy-rs/) (yet alloy is not
|
||||||
|
production ready).
|
||||||
|
|
||||||
|
### Ethers References
|
||||||
|
|
||||||
|
[^7]: https://github.com/alloy-rs/
|
||||||
|
[^8]: https://github.com/quay-rs/ethers-web/tree/main
|
||||||
|
[^9]: https://docs.rs/ethers/latest/ethers/index.html
|
||||||
Loading…
Reference in New Issue