@oceanprotocol/lib 2.5.1 → 2.6.0

package/dist/src/@types/Asset.d.ts

@@ -76,12 +76,34 @@ export interface AssetDatatoken {
      */
     serviceId: string;
 }
+export interface AssetPrice {
+    /**
+     * The price of the asset expressed as a number. If 0 then the price is FREE.
+     * @type {number}
+     */
+    value: number;
+    /**
+     * The symbol that the price of the asset is expressed in.
+     * @type {string}
+     */
+    tokenSymbol?: string;
+    /**
+     * The address of the token that the price needs to be paid in.
+     * @type {string}
+     */
+    tokenAddress?: string;
+}
 export interface Stats {
     /**
      * How often an asset was consumed, meaning how often it was either downloaded or used as part of a compute job.
      * @type {number}
      */
     orders: number;
+    /**
+     * Contains information about the price of this asset.
+     * @type {AssetPrice}
+     */
+    price: AssetPrice;
     /**
      * Total amount of veOCEAN allocated on this asset.
      * @type {number}

package/dist/src/@types/File.d.ts

@@ -1,4 +1,7 @@
 import { AbiItem } from 'web3-utils';
+interface FileTypeHeaders {
+    [key: string]: string;
+}
 export interface UrlFile {
     type: 'url';
     /**
@@ -16,6 +19,11 @@ export interface UrlFile {
      * @type {string}
      */
     method: string;
+    /**
+     * Headers key value pairs associated with the asset GET request
+     * @type {string}
+     */
+    headers?: FileTypeHeaders;
 }
 export interface GraphqlQuery {
     type: 'graphql';
@@ -33,6 +41,11 @@ export interface GraphqlQuery {
      * @type {string}
      */
     query: string;
+    /**
+     * Headers key value pairs associated with the asset GET request
+     * @type {string}
+     */
+    headers?: FileTypeHeaders;
 }
 export interface Arweave {
     type: 'arweave';
@@ -73,3 +86,4 @@ export interface Files {
     datatokenAddress: string;
     files: UrlFile[] | GraphqlQuery[] | Arweave[] | Smartcontract[] | Ipfs[];
 }
+export {};

package/dist/src/contracts/Datatoken.d.ts

@@ -190,6 +190,16 @@ export declare class Datatoken extends SmartContract {
      * @return {Promise<number>}
      */
     getDecimals(dtAddress: string): Promise<string>;
+    /** It returns the token symbol
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getSymbol(dtAddress: string): Promise<string>;
+    /** It returns the name of the token
+     * @param {String} dtAddress Datatoken adress
+     * @return {Promise<number>}
+     */
+    getName(dtAddress: string): Promise<string>;
     /** It returns the token decimals, how many supported decimal points
      * @param {String} dtAddress Datatoken adress
      * @return {Promise<number>}

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

@@ -31,20 +31,22 @@ export declare class Provider {
      */
     encrypt(data: any, providerUri: string, signal?: AbortSignal): Promise<string>;
     /** Get DDO File details (if possible)
-     * @param {string} did did
-     * @param {number} serviceId the id of the service for which to check the files
+     * @param {UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract} file one of the supported file structures
+     * @param {string} serviceId the id of the service for which to check the files
      * @param {string} providerUri uri of the provider that will be used to check the file
+     * @param {boolean} withChecksum if true, will return checksum of files content
      * @param {AbortSignal} signal abort signal
      * @return {Promise<FileInfo[]>} urlDetails
      */
     checkDidFiles(did: string, serviceId: string, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
     /** Get URL details (if possible)
-     * @param {string} url or did
+     * @param {UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract} file one of the supported file structures
      * @param {string} providerUri uri of the provider that will be used to check the file
+     * @param {boolean} withChecksum if true, will return checksum of files content
      * @param {AbortSignal} signal abort signal
      * @return {Promise<FileInfo[]>} urlDetails
      */
-    getFileInfo(file: UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract, providerUri: string, signal?: AbortSignal): Promise<FileInfo[]>;
+    getFileInfo(file: UrlFile | Arweave | Ipfs | GraphqlQuery | Smartcontract, providerUri: string, withChecksum?: boolean, signal?: AbortSignal): Promise<FileInfo[]>;
     /** Get Compute Environments
      * @return {Promise<ComputeEnvironment[]>} urlDetails
      */

package/dist/test/integration/ComputeExamples.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.js",
   "umd:main": "dist/lib.umd.js",
@@ -27,12 +27,14 @@
     "changelog": "auto-changelog -p",
     "prepublishOnly": "npm run build",
     "mocha": "TS_NODE_PROJECT='./test/tsconfig.json' mocha --config=test/.mocharc.json --node-env=test --exit",
+    "test": "npm run lint && npm run test:unit:cover && npm run test:integration:cover",
     "test:unit": "npm run mocha -- 'test/unit/**/*.test.ts'",
     "test:unit:cover": "nyc --report-dir coverage/unit --exclude 'src/@types/**/*' npm run test:unit",
     "test:integration": "npm run mocha -- 'test/integration/**/*.test.ts'",
     "test:integration:cover": "nyc --report-dir coverage/integration --no-clean npm run test:integration",
-    "create:guide": "./scripts/createCodeExamples.sh",
-    "commit:guide": "./scripts/commitChanges.sh"
+    "create:guide": "./scripts/createCodeExamples.sh test/integration/CodeExamples.test.ts",
+    "create:guidec2d": "./scripts/createCodeExamples.sh test/integration/ComputeExamples.test.ts",
+    "commit:guides": "./scripts/commitChanges.sh"
   },
   "repository": {
     "type": "git",
@@ -54,9 +56,9 @@
     "cross-fetch": "^3.1.5",
     "crypto-js": "^4.1.1",
     "decimal.js": "^10.4.1",
-    "web3-core": "^1.8.0",
-    "web3-eth-contract": "^1.8.0",
-    "web3": "^1.8.0"
+    "web3-core": "^1.8.1",
+    "web3-eth-contract": "^1.8.1",
+    "web3": "^1.8.1"
   },
   "devDependencies": {
     "@truffle/hdwallet-provider": "^2.0.14",
@@ -66,8 +68,8 @@
     "@types/mocha": "^10.0.0",
     "@types/node": "^18.0.1",
     "@types/node-fetch": "^3.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.38.0",
-    "@typescript-eslint/parser": "^5.38.0",
+    "@typescript-eslint/eslint-plugin": "^5.45.0",
+    "@typescript-eslint/parser": "^5.45.0",
     "auto-changelog": "^2.4.0",
     "chai": "^4.3.6",
     "chai-spies": "^1.0.0",