Skip to main content
Version: Next

Class: Nautilus

Nautilus.Nautilus

Constructors

constructor

Private new Nautilus(signer)

Parameters

NameType
signerSigner

Defined in

src/Nautilus/Nautilus.ts:44

Properties

config

Private config: Config

Defined in

src/Nautilus/Nautilus.ts:42


signer

Private signer: Signer

Defined in

src/Nautilus/Nautilus.ts:41

Methods

access

access(accessConfig): Promise<string>

Parameters

NameTypeDescription
accessConfigOmit<AccessConfig, "signer" | "chainConfig">configuration object

Returns

Promise<string>

Defined in

src/Nautilus/Nautilus.ts:317


compute

compute(computeConfig): Promise<ComputeJob | ComputeJob[]>

Parameters

NameType
computeConfigOmit<ComputeConfig, "signer" | "chainConfig">

Returns

Promise<ComputeJob | ComputeJob[]>

Defined in

src/Nautilus/Nautilus.ts:324


edit

edit(asset): Promise<PublishResponse>

Parameters

NameType
assetNautilusAsset

Returns

Promise<PublishResponse>

Defined in

src/Nautilus/Nautilus.ts:197


getAquariusAsset

getAquariusAsset(did): Promise<Asset>

Parameters

NameType
didstring

Returns

Promise<Asset>

Defined in

src/Nautilus/Nautilus.ts:280


getAquariusAssets

getAquariusAssets(dids): Promise<{ [did: string]: Asset; }>

Parameters

NameType
didsstring[]

Returns

Promise<{ [did: string]: Asset; }>

Defined in

src/Nautilus/Nautilus.ts:272


getChainConfig

Private getChainConfig(): Pick<CreateAssetConfig, "signer" | "chainConfig">

Returns

Pick<CreateAssetConfig, "signer" | "chainConfig">

Defined in

src/Nautilus/Nautilus.ts:115


getComputeResult

getComputeResult(computeResultConfig): Promise<string>

Parameters

NameType
computeResultConfigOmit<ComputeResultConfig, "signer">

Returns

Promise<string>

Defined in

src/Nautilus/Nautilus.ts:340


getComputeStatus

getComputeStatus(computeStatusConfig): Promise<ComputeJob>

Parameters

NameType
computeStatusConfigOmit<ComputeStatusConfig, "signer">

Returns

Promise<ComputeJob>

Defined in

src/Nautilus/Nautilus.ts:331


getOceanConfig

getOceanConfig(): Config

Returns

Config

Defined in

src/Nautilus/Nautilus.ts:127


hasValidConfig

Private hasValidConfig(): boolean

Returns

boolean

Defined in

src/Nautilus/Nautilus.ts:102


init

Private init(config?): Promise<void>

Parameters

NameType
config?Partial<Config>

Returns

Promise<void>

Defined in

src/Nautilus/Nautilus.ts:75


loadOceanConfig

Private loadOceanConfig(config?): Promise<void>

Parameters

NameType
config?Partial<Config>

Returns

Promise<void>

Defined in

src/Nautilus/Nautilus.ts:79


publish

publish(asset): Promise<PublishResponse>

Parameters

NameType
assetNautilusAsset

Returns

Promise<PublishResponse>

Defined in

src/Nautilus/Nautilus.ts:131


setAssetLifecycleState

setAssetLifecycleState(aquariusAsset, state): Promise<TransactionReceipt>

Parameters

NameType
aquariusAssetAsset
stateLifecycleStates

Returns

Promise<TransactionReceipt>

Defined in

src/Nautilus/Nautilus.ts:288


setServicePrice

setServicePrice(aquaAsset, serviceId, newPrice): Promise<TransactionReceipt>

Parameters

NameType
aquaAssetAsset
serviceIdstring
newPricestring

Returns

Promise<TransactionReceipt>

Defined in

src/Nautilus/Nautilus.ts:254


create

Static create(signer, config?): Promise<Nautilus>

Creates a new Nautilus instance

Parameters

NameType
signerSigner
config?Partial<Config>

Returns

Promise<Nautilus>

Defined in

src/Nautilus/Nautilus.ts:51


setLogLevel

Static setLogLevel(level): void

Set the log level for Nautilus ocean.js LoggerInstance is used for logging

Parameters

NameType
levelLogLevel

Returns

void

Defined in

src/Nautilus/Nautilus.ts:70