oceanprotocol/ocean.js
1
0
Fork 0
mirror of https://github.com/oceanprotocol/ocean.js.git synced 2024-11-26 20:39:05 +01:00
Code Releases Activity

formatting

Browse Source
This commit is contained in:
Matthias Kretschmann 2020-08-18 12:12:41 +02:00
parent ffad644d73
commit dcdd40bd2d
Signed by: m
GPG Key ID: 606EEEF3C479A91F
4 changed files with 72 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -6,12 +6,13 @@
`ocean-lib` is a Javascript library to privately & securely publish, exchange, `ocean-lib` is a Javascript library to privately & securely publish, exchange,
and consume data. With it, you can: and consume data. With it, you can:
* **Publish** data services: downloadable files, streaming data, or compute-to-data.
- **Publish** data services: downloadable files, streaming data, or compute-to-data.
Ocean creates a new [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md) Ocean creates a new [ERC20](https://github.com/ethereum/EIPs/blob/7f4f0377730f5fc266824084188cc17cf246932e/EIPS/eip-20.md)
data token for each data service or set of services. data token for each data service or set of services.
* **Mint** data tokens for the service - **Mint** data tokens for the service
* **Consume** data tokens, to access the service - **Consume** data tokens, to access the service
* **Transfer** data tokens to another owner, and **all other ERC20 actions** - **Transfer** data tokens to another owner, and **all other ERC20 actions**
using [web3.js](https://web3js.readthedocs.io/en/v1.2.9/web3-eth-contract.html) etc. using [web3.js](https://web3js.readthedocs.io/en/v1.2.9/web3-eth-contract.html) etc.
`ocean-lib` is part of the [Ocean Protocol](https://oceanprotocol.com) toolset. `ocean-lib` is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.
@ -20,7 +21,7 @@ This is in alpha state and you can expect running into problems. If you run into
## Quick Install ## Quick Install
```npm i @oceanprotocol/lib``` `npm i @oceanprotocol/lib`
## Quickstart: Simple Flow ## Quickstart: Simple Flow

25
docs/README_simple_flow.md
View File

@ -1,11 +1,11 @@
# ocean-lib # ocean-lib
`ocean-lib-js` is a Javascript/Typescript library to privately & securely publish, exchange, and consume data. With it, you can: `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 - **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.
* **Transfer** data tokens to another owner - **Mint** data tokens for a given data service
* **Consume** data tokens, to access the 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. `ocean-lib-js` is part of the [Ocean Protocol](www.oceanprotocol.com) toolset.
@ -14,6 +14,7 @@
``` ```
npm i --save @oceanprotocol/lib npm i --save @oceanprotocol/lib
``` ```
# Usage # Usage
``` ```
@ -30,6 +31,7 @@ const { Ocean, Logger } = require('@oceanprotocol/lib')
This section describes a flow with the simplest transfer of value, for static data. This section describes a flow with the simplest transfer of value, for static data.
Here's the steps. Here's the steps.
1. Alice publishes a dataset (= publishes a datatoken contract) 1. Alice publishes a dataset (= publishes a datatoken contract)
1. Alice mints 100 tokens 1. Alice mints 100 tokens
1. Alice transfers 1 token to Bob 1. Alice transfers 1 token to Bob
@ -37,17 +39,18 @@ Here's the steps.
Let's go through each of these in detail. Let's go through each of these in detail.
## 1. Alice publishes a dataset (= publishes a datatoken contract) ## 1. Alice publishes a dataset (= publishes a datatoken contract)
For now, you're Alice:) Let's proceed. For now, you're Alice:) Let's proceed.
Run `ganache-cli` locally: Run `ganache-cli` locally:
```bash ```bash
ganache-cli ganache-cli
``` ```
Then proceed in with your code: Then proceed in with your code:
```javascript ```javascript
const tokenAmount = 100 const tokenAmount = 100
const transferAmount = 1 const transferAmount = 1
@ -56,10 +59,14 @@ const blob = 'http://localhost:8030/api/v1/provider/services'
const alice = await ocean.accounts.list()[0] const alice = await ocean.accounts.list()[0]
const bob = await ocean.accounts.list()[0] const bob = await ocean.accounts.list()[0]
// create datatoken class // create datatoken class
const datatoken = new DataTokens(contracts.factoryAddress, factoryABI, datatokensABI, web3) const datatoken = new DataTokens(
contracts.factoryAddress,
factoryABI,
datatokensABI,
web3
)
// deploy datatoken // deploy datatoken
const tokenAddress = await datatoken.create(blob, alice) const tokenAddress = await datatoken.create(blob, alice)
``` ```
## 2. Alice hosts the dataset ## 2. Alice hosts the dataset
@ -90,9 +97,7 @@ const transactionId = ts['transactionHash']
Now, you are Bob :) Now, you are Bob :)
```javascript ```javascript
const config = new Config() const config = new Config()
const ocean = await Ocean.getInstance() const ocean = await Ocean.getInstance()