Class ContractsAPI

Contracts API for accessing contract addresses from the Nevermined API info endpoint.

Hierarchy

BasePaymentsAPI
- ContractsAPI

Constructors

constructor

new ContractsAPI(options: PaymentOptions): ContractsAPI
Parameters
- options: PaymentOptions
Returns ContractsAPI
Overrides BasePaymentsAPI.constructor
- Defined in src/api/contracts-api.ts:17

Properties

`Protected`accountAddress

accountAddress: string

`Protected` `Optional`appId

appId?: string

`Protected`currentOrganizationId

currentOrganizationId: string | null

`Protected`environment

environment: EnvironmentInfo

`Protected`environmentName

environmentName: EnvironmentName

`Protected`heliconeApiKey

heliconeApiKey: string

isBrowserInstance

isBrowserInstance: boolean = true

`Protected`nvmApiKey

nvmApiKey: string

`Protected`returnUrl

returnUrl: string

`Protected`scheme

scheme: "nvm"

`Protected` `Optional`version

version?: string

Methods

getAccountAddress

getAccountAddress(): string | undefined
It returns the account address associated with the NVM API Key used to initialize the Payments Library instance.

Returns string | undefined
The account address extracted from the NVM API Key
Inherited from BasePaymentsAPI.getAccountAddress
- Defined in src/api/base-payments.ts:125

`Protected`getBackendHTTPOptions

getBackendHTTPOptions(
    method: string,
    body?: any,
    extraHeaders?: Record<string, string>,
): any
Internal
Returns the HTTP options required to query the backend.
Parameters
- method: string
  HTTP method.
- Optionalbody: any
  Optional request body.
- OptionalextraHeaders: Record<string, string>
  Optional per-call header overrides. Use { 'X-Current-Org-Id': orgId } to target a specific workspace for one call without mutating the instance-level pin.
Returns any
HTTP options object.
Inherited from BasePaymentsAPI.getBackendHTTPOptions
- Defined in src/api/base-payments.ts:162

getContractAddress

getContractAddress(contractName: string): Promise<`0x${string}`>
Get a contract address by name (e.g., "PayAsYouGoTemplate").
Parameters
- contractName: string
Returns Promise<`0x${string}`>
- Defined in src/api/contracts-api.ts:53

getDeploymentInfo

getDeploymentInfo(): Promise<DeploymentInfo>
Fetch deployment info (including contract addresses) from the API root. The result is cached after the first call.

Returns Promise<DeploymentInfo>
- Defined in src/api/contracts-api.ts:25

getEnvironmentName

getEnvironmentName(): EnvironmentName
Returns the environment name used to initialize the Payments instance.

Returns EnvironmentName
The environment name (e.g. 'sandbox', 'live')
Inherited from BasePaymentsAPI.getEnvironmentName
- Defined in src/api/base-payments.ts:117

getOrganizationId

getOrganizationId(): string | null
Returns the current organization context applied to every authenticated backend request via the X-Current-Org-Id header.

null means "no pinned workspace" — the backend falls back to the caller's API-key tag or most-recent active membership.

Returns string | null
Inherited from BasePaymentsAPI.getOrganizationId
- Defined in src/api/base-payments.ts:136

getPayAsYouGoTemplateAddress

getPayAsYouGoTemplateAddress(): Promise<`0x${string}`>
Get the PayAsYouGoTemplate contract address (convenience accessor).

Returns Promise<`0x${string}`>
- Defined in src/api/contracts-api.ts:65

`Protected`getPublicHTTPOptions

getPublicHTTPOptions(
    method: string,
    body?: any,
): {
    body?: string;
    headers: { Accept: string; "Content-Type": string };
    method: string;
}
Internal
Get HTTP options for public backend requests (no authorization header). Converts body keys from snake_case to camelCase for consistency.
Parameters
- method: string
  HTTP method
- Optionalbody: any
  Optional request body (keys will be converted to camelCase)
Returns {
    body?: string;
    headers: { Accept: string; "Content-Type": string };
    method: string;
}
HTTP options object
Inherited from BasePaymentsAPI.getPublicHTTPOptions
- Defined in src/api/base-payments.ts:201

`Protected`parseNvmApiKey

parseNvmApiKey(): { accountAddress: string; heliconeApiKey: string }
Parses the NVM API Key to extract the account address.

Returns { accountAddress: string; heliconeApiKey: string }
Throws
PaymentsError if the API key is invalid.
Inherited from BasePaymentsAPI.parseNvmApiKey
- Defined in src/api/base-payments.ts:99

setOrganizationId

setOrganizationId(organizationId: string | null): void
Sets the organization context applied to every subsequent authenticated backend request via the X-Current-Org-Id header.

Pass null to clear the pin and fall back to the backend default.
Parameters
- organizationId: string | null
  Org ID (e.g. org-…) or null to clear.
Returns void
Inherited from BasePaymentsAPI.setOrganizationId
- Defined in src/api/base-payments.ts:148

Class ContractsAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ContractsAPI

Properties

ProtectedaccountAddress

Protected OptionalappId

ProtectedcurrentOrganizationId

Protectedenvironment

ProtectedenvironmentName

ProtectedheliconeApiKey

isBrowserInstance

ProtectednvmApiKey

ProtectedreturnUrl

Protectedscheme

Protected Optionalversion

Methods

getAccountAddress

Returns string | undefined

ProtectedgetBackendHTTPOptions

Parameters

Returns any

getContractAddress

Parameters

Returns Promise<`0x${string}`>

getDeploymentInfo

Returns Promise<DeploymentInfo>

getEnvironmentName

Returns EnvironmentName

getOrganizationId

Returns string | null

getPayAsYouGoTemplateAddress

Returns Promise<`0x${string}`>

ProtectedgetPublicHTTPOptions

Parameters

Returns { body?: string; headers: { Accept: string; "Content-Type": string }; method: string;}

ProtectedparseNvmApiKey

Returns { accountAddress: string; heliconeApiKey: string }

Throws

setOrganizationId

Parameters

Returns void

Settings

On This Page

`Protected`accountAddress

`Protected` `Optional`appId

`Protected`currentOrganizationId

`Protected`environment

`Protected`environmentName

`Protected`heliconeApiKey

`Protected`nvmApiKey

`Protected`returnUrl

`Protected`scheme

`Protected` `Optional`version

`Protected`getBackendHTTPOptions

`Protected`getPublicHTTPOptions

Returns {
body?: string;
headers: { Accept: string; "Content-Type": string };
method: string;
}

`Protected`parseNvmApiKey