@oceanprotocol/lib 8.0.4 → 8.0.5

package/dist/types/@types/AccessList.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Mapping of `chainId` -> list of smart contract addresses on that chain.
+ */
+export interface AccessList {
+    [chainId: string]: string[];
+}

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

@@ -1,3 +1,4 @@
+import { AccessList } from './AccessList';
 export interface HeadersObject {
     [key: string]: string;
 }
@@ -45,4 +46,28 @@ export interface FtpFileObject extends BaseFileObject {
     /** Full FTP or FTPS URL: ftp://[user:password@]host[:port]/path or ftps://... */
     url: string;
 }
-export type StorageObject = UrlFileObject | IpfsFileObject | ArweaveFileObject | S3FileObject | FtpFileObject;
+export interface PersistentStorageObject extends BaseFileObject {
+    type: 'nodePersistentStorage';
+    bucketId: string;
+    fileName: string;
+}
+export type StorageObject = UrlFileObject | IpfsFileObject | ArweaveFileObject | S3FileObject | FtpFileObject | PersistentStorageObject;
+export type PersistentStorageAccessList = AccessList;
+export interface PersistentStorageCreateBucketRequest {
+    accessLists: PersistentStorageAccessList[];
+}
+export interface PersistentStorageBucket {
+    bucketId: string;
+    owner: string;
+    createdAt: number;
+    accessLists: PersistentStorageAccessList[];
+}
+export interface PersistentStorageFileEntry {
+    bucketId: string;
+    name: string;
+    size: number;
+    lastModified: number;
+}
+export interface PersistentStorageDeleteFileResponse {
+    success: boolean;
+}

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

@@ -1,3 +1,4 @@
+import type { AccessList } from './AccessList.js';
 export interface ProviderFees {
     providerFeeAddress: string;
     providerFeeToken: string;
@@ -75,6 +76,9 @@ export interface NodeStatus {
         accessLists: string[] | null;
     };
     uptime: number;
+    persistentStorage?: {
+        accessLists?: AccessList[];
+    };
 }
 export interface UserCustomParameters {
     [key: string]: any;
@@ -117,6 +121,12 @@ export declare const PROTOCOL_COMMANDS: {
     PUSH_CONFIG: string;
     GET_LOGS: string;
     JOBS: string;
+    PERSISTENT_STORAGE_CREATE_BUCKET: string;
+    PERSISTENT_STORAGE_GET_BUCKETS: string;
+    PERSISTENT_STORAGE_LIST_FILES: string;
+    PERSISTENT_STORAGE_UPLOAD_FILE: string;
+    PERSISTENT_STORAGE_GET_FILE_OBJECT: string;
+    PERSISTENT_STORAGE_DELETE_FILE: string;
 };
 export interface NodeLogsParams {
     logId?: string;

package/dist/types/services/providers/BaseProvider.d.ts

@@ -1,8 +1,8 @@
 import { type Multiaddr } from '@multiformats/multiaddr';
 import { Signer } from 'ethers';
-import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ComputeResultStream, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, NodeStatus, NodeComputeJob, NodeLogsParams, NodeLogEntry } from '../../@types/index.js';
+import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ComputeResultStream, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, NodeStatus, NodeComputeJob, NodeLogsParams, NodeLogEntry, PersistentStorageAccessList, PersistentStorageBucket, PersistentStorageCreateBucketRequest, PersistentStorageDeleteFileResponse, PersistentStorageFileEntry, PersistentStorageObject } from '../../@types/index.js';
 import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
-import { type P2PConfig } from './P2pProvider.js';
+import { type P2PConfig, type P2PRequestBodyStream } from './P2pProvider.js';
 export { OCEAN_P2P_PROTOCOL, type P2PConfig } from './P2pProvider.js';
 export declare function getConsumerAddress(signerOrAuthToken: Signer | string): Promise<string>;
 export declare function getSignature(signerOrAuthToken: Signer | string, nonce: string, command: string): Promise<string | null>;
@@ -52,6 +52,16 @@ export declare class BaseProvider {
      * For auto-signed log fetching (HTTP or P2P), use downloadNodeLogs().
      */
     fetchNodeLogs(nodeUri: string | Multiaddr[], address: string, signature: string, nonce: string, logParams?: NodeLogsParams): Promise<NodeLogEntry[]>;
+    createPersistentStorageBucket(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, payload: PersistentStorageCreateBucketRequest, signal?: AbortSignal): Promise<{
+        bucketId: string;
+        owner: string;
+        accessList: PersistentStorageAccessList[];
+    }>;
+    getPersistentStorageBuckets(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, owner: string, chainId: number, signal?: AbortSignal): Promise<PersistentStorageBucket[]>;
+    listPersistentStorageFiles(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, bucketId: string, signal?: AbortSignal): Promise<PersistentStorageFileEntry[]>;
+    getPersistentStorageFileObject(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageObject>;
+    uploadPersistentStorageFile(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, bucketId: string, fileName: string, content: P2PRequestBodyStream, signal?: AbortSignal): Promise<PersistentStorageFileEntry>;
+    deletePersistentStorageFile(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, bucketId: string, fileName: string, chainId: number, signal?: AbortSignal): Promise<PersistentStorageDeleteFileResponse>;
     fetchConfig(nodeUri: string | Multiaddr[], payload: Record<string, any>): Promise<any>;
     pushConfig(nodeUri: string | Multiaddr[], payload: Record<string, any>): Promise<any>;
 }

package/dist/types/services/providers/HttpProvider.d.ts

@@ -1,10 +1,13 @@
 import { Signer } from 'ethers';
-import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, ComputeResultStream, NodeStatus, NodeComputeJob, NodeLogEntry } from '../../@types/index.js';
+import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, ServiceEndpoint, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, ComputeResultStream, NodeStatus, NodeComputeJob, NodeLogEntry, PersistentStorageAccessList, PersistentStorageBucket, PersistentStorageCreateBucketRequest, PersistentStorageDeleteFileResponse, PersistentStorageFileEntry, PersistentStorageObject } from '../../@types/index.js';
 import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
+import { type P2PRequestBodyStream } from './P2pProvider.js';
 export declare class HttpProvider {
     protected getConsumerAddress(s: Signer | string): Promise<string>;
     protected getSignature(s: Signer | string, nonce: string, command: string): Promise<string>;
     protected getAuthorization(s: Signer | string): string;
+    private getPersistentStorageSignaturePayload;
+    private resolvePersistentStorageRoute;
     /**
      * Returns the provider endpoints
      * @param {string} nodeUri - the provider url
@@ -245,4 +248,14 @@ export declare class HttpProvider {
     resolveDdo(nodeUri: string, did: string, signal?: AbortSignal): Promise<any>;
     validateDdo(nodeUri: string, ddo: DDO, signer: Signer, signal?: AbortSignal): Promise<ValidateMetadata>;
     private getData;
+    createPersistentStorageBucket(nodeUri: string, signerOrAuthToken: Signer | string, payload: PersistentStorageCreateBucketRequest, signal?: AbortSignal): Promise<{
+        bucketId: string;
+        owner: string;
+        accessList: PersistentStorageAccessList[];
+    }>;
+    getPersistentStorageBuckets(nodeUri: string, signerOrAuthToken: Signer | string, owner: string, chainId: number, signal?: AbortSignal): Promise<PersistentStorageBucket[]>;
+    listPersistentStorageFiles(nodeUri: string, signerOrAuthToken: Signer | string, bucketId: string, signal?: AbortSignal): Promise<PersistentStorageFileEntry[]>;
+    getPersistentStorageFileObject(nodeUri: string, signerOrAuthToken: Signer | string, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageObject>;
+    uploadPersistentStorageFile(nodeUri: string, signerOrAuthToken: Signer | string, bucketId: string, fileName: string, content: P2PRequestBodyStream, signal?: AbortSignal): Promise<PersistentStorageFileEntry>;
+    deletePersistentStorageFile(nodeUri: string, signerOrAuthToken: Signer | string, bucketId: string, fileName: string, chainId: number, signal?: AbortSignal): Promise<PersistentStorageDeleteFileResponse>;
 }

package/dist/types/services/providers/P2pProvider.d.ts

@@ -1,7 +1,7 @@
 import { type Libp2p, type Libp2pOptions } from 'libp2p';
 import { type Multiaddr } from '@multiformats/multiaddr';
 import { Signer } from 'ethers';
-import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, ComputeResultStream, NodeStatus, NodeComputeJob } from '../../@types/index.js';
+import { StorageObject, FileInfo, ComputeJob, ComputeOutput, ComputeAlgorithm, ComputeAsset, ComputeEnvironment, ProviderInitialize, ProviderComputeInitializeResults, UserCustomParameters, ComputeResourceRequest, ComputeJobMetadata, PolicyServerInitializeCommand, PolicyServerPassthroughCommand, dockerRegistryAuth, DownloadResponse, ComputeResultStream, NodeStatus, NodeComputeJob, PersistentStorageAccessList, PersistentStorageBucket, PersistentStorageCreateBucketRequest, PersistentStorageDeleteFileResponse, PersistentStorageFileEntry, PersistentStorageObject } from '../../@types/index.js';
 import { NodeLogsParams, NodeLogEntry } from '../../@types/Provider.js';
 import { type DDO, type ValidateMetadata } from '@oceanprotocol/ddo-js';
 export declare const OCEAN_P2P_PROTOCOL = "/ocean/nodes/1.0.0";
@@ -199,4 +199,15 @@ export declare class P2pProvider {
      * the caller is responsible for nonce retrieval and signing.
      */
     pushConfig(nodeUri: string | Multiaddr[], payload: Record<string, any>): Promise<any>;
+    private getPersistentStorageSignaturePayload;
+    createPersistentStorageBucket(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, payload: PersistentStorageCreateBucketRequest, signal?: AbortSignal): Promise<{
+        bucketId: string;
+        owner: string;
+        accessList: PersistentStorageAccessList[];
+    }>;
+    getPersistentStorageBuckets(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, owner: string, chainId: number, signal?: AbortSignal): Promise<PersistentStorageBucket[]>;
+    listPersistentStorageFiles(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, bucketId: string, signal?: AbortSignal): Promise<PersistentStorageFileEntry[]>;
+    getPersistentStorageFileObject(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, bucketId: string, fileName: string, signal?: AbortSignal): Promise<PersistentStorageObject>;
+    uploadPersistentStorageFile(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, bucketId: string, fileName: string, content: P2PRequestBodyStream, signal?: AbortSignal): Promise<PersistentStorageFileEntry>;
+    deletePersistentStorageFile(nodeUri: string | Multiaddr[], signerOrAuthToken: Signer | string, bucketId: string, fileName: string, chainId: number, signal?: AbortSignal): Promise<PersistentStorageDeleteFileResponse>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oceanprotocol/lib",
   "source": "./src/index.ts",
-  "version": "8.0.4",
+  "version": "8.0.5",
   "description": "JavaScript client library for Ocean Protocol",
   "main": "./dist/lib.cjs",
   "umd:main": "dist/lib.umd.js",