Class CustomnetWorker

The main interface to near-workspaces. Create a new worker instance with init, then run code on it.

Hierarchy

Worker
- CustomnetWorker

Index

Constructors

Properties

clientConfig config manager

Accessors

defaultConfig provider rootAccount

Methods

Constructors

constructor

new CustomnetWorker(config): CustomnetWorker
Parameters
- config: Config
Returns CustomnetWorker
Inherited from Worker.constructor
- Defined in packages/js/src/worker.ts:21

Properties

`Private` `Readonly` clientConfig

clientConfig: ClientConfig = ...

`Protected` config

config: Config

`Protected` manager

manager: NearAccountManager

Accessors

defaultConfig

get defaultConfig(): Config
Returns Config
- Defined in packages/js/src/worker.ts:103

provider

get provider(): JsonRpcProvider
Returns JsonRpcProvider
Overrides Worker.provider
- Defined in packages/js/src/worker.ts:94

rootAccount

get rootAccount(): NearAccount
Returns NearAccount
Inherited from Worker.rootAccount
- Defined in packages/js/src/worker.ts:58

Methods

tearDown

tearDown(): Promise<void>
Returns Promise<void>
Overrides Worker.tearDown
- Defined in packages/js/src/worker.ts:98

`Static` init

init(config): Promise<CustomnetWorker>
Initialize a new worker.

In local sandbox mode, this will:
- Create a new local blockchain
- Load the root account for that blockchain, available as root:
In testnet mode, the same functionality is achieved via different means: creating a new account as the root. Since all actions must occur on one blockchain instead of N.
Parameters
- config: Partial<Config>
  
  a configuration object
Returns Promise<CustomnetWorker>
an instance of the Worker class
Overrides Worker.init
- Defined in packages/js/src/worker.ts:72

Generated using TypeDoc