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>
172 lines
3.5 KiB
Markdown
172 lines
3.5 KiB
Markdown
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Aquarius
|
|
|
|
# Class: Aquarius
|
|
|
|
## Table of contents
|
|
|
|
### Constructors
|
|
|
|
- [constructor](Aquarius.md#constructor)
|
|
|
|
### Properties
|
|
|
|
- [aquariusURL](Aquarius.md#aquariusurl)
|
|
|
|
### Methods
|
|
|
|
- [getAssetMetadata](Aquarius.md#getassetmetadata)
|
|
- [querySearch](Aquarius.md#querysearch)
|
|
- [resolve](Aquarius.md#resolve)
|
|
- [validate](Aquarius.md#validate)
|
|
- [waitForAqua](Aquarius.md#waitforaqua)
|
|
|
|
## Constructors
|
|
|
|
### constructor
|
|
|
|
• **new Aquarius**(`aquariusURL`)
|
|
|
|
Instantiate Aquarius
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `aquariusURL` | `string` |
|
|
|
|
#### Defined in
|
|
|
|
[services/Aquarius.ts:21](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L21)
|
|
|
|
## Properties
|
|
|
|
### aquariusURL
|
|
|
|
• **aquariusURL**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[services/Aquarius.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L15)
|
|
|
|
## Methods
|
|
|
|
### getAssetMetadata
|
|
|
|
▸ **getAssetMetadata**(`did`, `signal?`): `Promise`<`any`\>
|
|
|
|
Search over the DDOs using a query.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `did` | `string` | DID of the asset |
|
|
| `signal?` | `AbortSignal` | abort signal |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<`any`\>
|
|
|
|
#### Defined in
|
|
|
|
[services/Aquarius.ts:135](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L135)
|
|
|
|
___
|
|
|
|
### querySearch
|
|
|
|
▸ **querySearch**(`query`, `signal?`): `Promise`<`any`\>
|
|
|
|
Search over the DDOs using a query.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `query` | [`SearchQuery`](../interfaces/SearchQuery.md) | Query to filter the DDOs. |
|
|
| `signal?` | `AbortSignal` | abort signal |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<`any`\>
|
|
|
|
#### Defined in
|
|
|
|
[services/Aquarius.ts:166](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L166)
|
|
|
|
___
|
|
|
|
### resolve
|
|
|
|
▸ **resolve**(`did`, `signal?`): `Promise`<[`Asset`](../interfaces/Asset.md)\>
|
|
|
|
Resolves a DID
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `did` | `string` | DID of the asset. |
|
|
| `signal?` | `AbortSignal` | abort signal |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<[`Asset`](../interfaces/Asset.md)\>
|
|
|
|
Asset
|
|
|
|
#### Defined in
|
|
|
|
[services/Aquarius.ts:30](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L30)
|
|
|
|
___
|
|
|
|
### validate
|
|
|
|
▸ **validate**(`ddo`, `signal?`): `Promise`<[`ValidateMetadata`](../interfaces/ValidateMetadata.md)\>
|
|
|
|
Validate DDO content
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `ddo` | [`DDO`](../interfaces/DDO.md) | DID Descriptor Object content. |
|
|
| `signal?` | `AbortSignal` | abort signal |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<[`ValidateMetadata`](../interfaces/ValidateMetadata.md)\>
|
|
|
|
.
|
|
|
|
#### Defined in
|
|
|
|
[services/Aquarius.ts:94](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L94)
|
|
|
|
___
|
|
|
|
### waitForAqua
|
|
|
|
▸ **waitForAqua**(`did`, `txid?`, `signal?`): `Promise`<[`Asset`](../interfaces/Asset.md)\>
|
|
|
|
Blocks until Aqua will cache the did (or the update for that did) or timeouts
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `did` | `string` | DID of the asset. |
|
|
| `txid?` | `string` | used when the did exists and we expect an update with that txid. |
|
|
| `signal?` | `AbortSignal` | abort signal |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<[`Asset`](../interfaces/Asset.md)\>
|
|
|
|
DDO of the asset.
|
|
|
|
#### Defined in
|
|
|
|
[services/Aquarius.ts:58](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Aquarius.ts#L58)
|