@oceanprotocol/lib 3.4.1 → 3.4.3

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

@@ -0,0 +1,148 @@
+import { DDO } from '.';
+export interface AssetNft {
+    /**
+     * Contract address of the deployed ERC721 NFT contract.
+     * @type {string}
+     */
+    address: string;
+    /**
+     * Name of NFT set in contract.
+     * @type {string}
+     */
+    name: string;
+    /**
+     * Symbol of NFT set in contract.
+     * @type {string}
+     */
+    symbol: string;
+    /**
+     * ETH account address of the NFT owner.
+     * @type {string}
+     */
+    owner: string;
+    /**
+     * State of the asset reflecting the NFT contract value.
+     * 0	Active.
+     * 1	End-of-life.
+     * 2	Deprecated (by another asset).
+     * 3	Revoked by publisher.
+     * 4	Ordering is temporary disabled.
+     * 5  Unlisted in markets.
+     * @type {number}
+     */
+    state: 0 | 1 | 2 | 3 | 4 | 5;
+    /**
+     * Contains the date of NFT creation.
+     * @type {string}
+     */
+    created: string;
+    /**
+     * NFT token URI.
+     * @type {string}
+     */
+    tokenURI: string;
+}
+export interface Purgatory {
+    /**
+     * If `true`, asset is in purgatory.
+     * @type {boolean}
+     */
+    state: boolean;
+    /**
+     * If asset is in purgatory, contains the reason for being there as defined in `list-purgatory`.
+     * @type {string}
+     */
+    reason: string;
+}
+export interface AssetDatatoken {
+    /**
+     * Contract address of the deployed Datatoken contract.
+     * @type {string}
+     */
+    address: string;
+    /**
+     * Name of NFT set in contract.
+     * @type {string}
+     */
+    name: string;
+    /**
+     * Symbol of NFT set in contract.
+     * @type {string}
+     */
+    symbol: string;
+    /**
+     * ID of the service the datatoken is attached to.
+     * @type {string}
+     */
+    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}
+     */
+    allocated?: number;
+}
+export interface AssetLastEvent {
+    tx: string;
+    block: number;
+    from: string;
+    contract: string;
+    datetime: string;
+}
+export interface Asset extends DDO {
+    /**
+     * Contains information about the ERC721 NFT contract which represents the intellectual property of the publisher.
+     * @type {string}
+     */
+    nft: AssetNft;
+    /**
+     * Contains information about the ERC20 Datatokens attached to asset services.
+     * @type {string}
+     */
+    datatokens: AssetDatatoken[];
+    /**
+     * Contains information about the last transaction that created or updated the DDO.
+     * @type {string}
+     */
+    event: AssetLastEvent;
+    /**
+     * The stats section contains different statistics fields. This section is added by Aquarius
+     * @type {Stats}
+     */
+    stats: Stats;
+    /**
+     * Contains information about an asset's purgatory status defined in
+     * [`list-purgatory`](https://github.com/oceanprotocol/list-purgatory).
+     * Marketplace interfaces are encouraged to prevent certain user actions like downloading on assets in purgatory.
+     * @type {Purgatory}
+     */
+    purgatory: Purgatory;
+}

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

@@ -0,0 +1,71 @@
+import { Metadata, MetadataAlgorithm } from '.';
+export type ComputeResultType = 'algorithmLog' | 'output' | 'configrationLog' | 'publishLog';
+export interface ComputeEnvironment {
+    id: string;
+    cpuNumber: number;
+    cpuType: string;
+    gpuNumber: number;
+    gpuType: string;
+    ramGB: number;
+    diskGB: number;
+    priceMin: number;
+    desc: string;
+    currentJobs: number;
+    maxJobs: number;
+    consumerAddress: string;
+    storageExpiry: number;
+    maxJobDuration: number;
+    lastSeen: number;
+}
+export interface ComputeResult {
+    filename: string;
+    filesize: number;
+    type: ComputeResultType;
+    index?: number;
+}
+export interface ComputeJob {
+    owner: string;
+    did?: string;
+    jobId: string;
+    dateCreated: string;
+    dateFinished: string;
+    status: number;
+    statusText: string;
+    results: ComputeResult[];
+    inputDID?: string[];
+    algoDID?: string;
+    agreementId?: string;
+    expireTimestamp: number;
+}
+export interface ComputeOutput {
+    publishAlgorithmLog?: boolean;
+    publishOutput?: boolean;
+    providerAddress?: string;
+    providerUri?: string;
+    metadata?: Metadata;
+    metadataUri?: string;
+    nodeUri?: string;
+    owner?: string;
+    secretStoreUri?: string;
+    whitelist?: string[];
+}
+export interface ComputeAsset {
+    documentId: string;
+    serviceId: string;
+    transferTxId?: string;
+    userdata?: {
+        [key: string]: any;
+    };
+}
+export interface ComputeAlgorithm {
+    documentId?: string;
+    serviceId?: string;
+    meta?: MetadataAlgorithm;
+    transferTxId?: string;
+    algocustomdata?: {
+        [key: string]: any;
+    };
+    userdata?: {
+        [key: string]: any;
+    };
+}

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

@@ -0,0 +1,26 @@
+export type AbiType = 'function' | 'constructor' | 'event' | 'fallback';
+export type StateMutabilityType = 'pure' | 'view' | 'nonpayable' | 'payable';
+export interface AbiInput {
+    name: string;
+    type: string;
+    indexed?: boolean;
+    components?: AbiInput[];
+    internalType?: string;
+}
+export interface AbiOutput {
+    name: string;
+    type: string;
+    components?: AbiOutput[];
+    internalType?: string;
+}
+export interface AbiItem {
+    anonymous?: boolean;
+    constant?: boolean;
+    inputs?: AbiInput[];
+    name?: string;
+    outputs?: AbiOutput[];
+    payable?: boolean;
+    stateMutability?: StateMutabilityType;
+    type: AbiType;
+    gas?: number;
+}

package/dist/types/@types/DDO/ConsumerParameter.d.ts

@@ -0,0 +1,37 @@
+export interface ConsumerParameter {
+    /**
+     * Parameter name.
+     * @type {string}
+     */
+    name: string;
+    /**
+     * Field type.
+     * @type {'text' | 'number' | 'boolean' | 'select'}
+     */
+    type: 'text' | 'number' | 'boolean' | 'select';
+    /**
+     * Displayed field label.
+     * @type {string}
+     */
+    label: string;
+    /**
+     * Defines if customer input for this field is mandatory.
+     * @type {boolean}
+     */
+    required: boolean;
+    /**
+     * Field description.
+     * @type {string}
+     */
+    description: string;
+    /**
+     * Field default value. For select types, string key of default option.
+     * @type {string}
+     */
+    default: string;
+    /**
+     * For select types, a list of options.
+     * @type {string}
+     */
+    options?: string;
+}

package/dist/types/@types/DDO/Credentials.d.ts

@@ -0,0 +1,8 @@
+export interface Credential {
+    type: string;
+    values: string[];
+}
+export interface Credentials {
+    allow: Credential[];
+    deny: Credential[];
+}

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

@@ -0,0 +1,55 @@
+import { Service, Metadata, Credentials, Event } from '..';
+/**
+ * DID Descriptor Object.
+ * Contains metadata about the asset, and define access in at least one service.
+ */
+export interface DDO {
+    /**
+     * Contexts used for validation.
+     * @type {string[]}
+     */
+    '@context': string[];
+    /**
+     * DID, descentralized ID.
+     * Computed as sha256(address of NFT contract + chainId)
+     * @type {string}
+     */
+    id: string;
+    /**
+     * Version information in SemVer notation
+     * referring to the DDO spec version
+     * @type {string}
+     */
+    version: string;
+    /**
+     * NFT contract address
+     * @type {string}
+     */
+    nftAddress: string;
+    /**
+     * ChainId of the network the DDO was published to.
+     * @type {number}
+     */
+    chainId: number;
+    /**
+     * Stores an object describing the asset.
+     * @type {Metadata}
+     */
+    metadata: Metadata;
+    /**
+     * Stores an array of services defining access to the asset.
+     * @type {Service[]}
+     */
+    services: Service[];
+    /**
+     * Describes the credentials needed to access a dataset
+     * in addition to the services definition.
+     * @type {Credentials}
+     */
+    credentials?: Credentials;
+    /**
+     * Describes the event of last metadata event
+     * @type {Event}
+     */
+    event?: Event;
+}

package/dist/types/@types/DDO/Event.d.ts

@@ -0,0 +1,27 @@
+export interface Event {
+    /**
+     * TX id of the last create/update
+     * @type {string}
+     */
+    txid?: string;
+    /**
+     * Block of txid
+     * @type {number}
+     */
+    block?: number;
+    /**
+     * Sender of tx
+     * @type {String}
+     */
+    from?: string;
+    /**
+     * Contract
+     * @type {String}
+     */
+    contract?: string;
+    /**
+     * datetime of tx
+     * @type {String}
+     */
+    datetime?: string;
+}

package/dist/types/@types/DDO/Metadata.d.ts

@@ -0,0 +1,141 @@
+import { ConsumerParameter } from './ConsumerParameter';
+export interface MetadataAlgorithm {
+    /**
+     * Programming language used to implement the software.
+     * @type {string}
+     */
+    language?: string;
+    /**
+     * Version of the software preferably in SemVer notation.
+     * @type {string}
+     */
+    version?: string;
+    /**
+     * Rawcode
+     * @type {string}
+     */
+    rawcode?: string;
+    /**
+     * Object describing the Docker container image.
+     * @type {Object}
+     */
+    container: {
+        /**
+         * The command to execute, or script to run inside the Docker image.
+         * @type {string}
+         */
+        entrypoint: string;
+        /**
+         * Name of the Docker image.
+         * @type {string}
+         */
+        image: string;
+        /**
+         * Tag of the Docker image.
+         * @type {string}
+         */
+        tag: string;
+        /**
+         * Checksum of the Docker image.
+         * @type {string}
+         */
+        checksum: string;
+        /**
+         * Array of objects describing the consumer parameters
+         * @type {ConsumerParameter[]}
+         */
+        consumerParameters?: ConsumerParameter[];
+    };
+    /**
+     * Array of objects describing the consumer parameters
+     * @type {ConsumerParameter[]}
+     */
+    consumerParameters?: ConsumerParameter[];
+}
+export interface Metadata {
+    /**
+     * Contains the date of publishing in ISO Date Time
+     * @type {string}
+     */
+    created: string;
+    /**
+     * Contains the the date of last update in ISO Date Time
+     * @type {string}
+     */
+    updated: string;
+    /**
+     * Descriptive name or title of the asset.
+     * @type {string}
+     */
+    name: string;
+    /**
+     * Details of what the resource is.
+     * @type {string}
+     */
+    description: string;
+    /**
+     * Asset type. Includes "dataset" (e.g. csv file), "algorithm" (e.g. Python script).
+     * Each type needs a different subset of metadata attributes.
+     * @type {'dataset' | 'algorithm'}
+     */
+    type: 'dataset' | 'algorithm';
+    /**
+     * Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
+     * @type {string}
+     */
+    author: string;
+    /**
+     * Short name referencing the license of the asset.
+     * If it’s not specified, the following value will be added: “No License Specified”.
+     * @type {string}
+     */
+    license: string;
+    /**
+     * Mapping of URL strings for data samples, or links to find out more information.
+     * Links may be to either a URL or another asset.
+     * @type {string[]}
+     */
+    links?: string[];
+    /**
+     * Array of keywords or tags used to describe this content. Empty by default.
+     * @type {string[]}
+     */
+    tags?: string[];
+    /**
+     * Array of categories associated to the asset. Note: recommended to use tags instead of this.
+     * @type {string[]}
+     */
+    categories?: string[];
+    /**
+     * The party holding the legal copyright. Empty by default.
+     * @type {string}
+     */
+    copyrightHolder?: string;
+    /**
+     *The language of the content. Use one of the language codes from the IETF BCP 47 standard
+     * @type {string}
+     */
+    contentLanguage?: string;
+    /**
+     * Information about asset of type algorithm. Required for algorithm assets.
+     * @type {MetadataAlgorithm}
+     */
+    algorithm?: MetadataAlgorithm;
+    /**
+     * Stores additional information, this is customizable by publisher
+     * @type {any}
+     */
+    additionalInformation?: any;
+}
+export interface MetadataProof {
+    validatorAddress?: string;
+    r?: string;
+    s?: string;
+    v?: number;
+}
+export interface ValidateMetadata {
+    valid: Boolean;
+    errors?: Object;
+    hash?: string;
+    proof?: MetadataProof;
+}

package/dist/types/@types/DDO/Service.d.ts

@@ -0,0 +1,106 @@
+import { ConsumerParameter } from './ConsumerParameter';
+import { Credentials } from './Credentials';
+export interface PublisherTrustedAlgorithm {
+    /**
+     * The DID of the algorithm which is trusted by the publisher.
+     * @type {string}
+     */
+    did: string;
+    /**
+     * Hash of algorithm’s files section.
+     * @type {string}
+     */
+    filesChecksum: string;
+    /**
+     * Hash of algorithm’s metadata.algorithm.container section.
+     * @type {string}
+     */
+    containerSectionChecksum: string;
+}
+export interface ServiceComputeOptions {
+    /**
+     * If true, any passed raw text will be allowed to run.
+     * Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input.
+     * Should be false by default in all implementations.
+     * @type {boolean}
+     */
+    allowRawAlgorithm: boolean;
+    /**
+     * If true, the algorithm job will have network access.
+     * @type {boolean}
+     */
+    allowNetworkAccess: boolean;
+    /**
+     * If empty, then any published algorithm is allowed.
+     * Otherwise, only published algorithms by some publishers are allowed
+     * @type {string[]}
+     */
+    publisherTrustedAlgorithmPublishers: string[];
+    /**
+     * If empty, then any published algorithm is allowed. (see below)
+     * @type {PublisherTrustedAlgorithm[]}
+     */
+    publisherTrustedAlgorithms: PublisherTrustedAlgorithm[];
+}
+export interface Service {
+    /**
+     * Unique ID
+     * @type {string}
+     */
+    id: string;
+    /**
+     * Type of service (access, compute, wss.
+     * @type {string}
+     */
+    type: 'access' | 'compute' | string;
+    /**
+     * Encrypted file URLs.
+     * @type {string}
+     */
+    files: string;
+    /**
+     * Datatoken address
+     * @type {string}
+     */
+    datatokenAddress: string;
+    /**
+     * Provider URL (schema + host).
+     * @type {string}
+     */
+    serviceEndpoint: string;
+    /**
+     * Describes the credentials needed to access a service
+     * @type {Credentials}
+     */
+    credentials?: Credentials;
+    /**
+     * Describing how long the service can be used after consumption is initiated.
+     * @type {number}
+     */
+    timeout: number;
+    /**
+     * Service friendly name
+     * @type {string}
+     */
+    name?: string;
+    /**
+     * Service description
+     * @type {string}
+     */
+    description?: string;
+    /**
+     * If service is of type compute, holds information about the compute-related privacy settings & resources.
+     * @type {ServiceComputeOptions}
+     */
+    compute?: ServiceComputeOptions;
+    /**
+     * Array of objects describing the consumer parameters
+     * @type {ConsumerParameter[]}
+     */
+    consumerParameters?: ConsumerParameter[];
+    /**
+     * Stores service specific additional information, this is customizable by publisher
+     * @type {any}
+     */
+    additionalInformation?: any;
+}

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

@@ -0,0 +1,42 @@
+import { ProviderFees } from '.';
+export interface DatatokenCreateParams {
+    templateIndex: number;
+    minter: string;
+    paymentCollector: string;
+    mpFeeAddress: string;
+    feeToken: string;
+    feeAmount: string;
+    cap: string;
+    name?: string;
+    symbol?: string;
+    filesObject?: any;
+    accessListFactory?: string;
+    allowAccessList?: string;
+    denyAccessList?: string;
+}
+export interface ConsumeMarketFee {
+    consumeMarketFeeAddress: string;
+    consumeMarketFeeToken: string;
+    consumeMarketFeeAmount: string;
+}
+export interface PublishingMarketFee {
+    publishMarketFeeAddress: string;
+    publishMarketFeeToken: string;
+    publishMarketFeeAmount: string;
+}
+export interface DatatokenRoles {
+    minter: boolean;
+    paymentManager: boolean;
+}
+export interface OrderParams {
+    consumer: string;
+    serviceIndex: number;
+    _providerFee: ProviderFees;
+    _consumeMarketFee: ConsumeMarketFee;
+}
+export interface DispenserParams {
+    maxTokens: string;
+    maxBalance: string;
+    withMint?: boolean;
+    allowedSwapper?: string;
+}

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

@@ -0,0 +1,16 @@
+export interface DispenserCreationParams {
+    dispenserAddress: string;
+    maxTokens: string;
+    maxBalance: string;
+    withMint?: boolean;
+    allowedSwapper?: string;
+}
+export interface DispenserToken {
+    active: boolean;
+    owner: string;
+    maxTokens: string;
+    maxBalance: string;
+    balance: string;
+    isMinter: boolean;
+    allowedSwapper: string;
+}

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

@@ -0,0 +1,4 @@
+export interface DownloadResponse {
+    data: ArrayBuffer;
+    filename: string;
+}