Skip to content

getPortalStatus

Fetch the lifecycle status of a single portal by address. Delegates to the backend, which returns null when no portal matches (404).

Import

ts
import { getPortalStatus } from "@0xcurvy/curvy-sdk/actions";

Usage

ts
const status = await getPortalStatus({ address: "0x..." });

Signature

ts
function getPortalStatus(parameters: GetPortalStatusParameters): Promise<PortalStatusResponse | null>

Returns

Promise<PortalStatusResponse | null>

The action resolves or returns the value shown in the signature.

Parameters

address

  • Type: string
  • Required: yes

Portal address (EVM hex or Solana base58) to look up.

ts
const result = await getPortalStatus({
  address, 
});

config

  • Type: CurvyConfig
  • Required: no

Curvy config to use. Defaults to the ambient config.

ts
const result = await getPortalStatus({
  address,
  config, 
});

Errors

Errors from config resolution and the underlying SDK operation are propagated to the caller.

Source

packages/@0xcurvy/sdk/src/actions/portals/getPortalStatus.ts