Class Client

Massa Web3 Client object wraps all public, private, wallet and smart-contracts-related functionalities.

Implements

IClient

Index

Constructors

Properties

clientConfig mnsResolverVar privateApiClient publicApiClient smartContractsClient walletClient

Methods

getPrivateProviders getProviders getPublicProviders mnsResolver privateApi publicApi setCustomProviders setNewDefaultProvider setNewMnsResolver smartContracts wallet

Constructors

constructor

new Client(clientConfig, baseAccount?, publicApiClient?, mnsResolverAddress?): Client
Constructor of the Client class.
Parameters
- clientConfig: IClientConfig
  client configuration object.
- Optional baseAccount: IBaseAccount
  base account to use for signing transactions (optional).
- Optional publicApiClient: PublicApiClient
  public api client to use (optional).
- Optional mnsResolverAddress: string
  MNS resolver address to use (optional).
Returns Client
- Defined in packages/massa-web3/src/web3/Client.ts:30

Properties

`Private` clientConfig

clientConfig: IClientConfig

client configuration object.

`Private` mnsResolverVar

mnsResolverVar: MnsResolver

`Private` privateApiClient

privateApiClient: PrivateApiClient

`Private` publicApiClient

publicApiClient: PublicApiClient

`Private` smartContractsClient

smartContractsClient: SmartContractsClient

`Private` walletClient

walletClient: WalletClient

Methods

getPrivateProviders

getPrivateProviders(): IProvider[]
Get all private providers.

Returns IProvider[]
all private providers.
- Defined in packages/massa-web3/src/web3/Client.ts:138

getProviders

getProviders(): IProvider[]
Get the currently set providers.

Returns IProvider[]
array of the known providers.
- Defined in packages/massa-web3/src/web3/Client.ts:129

getPublicProviders

getPublicProviders(): IProvider[]
Get all public providers

Returns IProvider[]
all public providers
- Defined in packages/massa-web3/src/web3/Client.ts:149

mnsResolver

mnsResolver(): MnsResolver
Get the MNS resolver object.

Returns MnsResolver
MnsResolver object.
Implementation of IClient.mnsResolver
- Defined in packages/massa-web3/src/web3/Client.ts:108

privateApi

privateApi(): PrivateApiClient
Get the private api related RPC methods.

Returns PrivateApiClient
PrivateApiClient object.
Implementation of IClient.privateApi
- Defined in packages/massa-web3/src/web3/Client.ts:72

publicApi

publicApi(): PublicApiClient
Get the public api related RPC methods.

Returns PublicApiClient
PublicApiClient object.
Implementation of IClient.publicApi
- Defined in packages/massa-web3/src/web3/Client.ts:81

setCustomProviders

setCustomProviders(providers): void
Set new providers.
Parameters
- providers: IProvider[]
  array of providers to set.
Returns void
Implementation of IClient.setCustomProviders
- Defined in packages/massa-web3/src/web3/Client.ts:117

setNewDefaultProvider

setNewDefaultProvider(provider): void
Set a new default json rpc provider.
Parameters
- provider: DefaultProviderUrls
  The new default provider to set.
Returns void
Implementation of IClient.setNewDefaultProvider
- Defined in packages/massa-web3/src/web3/Client.ts:160

setNewMnsResolver

setNewMnsResolver(contractAddress): void
Set a new MNS resolver address.
Parameters
- contractAddress: string
  The new MNS resolver contract address.
Returns void
Implementation of IClient.setNewMnsResolver
- Defined in packages/massa-web3/src/web3/Client.ts:182

smartContracts

smartContracts(): SmartContractsClient
Get the smart Contracts related methods.

Returns SmartContractsClient
SmartContractsClient object.
Implementation of IClient.smartContracts
- Defined in packages/massa-web3/src/web3/Client.ts:99

wallet

wallet(): WalletClient
Get the Wallet related methods.

Returns WalletClient
WalletClient object.
Implementation of IClient.wallet
- Defined in packages/massa-web3/src/web3/Client.ts:90

Generated using TypeDoc