@oceanprotocol/lib 3.3.0 → 3.3.1

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.
Files changed (83) hide show
  1. package/.nvmrc +1 -1
  2. package/CHANGELOG.md +19 -16
  3. package/dist/lib.js +1 -1
  4. package/dist/lib.js.map +1 -1
  5. package/dist/lib.modern.js +1 -1
  6. package/dist/lib.modern.js.map +1 -1
  7. package/dist/lib.module.js +1 -1
  8. package/dist/lib.module.js.map +1 -1
  9. package/dist/lib.umd.js +1 -1
  10. package/dist/lib.umd.js.map +1 -1
  11. package/package.json +1 -1
  12. package/dist/src/@types/Asset.d.ts +0 -148
  13. package/dist/src/@types/Compute.d.ts +0 -71
  14. package/dist/src/@types/Contracts.d.ts +0 -26
  15. package/dist/src/@types/DDO/ConsumerParameter.d.ts +0 -37
  16. package/dist/src/@types/DDO/Credentials.d.ts +0 -8
  17. package/dist/src/@types/DDO/DDO.d.ts +0 -55
  18. package/dist/src/@types/DDO/Event.d.ts +0 -27
  19. package/dist/src/@types/DDO/Metadata.d.ts +0 -141
  20. package/dist/src/@types/DDO/Service.d.ts +0 -100
  21. package/dist/src/@types/Datatoken.d.ts +0 -38
  22. package/dist/src/@types/Dispenser.d.ts +0 -16
  23. package/dist/src/@types/DownloadResponse.d.ts +0 -4
  24. package/dist/src/@types/File.d.ts +0 -89
  25. package/dist/src/@types/FileInfo.d.ts +0 -43
  26. package/dist/src/@types/FixedPrice.d.ts +0 -51
  27. package/dist/src/@types/NFT.d.ts +0 -18
  28. package/dist/src/@types/NFTFactory.d.ts +0 -20
  29. package/dist/src/@types/Provider.d.ts +0 -33
  30. package/dist/src/@types/ReturnTypes.d.ts +0 -3
  31. package/dist/src/@types/Router.d.ts +0 -59
  32. package/dist/src/@types/index.d.ts +0 -20
  33. package/dist/src/config/Config.d.ts +0 -153
  34. package/dist/src/config/ConfigHelper.d.ts +0 -12
  35. package/dist/src/config/index.d.ts +0 -2
  36. package/dist/src/contracts/Datatoken.d.ts +0 -278
  37. package/dist/src/contracts/Dispenser.d.ts +0 -73
  38. package/dist/src/contracts/FixedRateExchange.d.ts +0 -209
  39. package/dist/src/contracts/NFT.d.ts +0 -220
  40. package/dist/src/contracts/NFTFactory.d.ts +0 -165
  41. package/dist/src/contracts/Router.d.ts +0 -107
  42. package/dist/src/contracts/SmartContract.d.ts +0 -45
  43. package/dist/src/contracts/SmartContractWithAddress.d.ts +0 -17
  44. package/dist/src/contracts/df/DfRewards.d.ts +0 -31
  45. package/dist/src/contracts/df/DfStrategyV1.d.ts +0 -21
  46. package/dist/src/contracts/index.d.ts +0 -14
  47. package/dist/src/contracts/ve/VeAllocate.d.ts +0 -38
  48. package/dist/src/contracts/ve/VeFeeDistributor.d.ts +0 -29
  49. package/dist/src/contracts/ve/VeFeeEstimate.d.ts +0 -14
  50. package/dist/src/contracts/ve/VeOcean.d.ts +0 -68
  51. package/dist/src/index.d.ts +0 -5
  52. package/dist/src/services/Aquarius.d.ts +0 -53
  53. package/dist/src/services/Provider.d.ts +0 -197
  54. package/dist/src/services/index.d.ts +0 -2
  55. package/dist/src/utils/Constants.d.ts +0 -4
  56. package/dist/src/utils/ContractUtils.d.ts +0 -46
  57. package/dist/src/utils/DatatokenName.d.ts +0 -14
  58. package/dist/src/utils/DdoHelpers.d.ts +0 -13
  59. package/dist/src/utils/FetchHelper.d.ts +0 -14
  60. package/dist/src/utils/General.d.ts +0 -5
  61. package/dist/src/utils/Logger.d.ts +0 -19
  62. package/dist/src/utils/OrderUtils.d.ts +0 -20
  63. package/dist/src/utils/ProviderErrors.d.ts +0 -1
  64. package/dist/src/utils/SignatureUtils.d.ts +0 -12
  65. package/dist/src/utils/TokenUtils.d.ts +0 -70
  66. package/dist/src/utils/index.d.ts +0 -12
  67. package/dist/src/utils/minAbi.d.ts +0 -38
  68. package/dist/test/config.d.ts +0 -19
  69. package/dist/test/integration/CodeExamples.test.d.ts +0 -1
  70. package/dist/test/integration/ComputeExamples.test.d.ts +0 -1
  71. package/dist/test/integration/ComputeFlow.test.d.ts +0 -1
  72. package/dist/test/integration/Provider.test.d.ts +0 -1
  73. package/dist/test/integration/PublishEditConsume.test.d.ts +0 -1
  74. package/dist/test/integration/PublishFlows.test.d.ts +0 -1
  75. package/dist/test/integration/helpers.d.ts +0 -7
  76. package/dist/test/unit/DFRewards.test.d.ts +0 -1
  77. package/dist/test/unit/Datatoken.test.d.ts +0 -1
  78. package/dist/test/unit/Dispenser.test.d.ts +0 -1
  79. package/dist/test/unit/FixedRateExchange.test.d.ts +0 -1
  80. package/dist/test/unit/Nft.test.d.ts +0 -1
  81. package/dist/test/unit/NftFactory.test.d.ts +0 -1
  82. package/dist/test/unit/Router.test.d.ts +0 -1
  83. package/dist/test/unit/veOcean.test.d.ts +0 -1
@@ -1,89 +0,0 @@
1
- import { AbiItem } from './Contracts';
2
- interface FileTypeHeaders {
3
- [key: string]: string;
4
- }
5
- export interface UrlFile {
6
- type: 'url';
7
- /**
8
- * File index.
9
- * @type {number}
10
- */
11
- index?: number;
12
- /**
13
- * File URL.
14
- * @type {string}
15
- */
16
- url: string;
17
- /**
18
- * HTTP method used
19
- * @type {string}
20
- */
21
- method: string;
22
- /**
23
- * Headers key value pairs associated with the asset GET request
24
- * @type {string}
25
- */
26
- headers?: FileTypeHeaders;
27
- }
28
- export interface GraphqlQuery {
29
- type: 'graphql';
30
- /**
31
- * @type {number}
32
- */
33
- index?: number;
34
- /**
35
- * Endpoint URL
36
- * @type {string}
37
- */
38
- url: string;
39
- /**
40
- * query
41
- * @type {string}
42
- */
43
- query: string;
44
- /**
45
- * Headers key value pairs associated with the asset GET request
46
- * @type {string}
47
- */
48
- headers?: FileTypeHeaders;
49
- }
50
- export interface Arweave {
51
- type: 'arweave';
52
- /**
53
- * transactionId
54
- * @type {string}
55
- */
56
- transactionId: string;
57
- }
58
- export interface Ipfs {
59
- type: 'ipfs';
60
- /**
61
- * hash
62
- * @type {string}
63
- */
64
- hash: string;
65
- }
66
- export interface Smartcontract {
67
- type: 'smartcontract';
68
- /**
69
- * Smartcontract address
70
- * @type {string}
71
- */
72
- address: string;
73
- /**
74
- * ChainId
75
- * @type {number}
76
- */
77
- chainId: number;
78
- /**
79
- * Function ABI (not the entire smartcontract abi)
80
- * @type {AbiItem}
81
- */
82
- abi: AbiItem;
83
- }
84
- export interface Files {
85
- nftAddress: string;
86
- datatokenAddress: string;
87
- files: UrlFile[] | GraphqlQuery[] | Arweave[] | Smartcontract[] | Ipfs[];
88
- }
89
- export {};
@@ -1,43 +0,0 @@
1
- export interface FileInfo {
2
- /**
3
- * File URL.
4
- * @type {string}
5
- */
6
- type: string;
7
- /**
8
- * File format, if applicable.
9
- * @type {string}
10
- * @example "text/csv"
11
- */
12
- contentType?: string;
13
- /**
14
- * File content length.
15
- * @type {[type]}
16
- */
17
- contentLength?: string;
18
- /**
19
- * File index.
20
- * @type {number}
21
- */
22
- index?: number;
23
- /**
24
- * File URL.
25
- * @type {string}
26
- */
27
- url?: string;
28
- /**
29
- * HTTP method used
30
- * @type {string}
31
- */
32
- method?: string;
33
- /**
34
- * Computed file checksum
35
- * @type {string}
36
- */
37
- checksum?: string;
38
- /**
39
- * check if file exists
40
- * @type {boolean}
41
- */
42
- valid?: boolean;
43
- }
@@ -1,51 +0,0 @@
1
- export interface FreCreationParams {
2
- fixedRateAddress: string;
3
- baseTokenAddress: string;
4
- owner: string;
5
- marketFeeCollector: string;
6
- baseTokenDecimals: number;
7
- datatokenDecimals: number;
8
- fixedRate: string;
9
- marketFee: string;
10
- withMint?: boolean;
11
- allowedConsumer?: string;
12
- }
13
- export interface FreOrderParams {
14
- exchangeContract: string;
15
- exchangeId: string;
16
- maxBaseTokenAmount: string;
17
- baseTokenAddress: string;
18
- baseTokenDecimals?: number;
19
- swapMarketFee: string;
20
- marketFeeAddress: string;
21
- }
22
- export interface PriceAndFees {
23
- baseTokenAmount: string;
24
- oceanFeeAmount: string;
25
- marketFeeAmount: string;
26
- consumeMarketFeeAmount: string;
27
- }
28
- export interface FixedPriceExchange {
29
- active: boolean;
30
- exchangeOwner: string;
31
- datatoken: string;
32
- baseToken: string;
33
- fixedRate: string;
34
- dtDecimals: string;
35
- btDecimals: string;
36
- dtBalance: string;
37
- btBalance: string;
38
- dtSupply: string;
39
- btSupply: string;
40
- withMint: boolean;
41
- allowedSwapper: string;
42
- exchangeId?: string;
43
- }
44
- export interface FeesInfo {
45
- opcFee: string;
46
- marketFee: string;
47
- marketFeeCollector: string;
48
- marketFeeAvailable: string;
49
- oceanFeeAvailable: string;
50
- exchangeId: string;
51
- }
@@ -1,18 +0,0 @@
1
- import { MetadataProof } from '.';
2
- export interface MetadataAndTokenURI {
3
- metaDataState: number;
4
- metaDataDecryptorUrl: string;
5
- metaDataDecryptorAddress: string;
6
- flags: string;
7
- data: string;
8
- metaDataHash: string;
9
- tokenId: number;
10
- tokenURI: string;
11
- metadataProofs?: MetadataProof[];
12
- }
13
- export interface NftRoles {
14
- manager: boolean;
15
- deployERC20: boolean;
16
- updateMetadata: boolean;
17
- store: boolean;
18
- }
@@ -1,20 +0,0 @@
1
- import { ConsumeMarketFee, ProviderFees } from '.';
2
- export interface Template {
3
- templateAddress: string;
4
- isActive: boolean;
5
- }
6
- export interface TokenOrder {
7
- tokenAddress: string;
8
- consumer: string;
9
- serviceIndex: number;
10
- _providerFee: ProviderFees;
11
- _consumeMarketFee: ConsumeMarketFee;
12
- }
13
- export interface NftCreateData {
14
- name: string;
15
- symbol: string;
16
- templateIndex: number;
17
- tokenURI: string;
18
- transferable: boolean;
19
- owner: string;
20
- }
@@ -1,33 +0,0 @@
1
- export interface ProviderFees {
2
- providerFeeAddress: string;
3
- providerFeeToken: string;
4
- providerFeeAmount: string;
5
- v: string;
6
- r: string;
7
- s: string;
8
- providerData: string;
9
- validUntil: string;
10
- }
11
- export interface ProviderInitialize {
12
- datatoken: string;
13
- nonce: string;
14
- computeAddress: string;
15
- providerFee: ProviderFees;
16
- }
17
- export interface ProviderComputeInitialize {
18
- datatoken?: string;
19
- validOrder?: string;
20
- providerFee?: ProviderFees;
21
- }
22
- export interface ProviderComputeInitializeResults {
23
- algorithm?: ProviderComputeInitialize;
24
- datasets?: ProviderComputeInitialize[];
25
- }
26
- export interface ServiceEndpoint {
27
- serviceName: string;
28
- method: string;
29
- urlPath: string;
30
- }
31
- export interface UserCustomParameters {
32
- [key: string]: any;
33
- }
@@ -1,3 +0,0 @@
1
- import { BigNumber, providers } from 'ethers';
2
- export type ReceiptOrEstimate<G extends boolean = false> = G extends false ? providers.TransactionResponse : BigNumber;
3
- export type ReceiptOrDecimal<G extends boolean = false> = G extends false ? providers.TransactionResponse : number;
@@ -1,59 +0,0 @@
1
- export interface Operation {
2
- /**
3
- * used for FixedRate or Dispenser
4
- * @type {string}
5
- */
6
- exchangeIds: string;
7
- /**
8
- * pool Address
9
- * @type {string}
10
- */
11
- source: string;
12
- /**
13
- * operation:
14
- * 0 - swapExactAmountIn
15
- * 1 - swapExactAmountOut
16
- * 2 - FixedRateExchange
17
- * 3 - Dispenser
18
- * @type {number}
19
- */
20
- operation: number;
21
- /**
22
- * token in address
23
- * @type {string}
24
- */
25
- tokenIn: string;
26
- /**
27
- * when swapExactAmountIn is EXACT amount IN
28
- * expressed in Wei
29
- * @type {string | number}
30
- */
31
- amountsIn: string | number;
32
- /**
33
- * token out address
34
- * @type {string}
35
- */
36
- tokenOut: string;
37
- /**
38
- * when swapExactAmountIn is MIN amount OUT
39
- * expressed in Wei
40
- * @type {string | number}
41
- */
42
- amountsOut: string | number;
43
- /**
44
- * max price (only for pools)
45
- * expressed in Wei
46
- * @type {string | number}
47
- */
48
- maxPrice: string | number;
49
- /**
50
- * swap fee amount
51
- * @type {string}
52
- */
53
- swapMarketFee: string;
54
- /**
55
- * market fee address to receive fees
56
- * @type {string}
57
- */
58
- marketFeeAddress: string;
59
- }
@@ -1,20 +0,0 @@
1
- export * from './DDO/Credentials';
2
- export * from './DDO/DDO';
3
- export * from './DDO/Event';
4
- export * from './DDO/Metadata';
5
- export * from './DDO/ConsumerParameter';
6
- export * from './DDO/Service';
7
- export * from './Asset';
8
- export * from './Contracts';
9
- export * from './File';
10
- export * from './FileInfo';
11
- export * from './Compute';
12
- export * from './Datatoken';
13
- export * from './Dispenser';
14
- export * from './DownloadResponse';
15
- export * from './FixedPrice';
16
- export * from './NFT';
17
- export * from './NFTFactory';
18
- export * from './Provider';
19
- export * from './Router';
20
- export * from './ReturnTypes';
@@ -1,153 +0,0 @@
1
- import { AbiItem } from '../@types';
2
- import { LogLevel } from '../utils';
3
- export declare class Config {
4
- /**
5
- * Ethereum node URL.
6
- * @type {string}
7
- */
8
- nodeUri?: string;
9
- /**
10
- * Address of Provider.
11
- * @type {string}
12
- */
13
- providerAddress?: string;
14
- /**
15
- * Metadata Store URL.
16
- * @type {string}
17
- */
18
- metadataCacheUri?: string;
19
- /**
20
- * Provider URL.
21
- * @type {string}
22
- */
23
- providerUri?: string;
24
- /**
25
- * Web3 Provider.
26
- * @type {any}
27
- */
28
- web3Provider?: any;
29
- /**
30
- * Ocean Token address
31
- * @type {string}
32
- */
33
- oceanTokenAddress?: string;
34
- /**
35
- * Factory address
36
- * @type {string}
37
- */
38
- nftFactoryAddress?: string;
39
- /**
40
- * datatokens ABI
41
- * @type {string}
42
- */
43
- datatokensABI?: AbiItem | AbiItem[];
44
- /**
45
- * FixedRateExchangeAddress
46
- * @type {string}
47
- */
48
- fixedRateExchangeAddress?: string;
49
- /**
50
- * FixedRateExchangeAddressABI
51
- * @type {any}
52
- */
53
- fixedRateExchangeAddressABI?: AbiItem | AbiItem[];
54
- /**
55
- * DispenserAddress
56
- * @type {string}
57
- */
58
- dispenserAddress?: string;
59
- /**
60
- * DispenserABI
61
- * @type {any}
62
- */
63
- dispenserABI?: AbiItem | AbiItem[];
64
- /**
65
- * OPFCommunityFeeCollector
66
- * @type {string}
67
- */
68
- opfCommunityFeeCollector?: string;
69
- /**
70
- * SideStaking address
71
- * @type {string}
72
- */
73
- sideStakingAddress?: string;
74
- /**
75
- * block number of the deployment
76
- * @type {number}
77
- */
78
- startBlock?: number;
79
- /**
80
- * Log level.
81
- * @type {boolean | LogLevel}
82
- */
83
- verbose?: boolean | LogLevel;
84
- /**
85
- * Message shown when the user creates its own token.
86
- * @type {string}
87
- */
88
- authMessage?: string;
89
- /**
90
- * Token expiration time in ms.
91
- * @type {number}
92
- */
93
- authTokenExpiration?: number;
94
- /**
95
- * Parity config
96
- * @type {string}
97
- */
98
- parityUri?: string;
99
- threshold?: number;
100
- /**
101
- * Chain ID
102
- * @type {number}
103
- */
104
- chainId: number;
105
- /**
106
- * Network name ex: mainnet, goerli, polygon
107
- * @type {string}
108
- */
109
- network: string;
110
- /**
111
- * Url of the relevant subgraph instance ex: https://subgraph.mainnet.oceanprotocol.com
112
- * @type {string}
113
- */
114
- subgraphUri: string;
115
- /**
116
- * Url of the blockchain exporer ex: https://etherscan.io
117
- * @type {string}
118
- */
119
- explorerUri: string;
120
- /**
121
- * Ocean toke symbol on the chain, it's used just for convenience to reduce number of calls
122
- * @type {string}
123
- */
124
- oceanTokenSymbol: string;
125
- /**
126
- * Specify the transaction Block Timeout
127
- * @type {number}
128
- */
129
- transactionBlockTimeout: number;
130
- /**
131
- * Specify the transaction Confirmation Blocks
132
- * @type {number}
133
- */
134
- transactionConfirmationBlocks: number;
135
- /**
136
- * Specify the transaction Polling Blocks Timeout
137
- * @type {number}
138
- */
139
- transactionPollingTimeout: number;
140
- /**
141
- * Specify the multiplier for the gas fee
142
- * @type {number}
143
- */
144
- gasFeeMultiplier: number;
145
- veAllocate?: string;
146
- veOCEAN?: string;
147
- veDelegation?: string;
148
- veFeeDistributor?: string;
149
- veDelegationProxy?: string;
150
- DFRewards?: string;
151
- DFStrategyV1?: string;
152
- veFeeEstimate?: string;
153
- }
@@ -1,12 +0,0 @@
1
- import { Config } from '.';
2
- export declare const configHelperNetworks: Config[];
3
- export declare class ConfigHelper {
4
- getAddressesFromEnv(network: string, customAddresses?: any): Partial<Config>;
5
- /**
6
- * Returns the config object for a specific network supported by the oceanprotocol stack
7
- * @param {string | number} network the network's chainId or name
8
- * @param {string} infuraProjectId optional infura project id that will replace the configs node URI
9
- * @return {Config} Config obhjedct
10
- */
11
- getConfig(network: string | number, infuraProjectId?: string): Config;
12
- }
@@ -1,2 +0,0 @@
1
- export * from './Config';
2
- export * from './ConfigHelper';