@oceanprotocol/lib 5.0.4 → 5.0.5

package/dist/types/config/Config.d.ts

@@ -67,6 +67,11 @@ export declare class Config {
      * @type {string}
      */
     opfCommunityFeeCollector?: string;
+    /**
+     * OPFCommunityFeeCollector
+     * @type {string}
+     */
+    EnterpriseFeeCollector?: string;
     /**
      * SideStaking address
      * @type {string}
@@ -148,5 +153,6 @@ export declare class Config {
     veFeeEstimate?: string;
     sdk?: SDK;
     accessListFactory?: string;
+    escrow?: string;
 }
 export {};

package/dist/types/contracts/EnterpriseFeeCollector.d.ts

@@ -0,0 +1,33 @@
+import { Signer } from 'ethers';
+import { AbiItem } from '../@types';
+import { Config } from '../config';
+import { SmartContractWithAddress } from './SmartContractWithAddress';
+export declare class EnterpriseFeeCollectorContract extends SmartContractWithAddress {
+    getDefaultAbi(): AbiItem[];
+    /**
+     * Instantiate EnterpriseFeeCollectorContract class
+     * @param {string} address The contract address.
+     * @param {Signer} signer The signer object.
+     * @param {string | number} [network] Network id or name
+     * @param {Config} [config] The configuration object.
+     * @param {AbiItem[]} [abi] ABI array of the smart contract
+     */
+    constructor(address: string, signer: Signer, network?: string | number, config?: Config, abi?: AbiItem[]);
+    /**
+     * Check if token is allowed
+     * @return {Promise<any>} Boolean indicating if token is allowed
+     */
+    isTokenAllowed(token: string): Promise<boolean>;
+    /**
+     * Get Token details
+     * @return {Promise<any>} Token details
+     */
+    getToken(token: string): Promise<any>;
+    /**
+     * Calculate fee
+     * @param {string} token Token address
+     * @param {string} amount Amount
+     * @return {Promise<string>} Fee amount
+     */
+    calculateFee(token: string, amount: number): Promise<any>;
+}

package/dist/types/contracts/index.d.ts

@@ -19,3 +19,4 @@ export * from './Datatoken4.js';
 export * from './AccessList.js';
 export * from './AccessListFactory.js';
 export * from './Escrow.js';
+export * from './EnterpriseFeeCollector.js';

package/dist/types/services/Provider.d.ts

@@ -156,10 +156,11 @@ export declare class Provider {
      * @param {ComputeOutput} output The compute job output settings.
      * @param {any} policyServer Policy server data.
      * @param {AbortSignal} signal abort signal
+     * @param {number} queueMaxWaitTime Maximum time in seconds to wait in the compute queue if resources are not available
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
     computeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, maxJobDuration: number, token: string, resources: ComputeResourceRequest[], chainId: number, // network used by payment (only for payed compute jobs)
-    metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number): Promise<ComputeJob | ComputeJob[]>;
     /** Instruct the provider to start a FREE compute job (new C2D V2)
      * @param {string} providerUri The provider URI.
      * @param {SignerOrAuthToken} signerOrAuthToken The consumer signer object or auth token.
@@ -171,9 +172,10 @@ export declare class Provider {
      * @param {ComputeOutput} output The compute job output settings.
      * @param {any} policyServer Policy server data.
      * @param {AbortSignal} signal abort signal
+     * @param {number} queueMaxWaitTime Maximum time in seconds to wait in the compute queue if resources are not available
      * @return {Promise<ComputeJob | ComputeJob[]>} The compute job or jobs.
      */
-    freeComputeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal): Promise<ComputeJob | ComputeJob[]>;
+    freeComputeStart(providerUri: string, signerOrAuthToken: Signer | string, computeEnv: string, datasets: ComputeAsset[], algorithm: ComputeAlgorithm, resources?: ComputeResourceRequest[], metadata?: ComputeJobMetadata, additionalViewers?: string[], output?: ComputeOutput, policyServer?: any, signal?: AbortSignal, queueMaxWaitTime?: number): Promise<ComputeJob | ComputeJob[]>;
     /**
      *
      * @param providerUri provider URL

package/dist/types/utils/index.d.ts

@@ -11,3 +11,4 @@ export * from './TokenUtils.js';
 export * from './ProviderErrors.js';
 export * from './OrderUtils.js';
 export * from './Assets.js';
+export * from './Addresses.js';

package/docs/README.md

@@ -15,9 +15,12 @@
 
 With ocean.js, you can:
 
-- **Publish** data services: downloadable files or compute-to-data. Create an ERC721 **data NFT** for each service, and ERC20 **datatoken** for access (1.0 datatokens to access).
-- **Sell** datatokens for a fixed price. Sell data NFTs.
-- **Transfer** data NFTs & datatokens to another owner, and **all other ERC721 & ERC20 actions** using [web3.js](https://web3js.readthedocs.io/en/v1.2.9/web3-eth-contract.html) etc.
+- **Publish** data services: downloadable files or compute-to-data (C2D). Create an ERC721 **data NFT** for each service, and ERC20 **datatoken** for access (1.0 datatokens to access).
+- **Consume** data: download files or run compute-to-data jobs on datasets while preserving data privacy.
+- **Sell** datatokens via fixed-rate exchanges or dispense them for free.
+- **Manage pricing**: create fixed-rate exchanges, dispensers, or use dynamic pricing mechanisms for your assets.
+- **Compute-to-Data**: run algorithms on the ocean network.
+- **Transfer** data NFTs & datatokens to another owner, and **all other ERC721 & ERC20 actions** using ethers.js.
 
 ocean.js is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.
 
@@ -48,7 +51,7 @@ This is in alpha state. If you run into problems, please open up a [new issue](h
 npm install @oceanprotocol/lib
 ```
 
-- Checkout our [code examples](CodeExamples.md) or [compute to data examples](C2DExamples.md) to see how you can use ocean.js.
+- Checkout our [code examples](CodeExamples.md), [compute-to-data examples](ComputeExamples.md), or [quick reference cheatsheet](Cheatsheet.md) to see how you can use ocean.js.
 - Refer to the [Ocean Protocol documentation](https://docs.oceanprotocol.com/) for more guides and tutorials.
 - Visit the [Ocean Protocol website](https://docs.oceanprotocol.com/) for general information about Ocean Protocol.
 - If you have any difficulties or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5).
@@ -81,13 +84,13 @@ npm run format
 
 Test suite for unit & integration tests is setup with [Mocha](https://mochajs.org) as test runner, and [nyc](https://github.com/istanbuljs/nyc) for coverage reporting. A combined coverage report is sent to CodeClimate via the `coverage` GitHub Actions job.
 
-Running all tests requires running Ocean Protocol components beforehand with [Barge](https://github.com/oceanprotocol/barge), which also runs a `ganache-cli` instance:
+Running all tests requires running Ocean Protocol components beforehand with [Barge](https://github.com/oceanprotocol/barge), which also runs a local blockchain instance:
 
 ```bash
 git clone https://github.com/oceanprotocol/barge
 cd barge
 
-./start_ocean.sh --with-provider2 --no-dashboard --with-c2d
+./start_ocean.sh
 ```
 
 You can then proceed to run in another terminal.
@@ -176,7 +179,7 @@ Further releases afterwards can be done with `npm run release` again and selecti
 ## 🏛 License
 
 ```
-Copyright ((C)) 2023 Ocean Protocol Foundation
+Copyright ((C)) 2025 Ocean Protocol Foundation
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/docs/classes/Escrow.md

@@ -0,0 +1,285 @@
+[@oceanprotocol/lib](../README.md) / [Exports](../modules.md) / EscrowContract
+
+# Class: EscrowContract
+
+Manages escrow payments for C2D jobs - handles deposits, locks, and authorizations.
+
+## Hierarchy
+
+- [`SmartContractWithAddress`](SmartContractWithAddress.md)
+
+  ↳ **`EscrowContract`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Escrow.md#constructor)
+
+### Methods
+
+- [getFunds](Escrow.md#getfunds)
+- [getUserFunds](Escrow.md#getuserfunds)
+- [getUserTokens](Escrow.md#getusertokens)
+- [getLocks](Escrow.md#getlocks)
+- [getAuthorizations](Escrow.md#getauthorizations)
+- [verifyFundsForEscrowPayment](Escrow.md#verifyfundsforescrowpayment)
+- [deposit](Escrow.md#deposit)
+- [withdraw](Escrow.md#withdraw)
+- [authorize](Escrow.md#authorize)
+
+## Constructors
+
+### constructor
+
+• **new EscrowContract**(`address`, `signer`, `network?`, `config?`, `abi?`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `string` |
+| `signer` | `Signer` |
+| `network?` | `string` \| `number` |
+| `config?` | [`Config`](Config.md) |
+| `abi?` | [`AbiItem`](../interfaces/AbiItem.md)[] |
+
+#### Inherited from
+
+[SmartContractWithAddress](SmartContractWithAddress.md).[constructor](SmartContractWithAddress.md#constructor)
+
+#### Defined in
+
+[contracts/Escrow.ts:26](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L26)
+
+## Methods
+
+### getFunds
+
+▸ **getFunds**(`token`): `Promise`<`{available: bigint, locked: bigint}`\>
+
+Get total funds in escrow for a token
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `token` | `string` | token address |
+
+#### Returns
+
+`Promise`<`{available: bigint, locked: bigint}`\>
+
+Object with `available` and `locked` amounts
+
+#### Defined in
+
+[contracts/Escrow.ts:41](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L41)
+
+___
+
+### getUserFunds
+
+▸ **getUserFunds**(`payer`, `token`): `Promise`<`{available: bigint, locked: bigint}`\>
+
+Get user's available escrow balance
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `payer` | `string` | user address |
+| `token` | `string` | token address |
+
+#### Returns
+
+`Promise`<`{available: bigint, locked: bigint}`\>
+
+Object with `available` and `locked` amounts for this user/token pair
+
+#### Defined in
+
+[contracts/Escrow.ts:49](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L49)
+
+___
+
+### getUserTokens
+
+▸ **getUserTokens**(`payer`): `Promise`<`string[]`\>
+
+Get list of tokens user has deposited
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `payer` | `string` | user address |
+
+#### Returns
+
+`Promise`<`string[]`\>
+
+Array of token addresses this user has deposited
+
+#### Defined in
+
+[contracts/Escrow.ts:57](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L57)
+
+___
+
+### getLocks
+
+▸ **getLocks**(`token`, `payer`, `payee`): `Promise`<`Lock[]`\>
+
+Get active payment locks
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `token` | `string` | token address |
+| `payer` | `string` | payer address |
+| `payee` | `string` | payee address |
+
+#### Returns
+
+`Promise`<`Lock[]`\>
+
+Array of locks where each lock contains: `{jobId, payer, payee, amount, expiry, token}`
+
+#### Defined in
+
+[contracts/Escrow.ts:65](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L65)
+
+___
+
+### getAuthorizations
+
+▸ **getAuthorizations**(`token`, `payer`, `payee`): `Promise`<`Authorization[]`\>
+
+Get payment authorizations
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `token` | `string` | token address |
+| `payer` | `string` | payer address |
+| `payee` | `string` | payee address |
+
+#### Returns
+
+`Promise`<`Authorization[]`\>
+
+Array of authorizations where each contains: `{payee, maxLockedAmount, currentLockedAmount, maxLockSeconds, maxLockCounts, currentLocks}`
+
+#### Defined in
+
+[contracts/Escrow.ts:73](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L73)
+
+___
+
+### verifyFundsForEscrowPayment
+
+▸ **verifyFundsForEscrowPayment**(`token`, `consumerAddress`, `amountToDeposit?`, `maxLockedAmount?`, `maxLockSeconds?`, `maxLockCounts?`): `Promise`<`ValidationResponse`\>
+
+Checks if you have enough funds, authorizes and deposits if needed - all in one call
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `token` | `string` | payment token |
+| `consumerAddress` | `string` | compute environment consumer address |
+| `amountToDeposit?` | `string` | how much to deposit (optional) |
+| `maxLockedAmount?` | `string` | max amount for compute job |
+| `maxLockSeconds?` | `string` | max lock duration |
+| `maxLockCounts?` | `string` | max number of locks |
+
+#### Returns
+
+`Promise`<`ValidationResponse`\>
+
+validation status
+
+#### Defined in
+
+[contracts/Escrow.ts:98](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L98)
+
+___
+
+### deposit
+
+▸ **deposit**<`G`\>(`token`, `amount`, `estimateGas?`): `Promise`<`ReceiptOrEstimate`<`G`\>\>
+
+Deposit tokens into escrow
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `token` | `string` |
+| `amount` | `string` |
+| `estimateGas?` | `G` |
+
+#### Returns
+
+`Promise`<`ReceiptOrEstimate`<`G`\>\>
+
+#### Defined in
+
+[contracts/Escrow.ts:191](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L191)
+
+___
+
+### withdraw
+
+▸ **withdraw**<`G`\>(`tokens`, `amounts`, `estimateGas?`): `Promise`<`ReceiptOrEstimate`<`G`\>\>
+
+Withdraw tokens from escrow
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `tokens` | `string[]` | array of token addresses |
+| `amounts` | `string[]` | array of amounts to withdraw |
+| `estimateGas?` | `G` | - |
+
+#### Returns
+
+`Promise`<`ReceiptOrEstimate`<`G`\>\>
+
+#### Defined in
+
+[contracts/Escrow.ts:217](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L217)
+
+___
+
+### authorize
+
+▸ **authorize**<`G`\>(`token`, `payee`, `maxLockedAmount`, `maxLockSeconds`, `maxLockCounts`, `estimateGas?`): `Promise`<`ReceiptOrEstimate`<`G`\>\>
+
+Authorize someone to lock your funds
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `token` | `string` |
+| `payee` | `string` |
+| `maxLockedAmount` | `string` |
+| `maxLockSeconds` | `string` |
+| `maxLockCounts` | `string` |
+| `estimateGas?` | `G` |
+
+#### Returns
+
+`Promise`<`ReceiptOrEstimate`<`G`\>\>
+
+#### Defined in
+
+[contracts/Escrow.ts:274](https://github.com/oceanprotocol/ocean.js/blob/main/src/contracts/Escrow.ts#L274)
+
+___
+

package/docs/classes/Provider.md

@@ -15,6 +15,8 @@
 - [computeStart](Provider.md#computestart)
 - [computeStatus](Provider.md#computestatus)
 - [computeStop](Provider.md#computestop)
+- [freeComputeStart](Provider.md#freecomputestart)
+- [getComputeStartRoutes](Provider.md#getcomputestartroutes)
 - [encrypt](Provider.md#encrypt)
 - [getComputeEnvironments](Provider.md#getcomputeenvironments)
 - [getComputeResultUrl](Provider.md#getcomputeresulturl)
@@ -97,24 +99,28 @@ ___
 
 ### computeStart
 
-▸ **computeStart**(`providerUri`, `signer`, `computeEnv`, `datasets`, `algorithm`, `resources`, `chainId`, `output?`, `freeEnvironment`, `signal?`): `Promise`<[`ComputeJob`](../interfaces/ComputeJob.md) \| [`ComputeJob`](../interfaces/ComputeJob.md)[]\>
+▸ **computeStart**(`providerUri`, `signerOrAuthToken`, `computeEnv`, `datasets`, `algorithm`, `maxJobDuration`, `token`, `resources`, `chainId`, `metadata?`, `additionalViewers?`, `output?`, `policyServer?`, `signal?`): `Promise`<[`ComputeJob`](../interfaces/ComputeJob.md) \| [`ComputeJob`](../interfaces/ComputeJob.md)[]\>
 
-Instruct the provider to start a compute job
+Instruct the provider to start a PAID compute job (C2D V2)
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `providerUri` | `string` | The provider URI. |
-| `signer` | `Signer` | - | The consumer signer/account
-| `computeEnv` | `string` | The compute environment. |
-| `datasets` | [`ComputeAsset`](../interfaces/ComputeAsset.md) | The dataset to start compute on |
+| `signerOrAuthToken` | `Signer` \| `string` | The consumer signer object or auth token |
+| `computeEnv` | `string` | The compute environment ID. |
+| `datasets` | [`ComputeAsset`](../interfaces/ComputeAsset.md)[] | The datasets to start compute on (including additional datasets) |
 | `algorithm` | [`ComputeAlgorithm`](../interfaces/ComputeAlgorithm.md) | The algorithm to start compute with. |
-| `resources` | [`ComputeResourceRequest`](../interfaces/ComputeResourcesRequest.md) | The resources to start compute with. |
-| `chainId?` | [`number`] | The network for the payments |
+| `maxJobDuration` | `number` | The compute job max execution time. |
+| `token` | `string` | The token address for compute payment. |
+| `resources` | [`ComputeResourceRequest`](../interfaces/ComputeResourcesRequest.md)[] | The resources to start compute job with. |
+| `chainId` | `number` | The chain ID used for payments |
+| `metadata?` | `ComputeJobMetadata` | Additional metadata to be stored in the database. |
+| `additionalViewers?` | `string[]` | Additional addresses that can view the compute job results. |
 | `output?` | [`ComputeOutput`](../interfaces/ComputeOutput.md) | The compute job output settings. |
-| `signal?` | `AbortSignal` | abort signal |
-
+| `policyServer?` | `any` | Policy server data. |
+| `signal?` | `AbortSignal` | Abort signal |
 
 #### Returns
 
@@ -124,7 +130,7 @@ The compute job or jobs.
 
 #### Defined in
 
-[services/Provider.ts:516](https://github.com/oceanprotocol/ocean.js/blob/c99bc5c6/src/services/Provider.ts#L516)
+[services/Provider.ts:772](https://github.com/oceanprotocol/ocean.js/blob/main/src/services/Provider.ts#L772)
 
 ___
 
@@ -182,6 +188,65 @@ Instruct the provider to Stop the execution of a to stop a compute job.
 
 ___
 
+### freeComputeStart
+
+▸ **freeComputeStart**(`providerUri`, `signerOrAuthToken`, `computeEnv`, `datasets`, `algorithm`, `resources?`, `metadata?`, `additionalViewers?`, `output?`, `policyServer?`, `signal?`): `Promise`<[`ComputeJob`](../interfaces/ComputeJob.md) \| [`ComputeJob`](../interfaces/ComputeJob.md)[]\>
+
+Instruct the provider to start a FREE compute job (C2D V2)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `providerUri` | `string` | The provider URI. |
+| `signerOrAuthToken` | `Signer` \| `string` | The consumer signer object or auth token |
+| `computeEnv` | `string` | The compute environment ID. |
+| `datasets` | [`ComputeAsset`](../interfaces/ComputeAsset.md)[] | The datasets to start compute on (including additional datasets) |
+| `algorithm` | [`ComputeAlgorithm`](../interfaces/ComputeAlgorithm.md) | The algorithm to start compute with. |
+| `resources?` | [`ComputeResourceRequest`](../interfaces/ComputeResourcesRequest.md)[] | The resources to start compute job with. |
+| `metadata?` | `ComputeJobMetadata` | Additional metadata to be stored in the database. |
+| `additionalViewers?` | `string[]` | Additional addresses that can view the compute job results. |
+| `output?` | [`ComputeOutput`](../interfaces/ComputeOutput.md) | The compute job output settings. |
+| `policyServer?` | `any` | Policy server data. |
+| `signal?` | `AbortSignal` | Abort signal |
+
+#### Returns
+
+`Promise`<[`ComputeJob`](../interfaces/ComputeJob.md) \| [`ComputeJob`](../interfaces/ComputeJob.md)[]\>
+
+The compute job or jobs.
+
+#### Defined in
+
+[services/Provider.ts:892](https://github.com/oceanprotocol/ocean.js/blob/main/src/services/Provider.ts#L892)
+
+___
+
+### getComputeStartRoutes
+
+▸ **getComputeStartRoutes**(`providerUri`, `isFreeCompute?`): `Promise`<`string` \| `null`\>
+
+Get the compute start route path for either free or paid compute
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `providerUri` | `string` | `undefined` | The provider URI. |
+| `isFreeCompute` | `boolean` | `false` | Whether to get the free compute route (true) or paid compute route (false). |
+
+#### Returns
+
+`Promise`<`string` \| `null`\>
+
+The compute start route path or null if not available.
+
+#### Defined in
+
+[services/Provider.ts:1071](https://github.com/oceanprotocol/ocean.js/blob/main/src/services/Provider.ts#L1071)
+
+___
+
 ### encrypt
 
 ▸ **encrypt**(`data`, `chainId`, `providerUri`, `signal?`): `Promise`<`string`\>