Class ContractsAPI

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

Hierarchy

  • BasePaymentsAPI
    • ContractsAPI

Constructors

constructor

Properties

accountAddress appId? deploymentInfo? environment environmentName heliconeApiKey isBrowserInstance nvmApiKey returnUrl version?

Methods

getAccountAddress getBackendHTTPOptions getContractAddress getDeploymentInfo getPayAsYouGoTemplateAddress parseNvmApiKey

Constructors

constructor

Properties

Protected accountAddress

accountAddress: string

Protected Optional appId

appId?: string

Private Optional deploymentInfo

deploymentInfo?: DeploymentInfo

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 Optional version

version?: string

Methods

getAccountAddress

  • getAccountAddress(): undefined | string

  • It returns the account address associated with the NVM API Key used to initialize the Payments Library instance.

    Returns undefined | string

    The account address extracted from the NVM API Key

Protected getBackendHTTPOptions

  • getBackendHTTPOptions(method, body?): any
  • Internal

    Returns the HTTP options required to query the backend.

    Parameters

    • method: string

      HTTP method.

    • Optional body: any

      Optional request body.

    Returns any

    HTTP options object.

getContractAddress

  • getContractAddress(contractName): Promise<`0x${string}`>

  • Get a contract address by name (e.g., "PayAsYouGoTemplate").

    Parameters

    • contractName: string

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

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>

getPayAsYouGoTemplateAddress

  • getPayAsYouGoTemplateAddress(): Promise<`0x${string}`>

  • Get the PayAsYouGoTemplate contract address (convenience accessor).

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

Protected parseNvmApiKey

  • parseNvmApiKey(): {
        accountAddress: string;
        heliconeApiKey: string;
    }

  • Parses the NVM API Key to extract the account address.

    Returns {
        accountAddress: string;
        heliconeApiKey: string;
    }

    • accountAddress: string
    • heliconeApiKey: string

    Throws

    PaymentsError if the API key is invalid.

Settings

Member Visibility

Theme

On This Page

constructoraccountAddressappIddeploymentInfoenvironmentenvironmentNameheliconeApiKeyisBrowserInstancenvmApiKeyreturnUrlversiongetAccountAddressgetBackendHTTPOptionsgetContractAddressgetDeploymentInfogetPayAsYouGoTemplateAddressparseNvmApiKey