mirror of
https://github.com/oceanprotocol/ocean.js.git
synced 2024-11-26 20:39:05 +01:00
9bf71ba4f0
* add ethers * global updates * ve updates * ve tests * contract updates * first test passing * downgrade to ethers 5.7.2 * add log * add tx wait * full NftFactory.test * add wait * add Router tests * fix dispenser * Nft test * add dispenser tests * add fre tests part 1 * WIP datatoken unit tests * add DFRewards test * increase gas estimate * increase gas estimate * Work datatoken unit tests * datatoken test more tests * finished datatoken tests * fix nft get data * fix nft transfer tests * Provider int tests * Updating CodeExamples.md * update provider & fix publish flow int test * wip publish edit consume integration test * more work on publish edit consume integration test * fix edit publish edit consume integration test * add 3 int tests * Updating ComputeExamples.md * fix signature and download * fix compute flow integration test * udapte handleComputeOrder helper * update datatoken instance * update datatoken global variable * mint ocean tokens to consumer as well and added logs * update compute exammples * Updating ComputeExamples.md * wip code examples readme * update code examples readme * Updating CodeExamples.md * run all tests * update dep in readme * update readme * code examples update metadata flags * update dt instance in code examples md * set metadata updates * Updating CodeExamples.md * update code examples readme structure * Updating CodeExamples.md * update readmes table links * Updating CodeExamples.md * Updating ComputeExamples.md * clean-up * Updating CodeExamples.md * added missing unit tests for usdc fixed rate exchange tests * more cleanup and jsdoc updates * more jsdoc updates * donw with jsdoc updates * handle provider errors * add missing error handling file * adds most of the provider errors * update get compute env return type * Release 3.0.0-next.0 * adding Typedoc to ethers branch * update provider signature message * fix lint * Release 3.0.0-next.1 * fix lint * adding Typedoc to ethers branch * Updating CI to build and commit the documentation * Updating documentation * Updating script permissions * fix todos add missing logic to send tx * npm package cleanups * Release 3.0.0-next.2 * update log messages for errors * Release 3.0.0-next.3 * fix gasFee issue on sendTx * Release 3.0.0-next.4 * add consume params typings (#1731) * fix gas fee estimate * remove comments * add some delays before resolving datasets * adds delay to Publish flow tests * Release 3.0.0-next.5 --------- Co-authored-by: Bogdan Fazakas <bogdan.fazakas@gmail.com> Co-authored-by: GitHub Actions Bot <> Co-authored-by: Jamie Hewitt <jamie.hewitt15@gmail.com> Co-authored-by: Jamie Hewitt <jamie@oceanprotocol.com>
194 lines
4.4 KiB
Markdown
194 lines
4.4 KiB
Markdown
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Metadata
|
||
|
||
# Interface: Metadata
|
||
|
||
## Table of contents
|
||
|
||
### Properties
|
||
|
||
- [additionalInformation](Metadata.md#additionalinformation)
|
||
- [algorithm](Metadata.md#algorithm)
|
||
- [author](Metadata.md#author)
|
||
- [categories](Metadata.md#categories)
|
||
- [contentLanguage](Metadata.md#contentlanguage)
|
||
- [copyrightHolder](Metadata.md#copyrightholder)
|
||
- [created](Metadata.md#created)
|
||
- [description](Metadata.md#description)
|
||
- [license](Metadata.md#license)
|
||
- [links](Metadata.md#links)
|
||
- [name](Metadata.md#name)
|
||
- [tags](Metadata.md#tags)
|
||
- [type](Metadata.md#type)
|
||
- [updated](Metadata.md#updated)
|
||
|
||
## Properties
|
||
|
||
### additionalInformation
|
||
|
||
• `Optional` **additionalInformation**: `any`
|
||
|
||
Stores additional information, this is customizable by publisher
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:137](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L137)
|
||
|
||
___
|
||
|
||
### algorithm
|
||
|
||
• `Optional` **algorithm**: [`MetadataAlgorithm`](MetadataAlgorithm.md)
|
||
|
||
Information about asset of type algorithm. Required for algorithm assets.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:131](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L131)
|
||
|
||
___
|
||
|
||
### author
|
||
|
||
• **author**: `string`
|
||
|
||
Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:87](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L87)
|
||
|
||
___
|
||
|
||
### categories
|
||
|
||
• `Optional` **categories**: `string`[]
|
||
|
||
Array of categories associated to the asset. Note: recommended to use tags instead of this.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:113](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L113)
|
||
|
||
___
|
||
|
||
### contentLanguage
|
||
|
||
• `Optional` **contentLanguage**: `string`
|
||
|
||
The language of the content. Use one of the language codes from the IETF BCP 47 standard
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:125](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L125)
|
||
|
||
___
|
||
|
||
### copyrightHolder
|
||
|
||
• `Optional` **copyrightHolder**: `string`
|
||
|
||
The party holding the legal copyright. Empty by default.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:119](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L119)
|
||
|
||
___
|
||
|
||
### created
|
||
|
||
• **created**: `string`
|
||
|
||
Contains the date of publishing in ISO Date Time
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:56](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L56)
|
||
|
||
___
|
||
|
||
### description
|
||
|
||
• **description**: `string`
|
||
|
||
Details of what the resource is.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:74](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L74)
|
||
|
||
___
|
||
|
||
### license
|
||
|
||
• **license**: `string`
|
||
|
||
Short name referencing the license of the asset.
|
||
If it’s not specified, the following value will be added: “No License Specified”.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:94](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L94)
|
||
|
||
___
|
||
|
||
### links
|
||
|
||
• `Optional` **links**: `string`[]
|
||
|
||
Mapping of URL strings for data samples, or links to find out more information.
|
||
Links may be to either a URL or another asset.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:101](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L101)
|
||
|
||
___
|
||
|
||
### name
|
||
|
||
• **name**: `string`
|
||
|
||
Descriptive name or title of the asset.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:68](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L68)
|
||
|
||
___
|
||
|
||
### tags
|
||
|
||
• `Optional` **tags**: `string`[]
|
||
|
||
Array of keywords or tags used to describe this content. Empty by default.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:107](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L107)
|
||
|
||
___
|
||
|
||
### type
|
||
|
||
• **type**: ``"dataset"`` \| ``"algorithm"``
|
||
|
||
Asset type. Includes "dataset" (e.g. csv file), "algorithm" (e.g. Python script).
|
||
Each type needs a different subset of metadata attributes.
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:81](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L81)
|
||
|
||
___
|
||
|
||
### updated
|
||
|
||
• **updated**: `string`
|
||
|
||
Contains the the date of last update in ISO Date Time
|
||
|
||
#### Defined in
|
||
|
||
[@types/DDO/Metadata.ts:62](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Metadata.ts#L62)
|