Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@iamjaspreetsingh
iamjaspreetsingh committed Jun 30, 2019
1 parent daa28b6 commit aab9138
Show file tree
Hide file tree
Showing 3 changed files with 353 additions and 2 deletions.
165 changes: 165 additions & 0 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 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.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public 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.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
190 changes: 188 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,188 @@
# PartialOwnership
Partial ownership for digital assets on EOS
# dNFTs

The proposed standard is for distributed ownership of non fungible assets on EOS. For the digital assets like videos, music, e-books, photography etc., partial ownership is generally required. It would allow user to sell some part of their ownership on EOS platform by listing for it. Also, it would motivate the public participation in such valuable assets too.

**Telegram**: https://t.me/dnfts_eos
**Medium** : https://medium.com/quillhash/partial-ownership-on-eos-773aea600e3

### Architecture
<img src="https://github.com/Quillhash/dnfts/blob/master/architecture.png" >

### RAM usage
The RAM usage is used for every creation and listing of the digital asset. It also depends on how much data is stored in the mdata fields. If considered empty, each digital asset may take upto 0.4 - 0.5 kB RAM. The contract deployment requires ~717 kB RAM.

### Platforms using it
**Zeptagram** is the one doing great job using this standard and are first to implement it. They have created a marketplace for music rights via their platform. It shall be an awesome oppurtunity for anyone to list and earn from their music.
https://zeptagram.com/

---------------------------

### Contract Actions:

#### setconfig
```
ACTION setconfig(string version)
```

To maintain version and token category ids.

#### create

```
ACTION create (name issuer,
name category,
name token_name,
bool burnable,
string base_uri)
```

To create a new token under some category like ```Harrypotter``` for ```ebook``` category.

#### issue

```
ACTION issue (name to,
name category,
name token_name,
asset quantity,
string memo)
```

It is callable by issuer; to issue to their true ownership holders as per their percentage. Quantity needs to be in PER only.


#### burn

```
ACTION burn (name owner,
uint64_t category_name_id,
asset quantity)
```
It is callable only by token owner; to burn quantity PERs of their ownership on particular token.


#### buyshare

```
ACTION buyshare(name from,
name to,
asset quantity,
string memo)
```
It is called when a user sends EOS from eosio.token to this smart contract account with a memo of "sale_id,to_account"


#### listsale

```
ACTION listsale (name seller,
uint64_t category_id,
asset percent_share,
asset per_percent_amt)
```
It is callable only by owner; creates a sale listing in the token contract valid
for 1 week, transfers ownership to token contract


#### closesale

```
ACTION closesale (name seller,
uint64_t sale_id)
```
It is callable by seller if listing hasn't expired, or anyone if the listing is expired.


#### giveroyalty

```
ACTION giveroyalty (uint64_t category_id,
asset royalty)
```
This action is used to give away the royalty collected to the ownership holders of particular VT-A. The x% ownership means x% of the royalty. Can be called by the `_self` every quarter.

---------------------------

### Data Structures

#### tokenconfigs
```
TABLE tokenconfigs {
name standard;
string version;
};
```
Scope is _self.

#### categoryids
```
TABLE categoryids{
uint64_t cat_id;
uint64_t primary_key() const { return cat_id; }
};
```

#### accounts
```
TABLE accounts {
uint64_t category_name_id;
name category;
name token_name;
asset amount;
uint64_t primary_key() const { return category_name_id; }
};
```
Scope is owner of the asset.

#### dnft
```
TABLE dnft {
name owner;
uint64_t primary_key() const { return owner.value; }
};
```
Scope is category_id (category name -> token name)

#### dnftstats
```
TABLE dnftstats {
bool burnable;
name issuer;
name token_name;
uint64_t category_name_id;
asset current_supply;
asset issued_supply;
string base_uri;
uint64_t primary_key() const { return token_name.value; }
};
```
Scope is category,and token_name is unique, has information of all the tokens in the category..

#### asks
```
TABLE asks {
uint64_t sale_id;
name token_name;
name category;
name seller;
asset per_percent_amt;
asset percent_share;
time_point_sec expiration;
uint64_t primary_key() const { return sale_id; }
uint64_t get_seller() const { return seller.value; }
};
```
Scope is _self. All the information of sale listings are here.

---------------------------

## How to buy dNFTs ownership?

To buy the ownership, one has to transfer the EOS from the eosio.token **```transfer```** action with the memo as:
**```sale_id,to```**

## Standards for digital assets and NFTs
If your use case is different, the following standards may be helpful:
* https://github.com/CryptoLions/SimpleAssets
* https://github.com/MythicalGames/dgoods
* https://github.com/unicoeos/eosio.nft
Binary file added architecture.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aab9138

Please sign in to comment.