oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

GITBOOK-521: Updated datatoken templates page

Browse Source
This commit is contained in:
Ana Loznianu 2023-06-15 13:19:47 +00:00 committed by gitbook-bot
parent c8a9578fe5
commit a16636993f
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
3 changed files with 56 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
developers/contracts/datatoken-templates.md
View File

@ -21,13 +21,65 @@ The details regarding currently supported **datatoken templates** are as follows
### **Regular template**
The regular template allows users to buy/sell/hold datatokens. The datatokens can be minted by the address having a [`MINTER`](roles.md#minter) role, making the supply of datatoken variable. This template is assigned _**templateId**_ `1` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20Template.sol).
The regular template allows users to buy/sell/hold datatokens. The datatokens can be minted by the address having a [`MINTER`](roles.md#minter) role, making the supply of datatoken variable. This template is assigned _**`templateId`**_` ``= 1` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20Template.sol).
### **Enterprise template**
The enterprise template has additional functions apart from methods in the ERC20 interface. This additional feature allows access to the service by paying in the basetoken instead of the datatoken. Internally, the smart contract handles the conversion of basetoken to datatoken, initiating an order to access the service, and minting/burning the datatoken. The total supply of the datatoken effectively remains 0 in the case of the enterprise template. This template is assigned _**templateId**_ `2` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20TemplateEnterprise.sol).
The enterprise template has additional functions apart from methods in the ERC20 interface. This additional feature allows access to the service by paying in the basetoken instead of the datatoken. Internally, the smart contract handles the conversion of basetoken to datatoken, initiating an order to access the service, and minting/burning the datatoken. The total supply of the datatoken effectively remains 0 in the case of the enterprise template. This template is assigned _**`templateId =`**_`2` and the source code is available [here](https://github.com/oceanprotocol/contracts/blob/v4main/contracts/templates/ERC20TemplateEnterprise.sol).
#### Set the template
When you're in the process of creating an NFT, it's essential to indicate the specific template it should utilize. 
{% tabs %}
{% tab title="Ocean.js" %}
To personalize the template via ocean.js, you can achieve it by customizing the [NFTCreateData](https://github.com/oceanprotocol/ocean.js/blob/ae2ff1ccde53ace9841844c316a855de271f9a3f/src/%40types/NFTFactory.ts#L16) with your desired `templateIndex`. 
The default template used is 1.
```typescript
export interface NftCreateData {
name: string
symbol: string
templateIndex: number
tokenURI: string
transferable: boolean
owner: string
}
```
{% endtab %}
{% tab title="Ocean.py" %}
To personalize the template via ocean.py, you can achieve it by customizing the [DataNFTArguments](https://github.com/oceanprotocol/ocean.py/blob/bad11fb3a4cb00be8bab8febf3173682e1c091fd/ocean\_lib/models/data\_nft.py#L317) with your desired `template_index`.
The default template used is 1.
```python
name: str name of data NFT if creating a new one
symbol: str symbol of data NFT if creating a new one
template_index: int template index of the data NFT, by default is 1.
additional_datatoken_deployer: str address of an additional ERC20 deployer.
additional_metadata_updater: str address of an additional metadata updater.
uri: str URL of the data NFT.
"""
def __init__(
self,
name: str,
symbol: str,
template_index: Optional[int] = 1,
additional_datatoken_deployer: Optional[str] = None,
additional_metadata_updater: Optional[str] = None,
uri: Optional[str] = None,
transferable: Optional[bool] = None,
owner: Optional[str] = None,
)...
```
{% endtab %}
{% endtabs %}
{% hint style="info" %}
By default, all assets published through the Ocean Market use the Enterprise Template. 
{% endhint %}
#### Retrieve the template

2
user-guides/join-a-data-challenge.md
View File

@ -6,7 +6,7 @@ description: >-
# Join a Data Challenge
<figure><img src="../../.gitbook/assets/morpheus-taunting.gif" alt=""><figcaption><p>Bring on the data challenges.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/morpheus-taunting.gif" alt=""><figcaption><p>Bring on the data challenges.</p></figcaption></figure>
Hone your skills, work on real business problems, and earn sweet dosh along the way.&#x20;

2
user-guides/sponsor-a-data-challenge.md
View File

@ -4,7 +4,7 @@ description: Sponsor a data challenge to crowdsource solutions for your business
# Sponsor a Data Challenge
<figure><img src="../../.gitbook/assets/welcome-to-my-dojo.gif" alt=""><figcaption><p>Make the game, set the rules.</p></figcaption></figure>
<figure><img src="../.gitbook/assets/welcome-to-my-dojo.gif" alt=""><figcaption><p>Make the game, set the rules.</p></figcaption></figure>
Hosting a data challenge is a fun way to engage data scientists and machine learning experts around the world to **solve your real business problems**. Incentivize participants to **build products using your data**, **explain insights in your data**, or **provide useful data predictions** for your business. Plus, it's a whole lot cheaper than hiring an in-house data science team!