From 9511559b20b4a0be258f05b5bf94875cdd0fe559 Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Thu, 18 Jun 2020 13:56:33 +0200 Subject: [PATCH 01/14] update simpleflow docs --- README_simpleflow.md | 58 +++++++++++++---------------- test/integration/Simpleflow.test.ts | 12 +++--- 2 files changed, 30 insertions(+), 40 deletions(-) diff --git a/README_simpleflow.md b/README_simpleflow.md index 51f44b4a..b17b898a 100644 --- a/README_simpleflow.md +++ b/README_simpleflow.md @@ -36,47 +36,46 @@ Let's go through each of these in detail. For now, you're Alice:) Let's proceed. +Run `ganache-cli` locally: +```bash +ganache-cli +``` ```javascript -const { Ocean, Logger } = require('@oceanprotocol/lib') -const config={ - network: 'rinkeby', - privateKey:'8da4ef21b864d2cc526dbdb2a120bd2874c36c9d0a1fb7f8c63d7f7a8b41de8f', -} -const ocean = Ocean(alice_config) -const account = await ocean.accounts.list()[0] -const myToken = ocean.datatoken.create('localhost:8030',account) -const dt_address=myToken.getAddress() -console.log(dt_address) +const tokenAmount = 100 +const transferAmount = 1 +const blob = 'http://localhost:8030/api/v1/provider/services' + +const alice = await ocean.accounts.list()[0] +const bob = await ocean.accounts.list()[0] +// create datatoken class +const datatoken = new DataTokens(contracts.factoryAddress, factoryABI, datatokensABI, web3) +// deploy datatoken +const tokenAddress = await datatoken.create(blob, alice) + ``` ## 2. Alice hosts the dataset -A locally providerService is required, which will serve just one file for this demo. -Let's create the file to be shared: -``` -touch /var/mydata/myFolder1/file -```` - -Run the providerService: -(given that ERC20 contract address from the above is 0x1234) +Clone [provider-py](https://github.com/oceanprotocol/provider-py) and update your local environment variables: ``` -ENV DT="{'0x1234':'/var/mydata/myFolder1'}" -docker run @oceanprotocol/provider-py -e CONFIG=DT +export PROVIDER_ADDRESS=your_provider_address +export PROVIDER_KEY=your_provider_key +export CONFIG='{"File": "https://raw.githubusercontent.com/oceanprotocol/barge/master/README.md"}' ``` - ## 3. Alice mints 100 tokens ```javascript -myToken.mint(100) +datatoken.mint(tokenAddress, alice, tokenAmount) ``` ## 4. Alice transfers 1 token to Bob ```javascript -myToken.transfer(1,BobAddress) +const ts = await datatoken.transfer(tokenAddress, bob, transferAmount, alice) +const transactionId = ts['transactionHash'] ``` ## 5. Bob consumes dataset @@ -86,17 +85,10 @@ Now, you are Bob :) ```javascript -const bob_config={ - network: 'rinkeby', - privateKey:'1234ef21b864d2cc526dbdb2a120bd2874c36c9d0a1fb7f8c63d7f7a8b41de8f' -} -const bob_ocean = Ocean(bob_config) - - -const account = await bob_ocean.accounts.list()[0] -const asset=bob_ocean.assets.getFromDTAddress(dt_address)[0] -const file=asset.download(account) +const config = new Config() +const ocean = await Ocean.getInstance() +await ocean.assets.download(tokenAddress, blob, transactionId, bob) ``` diff --git a/test/integration/Simpleflow.test.ts b/test/integration/Simpleflow.test.ts index 15be5278..dff87162 100644 --- a/test/integration/Simpleflow.test.ts +++ b/test/integration/Simpleflow.test.ts @@ -1,4 +1,3 @@ -import { assert } from 'chai' import { TestContractHandler } from '../TestContractHandler' import { DataTokens } from '../../src/datatokens/Datatokens' import { Ocean } from '../../src/ocean/Ocean' @@ -16,15 +15,14 @@ describe('Simple flow', () => { let owner let bob let alice - let balance let contracts let datatoken let tokenAddress let transactionId - let tokenAmount = 100 - let transferAmount = 1 - let blob = 'http://localhost:8030/api/v1/provider/services' + const tokenAmount = 100 + const transferAmount = 1 + const blob = 'http://localhost:8030/api/v1/provider/services' describe('#test', () => { it('Initialize Ocean contracts v3', async () => { @@ -47,13 +45,13 @@ describe('Simple flow', () => { }) it('Alice transfers 1 token to Bob', async () => { - const ts = await datatoken.transfer(tokenAddress, bob, tokenAmount, alice) + const ts = await datatoken.transfer(tokenAddress, bob, transferAmount, alice) transactionId = ts['transactionHash'] }) it('Bob consumes dataset', async () => { const config = new Config() - let ocean = await Ocean.getInstance(config) + const ocean = await Ocean.getInstance(config) await ocean.assets.download(tokenAddress, blob, transactionId, bob) }) }) From 07449ed18d82a035ee827439a060fd2a55068967 Mon Sep 17 00:00:00 2001 From: Ahmed Ali Date: Fri, 19 Jun 2020 15:34:45 +0200 Subject: [PATCH 02/14] fix tests --- package.json | 2 +- test/integration/Simpleflow.test.ts | 16 ++++++++++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/package.json b/package.json index aa932f1d..7d81dc0d 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ "changelog": "auto-changelog -p", "prepublishOnly": "npm run build", "test:unit": "mocha --config=test/unit/.mocharc.json --node-env=test --exit test/unit/**/*.ts", - "test:integration": "mocha --opts test/integration/mocha.opts" + "test:integration": "mocha --config=test/integration/.mocharc.json --node-env=test --exit test/integration/**/*.ts" }, "repository": { "type": "git", diff --git a/test/integration/Simpleflow.test.ts b/test/integration/Simpleflow.test.ts index 92e3ab43..6ce2313d 100644 --- a/test/integration/Simpleflow.test.ts +++ b/test/integration/Simpleflow.test.ts @@ -6,9 +6,8 @@ import { Config } from '../../src/models/Config' const Web3 = require('web3') const web3 = new Web3('http://127.0.0.1:8545') - -const factoryABI = require('../../src/datatokens/FactoryABI.json') -const datatokensABI = require('../../src/datatokens/DatatokensABI.json') +const factory = require('@oceanprotocol/contracts/artifacts/development/Factory.json') +const datatokensTemplate = require('@oceanprotocol/contracts/artifacts/development/DataTokenTemplate.json') describe('Simple flow', () => { let owner @@ -26,7 +25,12 @@ describe('Simple flow', () => { describe('#test', () => { it('Initialize Ocean contracts v3', async () => { - contracts = new TestContractHandler(factoryABI, datatokensABI) + contracts = new TestContractHandler( + factory.abi, + datatokensTemplate.abi, + datatokensTemplate.bytecode, + factory.bytecode + ) await contracts.getAccounts() owner = contracts.accounts[0] alice = contracts.accounts[1] @@ -38,8 +42,8 @@ describe('Simple flow', () => { // Alice creates a Datatoken datatoken = new DataTokens( contracts.factoryAddress, - factoryABI, - datatokensABI, + factory.abi, + datatokensTemplate.abi, web3 ) tokenAddress = await datatoken.create(blob, alice) From c9799e271d87f58d3a432f59539fa39989b54818 Mon Sep 17 00:00:00 2001 From: Ahmed Ali Date: Fri, 19 Jun 2020 15:55:34 +0200 Subject: [PATCH 03/14] fix lint --- test/integration/Simpleflow.test.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/integration/Simpleflow.test.ts b/test/integration/Simpleflow.test.ts index 6ce2313d..1eef5ce6 100644 --- a/test/integration/Simpleflow.test.ts +++ b/test/integration/Simpleflow.test.ts @@ -26,7 +26,7 @@ describe('Simple flow', () => { describe('#test', () => { it('Initialize Ocean contracts v3', async () => { contracts = new TestContractHandler( - factory.abi, + factory.abi, datatokensTemplate.abi, datatokensTemplate.bytecode, factory.bytecode From c16e277fde8b6edff5af958a6bdf03b5ebab07cb Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Mon, 22 Jun 2020 05:08:51 +0200 Subject: [PATCH 04/14] add marketplace flow --- test/integration/Marketplaceflow.test.ts | 28 ++++++++++++------------ 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/test/integration/Marketplaceflow.test.ts b/test/integration/Marketplaceflow.test.ts index 25d8eea2..a247621f 100644 --- a/test/integration/Marketplaceflow.test.ts +++ b/test/integration/Marketplaceflow.test.ts @@ -15,7 +15,7 @@ describe('Marketplace flow', () => { let alice let contracts let datatoken - let tokenAddress + // let tokenAddress let transactionId const tokenAmount = 100 @@ -45,28 +45,28 @@ describe('Marketplace flow', () => { datatokensTemplate.abi, web3 ) - // tokenAddress = await datatoken.create(blob, alice) const config = new Config() const ocean = await Ocean.getInstance(config) ddo = await ocean.assets.createSimpleAsset(datatoken, alice, blob) + await console.log(ddo) }) - // it('Alice mints 100 tokens', async () => { - // await datatoken.mint(tokenAddress, alice, tokenAmount) - // }) + it('Alice mints 100 tokens', async () => { + await datatoken.mint(ddo, alice, tokenAmount) + }) - // it('Alice transfers 1 token to Bob', async () => { - // const ts = await datatoken.transfer(tokenAddress, bob, transferAmount, alice) - // transactionId = ts.transactionHash - // }) + it('Bob gets 1 datatoken', async () => { + const ts = await datatoken.transfer(ddo, bob, transferAmount, alice) + transactionId = ts.transactionHash + }) - // it('Bob consumes dataset', async () => { - // const config = new Config() - // const ocean = await Ocean.getInstance(config) - // await ocean.assets.download(tokenAddress, blob, transactionId, bob) - // }) + it('Bob consumes dataset', async () => { + const config = new Config() + const ocean = await Ocean.getInstance(config) + await ocean.assets.download(ddo, blob, transactionId, bob) + }) }) }) From 507f5f656d5e4a35ee2f47464c665a432a1ae0b9 Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Mon, 22 Jun 2020 05:11:34 +0200 Subject: [PATCH 05/14] fix remove console.log --- test/integration/Marketplaceflow.test.ts | 3 --- 1 file changed, 3 deletions(-) diff --git a/test/integration/Marketplaceflow.test.ts b/test/integration/Marketplaceflow.test.ts index a247621f..76ca66b5 100644 --- a/test/integration/Marketplaceflow.test.ts +++ b/test/integration/Marketplaceflow.test.ts @@ -15,7 +15,6 @@ describe('Marketplace flow', () => { let alice let contracts let datatoken - // let tokenAddress let transactionId const tokenAmount = 100 @@ -50,8 +49,6 @@ describe('Marketplace flow', () => { const ocean = await Ocean.getInstance(config) ddo = await ocean.assets.createSimpleAsset(datatoken, alice, blob) - - await console.log(ddo) }) it('Alice mints 100 tokens', async () => { From 68f435a11d9016dca92d5da6d0d3de4df796e3a3 Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Mon, 22 Jun 2020 08:59:02 +0200 Subject: [PATCH 06/14] add rinkeby test --- test/TestContractHandler.ts | 14 ++++++------- test/integration/Marketplaceflow.test.ts | 5 +++-- test/integration/Rinkeby.test.ts | 25 ++++++++++++++++++++++++ test/integration/Simpleflow.test.ts | 3 ++- 4 files changed, 37 insertions(+), 10 deletions(-) create mode 100644 test/integration/Rinkeby.test.ts diff --git a/test/TestContractHandler.ts b/test/TestContractHandler.ts index f6484dd9..e2041832 100644 --- a/test/TestContractHandler.ts +++ b/test/TestContractHandler.ts @@ -1,8 +1,5 @@ import { Contract } from 'web3-eth-contract' -const Web3 = require('web3') -const web3 = new Web3('http://127.0.0.1:8545') - export class TestContractHandler { public factory: Contract public template: Contract @@ -11,21 +8,24 @@ export class TestContractHandler { public factoryBytecode: string public factoryAddress: string public templateAddress: string + public web3: any constructor( factoryABI: Contract, datatokensABI: Contract, templateBytecode: string, - factoryBytecode: string + factoryBytecode: string, + web3: any ) { - this.factory = new web3.eth.Contract(factoryABI) - this.template = new web3.eth.Contract(datatokensABI) + this.web3 = web3 + this.factory = new this.web3.eth.Contract(factoryABI) + this.template = new this.web3.eth.Contract(datatokensABI) this.templateBytecode = templateBytecode this.factoryBytecode = factoryBytecode } public async getAccounts() { - this.accounts = await web3.eth.getAccounts() + this.accounts = await this.web3.eth.getAccounts() } public async deployContracts(minter: string) { diff --git a/test/integration/Marketplaceflow.test.ts b/test/integration/Marketplaceflow.test.ts index 76ca66b5..78e96926 100644 --- a/test/integration/Marketplaceflow.test.ts +++ b/test/integration/Marketplaceflow.test.ts @@ -27,7 +27,8 @@ describe('Marketplace flow', () => { factory.abi, datatokensTemplate.abi, datatokensTemplate.bytecode, - factory.bytecode + factory.bytecode, + web3 ) await contracts.getAccounts() owner = contracts.accounts[0] @@ -66,4 +67,4 @@ describe('Marketplace flow', () => { await ocean.assets.download(ddo, blob, transactionId, bob) }) }) -}) +}) \ No newline at end of file diff --git a/test/integration/Rinkeby.test.ts b/test/integration/Rinkeby.test.ts new file mode 100644 index 00000000..741e42ac --- /dev/null +++ b/test/integration/Rinkeby.test.ts @@ -0,0 +1,25 @@ +import { TestContractHandler } from '../TestContractHandler' + +const Web3 = require('web3') +const web3 = new Web3('wss://rinkeby.infura.io/ws/v3/357f2fe737db4304bd2f7285c5602d0d') +const factory = require('@oceanprotocol/contracts/artifacts/development/Factory.json') +const datatokensTemplate = require('@oceanprotocol/contracts/artifacts/development/DataTokenTemplate.json') + +describe('Rinkeby test', () => { + let owner + let contracts + + describe('#test', () => { + it('Initialize Ocean contracts v3', async () => { + contracts = new TestContractHandler( + factory.abi, + datatokensTemplate.abi, + datatokensTemplate.bytecode, + factory.bytecode, + web3 + ) + await contracts.deployContracts(owner) + }) + + }) +}) \ No newline at end of file diff --git a/test/integration/Simpleflow.test.ts b/test/integration/Simpleflow.test.ts index 7617048f..1dd54e39 100644 --- a/test/integration/Simpleflow.test.ts +++ b/test/integration/Simpleflow.test.ts @@ -27,7 +27,8 @@ describe('Simple flow', () => { factory.abi, datatokensTemplate.abi, datatokensTemplate.bytecode, - factory.bytecode + factory.bytecode, + web3 ) await contracts.getAccounts() owner = contracts.accounts[0] From 1454785e1786b74c5e7aaae4b3b959e69f475465 Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Mon, 22 Jun 2020 09:26:49 +0200 Subject: [PATCH 07/14] add rinkeby contracts deployment --- test/TestContractHandler.ts | 4 ++-- test/integration/Rinkeby.test.ts | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/test/TestContractHandler.ts b/test/TestContractHandler.ts index e2041832..683b5630 100644 --- a/test/TestContractHandler.ts +++ b/test/TestContractHandler.ts @@ -53,7 +53,7 @@ export class TestContractHandler { .send({ from: minter, gas: estGas + 1, - gasPrice: '12345678' + gasPrice: '3000000000' }) .then(function (contract) { return contract.options.address @@ -77,7 +77,7 @@ export class TestContractHandler { .send({ from: minter, gas: estGas + 1, - gasPrice: '12345678' + gasPrice: '3000000000' }) .then(function (contract) { return contract.options.address diff --git a/test/integration/Rinkeby.test.ts b/test/integration/Rinkeby.test.ts index 741e42ac..38fef0f7 100644 --- a/test/integration/Rinkeby.test.ts +++ b/test/integration/Rinkeby.test.ts @@ -6,7 +6,6 @@ const factory = require('@oceanprotocol/contracts/artifacts/development/Factory. const datatokensTemplate = require('@oceanprotocol/contracts/artifacts/development/DataTokenTemplate.json') describe('Rinkeby test', () => { - let owner let contracts describe('#test', () => { @@ -18,7 +17,12 @@ describe('Rinkeby test', () => { factory.bytecode, web3 ) - await contracts.deployContracts(owner) + + const privateKey = 'PRIVATE_KEY' + const account = web3.eth.accounts.privateKeyToAccount('0x' + privateKey) + web3.eth.accounts.wallet.add(account) + + await contracts.deployContracts(account.address) }) }) From 24c8a87623f70ea96b6ebd0e5677011241281960 Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Mon, 22 Jun 2020 09:38:43 +0200 Subject: [PATCH 08/14] add rinkeby test --- test/integration/Rinkeby.test.ts | 24 +++++++++++++++++++++++- test/integration/Simpleflow.test.ts | 2 +- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/test/integration/Rinkeby.test.ts b/test/integration/Rinkeby.test.ts index 38fef0f7..e8abacbb 100644 --- a/test/integration/Rinkeby.test.ts +++ b/test/integration/Rinkeby.test.ts @@ -1,4 +1,5 @@ import { TestContractHandler } from '../TestContractHandler' +import { DataTokens } from '../../src/datatokens/Datatokens' const Web3 = require('web3') const web3 = new Web3('wss://rinkeby.infura.io/ws/v3/357f2fe737db4304bd2f7285c5602d0d') @@ -6,7 +7,14 @@ const factory = require('@oceanprotocol/contracts/artifacts/development/Factory. const datatokensTemplate = require('@oceanprotocol/contracts/artifacts/development/DataTokenTemplate.json') describe('Rinkeby test', () => { + let account let contracts + let datatoken + let tokenAddress + + const tokenAmount = 100 + const blob = 'http://localhost:8030/api/v1/provider/services' + describe('#test', () => { it('Initialize Ocean contracts v3', async () => { @@ -19,11 +27,25 @@ describe('Rinkeby test', () => { ) const privateKey = 'PRIVATE_KEY' - const account = web3.eth.accounts.privateKeyToAccount('0x' + privateKey) + account = web3.eth.accounts.privateKeyToAccount('0x' + privateKey) web3.eth.accounts.wallet.add(account) await contracts.deployContracts(account.address) }) + it('Publish a dataset', async () => { + datatoken = new DataTokens( + contracts.factoryAddress, + factory.abi, + datatokensTemplate.abi, + web3 + ) + + tokenAddress = await datatoken.create(blob, account.address) + }) + + it('Mint 100 tokens', async () => { + await datatoken.mint(tokenAddress, account.address, tokenAmount) + }) }) }) \ No newline at end of file diff --git a/test/integration/Simpleflow.test.ts b/test/integration/Simpleflow.test.ts index 1dd54e39..93fbcb81 100644 --- a/test/integration/Simpleflow.test.ts +++ b/test/integration/Simpleflow.test.ts @@ -53,7 +53,7 @@ describe('Simple flow', () => { }) it('Alice transfers 1 token to Bob', async () => { - const ts = await datatoken.transfer(tokenAddress, bob, tokenAmount, alice) + const ts = await datatoken.transfer(tokenAddress, bob, transferAmount, alice) transactionId = ts.transactionHash }) From 8193838a967bc51d4f5c9a84ee511140a6d3ece4 Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Mon, 22 Jun 2020 13:21:51 +0200 Subject: [PATCH 09/14] fix tests lint --- src/ocean/Assets.ts | 6 +++++- test/integration/Marketplaceflow.test.ts | 4 ++-- test/integration/Rinkeby.test.ts | 5 ++--- test/unit/Datatokens.test.ts | 3 ++- 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/src/ocean/Assets.ts b/src/ocean/Assets.ts index 0f28a644..8f5b40d4 100644 --- a/src/ocean/Assets.ts +++ b/src/ocean/Assets.ts @@ -51,7 +51,11 @@ export class Assets extends Instantiable { * @param {Account} publisher Publisher account. * @return {Promise} */ - public createSimpleAsset(datatoken: DataTokens, publisher: Account, blob: string): Promise { + public createSimpleAsset( + datatoken: DataTokens, + publisher: Account, + blob: string + ): Promise { const publisherURI = this.ocean.brizo.getURI() // const jsonBlob = { t: 0, url: publisherURI } return datatoken.create(JSON.stringify(blob), publisher) diff --git a/test/integration/Marketplaceflow.test.ts b/test/integration/Marketplaceflow.test.ts index 78e96926..0070b82b 100644 --- a/test/integration/Marketplaceflow.test.ts +++ b/test/integration/Marketplaceflow.test.ts @@ -45,7 +45,7 @@ describe('Marketplace flow', () => { datatokensTemplate.abi, web3 ) - + const config = new Config() const ocean = await Ocean.getInstance(config) @@ -67,4 +67,4 @@ describe('Marketplace flow', () => { await ocean.assets.download(ddo, blob, transactionId, bob) }) }) -}) \ No newline at end of file +}) diff --git a/test/integration/Rinkeby.test.ts b/test/integration/Rinkeby.test.ts index e8abacbb..fdfe5ce3 100644 --- a/test/integration/Rinkeby.test.ts +++ b/test/integration/Rinkeby.test.ts @@ -15,7 +15,6 @@ describe('Rinkeby test', () => { const tokenAmount = 100 const blob = 'http://localhost:8030/api/v1/provider/services' - describe('#test', () => { it('Initialize Ocean contracts v3', async () => { contracts = new TestContractHandler( @@ -25,7 +24,7 @@ describe('Rinkeby test', () => { factory.bytecode, web3 ) - + const privateKey = 'PRIVATE_KEY' account = web3.eth.accounts.privateKeyToAccount('0x' + privateKey) web3.eth.accounts.wallet.add(account) @@ -48,4 +47,4 @@ describe('Rinkeby test', () => { await datatoken.mint(tokenAddress, account.address, tokenAmount) }) }) -}) \ No newline at end of file +}) diff --git a/test/unit/Datatokens.test.ts b/test/unit/Datatokens.test.ts index cd15c644..2df7bfce 100644 --- a/test/unit/Datatokens.test.ts +++ b/test/unit/Datatokens.test.ts @@ -24,7 +24,8 @@ describe('DataTokens', () => { factory.abi, datatokensTemplate.abi, datatokensTemplate.bytecode, - factory.bytecode + factory.bytecode, + web3 ) await contracts.getAccounts() minter = contracts.accounts[0] From ba261564f9e9d9c18b1bed68732f8813cd7d2a61 Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Mon, 22 Jun 2020 13:31:11 +0200 Subject: [PATCH 10/14] add test:cover --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 7d81dc0d..2bc06fe6 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,8 @@ "changelog": "auto-changelog -p", "prepublishOnly": "npm run build", "test:unit": "mocha --config=test/unit/.mocharc.json --node-env=test --exit test/unit/**/*.ts", - "test:integration": "mocha --config=test/integration/.mocharc.json --node-env=test --exit test/integration/**/*.ts" + "test:integration": "mocha --config=test/integration/.mocharc.json --node-env=test --exit test/integration/**/*.ts", + "test:cover": "nyc --report-dir coverage/unit npm run test:unit" }, "repository": { "type": "git", From dca634042411512d77e39ea9840359ec24b8a1ff Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Tue, 23 Jun 2020 10:22:58 +0200 Subject: [PATCH 11/14] apd marketplace flow --- README_marketplace_flow.md | 204 ++++++++++++++++--------------------- 1 file changed, 88 insertions(+), 116 deletions(-) diff --git a/README_marketplace_flow.md b/README_marketplace_flow.md index 725da0bf..30f75971 100644 --- a/README_marketplace_flow.md +++ b/README_marketplace_flow.md @@ -1,154 +1,126 @@ - # ocean-lib +# Quickstart: Marketplace Flow +This batteries-included flow includes metadata, multiple services for one datatoken, and compute-to-data. -`ocean-lib-js` is a Javascript/Typescript library to privately & securely publish, exchange, and consume data. With it, you can: -* **Publish** data services: static data, streaming data, or compute-to-data. Every data service gets its own [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md) token. -* **Mint** data tokens for a given data service -* **Transfer** data tokens to another owner -* **Consume** data tokens, to access the service - -`ocean-lib-js` is part of the [Ocean Protocol](www.oceanprotocol.com) toolset. - -# Installation -``` -// ES6 -import { Ocean, Logger } from '@oceanprotocol/lib' - -// ES2015 -const { Ocean, Logger } = require('@oceanprotocol/lib') - -``` - -# Quickstart - -This section describes a marketplace flow with multiple services +It focuses on Alice's experience as a publisher, and Bob's experience as a buyer & consumer. The rest are services used by Alice and Bob. Here's the steps. -1. Alice publishes a dataset (= publishes a datatoken contract) +1. Initialize services +1. Alice publishes assets for data services (= publishes a datatoken contract and metadata) 1. Alice mints 100 tokens -1. Alice transfers 1 token to Bob -1. Bob consumes dataset +1. Alice allows marketplace to sell her datatokens +1. Marketplace posts asset for sale +1. Value swap: Bob buys datatokens from marketplace +1. Bob uses a service he just purchased (download) -Let's go through each of these in detail. +Let's go through each step. +## 0. Installation -## 1. Alice hosts the dataset +If you haven't installed yet: +```console +pip install ocean-lib +``` -A locally providerService ,metadatastore and marketplace are required: +## 1. Initialize services + +This quickstart treats the publisher service, metadata store, and marketplace as +externally-run services. For convenience, we run them locally in default settings. -Run the providerService and metadatastore: ``` docker run @oceanprotocol/provider-py:latest -docker run @oceanprotocol/aquarius:latest +docker run @oceanprotocol/metadatastore:latest docker run @oceanprotocol/marketplace:latest ``` +## 2. Alice publishes assets for data services (= publishes a datatoken contract) -## 2. Alice publishes a dataset (= publishes a datatoken contract) +```python +from ocean_lib import Ocean +from ocean_lib.web3_internal.utils import get_account -For now, you're Alice:) Let's proceed. - - -```javascript -const { Ocean, Logger } = require('@oceanprotocol/lib') - -const marketPlaceAddress='0x9876' -//Alice's config -const config={ - network: 'rinkeby', - privateKey:'8da4ef21b864d2cc526dbdb2a120bd2874c36c9d0a1fb7f8c63d7f7a8b41de8f', - metadataStoreURI: 'localhost:5000', - providerUri: 'localhost:8030' +#Alice's config +config = { + 'network' : 'rinkeby', + 'privateKey' :'8da4ef21b864d2cc526dbdb2a120bd2874c36c9d0a1fb7f8c63d7f7a8b41de8f', + 'metadataStoreUri' : 'localhost:5000', + 'providerUri' : 'localhost:8030' } -const ocean = Ocean(alice_config) -const account = await ocean.accounts.list()[0] +ocean = Ocean(config) +account = get_account(0) +data_token = ocean.create_data_token(ocean.config.metadata_store_url, account) +token_address = data_token.address -const myToken = ocean.datatoken.create(config.metadataStoreURI,account) -//Alice allows MarketPlace to transfer 20 DT -myToken.approve(marketPlaceAddress,20) +metadata = {"main": { + "type": "dataset", "name": "10 Monkey Species Small", "author": "Mario", + "license": "CC0: Public Domain", "dateCreated": "2012-02-01T10:55:11Z", + "files": [{ "index": 0, "contentType": "application/zip", "url": "https://s3.amazonaws.com/datacommons-seeding-us-east/10_Monkey_Species_Small/assets/training.zip"}, + { "index": 1, "contentType": "text/text", "url": "https://s3.amazonaws.com/datacommons-seeding-us-east/10_Monkey_Species_Small/assets/monkey_labels.txt"}, + { "index": 2, "contentType": "application/zip", "url": "https://s3.amazonaws.com/datacommons-seeding-us-east/10_Monkey_Species_Small/assets/validation.zip"}]}} +asset = ocean.assets.create(metadata, account, data_token_address=token_address) +assert token_address == asset._other_values['dataTokenAddress'] -const dt_address=myToken.getAddress() - -//create asset 1 -const metaData={ - "did":"did:op:1234", - "owner":"0xaaaaa", - "dtAddress":dt_address, - "name":"Asset1", - "services="[ - { "id":0, "serviceEndpoint":"providerUri", "type":"download", "dtCost":10, "timeout":0, - "files":[{"url":"http://example.net"},{"url":"http://example.com" }] - }, - { "id":1, "type":"compute", "serviceEndpoint":"providerUri", "dtCost":1,"timeout":3600}, - { "id":2, "type":"compute", "serviceEndpoint":"providerUri", "dtCost":2, "timeout":7200 }, - ] -} -//create will encrypt the URLs using publisher and update the ddo before pushing to aquarius -//create will require that metaData.dtAddress is a valid DT Contract address -const asset = ocean.assets.create(metaData,account) -const did = asset.did +did = asset.did ``` - - ## 3. Alice mints 100 tokens -```javascript -myToken.mint(100) +```python +data_token.mint(account.address, 100, account) ``` -## 4. Exchange of value : How Bob gets DT -```javascript -const bob_config={ - network: 'rinkeby', - privateKey:'1234ef21b864d2cc526dbdb2a120bd2874c36c9d0a1fb7f8c63d7f7a8b41de8f' - marketPlaceUri: 'localhost:3000' -} -const bob_ocean = Ocean(bob_config) -const bob_account = await bob_ocean.accounts.list()[0] +## 4. Alice allows marketplace to sell her datatokens -const asset = ocean.assets.resolve(did) -const serviceIndex = assets.findServiceByType('compute') -const num_dt_needed = assets.getDtCost(serviceIndex) -//Bob need to buy num_dt_needed . DTAddress = asset.dtAddress - -const {price, currency } = ocean.marketplace.getPrice(num_dt_needed,asset.dtAddress) -bob_account.approve(price, currency, marketPlaceAddress) -ocean.marketplace.buy(num_dt_needed,asset.dtAddress) +```python +marketplace_address = '0x068ed00cf0441e4829d9784fcbe7b9e26d4bd8d0' +data_token.approve(marketplace_address, 20) ``` -## 5. Bob consumes dataset +## 5. Marketplace posts asset for sale +Now, you're the marketplace:) -Now, you are Bob :) +```python +from ocean_lib import Ocean - -```javascript - -const bob_config={ - network: 'rinkeby', - privateKey:'1234ef21b864d2cc526dbdb2a120bd2874c36c9d0a1fb7f8c63d7f7a8b41de8f' +#Market's config +config = { + 'network': 'rinkeby', + 'privateKey':'1234ef21b864d2cc526dbdb2a120bd2874c36c9d0a1fb7f8c63d7f7a8b41de8f', } -const bob_ocean = Ocean(bob_config) +market_ocean = Ocean(config) +asset = ocean.assets.resolve(did) +service1 = asset.get_service('download') +service2 = asset.get_service('access') +price = 10.0 #marketplace-set price of 10 USD / datatoken -const account = await bob_ocean.accounts.list()[0] -const asset = ocean.assets.getFromDID(did) -const serviceIndex = assets.findServiceByType('compute') - -export const rawAlgoMeta = { - rawcode: `console.log('Hello world'!)`, - format: 'docker-image', - version: '0.1', - container: { - entrypoint: 'node $ALGO', - image: 'node', - tag: '10' - } -} - -const computeJob=asset.StartCompute(serviceIndex, rawAlgoMeta, account) - +#Display key asset information, such as the cost of each service +print(f"Service 1 costs {service1.get_num_dt_needed() * price} USD") # 1.5 * 10 = 15 +print(f"Service 2 costs {service2.get_num_dt_needed() * price} USD") # 2.5 * 10 = 25 ``` +## 6. Value swap: Bob buys datatokens from marketplace +```python +#Not shown: in marketplace GUI, Bob uses Stripe to send USD to marketplace (or other methods / currencies). + +market_token = market_ocean.get_data_token(token_address) +market_token.transfer(dst_address=bob_address, 1.0) +``` + +## 7. Bob uses a service he just purchased (download) +Now, you're Bob:) + +```python + +#Bob's config +config = { + 'network': 'rinkeby', + 'privateKey':'1234ef21b864d2cc526dbdb2a120bd2874c36c9d0a1fb7f8c63d7f7a8b41de8o', +} +market_ocean = Ocean(config) + +service = asset.get_service('access') +file_path = bob_ocean.assets.download(asset.did, service.index, bob_account, '~/my-datasets') +``` \ No newline at end of file From d9c478b71f2d65b6fb4585987d8f63b6ccb6056c Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Tue, 23 Jun 2020 19:13:55 +0200 Subject: [PATCH 12/14] wip add assets.create --- src/brizo/Brizo.ts | 2 +- test/integration/Marketplaceflow.test.ts | 55 +++++++++++++++++------- 2 files changed, 40 insertions(+), 17 deletions(-) diff --git a/src/brizo/Brizo.ts b/src/brizo/Brizo.ts index 6dc55aa0..7bd26e06 100644 --- a/src/brizo/Brizo.ts +++ b/src/brizo/Brizo.ts @@ -2,7 +2,7 @@ import Account from '../ocean/Account' import { noZeroX } from '../utils' import { Instantiable, InstantiableConfig } from '../Instantiable.abstract' -const apiPath = '/api/v1/brizo/services' +const apiPath = '/api/v1/provider/services' /** * Provides an interface for provider service. diff --git a/test/integration/Marketplaceflow.test.ts b/test/integration/Marketplaceflow.test.ts index 0070b82b..ce0261e3 100644 --- a/test/integration/Marketplaceflow.test.ts +++ b/test/integration/Marketplaceflow.test.ts @@ -2,6 +2,7 @@ import { TestContractHandler } from '../TestContractHandler' import { DataTokens } from '../../src/datatokens/Datatokens' import { Ocean } from '../../src/ocean/Ocean' import { Config } from '../../src/models/Config' +import Accounts from "../../src/ocean/Account" // ?? const Web3 = require('web3') const web3 = new Web3('http://127.0.0.1:8545') @@ -9,14 +10,16 @@ const factory = require('@oceanprotocol/contracts/artifacts/development/Factory. const datatokensTemplate = require('@oceanprotocol/contracts/artifacts/development/DataTokenTemplate.json') describe('Marketplace flow', () => { - let ddo let owner let bob - let alice + let asset let contracts let datatoken + let tokenAddress let transactionId + let alice = new Accounts() + const tokenAmount = 100 const transferAmount = 1 const blob = 'http://localhost:8030/api/v1/provider/services' @@ -32,11 +35,30 @@ describe('Marketplace flow', () => { ) await contracts.getAccounts() owner = contracts.accounts[0] - alice = contracts.accounts[1] bob = contracts.accounts[2] + + await alice.setId(contracts.accounts[1]) + await alice.setPassword("0x4a608ef70ce229351d37be7b07ddd7a3ce46709911cf8c8c4bcabd8a6c563711") + await contracts.deployContracts(owner) }) + it('Generates metadata', async () => { + + asset = { + main: { + type: 'dataset', + name: 'test-dataset', + dateCreated: + new Date(Date.now()) + .toISOString() + .split('.')[0] + 'Z', // remove milliseconds + author: 'oceanprotocol-team', + license: 'MIT' + } + } + }) + it('Alice publishes a dataset', async () => { // Alice creates a Datatoken datatoken = new DataTokens( @@ -49,22 +71,23 @@ describe('Marketplace flow', () => { const config = new Config() const ocean = await Ocean.getInstance(config) - ddo = await ocean.assets.createSimpleAsset(datatoken, alice, blob) + tokenAddress = await datatoken.create(blob, alice.getId()) + await ocean.assets.create(asset, alice, [], tokenAddress) }) - it('Alice mints 100 tokens', async () => { - await datatoken.mint(ddo, alice, tokenAmount) - }) + // it('Alice mints 100 tokens', async () => { + // await datatoken.mint(ddo, alice, tokenAmount) + // }) - it('Bob gets 1 datatoken', async () => { - const ts = await datatoken.transfer(ddo, bob, transferAmount, alice) - transactionId = ts.transactionHash - }) + // it('Bob gets 1 datatoken', async () => { + // const ts = await datatoken.transfer(ddo, bob, transferAmount, alice) + // transactionId = ts.transactionHash + // }) - it('Bob consumes dataset', async () => { - const config = new Config() - const ocean = await Ocean.getInstance(config) - await ocean.assets.download(ddo, blob, transactionId, bob) - }) + // it('Bob consumes dataset', async () => { + // const config = new Config() + // const ocean = await Ocean.getInstance(config) + // await ocean.assets.download(ddo, blob, transactionId, bob) + // }) }) }) From 45f5591551d92e9dc538df45a7878a3ed7b4401b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Jun 2020 01:04:07 +0000 Subject: [PATCH 13/14] Bump uuid from 8.1.0 to 8.2.0 Bumps [uuid](https://github.com/uuidjs/uuid) from 8.1.0 to 8.2.0. - [Release notes](https://github.com/uuidjs/uuid/releases) - [Changelog](https://github.com/uuidjs/uuid/blob/master/CHANGELOG.md) - [Commits](https://github.com/uuidjs/uuid/compare/v8.1.0...v8.2.0) Signed-off-by: dependabot[bot] --- package-lock.json | 12 +++++++++--- package.json | 2 +- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 89321775..8594e05c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9775,6 +9775,12 @@ "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.2.tgz", "integrity": "sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==", "dev": true + }, + "uuid": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.1.0.tgz", + "integrity": "sha512-CI18flHDznR0lq54xBycOVmphdCYnQLKn8abKn7PXUiKUGdEd+/l9LWNJmugXel4hXq7S+RMNl34ecyC9TntWg==", + "dev": true } } }, @@ -11339,9 +11345,9 @@ "integrity": "sha1-n5VxD1CiZ5R7LMwSR0HBAoQn5xM=" }, "uuid": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.1.0.tgz", - "integrity": "sha512-CI18flHDznR0lq54xBycOVmphdCYnQLKn8abKn7PXUiKUGdEd+/l9LWNJmugXel4hXq7S+RMNl34ecyC9TntWg==" + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.2.0.tgz", + "integrity": "sha512-CYpGiFTUrmI6OBMkAdjSDM0k5h8SkkiTP4WAjQgDgNB1S3Ou9VBEvr6q0Kv2H1mMk7IWfxYGpMH5sd5AvcIV2Q==" }, "v8-compile-cache": { "version": "2.1.0", diff --git a/package.json b/package.json index df451835..d982bc62 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "fs": "0.0.1-security", "node-fetch": "^2.6.0", "save-file": "^2.3.1", - "uuid": "^8.0.0", + "uuid": "^8.2.0", "web3": "^1.2.9", "web3-eth-contract": "^1.2.9", "whatwg-url": "^8.0.0" From 5ca06863c279db30ce8694183f7a2c2e383a2bc5 Mon Sep 17 00:00:00 2001 From: arsenyjin Date: Wed, 24 Jun 2020 12:45:35 +0200 Subject: [PATCH 14/14] wip: add marketplace flow --- test/integration/Marketplaceflow.test.ts | 50 +++++++++++++++++------- 1 file changed, 36 insertions(+), 14 deletions(-) diff --git a/test/integration/Marketplaceflow.test.ts b/test/integration/Marketplaceflow.test.ts index ce0261e3..10a3af60 100644 --- a/test/integration/Marketplaceflow.test.ts +++ b/test/integration/Marketplaceflow.test.ts @@ -13,15 +13,19 @@ describe('Marketplace flow', () => { let owner let bob let asset + let marketplace + let marketOcean let contracts let datatoken let tokenAddress let transactionId + let service1 + let service2 let alice = new Accounts() const tokenAmount = 100 - const transferAmount = 1 + const transferAmount = 2 const blob = 'http://localhost:8030/api/v1/provider/services' describe('#test', () => { @@ -36,6 +40,7 @@ describe('Marketplace flow', () => { await contracts.getAccounts() owner = contracts.accounts[0] bob = contracts.accounts[2] + marketplace = contracts.accounts[3] await alice.setId(contracts.accounts[1]) await alice.setPassword("0x4a608ef70ce229351d37be7b07ddd7a3ce46709911cf8c8c4bcabd8a6c563711") @@ -43,6 +48,10 @@ describe('Marketplace flow', () => { await contracts.deployContracts(owner) }) + it('Alice publishes a datatoken contract', async () => { + tokenAddress = await datatoken.create(blob, alice.getId()) + }) + it('Generates metadata', async () => { asset = { @@ -72,22 +81,35 @@ describe('Marketplace flow', () => { const ocean = await Ocean.getInstance(config) tokenAddress = await datatoken.create(blob, alice.getId()) - await ocean.assets.create(asset, alice, [], tokenAddress) + asset = await ocean.assets.create(asset, alice, [], tokenAddress) }) - // it('Alice mints 100 tokens', async () => { - // await datatoken.mint(ddo, alice, tokenAmount) - // }) + it('Alice mints 100 tokens', async () => { + await datatoken.mint(tokenAddress, alice.getId(), tokenAmount) + }) - // it('Bob gets 1 datatoken', async () => { - // const ts = await datatoken.transfer(ddo, bob, transferAmount, alice) - // transactionId = ts.transactionHash - // }) + it('Marketplace posts asset for sale', async () => { + const config = new Config() + marketOcean = await Ocean.getInstance(config) - // it('Bob consumes dataset', async () => { - // const config = new Config() - // const ocean = await Ocean.getInstance(config) - // await ocean.assets.download(ddo, blob, transactionId, bob) - // }) + service1 = marketOcean.assets.getService('download') + service2 = marketOcean.assets.getService('access') + + }) + + it('Bob gets datatokens', async () => { + const ts = await datatoken.transfer(tokenAddress, bob, transferAmount, alice) + transactionId = ts.transactionHash + }) + + it('Bob consumes asset 1', async () => { + const config = new Config() + const ocean = await Ocean.getInstance(config) + await ocean.assets.download(asset.did, service1.index, bob, '~/my-datasets') + }) + + it('Bob consumes asset 2', async () => { + // TODO + }) }) })