Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 4.84 KB

overview.md

File metadata and controls

69 lines (41 loc) · 4.84 KB
Raw

Smart Contracts

The system can be broken down into administrative contracts that primarily deal with the core infrastructure, and a series of action contracts that interact with users, videos, and metadata.

The following define Paratii's administrative contracts:

ParatiiRegistry

The ParatiiRegistry.sol contract is a simple key-value store on the blockchain that holds Paratii general settings. In particular, this is the place where the addresses of the deployed Paratii contracts are stored.

For example, the following call will get the address of the ParatiiToken contract:

let paratiiRegistery = paratii.contracts.ParatiiRegistry
paratiiRegistry.getAddress('ParatiiToken')`

The ParatiiRegistry is an Ownable contract, and contains simple setters and getters for several solidity types:

ParatiiRegistry.setAddress('UserRegistry', '0x12345') // can only be called by the owner of the contract instance
ParatiiRegistry.setUint('a-useful-constant', 99999)
ParatiiRegistry.getUint('a-useful-constant') // will return 99999

ParatiiToken

ParatiiToken.sol is an ERC20 token contract and contains the balances of all Paratii account holders.

paratiToken.balanceOf('0x123') // will return the balance of the given address

ParatiiAvatar

ParatiiAvatar.sol is a contract that can send and receive ETH and other ERC20 tokens, designed to collect and desimburse redistribution funds. It is controlled by a number of whitelisted addresses.

erc20Token = 0x12345667
paratiiAvatar.transferFrom(erc20Token, fromAddress, toAddress, amount) // will fail because you are not whitelisted
paratiiAvatar.addToWhitelist(0x22222222)
paratiiAvatar.transferFrom(erc20Token, fromAddress, toAddress, amount, { from: 0x22222222}) // sender is 0x2222, whihc is in the whitelist
paratiiAvatar.transfer(toAddress, amount) // transfer some ether to toAddress

These contracts are expected to remain unchanged. By contrast, the action contracts may be updated, and are expected to grow in number as Paratii develops new features. Administrative contracts interact with a series of action contracts in a simple pattern:

  1. Trigger one or more web.js hooks through an Event.
  2. Log the interaction within Paratii's metadata database.

These action contracts currently are:

UserRegistry

A registry with information about users: user metadata, upvote/downvote history, ownership of videos.

VideoRegistry

VideoRegistry.sol contains information about videos: their IPFS hash, its owner, and the price. This contract only stores essential information: additional metadata (duration, license, descriptions, etc etc) can be stored in IPFS.

VideoStore

The VideoStore is a contracts that tracks ownership and prices of videos (be it negative or positive). Buying (i.e. pay-per-view), for example, will register a purchase, and split the money being sent between the owner of the video and the VideoStore.sol. To do this, the user must initiate two transactions:

  • the client calls ParatiiToken.approve(ParatiiAvatar.address, price_of_video) to allows the paratiiAvatar to transfer the price_of_video. (For small transactions, this can be done transparently)
  • the client calls VideoStore.buyVideo(videoId), triggering a number of steps:
  • the price of the video will be transfered to the paratiiAvatar
  • an event will be logged that the video is unlocked for this user
  • records the purchase of a video on within the UserRegistry allowing the new owner to like/dislike the video
  • a part of the price will be transfered (immediately?) to the owner, other goes tot he redistrubtion pool. (In the first iteration, we can give all money to thee owner)

In addition, Paratii currently uses a simple wrapper contract, SendEther.sol, that can be used to send Ether, and will log an event that can be read by clients and logged to transaction history.

Interacting with the Paratii contracts

The paratii.js library is the preferred way for clients to interact with the deployed contracts, offering access to them, wallet functionality, and convenience functions that provide more useful error handling than direct calls to the blockchain.