Ocean Node client

In v1 there were two services: Aquarius for metadata and Provider for everything else. v2 talks to a single ocean-node, which serves metadata, provider services, the indexer and compute — which is why metadataCacheUri and providerUri collapsed into one oceanNodeUri.

Most of the time nautilus wraps this for you. When it does not, take the client.

const node = nautilus.getNodeClient() 
 
const status = await node.getNodeStatus()

Checking what you are pointed at

Worth doing first when something behaves unexpectedly — a v1 Provider and an ocean-node answer on the same port but are not the same thing.

const node = nautilus.getNodeClient()
 
const ok = await node.isValidNode() 
const status = await node.getNodeStatus() 

Authentication

The client accepts three forms of auth, expressed as NodeAuth:

Minting a token is worth it for anything doing many calls:

const token = await createAuthToken(signer, nodeUri) 
 
// … many calls later
await revokeAuthToken(signer, token, nodeUri) 

Calls nautilus does not wrap

Files

// What the node can see about a file, before you publish it.
const info = await node.getFileInfo(
  { type: 'url', url: 'https://data.example/x.csv', method: 'GET' } as never
)
 
// Whether a published asset's files are still readable.
const check = await node.checkDidFiles('did:ope:1234abcd...', 'service-id') 

checkDidFiles is the quickest way to find out whether an asset has rotted — a file server that went away shows up here rather than at download time.

Buckets

The node's persistent storage, which is what NodePersistentRemoteStore uses underneath.

const bucketId = await node.createBucket([], 'my-bucket') 
 
// `content` is a request body stream, not a string — a web `ReadableStream`,
// a Node stream or a `Blob` all work.
await node.uploadFile(bucketId, 'notes.txt', new Blob(['hello']).stream()) 
 
const object = await node.getFileObject(bucketId, 'notes.txt')

Remote validation

Local validation is what publish runs. If you also want the node's opinion:

const result = await node.validateRemote(ddo) 

Errors

Every call is wrapped, so failures arrive as OceanNodeError with the operation named and the original error kept on cause.

try {
  await run()
} catch (error) {
  if (error instanceof OceanNodeError) {
    console.error(error.operation, error.message, error.cause) 
  }
}

Building one directly

You rarely need to — Nautilus.create builds it — but the constructor is public.

const node = new OceanNodeClient({
  nodeUri: 'https://ocean-node.dev.pontus-x.eu',
  chainId: 32456,
  auth: signer
})

nodeUri also accepts a peerId or multiaddr, which switches it to the libp2p transport.