@oceanprotocol/lib 3.4.2 → 3.4.3

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

@@ -0,0 +1,89 @@
+import { AbiItem } from './Contracts';
+interface FileTypeHeaders {
+    [key: string]: string;
+}
+export interface UrlFile {
+    type: 'url';
+    /**
+     * File index.
+     * @type {number}
+     */
+    index?: number;
+    /**
+     * File URL.
+     * @type {string}
+     */
+    url: string;
+    /**
+     * HTTP method used
+     * @type {string}
+     */
+    method: string;
+    /**
+     * Headers key value pairs associated with the asset GET request
+     * @type {string}
+     */
+    headers?: FileTypeHeaders;
+}
+export interface GraphqlQuery {
+    type: 'graphql';
+    /**
+     * @type {number}
+     */
+    index?: number;
+    /**
+     * Endpoint URL
+     * @type {string}
+     */
+    url: string;
+    /**
+     * query
+     * @type {string}
+     */
+    query: string;
+    /**
+     * Headers key value pairs associated with the asset GET request
+     * @type {string}
+     */
+    headers?: FileTypeHeaders;
+}
+export interface Arweave {
+    type: 'arweave';
+    /**
+     * transactionId
+     * @type {string}
+     */
+    transactionId: string;
+}
+export interface Ipfs {
+    type: 'ipfs';
+    /**
+     * hash
+     * @type {string}
+     */
+    hash: string;
+}
+export interface Smartcontract {
+    type: 'smartcontract';
+    /**
+     * Smartcontract address
+     * @type {string}
+     */
+    address: string;
+    /**
+     * ChainId
+     * @type {number}
+     */
+    chainId: number;
+    /**
+     * Function ABI (not the entire smartcontract abi)
+     * @type {AbiItem}
+     */
+    abi: AbiItem;
+}
+export interface Files {
+    nftAddress: string;
+    datatokenAddress: string;
+    files: UrlFile[] | GraphqlQuery[] | Arweave[] | Smartcontract[] | Ipfs[];
+}
+export {};

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

@@ -0,0 +1,43 @@
+export interface FileInfo {
+    /**
+     * File URL.
+     * @type {string}
+     */
+    type: string;
+    /**
+     * File format, if applicable.
+     * @type {string}
+     * @example "text/csv"
+     */
+    contentType?: string;
+    /**
+     * File content length.
+     * @type {[type]}
+     */
+    contentLength?: string;
+    /**
+     * File index.
+     * @type {number}
+     */
+    index?: number;
+    /**
+     * File URL.
+     * @type {string}
+     */
+    url?: string;
+    /**
+     * HTTP method used
+     * @type {string}
+     */
+    method?: string;
+    /**
+     * Computed file checksum
+     * @type {string}
+     */
+    checksum?: string;
+    /**
+     * check if file exists
+     * @type {boolean}
+     */
+    valid?: boolean;
+}

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

@@ -0,0 +1,51 @@
+export interface FreCreationParams {
+    fixedRateAddress: string;
+    baseTokenAddress: string;
+    owner: string;
+    marketFeeCollector: string;
+    baseTokenDecimals: number;
+    datatokenDecimals: number;
+    fixedRate: string;
+    marketFee: string;
+    withMint?: boolean;
+    allowedConsumer?: string;
+}
+export interface FreOrderParams {
+    exchangeContract: string;
+    exchangeId: string;
+    maxBaseTokenAmount: string;
+    baseTokenAddress: string;
+    baseTokenDecimals?: number;
+    swapMarketFee: string;
+    marketFeeAddress: string;
+}
+export interface PriceAndFees {
+    baseTokenAmount: string;
+    oceanFeeAmount: string;
+    marketFeeAmount: string;
+    consumeMarketFeeAmount: string;
+}
+export interface FixedPriceExchange {
+    active: boolean;
+    exchangeOwner: string;
+    datatoken: string;
+    baseToken: string;
+    fixedRate: string;
+    dtDecimals: string;
+    btDecimals: string;
+    dtBalance: string;
+    btBalance: string;
+    dtSupply: string;
+    btSupply: string;
+    withMint: boolean;
+    allowedSwapper: string;
+    exchangeId?: string;
+}
+export interface FeesInfo {
+    opcFee: string;
+    marketFee: string;
+    marketFeeCollector: string;
+    marketFeeAvailable: string;
+    oceanFeeAvailable: string;
+    exchangeId: string;
+}

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

@@ -0,0 +1,18 @@
+import { MetadataProof } from '.';
+export interface MetadataAndTokenURI {
+    metaDataState: number;
+    metaDataDecryptorUrl: string;
+    metaDataDecryptorAddress: string;
+    flags: string;
+    data: string;
+    metaDataHash: string;
+    tokenId: number;
+    tokenURI: string;
+    metadataProofs?: MetadataProof[];
+}
+export interface NftRoles {
+    manager: boolean;
+    deployERC20: boolean;
+    updateMetadata: boolean;
+    store: boolean;
+}

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

@@ -0,0 +1,20 @@
+import { ConsumeMarketFee, ProviderFees } from '.';
+export interface Template {
+    templateAddress: string;
+    isActive: boolean;
+}
+export interface TokenOrder {
+    tokenAddress: string;
+    consumer: string;
+    serviceIndex: number;
+    _providerFee: ProviderFees;
+    _consumeMarketFee: ConsumeMarketFee;
+}
+export interface NftCreateData {
+    name: string;
+    symbol: string;
+    templateIndex: number;
+    tokenURI: string;
+    transferable: boolean;
+    owner: string;
+}

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

@@ -0,0 +1,33 @@
+export interface ProviderFees {
+    providerFeeAddress: string;
+    providerFeeToken: string;
+    providerFeeAmount: string;
+    v: string;
+    r: string;
+    s: string;
+    providerData: string;
+    validUntil: string;
+}
+export interface ProviderInitialize {
+    datatoken: string;
+    nonce: string;
+    computeAddress: string;
+    providerFee: ProviderFees;
+}
+export interface ProviderComputeInitialize {
+    datatoken?: string;
+    validOrder?: string;
+    providerFee?: ProviderFees;
+}
+export interface ProviderComputeInitializeResults {
+    algorithm?: ProviderComputeInitialize;
+    datasets?: ProviderComputeInitialize[];
+}
+export interface ServiceEndpoint {
+    serviceName: string;
+    method: string;
+    urlPath: string;
+}
+export interface UserCustomParameters {
+    [key: string]: any;
+}

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

@@ -0,0 +1,3 @@
+import { BigNumber, providers } from 'ethers';
+export type ReceiptOrEstimate<G extends boolean = false> = G extends false ? providers.TransactionResponse : BigNumber;
+export type ReceiptOrDecimal<G extends boolean = false> = G extends false ? providers.TransactionResponse : number;

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

@@ -0,0 +1,59 @@
+export interface Operation {
+    /**
+     * used for FixedRate or Dispenser
+     * @type {string}
+     */
+    exchangeIds: string;
+    /**
+     * pool Address
+     * @type {string}
+     */
+    source: string;
+    /**
+     * operation:
+     * 0 - swapExactAmountIn
+     * 1 - swapExactAmountOut
+     * 2 - FixedRateExchange
+     * 3 - Dispenser
+     * @type {number}
+     */
+    operation: number;
+    /**
+     * token in address
+     * @type {string}
+     */
+    tokenIn: string;
+    /**
+     * when swapExactAmountIn is EXACT amount IN
+     * expressed in Wei
+     * @type {string | number}
+     */
+    amountsIn: string | number;
+    /**
+     * token out address
+     * @type {string}
+     */
+    tokenOut: string;
+    /**
+     * when swapExactAmountIn is MIN amount OUT
+     * expressed in Wei
+     * @type {string | number}
+     */
+    amountsOut: string | number;
+    /**
+     * max price (only for pools)
+     * expressed in Wei
+     * @type {string | number}
+     */
+    maxPrice: string | number;
+    /**
+     * swap fee amount
+     * @type {string}
+     */
+    swapMarketFee: string;
+    /**
+     * market fee address to receive fees
+     * @type {string}
+     */
+    marketFeeAddress: string;
+}

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

@@ -0,0 +1,20 @@
+export * from './DDO/Credentials';
+export * from './DDO/DDO';
+export * from './DDO/Event';
+export * from './DDO/Metadata';
+export * from './DDO/ConsumerParameter';
+export * from './DDO/Service';
+export * from './Asset';
+export * from './Contracts';
+export * from './File';
+export * from './FileInfo';
+export * from './Compute';
+export * from './Datatoken';
+export * from './Dispenser';
+export * from './DownloadResponse';
+export * from './FixedPrice';
+export * from './NFT';
+export * from './NFTFactory';
+export * from './Provider';
+export * from './Router';
+export * from './ReturnTypes';

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

@@ -0,0 +1,162 @@
+import { AbiItem } from '../@types';
+import { LogLevel } from '../utils';
+type SDK = 'evm' | 'oasis';
+export declare class Config {
+    /**
+     * Ethereum node URL.
+     * @type {string}
+     */
+    nodeUri?: string;
+    /**
+     * Address of Provider.
+     * @type {string}
+     */
+    providerAddress?: string;
+    /**
+     * Metadata Store URL.
+     * @type {string}
+     */
+    metadataCacheUri?: string;
+    /**
+     * Provider URL.
+     * @type {string}
+     */
+    providerUri?: string;
+    /**
+     * Web3 Provider.
+     * @type {any}
+     */
+    web3Provider?: any;
+    /**
+     * Ocean Token address
+     * @type {string}
+     */
+    oceanTokenAddress?: string;
+    /**
+     * Factory address
+     * @type {string}
+     */
+    nftFactoryAddress?: string;
+    /**
+     * Router Factory address
+     * @type {string}
+     */
+    routerFactoryAddress?: string;
+    /**
+     * datatokens ABI
+     * @type {string}
+     */
+    datatokensABI?: AbiItem | AbiItem[];
+    /**
+     * FixedRateExchangeAddress
+     * @type {string}
+     */
+    fixedRateExchangeAddress?: string;
+    /**
+     * FixedRateExchangeAddressABI
+     * @type {any}
+     */
+    fixedRateExchangeAddressABI?: AbiItem | AbiItem[];
+    /**
+     * DispenserAddress
+     * @type {string}
+     */
+    dispenserAddress?: string;
+    /**
+     * DispenserABI
+     * @type {any}
+     */
+    dispenserABI?: AbiItem | AbiItem[];
+    /**
+     * OPFCommunityFeeCollector
+     * @type {string}
+     */
+    opfCommunityFeeCollector?: string;
+    /**
+     * SideStaking address
+     * @type {string}
+     */
+    sideStakingAddress?: string;
+    /**
+     * block number of the deployment
+     * @type {number}
+     */
+    startBlock?: number;
+    /**
+     * Log level.
+     * @type {boolean | LogLevel}
+     */
+    verbose?: boolean | LogLevel;
+    /**
+     * Message shown when the user creates its own token.
+     * @type {string}
+     */
+    authMessage?: string;
+    /**
+     * Token expiration time in ms.
+     * @type {number}
+     */
+    authTokenExpiration?: number;
+    /**
+     * Parity config
+     * @type {string}
+     */
+    parityUri?: string;
+    threshold?: number;
+    /**
+     * Chain ID
+     * @type {number}
+     */
+    chainId: number;
+    /**
+     * Network name ex: mainnet, goerli, polygon
+     * @type {string}
+     */
+    network: string;
+    /**
+     * Url of the relevant subgraph instance ex: https://subgraph.mainnet.oceanprotocol.com
+     * @type {string}
+     */
+    subgraphUri: string;
+    /**
+     * Url of the  blockchain exporer ex: https://etherscan.io
+     * @type {string}
+     */
+    explorerUri: string;
+    /**
+     * Ocean toke symbol on the chain, it's used just for convenience to reduce number of calls
+     * @type {string}
+     */
+    oceanTokenSymbol: string;
+    /**
+     * Specify the transaction Block Timeout
+     * @type {number}
+     */
+    transactionBlockTimeout: number;
+    /**
+     * Specify the transaction Confirmation Blocks
+     * @type {number}
+     */
+    transactionConfirmationBlocks: number;
+    /**
+     * Specify the transaction Polling Blocks Timeout
+     * @type {number}
+     */
+    transactionPollingTimeout: number;
+    /**
+     * Specify the multiplier for the gas fee
+     * @type {number}
+     */
+    gasFeeMultiplier: number;
+    veAllocate?: string;
+    veOCEAN?: string;
+    veDelegation?: string;
+    veFeeDistributor?: string;
+    veDelegationProxy?: string;
+    DFRewards?: string;
+    DFStrategyV1?: string;
+    veFeeEstimate?: string;
+    sdk?: SDK;
+    accessListFactory?: string;
+}
+export {};

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

@@ -0,0 +1,13 @@
+import { Config } from '.';
+export declare const configHelperNetworks: Config[];
+export declare const KNOWN_CONFIDENTIAL_EVMS: number[];
+export declare class ConfigHelper {
+    getAddressesFromEnv(network: string, customAddresses?: any): Partial<Config>;
+    /**
+     * Returns the config object for a specific network supported by the oceanprotocol stack
+     * @param {string | number} network the network's chainId or name
+     * @param {string} infuraProjectId optional infura project id that will replace the configs node URI
+     * @return {Config} Config obhjedct
+     */
+    getConfig(network: string | number, infuraProjectId?: string): Config;
+}

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

@@ -0,0 +1,2 @@
+export * from './Config';
+export * from './ConfigHelper';

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

@@ -0,0 +1,85 @@
+import { Signer } from 'ethers';
+import { AbiItem, ReceiptOrEstimate } from '../@types';
+import { Config } from '../config';
+import { SmartContractWithAddress } from './SmartContractWithAddress';
+export declare class AccessListContract extends SmartContractWithAddress {
+    abiEnterprise: AbiItem[];
+    getDefaultAbi(): AbiItem[];
+    /**
+     * Instantiate AccessList 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
+     * @param {AbiItem[]} abiEnterprise Enterprise ABI array of the smart contract
+     */
+    constructor(address: string, signer: Signer, network?: string | number, config?: Config, abi?: AbiItem[]);
+    /**
+     * Get Token Uri
+     * @return {Promise<string>} Token URI
+     */
+    getTokenUri(tokenId: number): Promise<string>;
+    /**
+     * Get Owner
+     * @return {Promise<string>} Owner
+     */
+    getOwner(): Promise<string>;
+    /**
+     * Get Id
+     * @return {Promise<string>} Id
+     */
+    getId(): Promise<number>;
+    /**
+     * Get Name of Access list
+     * @return {Promise<string>} Name
+     */
+    getName(): Promise<string>;
+    /**
+     * Get Symbol of Access list
+     * @return {Promise<string>} Symbol
+     */
+    getSymbol(): Promise<string>;
+    /**
+     * Get Address Balance for access list token
+     * @param {String} address user adress
+     * @return {Promise<String>} balance  Number of datatokens. Will be converted from wei
+     */
+    balance(address: string): Promise<string>;
+    /**
+     * Add address to access list
+     * @param {String} user Minter address
+     * @param {String} tokenUri tokenURI
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value
+     */
+    mint<G extends boolean = false>(user: string, tokenUri: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Batch add addresses to the access list
+     * @param {String} users Minter addresses
+     * @param {String} tokenUris tokenURI
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value
+     */
+    batchMint<G extends boolean = false>(users: Array<string>, tokenUris: Array<string>, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Delete address from access list
+     * @param {Number} tokenId token ID
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value
+     */
+    burn<G extends boolean = false>(tokenId: number, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Transfer Ownership of an access list, called by owner of access list
+     * @param {Number} newOwner new owner of the access list
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value
+     */
+    transferOwnership<G extends boolean = false>(newOwner: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+    /**
+     * Renounce Ownership of an access list, called by owner of access list
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value
+     */
+    renounceOwnership<G extends boolean = false>(estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+}

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

@@ -0,0 +1,56 @@
+import { BigNumber, Signer } from 'ethers';
+import { Config } from '../config';
+import { AbiItem, ReceiptOrEstimate } from '../@types';
+import { SmartContractWithAddress } from './SmartContractWithAddress';
+/**
+ * Provides an interface for Access List Factory contract
+ */
+export declare class AccesslistFactory extends SmartContractWithAddress {
+    getDefaultAbi(): AbiItem[];
+    /**
+     * Instantiate AccessListFactory class
+     * @param {string} address The factory 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[]);
+    /**
+     * Create new Access List Contract
+     * @param {string} nameAccessList The name for access list.
+     * @param {string} symbolAccessList The symbol for access list.
+     * @param {string[]} tokenURI Token URIs list.
+     * @param {boolean} transferable Default false, to be soulbound.
+     * @param {string} owner Owner of the access list.
+     * @param {string[]} user Users of the access lists as addresses.
+     * @param {Boolean} [estimateGas] if True, return gas estimate
+     * @return {Promise<string|BigNumber>} The transaction hash or the gas estimate.
+     */
+    deployAccessListContract<G extends boolean = false>(nameAccessList: string, symbolAccessList: string, tokenURI: string[], transferable: boolean, owner: string, user: string[], estimateGas?: G): Promise<G extends false ? string : BigNumber>;
+    /**
+     *  Get Factory Owner
+     * @return {Promise<string>} Factory Owner address
+     */
+    getOwner(): Promise<string>;
+    /**
+     *  Is a list contract soul bound?
+     * @param {String} contractAddress list contract address
+     * @return {Promise<boolean>} is soulbound?
+     */
+    isSoulbound(contractAddress: string): Promise<boolean>;
+    /**
+     *  Is a list contract deployed?
+     * @param {String} contractAddress list contract address
+     * @return {Promise<boolean>} is deployed?
+     */
+    isDeployed(contractAddress: string): Promise<boolean>;
+    /**
+     * changeTemplateAddress - only factory Owner
+     * @param {String} owner caller address
+     * @param {Number} templateAddress address of the template we want to change
+     * @param {Boolean} estimateGas if True, return gas estimate
+     * @return {Promise<ReceiptOrEstimate>} returns the transaction receipt or the estimateGas value, current token template count
+     */
+    changeTemplateAddress<G extends boolean = false>(owner: string, templateAddress: string, estimateGas?: G): Promise<ReceiptOrEstimate<G>>;
+}