@oceanprotocol/lib 7.0.0-next.0 → 7.0.0-next.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib.cjs +4 -3
- package/dist/lib.module.mjs +4 -3
- package/dist/lib.umd.js +4 -3
- package/dist/types/@types/Compute.d.ts +21 -0
- package/dist/types/@types/Provider.d.ts +39 -0
- package/dist/types/services/providers/BaseProvider.d.ts +35 -32
- package/dist/types/services/providers/HttpProvider.d.ts +4 -2
- package/dist/types/services/providers/P2pProvider.d.ts +39 -37
- package/package.json +27 -21
- package/.mocharc.json +0 -8
- package/.nvmrc +0 -1
- package/CHANGELOG.md +0 -3228
- package/Cheatsheet.md +0 -326
- package/CodeExamples.md +0 -881
- package/ComputeExamples.md +0 -941
- package/dist/lib.cjs.map +0 -1
- package/dist/lib.modern.js +0 -4
- package/dist/lib.modern.js.map +0 -1
- package/dist/lib.module.mjs.map +0 -1
- package/dist/lib.umd.js.map +0 -1
- package/docs/.nojekyll +0 -1
- package/docs/README.md +0 -195
- package/docs/classes/Aquarius.md +0 -175
- package/docs/classes/Config.md +0 -481
- package/docs/classes/ConfigHelper.md +0 -66
- package/docs/classes/Datatoken.md +0 -1123
- package/docs/classes/Dispenser.md +0 -502
- package/docs/classes/Escrow.md +0 -285
- package/docs/classes/FixedRateExchange.md +0 -1068
- package/docs/classes/Logger.md +0 -191
- package/docs/classes/Nft.md +0 -970
- package/docs/classes/NftFactory.md +0 -861
- package/docs/classes/Provider.md +0 -727
- package/docs/classes/Router.md +0 -645
- package/docs/classes/SmartContract.md +0 -193
- package/docs/classes/SmartContractWithAddress.md +0 -268
- package/docs/enums/LogLevel.md +0 -63
- package/docs/interfaces/AbiInput.md +0 -63
- package/docs/interfaces/AbiItem.md +0 -107
- package/docs/interfaces/AbiOutput.md +0 -52
- package/docs/interfaces/Arweave.md +0 -32
- package/docs/interfaces/Asset.md +0 -227
- package/docs/interfaces/AssetDatatoken.md +0 -60
- package/docs/interfaces/AssetLastEvent.md +0 -63
- package/docs/interfaces/AssetNft.md +0 -105
- package/docs/interfaces/AssetPrice.md +0 -47
- package/docs/interfaces/ComputeAlgorithm.md +0 -82
- package/docs/interfaces/ComputeAsset.md +0 -56
- package/docs/interfaces/ComputeEnvFees.md +0 -30
- package/docs/interfaces/ComputeEnvFeesStructure.md +0 -20
- package/docs/interfaces/ComputeEnvironment.md +0 -177
- package/docs/interfaces/ComputeJob.md +0 -173
- package/docs/interfaces/ComputeOutput.md +0 -118
- package/docs/interfaces/ComputeResourcesPricingInfo.md +0 -30
- package/docs/interfaces/ComputeResourcesRequest.md +0 -34
- package/docs/interfaces/ComputeResult.md +0 -52
- package/docs/interfaces/ConsumeMarketFee.md +0 -41
- package/docs/interfaces/Credential.md +0 -30
- package/docs/interfaces/Credentials.md +0 -30
- package/docs/interfaces/DDO.md +0 -137
- package/docs/interfaces/DatatokenCreateParams.md +0 -107
- package/docs/interfaces/DatatokenRoles.md +0 -30
- package/docs/interfaces/DispenserCreationParams.md +0 -63
- package/docs/interfaces/DispenserParams.md +0 -52
- package/docs/interfaces/DispenserToken.md +0 -85
- package/docs/interfaces/DownloadResponse.md +0 -30
- package/docs/interfaces/Event.md +0 -73
- package/docs/interfaces/FeesInfo.md +0 -74
- package/docs/interfaces/FileInfo.md +0 -118
- package/docs/interfaces/Files.md +0 -41
- package/docs/interfaces/FixedPriceExchange.md +0 -162
- package/docs/interfaces/FreCreationParams.md +0 -118
- package/docs/interfaces/FreOrderParams.md +0 -85
- package/docs/interfaces/GraphqlQuery.md +0 -69
- package/docs/interfaces/Ipfs.md +0 -32
- package/docs/interfaces/Metadata.md +0 -193
- package/docs/interfaces/MetadataAlgorithm.md +0 -69
- package/docs/interfaces/MetadataAndTokenURI.md +0 -107
- package/docs/interfaces/MetadataProof.md +0 -52
- package/docs/interfaces/NftCreateData.md +0 -74
- package/docs/interfaces/NftRoles.md +0 -52
- package/docs/interfaces/Operation.md +0 -145
- package/docs/interfaces/OrderParams.md +0 -52
- package/docs/interfaces/PriceAndFees.md +0 -52
- package/docs/interfaces/ProviderComputeInitialize.md +0 -41
- package/docs/interfaces/ProviderComputeInitializeResults.md +0 -43
- package/docs/interfaces/ProviderFees.md +0 -96
- package/docs/interfaces/ProviderInitialize.md +0 -52
- package/docs/interfaces/PublisherTrustedAlgorithm.md +0 -47
- package/docs/interfaces/PublishingMarketFee.md +0 -41
- package/docs/interfaces/Purgatory.md +0 -34
- package/docs/interfaces/RunningPlatform.md +0 -30
- package/docs/interfaces/SearchQuery.md +0 -67
- package/docs/interfaces/Service.md +0 -138
- package/docs/interfaces/ServiceComputeOptions.md +0 -63
- package/docs/interfaces/ServiceEndpoint.md +0 -41
- package/docs/interfaces/Smartcontract-1.md +0 -58
- package/docs/interfaces/Stats.md +0 -47
- package/docs/interfaces/Template.md +0 -30
- package/docs/interfaces/TokenOrder.md +0 -63
- package/docs/interfaces/UrlFile.md +0 -71
- package/docs/interfaces/UserCustomParameters.md +0 -7
- package/docs/interfaces/ValidateMetadata.md +0 -52
- package/docs/modules.md +0 -850
- package/typedoc.json +0 -4
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / ConsumeMarketFee
|
|
2
|
-
|
|
3
|
-
# Interface: ConsumeMarketFee
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [consumeMarketFeeAddress](ConsumeMarketFee.md#consumemarketfeeaddress)
|
|
10
|
-
- [consumeMarketFeeAmount](ConsumeMarketFee.md#consumemarketfeeamount)
|
|
11
|
-
- [consumeMarketFeeToken](ConsumeMarketFee.md#consumemarketfeetoken)
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### consumeMarketFeeAddress
|
|
16
|
-
|
|
17
|
-
• **consumeMarketFeeAddress**: `string`
|
|
18
|
-
|
|
19
|
-
#### Defined in
|
|
20
|
-
|
|
21
|
-
[@types/Datatoken.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L16)
|
|
22
|
-
|
|
23
|
-
___
|
|
24
|
-
|
|
25
|
-
### consumeMarketFeeAmount
|
|
26
|
-
|
|
27
|
-
• **consumeMarketFeeAmount**: `string`
|
|
28
|
-
|
|
29
|
-
#### Defined in
|
|
30
|
-
|
|
31
|
-
[@types/Datatoken.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L18)
|
|
32
|
-
|
|
33
|
-
___
|
|
34
|
-
|
|
35
|
-
### consumeMarketFeeToken
|
|
36
|
-
|
|
37
|
-
• **consumeMarketFeeToken**: `string`
|
|
38
|
-
|
|
39
|
-
#### Defined in
|
|
40
|
-
|
|
41
|
-
[@types/Datatoken.ts:17](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L17)
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Credential
|
|
2
|
-
|
|
3
|
-
# Interface: Credential
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [type](Credential.md#type)
|
|
10
|
-
- [values](Credential.md#values)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### type
|
|
15
|
-
|
|
16
|
-
• **type**: `string`
|
|
17
|
-
|
|
18
|
-
#### Defined in
|
|
19
|
-
|
|
20
|
-
[@types/DDO/Credentials.ts:2](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Credentials.ts#L2)
|
|
21
|
-
|
|
22
|
-
___
|
|
23
|
-
|
|
24
|
-
### values
|
|
25
|
-
|
|
26
|
-
• **values**: `string`[]
|
|
27
|
-
|
|
28
|
-
#### Defined in
|
|
29
|
-
|
|
30
|
-
[@types/DDO/Credentials.ts:3](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Credentials.ts#L3)
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Credentials
|
|
2
|
-
|
|
3
|
-
# Interface: Credentials
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [allow](Credentials.md#allow)
|
|
10
|
-
- [deny](Credentials.md#deny)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### allow
|
|
15
|
-
|
|
16
|
-
• **allow**: [`Credential`](Credential.md)[]
|
|
17
|
-
|
|
18
|
-
#### Defined in
|
|
19
|
-
|
|
20
|
-
[@types/DDO/Credentials.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Credentials.ts#L7)
|
|
21
|
-
|
|
22
|
-
___
|
|
23
|
-
|
|
24
|
-
### deny
|
|
25
|
-
|
|
26
|
-
• **deny**: [`Credential`](Credential.md)[]
|
|
27
|
-
|
|
28
|
-
#### Defined in
|
|
29
|
-
|
|
30
|
-
[@types/DDO/Credentials.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Credentials.ts#L8)
|
package/docs/interfaces/DDO.md
DELETED
|
@@ -1,137 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DDO
|
|
2
|
-
|
|
3
|
-
# Interface: DDO
|
|
4
|
-
|
|
5
|
-
DID Descriptor Object.
|
|
6
|
-
Contains metadata about the asset, and define access in at least one service.
|
|
7
|
-
|
|
8
|
-
## Hierarchy
|
|
9
|
-
|
|
10
|
-
- **`DDO`**
|
|
11
|
-
|
|
12
|
-
↳ [`Asset`](Asset.md)
|
|
13
|
-
|
|
14
|
-
## Table of contents
|
|
15
|
-
|
|
16
|
-
### Properties
|
|
17
|
-
|
|
18
|
-
- [@context](DDO.md#@context)
|
|
19
|
-
- [chainId](DDO.md#chainid)
|
|
20
|
-
- [credentials](DDO.md#credentials)
|
|
21
|
-
- [event](DDO.md#event)
|
|
22
|
-
- [id](DDO.md#id)
|
|
23
|
-
- [metadata](DDO.md#metadata)
|
|
24
|
-
- [nftAddress](DDO.md#nftaddress)
|
|
25
|
-
- [services](DDO.md#services)
|
|
26
|
-
- [version](DDO.md#version)
|
|
27
|
-
|
|
28
|
-
## Properties
|
|
29
|
-
|
|
30
|
-
### @context
|
|
31
|
-
|
|
32
|
-
• **@context**: `string`[]
|
|
33
|
-
|
|
34
|
-
Contexts used for validation.
|
|
35
|
-
|
|
36
|
-
#### Defined in
|
|
37
|
-
|
|
38
|
-
[@types/DDO/DDO.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L12)
|
|
39
|
-
|
|
40
|
-
___
|
|
41
|
-
|
|
42
|
-
### chainId
|
|
43
|
-
|
|
44
|
-
• **chainId**: `number`
|
|
45
|
-
|
|
46
|
-
ChainId of the network the DDO was published to.
|
|
47
|
-
|
|
48
|
-
#### Defined in
|
|
49
|
-
|
|
50
|
-
[@types/DDO/DDO.ts:38](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L38)
|
|
51
|
-
|
|
52
|
-
___
|
|
53
|
-
|
|
54
|
-
### credentials
|
|
55
|
-
|
|
56
|
-
• `Optional` **credentials**: [`Credentials`](Credentials.md)
|
|
57
|
-
|
|
58
|
-
Describes the credentials needed to access a dataset
|
|
59
|
-
in addition to the services definition.
|
|
60
|
-
|
|
61
|
-
#### Defined in
|
|
62
|
-
|
|
63
|
-
[@types/DDO/DDO.ts:57](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L57)
|
|
64
|
-
|
|
65
|
-
___
|
|
66
|
-
|
|
67
|
-
### event
|
|
68
|
-
|
|
69
|
-
• `Optional` **event**: [`Event`](Event.md)
|
|
70
|
-
|
|
71
|
-
Describes the event of last metadata event
|
|
72
|
-
|
|
73
|
-
#### Defined in
|
|
74
|
-
|
|
75
|
-
[@types/DDO/DDO.ts:63](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L63)
|
|
76
|
-
|
|
77
|
-
___
|
|
78
|
-
|
|
79
|
-
### id
|
|
80
|
-
|
|
81
|
-
• **id**: `string`
|
|
82
|
-
|
|
83
|
-
DID, descentralized ID.
|
|
84
|
-
Computed as sha256(address of NFT contract + chainId)
|
|
85
|
-
|
|
86
|
-
#### Defined in
|
|
87
|
-
|
|
88
|
-
[@types/DDO/DDO.ts:19](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L19)
|
|
89
|
-
|
|
90
|
-
___
|
|
91
|
-
|
|
92
|
-
### metadata
|
|
93
|
-
|
|
94
|
-
• **metadata**: [`Metadata`](Metadata.md)
|
|
95
|
-
|
|
96
|
-
Stores an object describing the asset.
|
|
97
|
-
|
|
98
|
-
#### Defined in
|
|
99
|
-
|
|
100
|
-
[@types/DDO/DDO.ts:44](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L44)
|
|
101
|
-
|
|
102
|
-
___
|
|
103
|
-
|
|
104
|
-
### nftAddress
|
|
105
|
-
|
|
106
|
-
• **nftAddress**: `string`
|
|
107
|
-
|
|
108
|
-
NFT contract address
|
|
109
|
-
|
|
110
|
-
#### Defined in
|
|
111
|
-
|
|
112
|
-
[@types/DDO/DDO.ts:32](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L32)
|
|
113
|
-
|
|
114
|
-
___
|
|
115
|
-
|
|
116
|
-
### services
|
|
117
|
-
|
|
118
|
-
• **services**: [`Service`](Service.md)[]
|
|
119
|
-
|
|
120
|
-
Stores an array of services defining access to the asset.
|
|
121
|
-
|
|
122
|
-
#### Defined in
|
|
123
|
-
|
|
124
|
-
[@types/DDO/DDO.ts:50](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L50)
|
|
125
|
-
|
|
126
|
-
___
|
|
127
|
-
|
|
128
|
-
### version
|
|
129
|
-
|
|
130
|
-
• **version**: `string`
|
|
131
|
-
|
|
132
|
-
Version information in SemVer notation
|
|
133
|
-
referring to the DDO spec version
|
|
134
|
-
|
|
135
|
-
#### Defined in
|
|
136
|
-
|
|
137
|
-
[@types/DDO/DDO.ts:26](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/DDO.ts#L26)
|
|
@@ -1,107 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DatatokenCreateParams
|
|
2
|
-
|
|
3
|
-
# Interface: DatatokenCreateParams
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [cap](DatatokenCreateParams.md#cap)
|
|
10
|
-
- [feeAmount](DatatokenCreateParams.md#feeamount)
|
|
11
|
-
- [feeToken](DatatokenCreateParams.md#feetoken)
|
|
12
|
-
- [minter](DatatokenCreateParams.md#minter)
|
|
13
|
-
- [mpFeeAddress](DatatokenCreateParams.md#mpfeeaddress)
|
|
14
|
-
- [name](DatatokenCreateParams.md#name)
|
|
15
|
-
- [paymentCollector](DatatokenCreateParams.md#paymentcollector)
|
|
16
|
-
- [symbol](DatatokenCreateParams.md#symbol)
|
|
17
|
-
- [templateIndex](DatatokenCreateParams.md#templateindex)
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### cap
|
|
22
|
-
|
|
23
|
-
• **cap**: `string`
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[@types/Datatoken.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L10)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### feeAmount
|
|
32
|
-
|
|
33
|
-
• **feeAmount**: `string`
|
|
34
|
-
|
|
35
|
-
#### Defined in
|
|
36
|
-
|
|
37
|
-
[@types/Datatoken.ts:9](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L9)
|
|
38
|
-
|
|
39
|
-
___
|
|
40
|
-
|
|
41
|
-
### feeToken
|
|
42
|
-
|
|
43
|
-
• **feeToken**: `string`
|
|
44
|
-
|
|
45
|
-
#### Defined in
|
|
46
|
-
|
|
47
|
-
[@types/Datatoken.ts:8](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L8)
|
|
48
|
-
|
|
49
|
-
___
|
|
50
|
-
|
|
51
|
-
### minter
|
|
52
|
-
|
|
53
|
-
• **minter**: `string`
|
|
54
|
-
|
|
55
|
-
#### Defined in
|
|
56
|
-
|
|
57
|
-
[@types/Datatoken.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L5)
|
|
58
|
-
|
|
59
|
-
___
|
|
60
|
-
|
|
61
|
-
### mpFeeAddress
|
|
62
|
-
|
|
63
|
-
• **mpFeeAddress**: `string`
|
|
64
|
-
|
|
65
|
-
#### Defined in
|
|
66
|
-
|
|
67
|
-
[@types/Datatoken.ts:7](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L7)
|
|
68
|
-
|
|
69
|
-
___
|
|
70
|
-
|
|
71
|
-
### name
|
|
72
|
-
|
|
73
|
-
• `Optional` **name**: `string`
|
|
74
|
-
|
|
75
|
-
#### Defined in
|
|
76
|
-
|
|
77
|
-
[@types/Datatoken.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L11)
|
|
78
|
-
|
|
79
|
-
___
|
|
80
|
-
|
|
81
|
-
### paymentCollector
|
|
82
|
-
|
|
83
|
-
• **paymentCollector**: `string`
|
|
84
|
-
|
|
85
|
-
#### Defined in
|
|
86
|
-
|
|
87
|
-
[@types/Datatoken.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L6)
|
|
88
|
-
|
|
89
|
-
___
|
|
90
|
-
|
|
91
|
-
### symbol
|
|
92
|
-
|
|
93
|
-
• `Optional` **symbol**: `string`
|
|
94
|
-
|
|
95
|
-
#### Defined in
|
|
96
|
-
|
|
97
|
-
[@types/Datatoken.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L12)
|
|
98
|
-
|
|
99
|
-
___
|
|
100
|
-
|
|
101
|
-
### templateIndex
|
|
102
|
-
|
|
103
|
-
• **templateIndex**: `number`
|
|
104
|
-
|
|
105
|
-
#### Defined in
|
|
106
|
-
|
|
107
|
-
[@types/Datatoken.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L4)
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DatatokenRoles
|
|
2
|
-
|
|
3
|
-
# Interface: DatatokenRoles
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [minter](DatatokenRoles.md#minter)
|
|
10
|
-
- [paymentManager](DatatokenRoles.md#paymentmanager)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### minter
|
|
15
|
-
|
|
16
|
-
• **minter**: `boolean`
|
|
17
|
-
|
|
18
|
-
#### Defined in
|
|
19
|
-
|
|
20
|
-
[@types/Datatoken.ts:28](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L28)
|
|
21
|
-
|
|
22
|
-
___
|
|
23
|
-
|
|
24
|
-
### paymentManager
|
|
25
|
-
|
|
26
|
-
• **paymentManager**: `boolean`
|
|
27
|
-
|
|
28
|
-
#### Defined in
|
|
29
|
-
|
|
30
|
-
[@types/Datatoken.ts:29](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L29)
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DispenserCreationParams
|
|
2
|
-
|
|
3
|
-
# Interface: DispenserCreationParams
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [allowedSwapper](DispenserCreationParams.md#allowedswapper)
|
|
10
|
-
- [dispenserAddress](DispenserCreationParams.md#dispenseraddress)
|
|
11
|
-
- [maxBalance](DispenserCreationParams.md#maxbalance)
|
|
12
|
-
- [maxTokens](DispenserCreationParams.md#maxtokens)
|
|
13
|
-
- [withMint](DispenserCreationParams.md#withmint)
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
### allowedSwapper
|
|
18
|
-
|
|
19
|
-
• `Optional` **allowedSwapper**: `string`
|
|
20
|
-
|
|
21
|
-
#### Defined in
|
|
22
|
-
|
|
23
|
-
[@types/Dispenser.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L6)
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### dispenserAddress
|
|
28
|
-
|
|
29
|
-
• **dispenserAddress**: `string`
|
|
30
|
-
|
|
31
|
-
#### Defined in
|
|
32
|
-
|
|
33
|
-
[@types/Dispenser.ts:2](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L2)
|
|
34
|
-
|
|
35
|
-
___
|
|
36
|
-
|
|
37
|
-
### maxBalance
|
|
38
|
-
|
|
39
|
-
• **maxBalance**: `string`
|
|
40
|
-
|
|
41
|
-
#### Defined in
|
|
42
|
-
|
|
43
|
-
[@types/Dispenser.ts:4](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L4)
|
|
44
|
-
|
|
45
|
-
___
|
|
46
|
-
|
|
47
|
-
### maxTokens
|
|
48
|
-
|
|
49
|
-
• **maxTokens**: `string`
|
|
50
|
-
|
|
51
|
-
#### Defined in
|
|
52
|
-
|
|
53
|
-
[@types/Dispenser.ts:3](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L3)
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
|
|
57
|
-
### withMint
|
|
58
|
-
|
|
59
|
-
• `Optional` **withMint**: `boolean`
|
|
60
|
-
|
|
61
|
-
#### Defined in
|
|
62
|
-
|
|
63
|
-
[@types/Dispenser.ts:5](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L5)
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DispenserParams
|
|
2
|
-
|
|
3
|
-
# Interface: DispenserParams
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [allowedSwapper](DispenserParams.md#allowedswapper)
|
|
10
|
-
- [maxBalance](DispenserParams.md#maxbalance)
|
|
11
|
-
- [maxTokens](DispenserParams.md#maxtokens)
|
|
12
|
-
- [withMint](DispenserParams.md#withmint)
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### allowedSwapper
|
|
17
|
-
|
|
18
|
-
• `Optional` **allowedSwapper**: `string`
|
|
19
|
-
|
|
20
|
-
#### Defined in
|
|
21
|
-
|
|
22
|
-
[@types/Datatoken.ts:43](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L43)
|
|
23
|
-
|
|
24
|
-
___
|
|
25
|
-
|
|
26
|
-
### maxBalance
|
|
27
|
-
|
|
28
|
-
• **maxBalance**: `string`
|
|
29
|
-
|
|
30
|
-
#### Defined in
|
|
31
|
-
|
|
32
|
-
[@types/Datatoken.ts:41](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L41)
|
|
33
|
-
|
|
34
|
-
___
|
|
35
|
-
|
|
36
|
-
### maxTokens
|
|
37
|
-
|
|
38
|
-
• **maxTokens**: `string`
|
|
39
|
-
|
|
40
|
-
#### Defined in
|
|
41
|
-
|
|
42
|
-
[@types/Datatoken.ts:40](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L40)
|
|
43
|
-
|
|
44
|
-
___
|
|
45
|
-
|
|
46
|
-
### withMint
|
|
47
|
-
|
|
48
|
-
• `Optional` **withMint**: `boolean`
|
|
49
|
-
|
|
50
|
-
#### Defined in
|
|
51
|
-
|
|
52
|
-
[@types/Datatoken.ts:42](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Datatoken.ts#L42)
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DispenserToken
|
|
2
|
-
|
|
3
|
-
# Interface: DispenserToken
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [active](DispenserToken.md#active)
|
|
10
|
-
- [allowedSwapper](DispenserToken.md#allowedswapper)
|
|
11
|
-
- [balance](DispenserToken.md#balance)
|
|
12
|
-
- [isMinter](DispenserToken.md#isminter)
|
|
13
|
-
- [maxBalance](DispenserToken.md#maxbalance)
|
|
14
|
-
- [maxTokens](DispenserToken.md#maxtokens)
|
|
15
|
-
- [owner](DispenserToken.md#owner)
|
|
16
|
-
|
|
17
|
-
## Properties
|
|
18
|
-
|
|
19
|
-
### active
|
|
20
|
-
|
|
21
|
-
• **active**: `boolean`
|
|
22
|
-
|
|
23
|
-
#### Defined in
|
|
24
|
-
|
|
25
|
-
[@types/Dispenser.ts:10](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L10)
|
|
26
|
-
|
|
27
|
-
___
|
|
28
|
-
|
|
29
|
-
### allowedSwapper
|
|
30
|
-
|
|
31
|
-
• **allowedSwapper**: `string`
|
|
32
|
-
|
|
33
|
-
#### Defined in
|
|
34
|
-
|
|
35
|
-
[@types/Dispenser.ts:16](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L16)
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
|
-
### balance
|
|
40
|
-
|
|
41
|
-
• **balance**: `string`
|
|
42
|
-
|
|
43
|
-
#### Defined in
|
|
44
|
-
|
|
45
|
-
[@types/Dispenser.ts:14](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L14)
|
|
46
|
-
|
|
47
|
-
___
|
|
48
|
-
|
|
49
|
-
### isMinter
|
|
50
|
-
|
|
51
|
-
• **isMinter**: `boolean`
|
|
52
|
-
|
|
53
|
-
#### Defined in
|
|
54
|
-
|
|
55
|
-
[@types/Dispenser.ts:15](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L15)
|
|
56
|
-
|
|
57
|
-
___
|
|
58
|
-
|
|
59
|
-
### maxBalance
|
|
60
|
-
|
|
61
|
-
• **maxBalance**: `string`
|
|
62
|
-
|
|
63
|
-
#### Defined in
|
|
64
|
-
|
|
65
|
-
[@types/Dispenser.ts:13](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L13)
|
|
66
|
-
|
|
67
|
-
___
|
|
68
|
-
|
|
69
|
-
### maxTokens
|
|
70
|
-
|
|
71
|
-
• **maxTokens**: `string`
|
|
72
|
-
|
|
73
|
-
#### Defined in
|
|
74
|
-
|
|
75
|
-
[@types/Dispenser.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L12)
|
|
76
|
-
|
|
77
|
-
___
|
|
78
|
-
|
|
79
|
-
### owner
|
|
80
|
-
|
|
81
|
-
• **owner**: `string`
|
|
82
|
-
|
|
83
|
-
#### Defined in
|
|
84
|
-
|
|
85
|
-
[@types/Dispenser.ts:11](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/Dispenser.ts#L11)
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / DownloadResponse
|
|
2
|
-
|
|
3
|
-
# Interface: DownloadResponse
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [data](DownloadResponse.md#data)
|
|
10
|
-
- [filename](DownloadResponse.md#filename)
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### data
|
|
15
|
-
|
|
16
|
-
• **data**: `ArrayBuffer`
|
|
17
|
-
|
|
18
|
-
#### Defined in
|
|
19
|
-
|
|
20
|
-
[@types/DownloadResponse.ts:2](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DownloadResponse.ts#L2)
|
|
21
|
-
|
|
22
|
-
___
|
|
23
|
-
|
|
24
|
-
### filename
|
|
25
|
-
|
|
26
|
-
• **filename**: `string`
|
|
27
|
-
|
|
28
|
-
#### Defined in
|
|
29
|
-
|
|
30
|
-
[@types/DownloadResponse.ts:3](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DownloadResponse.ts#L3)
|
package/docs/interfaces/Event.md
DELETED
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / Event
|
|
2
|
-
|
|
3
|
-
# Interface: Event
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [block](Event.md#block)
|
|
10
|
-
- [contract](Event.md#contract)
|
|
11
|
-
- [datetime](Event.md#datetime)
|
|
12
|
-
- [from](Event.md#from)
|
|
13
|
-
- [txid](Event.md#txid)
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
### block
|
|
18
|
-
|
|
19
|
-
• `Optional` **block**: `number`
|
|
20
|
-
|
|
21
|
-
Block of txid
|
|
22
|
-
|
|
23
|
-
#### Defined in
|
|
24
|
-
|
|
25
|
-
[@types/DDO/Event.ts:12](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L12)
|
|
26
|
-
|
|
27
|
-
___
|
|
28
|
-
|
|
29
|
-
### contract
|
|
30
|
-
|
|
31
|
-
• `Optional` **contract**: `string`
|
|
32
|
-
|
|
33
|
-
Contract
|
|
34
|
-
|
|
35
|
-
#### Defined in
|
|
36
|
-
|
|
37
|
-
[@types/DDO/Event.ts:24](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L24)
|
|
38
|
-
|
|
39
|
-
___
|
|
40
|
-
|
|
41
|
-
### datetime
|
|
42
|
-
|
|
43
|
-
• `Optional` **datetime**: `string`
|
|
44
|
-
|
|
45
|
-
datetime of tx
|
|
46
|
-
|
|
47
|
-
#### Defined in
|
|
48
|
-
|
|
49
|
-
[@types/DDO/Event.ts:30](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L30)
|
|
50
|
-
|
|
51
|
-
___
|
|
52
|
-
|
|
53
|
-
### from
|
|
54
|
-
|
|
55
|
-
• `Optional` **from**: `string`
|
|
56
|
-
|
|
57
|
-
Sender of tx
|
|
58
|
-
|
|
59
|
-
#### Defined in
|
|
60
|
-
|
|
61
|
-
[@types/DDO/Event.ts:18](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L18)
|
|
62
|
-
|
|
63
|
-
___
|
|
64
|
-
|
|
65
|
-
### txid
|
|
66
|
-
|
|
67
|
-
• `Optional` **txid**: `string`
|
|
68
|
-
|
|
69
|
-
TX id of the last create/update
|
|
70
|
-
|
|
71
|
-
#### Defined in
|
|
72
|
-
|
|
73
|
-
[@types/DDO/Event.ts:6](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/@types/DDO/Event.ts#L6)
|