Class VeChainProvider

constructor

• new VeChainProvider(thorClient, wallet?, enableDelegation?): VeChainProvider

• Constructor for VeChainProvider

  Parameters

  • thorClient: ThorClient

    ThorClient instance.
  • Optionalwallet: ProviderInternalWallet

    ProviderInternalWallet instance. It is optional because the majority of the methods do not require a wallet.
  • enableDelegation: boolean = false

    Enable fee delegation or not.

  Returns VeChainProvider

  Throws

ReadonlyenableDelegation

ReadonlysubscriptionManager

ReadonlythorClient

Optional Readonlywallet

destroy

• destroy(): void

• Destroys the provider by closing the thorClient and stopping the provider poll instance if present. This is because thorClient and the provider might be initialized with a polling interval.

  Returns void

getPollInstance

• getPollInstance(): EventPoll<SubscriptionEvent[]>

• Returns the poll instance for subscriptions.

  Returns EventPoll<SubscriptionEvent[]>

getSigner

• getSigner(addressOrIndex?): Promise<VeChainSigner>

• Get a signer into the internal wallet provider for the given address.

  Parameters

  • OptionaladdressOrIndex: string | number

    Address of index of the account.

  Returns Promise<VeChainSigner>

  The signer for the given address.

isThereActiveSubscriptions

• isThereActiveSubscriptions(): boolean

• Checks if there are active subscriptions. This method checks if there are any active log subscriptions or a new heads subscription.

  Returns boolean

  A boolean indicating whether there are active subscriptions.

lookupAddress

• lookupAddress(address): Promise<string>

• Use vet.domains to look up a verified primary name for an address

  Parameters

  • address: string

    The address to lookup

  Returns Promise<string>

  the primary name for an address or null

request

• request(args): Promise<unknown>

• This method is used to send a request to the provider. Basically, it is a wrapper around the RPCMethodsMap.

  Parameters

  • args: EIP1193RequestArguments

    Method and parameters to be used for the request.

  Returns Promise<unknown>

  The result of the request.

  Throws

resolveName

• resolveName(vnsName): Promise<string>

• Use vet.domains to resolve name to address

  Parameters

  • vnsName: string

    The name to resolve

  Returns Promise<string>

  the address for a name or null

startSubscriptionsPolling

• startSubscriptionsPolling(): boolean

• Initializes and starts the polling mechanism for subscription events. This method sets up an event poll that periodically checks for new events related to active subscriptions, such as 'newHeads' or log subscriptions. When new data is available, it emits these events to listeners.

  This method leverages the Poll.createEventPoll utility to create the polling mechanism, which is then started by invoking startListen on the poll instance.

  Returns boolean

stopSubscriptionsPolling

• stopSubscriptionsPolling(): boolean

• Stops the polling mechanism for subscription events. This method stops the polling mechanism for subscription events, if it is active.

  Returns boolean

  A boolean indicating whether the polling mechanism was stopped.