Class PrivateApiClient

Private Api Client for interacting with a massa node.

Hierarchy

BaseClient
- PrivateApiClient

Implements

IPrivateApiClient

Index

Constructors

constructor

new PrivateApiClient(clientConfig: IClientConfig): PrivateApiClient
Constructor for the PrivateApiClient object.
Parameters
- clientConfig: IClientConfig
  
  The client configuration.
Returns PrivateApiClient
Overrides BaseClient.constructor
- Defined in src/web3/PrivateApiClient.ts:17

Properties

clientConfig

clientConfig: IClientConfig

Methods

`Protected` compactBytesForOperation

compactBytesForOperation(data: DataType, opTypeId: OperationTypeId, expirePeriod: number): Buffer
Compacts bytes payload per operation.

Returns
The compacted bytes payload.
Parameters
- data: DataType
  
  The operation data.
- opTypeId: OperationTypeId
  
  The operation type id.
- expirePeriod: number
  
  The expire period.
Returns Buffer
Inherited from BaseClient.compactBytesForOperation
- Defined in src/web3/BaseClient.ts:277

`Protected` getPrivateProviders

getPrivateProviders(): IProvider[]
Returns all the private providers.

Returns
An array of IProvider containing all the private providers.

Returns IProvider[]
Inherited from BaseClient.getPrivateProviders
- Defined in src/web3/BaseClient.ts:113

`Protected` getPublicProviders

getPublicProviders(): IProvider[]
Returns all the public providers.

Returns
An array of IProvider containing all the public providers.

Returns IProvider[]
Inherited from BaseClient.getPublicProviders
- Defined in src/web3/BaseClient.ts:124

nodeAddStakingSecretKeys

nodeAddStakingSecretKeys(secretKeys: string[]): Promise<void>
Add staking private keys.

Returns
A promise that resolves when the request is complete.
Parameters
- secretKeys: string[]
  
  The secret keys to add.
Returns Promise<void>
Implementation of IPrivateApiClient.nodeAddStakingSecretKeys
- Defined in src/web3/PrivateApiClient.ts:251

nodeAddToPeersWhitelist

nodeAddToPeersWhitelist(ipAddress: string): Promise<void>
Add a given Node IP address from the whitelist.

Returns
A promise that resolves when the request is complete.
Parameters
- ipAddress: string
  
  The IP address to add to the whitelist.
Returns Promise<void>
Implementation of IPrivateApiClient.nodeAddToPeersWhitelist
- Defined in src/web3/PrivateApiClient.ts:44

nodeBanById

nodeBanById(id: string): Promise<void>
Ban a given node Id.

Returns
A promise that resolves when the request is complete.
Parameters
- id: string
  
  The node id to ban.
Returns Promise<void>
Implementation of IPrivateApiClient.nodeBanById
- Defined in src/web3/PrivateApiClient.ts:149

nodeBanByIpAddress

nodeBanByIpAddress(ipAddress: string): Promise<void>
Ban a given node IP address.

Returns
A promise that resolves when the request is complete.
Parameters
- ipAddress: string
  
  The IP address to ban.
Returns Promise<void>
Implementation of IPrivateApiClient.nodeBanByIpAddress
- Defined in src/web3/PrivateApiClient.ts:128

nodeGetStakingAddresses

nodeGetStakingAddresses(): Promise<string[]>
Get staking addresses.

Returns
A promise that resolves to an array of addresses (strings).

Returns Promise<string[]>
Implementation of IPrivateApiClient.nodeGetStakingAddresses
- Defined in src/web3/PrivateApiClient.ts:205

nodeRemoveFromWhitelist

nodeRemoveFromWhitelist(ipAddress: string): Promise<void>
Remove a given Node IP address from the whitelist.

Returns
A promise that resolves when the request is complete.
Parameters
- ipAddress: string
  
  The IP address to remove from the whitelist.
Returns Promise<void>
Implementation of IPrivateApiClient.nodeRemoveFromWhitelist
- Defined in src/web3/PrivateApiClient.ts:66

nodeRemoveStakingAddresses

nodeRemoveStakingAddresses(addresses: string[]): Promise<void>
Remove staking addresses.

Returns
A promise that resolves when the request is complete.
Parameters
- addresses: string[]
  
  The addresses to remove.
Returns Promise<void>
Implementation of IPrivateApiClient.nodeRemoveStakingAddresses
- Defined in src/web3/PrivateApiClient.ts:227

nodeSignMessage

nodeSignMessage(message: Uint8Array): Promise<ISignedMessage>
Node signs a message.

Returns
A promise that resolves to an ISignedMessage object.
Parameters
- message: Uint8Array
  
  The message to sign.
Returns Promise<ISignedMessage>
Implementation of IPrivateApiClient.nodeSignMessage
- Defined in src/web3/PrivateApiClient.ts:185

nodeStop

nodeStop(): Promise<void>
Stops the node.

Returns
A promise that resolves when the request is complete.

Returns Promise<void>
Implementation of IPrivateApiClient.nodeStop
- Defined in src/web3/PrivateApiClient.ts:166

nodeUnbanById

nodeUnbanById(nodeId: string): Promise<void>
Unban a given node id.

Returns
A promise that resolves when the request is complete.
Parameters
- nodeId: string
  
  The node id to unban.
Returns Promise<void>
Implementation of IPrivateApiClient.nodeUnbanById
- Defined in src/web3/PrivateApiClient.ts:108

nodeUnbanByIpAddress

nodeUnbanByIpAddress(ipAddress: string): Promise<void>
Unban a given IP address.

Returns
A promise that resolves when the request is complete.
Parameters
- ipAddress: string
  
  The IP address to unban.
Returns Promise<void>
Implementation of IPrivateApiClient.nodeUnbanByIpAddress
- Defined in src/web3/PrivateApiClient.ts:88

`Protected` sendJsonRPCRequest

sendJsonRPCRequest<T>(resource: JSON_RPC_REQUEST_METHOD, params: object): Promise<T>
Sends a post JSON rpc request to the node.

Throws
An error if the rpc method returns an error.

Returns
A promise that resolves as the result of the rpc method.
Type Parameters
- T
Parameters
- resource: JSON_RPC_REQUEST_METHOD
  
  The rpc method to call.
- params: object
  
  The parameters to pass to the rpc method.
Returns Promise<T>
Inherited from BaseClient.sendJsonRPCRequest
- Defined in src/web3/BaseClient.ts:252

setProviders

setProviders(providers: IProvider[]): void
Set new providers as IProvider.

Throws
Will throw an error if no public providers are included in the given array of providers.

Throws
Will throw an error if no private providers are included in the given array of providers.
Parameters
- providers: IProvider[]
  
  The new providers to set as an array of IProvider.
Returns void
Inherited from BaseClient.setProviders
- Defined in src/web3/BaseClient.ts:94

Class PrivateApiClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

clientConfig: IClientConfig

Returns PrivateApiClient

Properties

clientConfig

Methods

Protected compactBytesForOperation

Returns

Parameters

data: DataType

opTypeId: OperationTypeId

expirePeriod: number

Returns Buffer

Protected getPrivateProviders

Returns

Returns IProvider[]

Protected getPublicProviders

Returns

Returns IProvider[]

nodeAddStakingSecretKeys

Returns

Parameters

secretKeys: string[]

Returns Promise<void>

nodeAddToPeersWhitelist

Returns

Parameters

ipAddress: string

Returns Promise<void>

nodeBanById

Returns

Parameters

id: string

Returns Promise<void>

nodeBanByIpAddress

Returns

Parameters

ipAddress: string

Returns Promise<void>

nodeGetStakingAddresses

Returns

Returns Promise<string[]>

nodeRemoveFromWhitelist

Returns

Parameters

ipAddress: string

Returns Promise<void>

nodeRemoveStakingAddresses

Returns

Parameters

addresses: string[]

Returns Promise<void>

nodeSignMessage

Returns

Parameters

message: Uint8Array

Returns Promise<ISignedMessage>

nodeStop

Returns

Returns Promise<void>

nodeUnbanById

Returns

Parameters

nodeId: string

Returns Promise<void>

nodeUnbanByIpAddress

Returns

Parameters

ipAddress: string

Returns Promise<void>

Protected sendJsonRPCRequest

`Protected` compactBytesForOperation

`Protected` getPrivateProviders

`Protected` getPublicProviders

`Protected` sendJsonRPCRequest