JS library for clients to interact with deployed contracts, with wallet functionality, access to blockchain data and convenience functions.
License: GNU General Public License v3.0
In particular, "deployContracts" is typically a function that should be hidden (or even unavailable) to web slcients.
We can create a seperate paratii.admin namespace for this.
We have to figure out if it's a web3 issue or something nasty on our side
This does not work on testrpc, so we will need to have the lib work with parity first. This is tracked in issue #26
for example, paratii.eth.vids.get() should reaise an error if the registry address is not set (now it seems to go in timeout)
What we'd like is some way to do simple "authentication" in the following way:
Client likes to authanticate with a webservice (or prove his identity)
In particular, we'd like:
paratii.utils.newChallenge() (can be just a random string on first iteration). (The logistiscs of sending the challenge over http or whatever is in scope of the paratii-db project and not in paratiilib)paratii.utils.signMessage(messageToSign) which returns a utf encoded string that can be sent to the server. This function will just be based on hashMessage or sign functions of web3 (not sure which one is the appropriate one to use here): http://web3js.readthedocs.io/en/1.0/web3-eth-accounts.html#hashmessage.paratii.utils.recoverAccount(msg), whch returns the ethereum address used to sign the message (based on http://web3js.readthedocs.io/en/1.0/web3-eth-accounts.html#recover)`utI'm not sure about the utils name space (which is not there yet)
The tasks are:
Which is a bug; all calls to the blockchain should pass also without adn address
The bug is described here: Paratii-Video/paratii-portal#16 (comment)
first task is to isoalte it in a separate test case
This needs to be defined, still. Here is a first idea:
`paratii.core.playlists.get(playlistId)`
`paratii.core.playlists.create(...)`
`paratii.core.playlists.update(playlistId, {fiedls:to, update:foo})`
`paratii.core.playlists.search(qry)`
Gettings videos of a playlist:
`paratii.core.vids.search({ playlist: playlistId })`
Get playlist of a video:
`paratii.core.playlists.search( { video: videoId })`
these (and all other) async functions should return a promise (instaed of a callback)
At the moment, the file argument is simply ignored..
perhaps a uuid.
paratii.core.vids.delete(videoId)
deletes the video from the blockcahin (i.e. calls 'paratii.eth.vids.delete()).
(we cannot delete the ipfs data, so this is it)
[IPFS] Error: Not able to start from state: running
Problem
Currently, this library is not easy to install and use. It requires installing the dev branch of this repo, npm link-ing, and then manually running npm run pack to bundle the lib.
another issue is that when another module includes paratii-lib in its bundle via webpack, it includes paratii.ipfs.uploader.js (which should only run on node). This leads to an error that the 'fs' module cannot be resolved. paratii-lib tries to handle this with this line, but it does not seem to work w/ webpack.
Proposed Solution(s) (once dev is merged into master)
Either automatically bundle the lib on postInstall, or publish the lib to npm and handle bundling automatically via a prePublish hook
cc @ya7ya
Implement the following functions:
paratii.core.vids.like(videoId)
paratii.eth.vids.like(videoId)
paratii.core.vids.dislike(videoId)
paratii.eth.vids.dislike(videoId)
Registers the 'like' in the blockcahin (i.e. calls paratii.eth.vids.like(videoId), which calls the likes.likeVideo(..) contract. (See paratii-contracts for detaisl on thsi contract)
paratii.core.vids.update(videoId, {foo: bar })
Set the value fo foo of the video given to videoId to bar (and leave all other values untouched). Returns an object representing the new data. Cf. paratii.eth.vids.update for the general idea.
cf https://github.com/Paratii-Video/paratii-lib/blob/master/docs/paratii-ipfs.md for specifictions
i.e. something reactive instead of what is no in Play.js:
<Header>
<Logo src={logo} alt='logo' />
</Header>
We have two different but similar use cases:
Given that each user corresponds to an ethereum account, the idea is that a client can authenticate not by sending the password, but sending a signed message that proves she controls an ethereum account.
For example, the idea is that http://paratii.video/rip?url=http://youtu.be/videoId&account=0x123455&signature=0x1234.. is only a valid call if the signature is a signed message that includes (a hash) of the other provided arguments - there garanteeing that an attacker cannot tamper with the parameters). But perhaps this pattern can be simplified (e.g. if we include the parameters in the signed message, we do not need to send them over separately)
This functinoality will be based on the web3.eth.accounts.sign and .recover functionality.
The exact API we want may change depending on what we learn during implementation, but could look like this:
// initialize a Paratii object
// // we need to implement wallet handling and locking and things, but for the purposes of this issue
// we just pass the private key directly
paratii = new Paratii({privateKey: 0x124555})
// signs the message with the given key (for use by the client)
// returns a string that we can include in http requests
paratii.utils.signMessage(msg)
// extract the account from a messag signed with the call above
// returns an ethereum account
// this function just wrap web3.eth.accounts.recover
paratii.utils.recoverAccount(msg)
// check if a request in the style of case (2) above is valid
paratii.utils.isValidRequest({arg1: 'x', arg2: 'y', signature: '0x143545..'})
We now use the default-options npm package to do some argument checking for all functions.
this has been a hasty choice - (not necessarily bad, but made without much thought).
So we should see if there is abetter alternative, probably here in the comments is a good place.
What we are looking for is:
Problem
Currently, the only (I think) way to use paratii-lib to get data about a video (given the video ID) is to use ParatiiEth. To instantiate ParatiiEth, you need an ethereum address (along w/ some other config). However, I think you should be able to retrieve info about a video w/o having any particular user's eth address.
@jellegerbrandy does this make sense? If yes, we can figure out how to expose this api (and potentially others that should not require an address). If not, please inform me of the appropriate way to fetch this data/use the lib
cc @ya7ya
yarn test doesn't pass, shows this: Error: Private key suspiciously small: < 16 bytes. Aborting!. Full output:
Milans-MacBook-Air:paratii-lib milankragujevic$ yarn test
yarn run v1.3.2
$ mocha --require babel.js --exit --timeout 10000 test/*.js
Paratii API:
✓ deployContracts should deploy and register all contracts (497ms)
Paratii API:
✓ diagnose() should run without errors (318ms)
Paratii API:
4
✓ example session from ../docs/example-session.md should work (235ms)
Paratii configuration:
✓ paratii.config should return the configuration with default values
✓ testnet configuration should be recognized
✓ should be possible to create a second Paratii object with the same settings (244ms)
✓ should be possible to create a Paratii instance without an address or registryAddress
✓ setAccount should set the account
✓ paratii.eth.web3 should be available
paratii.core API: :
✓ should be configured
- core.users.create() should work as expected
- core.users.get() should work as expected
paratii.core.vids:
bitswap options: { maxMessageSize: 32768 }
✓ core.vids.create() and get() should work as expected (5024ms)
bitswap options: { maxMessageSize: 32768 }
✓ core.vids.create() should accept ipfsHash as argument (5435ms)
bitswap options: { maxMessageSize: 32768 }
✓ core.vids.update() should work as expected (1567ms)
- core.vids.delete() should work as expected
- core.vids.like() should work as expected
- core.vids.dislike() should work as expected
- core.vids.view() should work as expected
- core.vids.buy() should work as expected
- core.vids.search() should work as expected
paratii.db API: :
✓ should be configured
- db.vids.get() should work as expected
- db.users.get() should work as expected
- db.vids.search() should work as expected
✓ should be available as an attribute on Paratii instances
paratii.eth.events API: :
✓ subscription to Tranfer PTI events should work as expected (70ms)
✓ subscription to Create Video events should work as expected (45ms)
paratii.eth API: :
✓ getContracts() should return the contracts
✓ contracts should have their address set (70ms)
✓ getContract() should return the correct contract
1) balanceOf() should return the right balances
✓ transfer ETH should work as expected
✓ transfer PTI should work as expected
✓ deployContract should throw a sensible error if address is not set
paratii.eth.users: :
✓ users.create(), .get(), .update() and .delete() should work (83ms)
- missing or wrong arguments in users.create() should trhow meaningful errors
paratii.eth.vids:
✓ vids.create(), .get(), .update() and .delete() should work (83ms)
- vids.create() should throw meaningful errors
- vids.create() should create a fresh id if no id wat provided
paratii.eth.wallet: :
✓ init account is added to wallet
✓ if no account is given, the wallet accounts are empty
✓ wallet.create() works (165ms)
✓ wallet.create() does not create a new wallet object (156ms)
✓ wallet.create() creates a new mnenomic if not mnomic is given (49ms)
✓ wallet.encrypt() and decrypt() works (546ms)
✓ send() should fail if no wallet is present
✓ send() should succeed if a private key is passed to the constructor (43ms)
✓ send() should succeed if a private key is passed to the constructor (44ms)
✓ eth.wallet.isValidMnemonic() should work as expected
✓ eth.wallet.newMnemonic() should work as expected
✓ eth.wallet.create() should throw if a wallet already has an account
✓ eth.wallet.getMnemonic() should work as expected (71ms)
ParatiiIPFS: :
✓ should exist
bitswap options: { maxMessageSize: 32768 }
✓ should create an instance without trouble (2914ms)
bitswap options: { maxMessageSize: 32768 }
✓ should allow for simple add() and get() of files (778ms)
bitswap options: { maxMessageSize: 32768 }
✓ put a JSON object and get it back (3370ms)
bitswap options: { maxMessageSize: 32768 }
✓ should exist and work as an attribute on the Paratii object (870ms)
ParatiiIPFS: :
{ onDone: [Function: onDone], onError: [Function: onError] }
bitswap options: { maxMessageSize: 32768 }
Adding test/data/some-file.txt
Adding QmS8yinWCD1vm7WJx34tg81FpjEXbdYXf3Y5XcCeh29C6K finished
uploader Finished [ undefined ]
✓ should allow for file upload (3444ms)
bitswap options: { maxMessageSize: 32768 }
reading file genericJson.json
reading file some-file.txt
this is the hash to return
✓ should add a directory to IPFS (3270ms)
bitswap options: { maxMessageSize: 32768 }
uploader Finished []
_signalTranscoder Got an empty Array. files: []
✓ addAndTranscode() should work as expected (6580ms)
- should be able to grab a youtube video and upload it
- should be able to grab a vimeo video and upload it
Paratii API:
✓ paratii exists..
47 passing (41s)
16 pending
1 failing
1) paratii.eth API: :
balanceOf() should return the right balances:
Error: Private key suspiciously small: < 16 bytes. Aborting!
at Wallet.create$ (lib/paratii.eth.wallet.js:36:17)
at tryCatch (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:62:40)
at Generator.invoke [as _invoke] (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:296:22)
at Generator.prototype.(anonymous function) [as next] (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:114:21)
at tryCatch (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:62:40)
at invoke (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:152:20)
at node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:195:11
at new Promise (<anonymous>)
at callInvokeWithMethodAndArg (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:194:16)
at AsyncIterator.enqueue (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:217:13)
at AsyncIterator.prototype.(anonymous function) [as next] (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:114:21)
at Object.runtime.async (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:241:14)
at Wallet.create (lib/paratii.eth.wallet.js:7:3)
at Context._callee5$ (test/paratii.eth.js:76:45)
at tryCatch (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:62:40)
at Generator.invoke [as _invoke] (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:296:22)
at Generator.prototype.(anonymous function) [as next] (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:114:21)
at tryCatch (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:62:40)
at invoke (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:152:20)
at node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:195:11
at new Promise (<anonymous>)
at callInvokeWithMethodAndArg (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:194:16)
at AsyncIterator.enqueue (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:217:13)
at AsyncIterator.prototype.(anonymous function) [as next] (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:114:21)
at Object.runtime.async (node_modules/babel-runtime/node_modules/regenerator-runtime/runtime.js:241:14)
at Context._callee5 (test/paratii.eth.js:72:54)
at <anonymous>
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
Milans-MacBook-Air:paratii-lib milankragujevic$
On macOS 10.13 with 8GB of RAM.
So far I am the only confirmed affected user, but:
A fresh npm i in paratii-portal and a fresh yarn within this package fail because of an error within youtube-dl.
From within this lib:
/Users/benjaminbaum/Desktop/Development/paratii-lib/node_modules/youtube-dl/lib/downloader.js:20
if (res.statusCode !== 302) {
^
TypeError: Cannot read property 'statusCode' of undefined
at Request._callback (/Users/benjaminbaum/Desktop/Development/paratii-lib/node_modules/youtube-dl/lib/downloader.js:20:17)
From paratii-portal:
41153 error code ELIFECYCLE
41154 error errno 1
41155 error [email protected] postinstall: `node ./scripts/download.js`
41155 error Exit status 1
41156 error Failed at the [email protected] postinstall script.
41156 error This is probably not a problem with npm. There is likely additional logging output above.
It is not in the new web3 release yet, it seems, which is a problem for us.
We may want ot make a PR:
Buying a video is a complex operation. At the moment, this is handled by code it he paratii-player repostory, which should be migrated here.
The exact API is still te be decided, the first iteration should at least implement:
paratii.core.vids.search({keyword: some-keyword})
Which will just be a call to:
paratii.db.vids.search(...)
The logic can be taken from the code in paratii-player.
Note that this issue depends on having a functioning database index. This will be developed here: https://github.com/Paratii-Video/paratii-db
this is a precondition for #25, but in general a good idea because this is also or "production node".
https://github.com/Paratii-Video/paratii-lib/blob/master/docs/paratii-core.md
core.vids.create(...) takes a file argument - which is the video to be uploaded and transcoded.
how shall we pass that file? At the moment, it is a path to a local file, but probably the best is to change the type to filestream.
(@ya7ya , what dayya say?)
There is an example that runs through some standard operations on the Paratii library.
The main point of that document is to define the way we interact with the library. (which means that we can change the specs if we discover, working with the lib, that the API is not well-defined)
the example is here:
https://github.com/Paratii-Video/paratii-lib/blob/master/docs/example-session.md
With a correspnoding test that runs each fo these steps:
https://github.com/Paratii-Video/paratii-lib/blob/master/test/example-session.js
This issue tracks progress on implementing that session:
https://github.com/Paratii-Video/paratii-lib/blob/master/docs/api.md
roughly, should return this promise:
this.eth.contracts.ParatiiToken.balanceOf(this.personal.address)
ref: web3/web3.js#1170
we are waiting for a patch
cf https://github.com/Paratii-Video/paratii-lib/blob/master/docs/api.md#config
paratii.config is an array with the settings (as per the docs)Add some lines that you need to install parity and how to run parity
The exact form of the API is not yet defined, but can look like this:
paratii.core.transactions.search({})
will return all transactions related to the user paratii.core.address
Note that this issue depends on having a functioning database index. This will be developed here: https://github.com/Paratii-Video/paratii-db
At the moment, contracts.UserRegistry` is the interface constructed from the ABI - so it has no error handling, each function call at most a single transaction, etc.
The idea is that userRegistry.registerUser first does some typechecking fo arguments, and then calls the ABI method on userRegistry.methods.registerUser(...).send() )
Concretely, the approach is that for each contract that is accessible from the Paratii object, there will be a js class that will extend the class created by web3.eth.Contract(ABISPECS).
For a first iteration we can do the minimum required for #1, and just map userRegistry.registerUser(...args) to userRegistry.method.registerUser(...args).send() directly
$ yarn add github:Paratii-Video/paratii-lib#master
error [email protected]: The engine "node" is incompatible with this module. Expected version ">=8.9.0".
error Found incompatible moduleYou can work around this with yarn --ignore-engines, but I'm not sure that this is a great workaround.
This is the paratii.cure.users; it can be written using the exact same pattern as paratii.core.vids
All the contracts should already be in place, so this is not hard to implement.
See docs/paratii-core.md for a (very short) sketch of the API
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.