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>
139 lines
2.8 KiB
Markdown
139 lines
2.8 KiB
Markdown
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Service
|
|
|
|
# Interface: Service
|
|
|
|
## Table of contents
|
|
|
|
### Properties
|
|
|
|
- [additionalInformation](Service.md#additionalinformation)
|
|
- [compute](Service.md#compute)
|
|
- [datatokenAddress](Service.md#datatokenaddress)
|
|
- [description](Service.md#description)
|
|
- [files](Service.md#files)
|
|
- [id](Service.md#id)
|
|
- [name](Service.md#name)
|
|
- [serviceEndpoint](Service.md#serviceendpoint)
|
|
- [timeout](Service.md#timeout)
|
|
- [type](Service.md#type)
|
|
|
|
## Properties
|
|
|
|
### additionalInformation
|
|
|
|
• `Optional` **additionalInformation**: `any`
|
|
|
|
Stores service specific additional information, this is customizable by publisher
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:109](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L109)
|
|
|
|
___
|
|
|
|
### compute
|
|
|
|
• `Optional` **compute**: [`ServiceComputeOptions`](ServiceComputeOptions.md)
|
|
|
|
If service is of type compute, holds information about the compute-related privacy settings & resources.
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:103](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L103)
|
|
|
|
___
|
|
|
|
### datatokenAddress
|
|
|
|
• **datatokenAddress**: `string`
|
|
|
|
Datatoken address
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:73](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L73)
|
|
|
|
___
|
|
|
|
### description
|
|
|
|
• `Optional` **description**: `string`
|
|
|
|
Service description
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:97](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L97)
|
|
|
|
___
|
|
|
|
### files
|
|
|
|
• **files**: `string`
|
|
|
|
Encrypted file URLs.
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:67](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L67)
|
|
|
|
___
|
|
|
|
### id
|
|
|
|
• **id**: `string`
|
|
|
|
Unique ID
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:55](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L55)
|
|
|
|
___
|
|
|
|
### name
|
|
|
|
• `Optional` **name**: `string`
|
|
|
|
Service friendly name
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:91](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L91)
|
|
|
|
___
|
|
|
|
### serviceEndpoint
|
|
|
|
• **serviceEndpoint**: `string`
|
|
|
|
Provider URL (schema + host).
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:79](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L79)
|
|
|
|
___
|
|
|
|
### timeout
|
|
|
|
• **timeout**: `number`
|
|
|
|
Describing how long the service can be used after consumption is initiated.
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:85](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L85)
|
|
|
|
___
|
|
|
|
### type
|
|
|
|
• **type**: `string`
|
|
|
|
Type of service (access, compute, wss.
|
|
|
|
#### Defined in
|
|
|
|
[@types/DDO/Service.ts:61](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Service.ts#L61)
|