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>
228 lines
4.6 KiB
Markdown
228 lines
4.6 KiB
Markdown
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Asset
|
|
|
|
# Interface: Asset
|
|
|
|
DID Descriptor Object.
|
|
Contains metadata about the asset, and define access in at least one service.
|
|
|
|
## Hierarchy
|
|
|
|
- [`DDO`](DDO.md)
|
|
|
|
↳ **`Asset`**
|
|
|
|
## Table of contents
|
|
|
|
### Properties
|
|
|
|
- [@context](Asset.md#@context)
|
|
- [chainId](Asset.md#chainid)
|
|
- [credentials](Asset.md#credentials)
|
|
- [datatokens](Asset.md#datatokens)
|
|
- [event](Asset.md#event)
|
|
- [id](Asset.md#id)
|
|
- [metadata](Asset.md#metadata)
|
|
- [nft](Asset.md#nft)
|
|
- [nftAddress](Asset.md#nftaddress)
|
|
- [purgatory](Asset.md#purgatory)
|
|
- [services](Asset.md#services)
|
|
- [stats](Asset.md#stats)
|
|
- [version](Asset.md#version)
|
|
|
|
## Properties
|
|
|
|
### @context
|
|
|
|
• **@context**: `string`[]
|
|
|
|
Contexts used for validation.
|
|
|
|
#### Inherited from
|
|
|
|
[DDO](DDO.md).[@context](DDO.md#@context)
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/DDO.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L12)
|
|
|
|
___
|
|
|
|
### chainId
|
|
|
|
• **chainId**: `number`
|
|
|
|
ChainId of the network the DDO was published to.
|
|
|
|
#### Inherited from
|
|
|
|
[DDO](DDO.md).[chainId](DDO.md#chainid)
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/DDO.ts:38](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L38)
|
|
|
|
___
|
|
|
|
### credentials
|
|
|
|
• `Optional` **credentials**: [`Credentials`](Credentials.md)
|
|
|
|
Describes the credentials needed to access a dataset
|
|
in addition to the services definition.
|
|
|
|
#### Inherited from
|
|
|
|
[DDO](DDO.md).[credentials](DDO.md#credentials)
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/DDO.ts:57](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L57)
|
|
|
|
___
|
|
|
|
### datatokens
|
|
|
|
• **datatokens**: [`AssetDatatoken`](AssetDatatoken.md)[]
|
|
|
|
Contains information about the ERC20 Datatokens attached to asset services.
|
|
|
|
#### Defined in
|
|
|
|
[@types/Asset.ts:151](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L151)
|
|
|
|
___
|
|
|
|
### event
|
|
|
|
• **event**: [`AssetLastEvent`](AssetLastEvent.md)
|
|
|
|
Contains information about the last transaction that created or updated the DDO.
|
|
|
|
#### Overrides
|
|
|
|
[DDO](DDO.md).[event](DDO.md#event)
|
|
|
|
#### Defined in
|
|
|
|
[@types/Asset.ts:157](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L157)
|
|
|
|
___
|
|
|
|
### id
|
|
|
|
• **id**: `string`
|
|
|
|
DID, descentralized ID.
|
|
Computed as sha256(address of NFT contract + chainId)
|
|
|
|
#### Inherited from
|
|
|
|
[DDO](DDO.md).[id](DDO.md#id)
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/DDO.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L19)
|
|
|
|
___
|
|
|
|
### metadata
|
|
|
|
• **metadata**: [`Metadata`](Metadata.md)
|
|
|
|
Stores an object describing the asset.
|
|
|
|
#### Inherited from
|
|
|
|
[DDO](DDO.md).[metadata](DDO.md#metadata)
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/DDO.ts:44](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L44)
|
|
|
|
___
|
|
|
|
### nft
|
|
|
|
• **nft**: [`AssetNft`](AssetNft.md)
|
|
|
|
Contains information about the ERC721 NFT contract which represents the intellectual property of the publisher.
|
|
|
|
#### Defined in
|
|
|
|
[@types/Asset.ts:145](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L145)
|
|
|
|
___
|
|
|
|
### nftAddress
|
|
|
|
• **nftAddress**: `string`
|
|
|
|
NFT contract address
|
|
|
|
#### Inherited from
|
|
|
|
[DDO](DDO.md).[nftAddress](DDO.md#nftaddress)
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/DDO.ts:32](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L32)
|
|
|
|
___
|
|
|
|
### purgatory
|
|
|
|
• **purgatory**: [`Purgatory`](Purgatory.md)
|
|
|
|
Contains information about an asset's purgatory status defined in
|
|
[`list-purgatory`](https://github.com/oceanprotocol/list-purgatory).
|
|
Marketplace interfaces are encouraged to prevent certain user actions like downloading on assets in purgatory.
|
|
|
|
#### Defined in
|
|
|
|
[@types/Asset.ts:171](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L171)
|
|
|
|
___
|
|
|
|
### services
|
|
|
|
• **services**: [`Service`](Service.md)[]
|
|
|
|
Stores an array of services defining access to the asset.
|
|
|
|
#### Inherited from
|
|
|
|
[DDO](DDO.md).[services](DDO.md#services)
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/DDO.ts:50](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L50)
|
|
|
|
___
|
|
|
|
### stats
|
|
|
|
• **stats**: [`Stats`](Stats.md)
|
|
|
|
The stats section contains different statistics fields. This section is added by Aquarius
|
|
|
|
#### Defined in
|
|
|
|
[@types/Asset.ts:163](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Asset.ts#L163)
|
|
|
|
___
|
|
|
|
### version
|
|
|
|
• **version**: `string`
|
|
|
|
Version information in SemVer notation
|
|
referring to the DDO spec version
|
|
|
|
#### Inherited from
|
|
|
|
[DDO](DDO.md).[version](DDO.md#version)
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/DDO.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L26)
|