Class contracts

Hierarchy

contracts

Constructors

constructor

new contracts(config: GridClientConfig): contracts

- Defined in packages/grid_client/src/modules/contracts.ts:41
Parameters
- config: GridClientConfig
Returns contracts

Properties

client

client: TFClient

config

config: GridClientConfig

nodes

nodes: Nodes

Methods

activeRentContractForNode

activeRentContractForNode(options: RentContractGetModel): Promise<number>

- Defined in packages/grid_client/src/modules/contracts.ts:107
Parameters
- options: RentContractGetModel
Returns Promise<number>

approveServiceContract

approveServiceContract(options: ServiceContractApproveModel): Promise<ServiceContract>

- Defined in packages/grid_client/src/modules/contracts.ts:162
Parameters
- options: ServiceContractApproveModel
Returns Promise<ServiceContract>

batchCancelContracts

batchCancelContracts(options: BatchCancelContractsModel): Promise<number[]>

- Defined in packages/grid_client/src/modules/contracts.ts:217
Parameters
- options: BatchCancelContractsModel
Returns Promise<number[]>

billServiceContract

billServiceContract(options: ServiceContractBillModel): Promise<ServiceContract>

- Defined in packages/grid_client/src/modules/contracts.ts:169
Parameters
- options: ServiceContractBillModel
Returns Promise<ServiceContract>

cancel

cancel(options: ContractCancelModel): Promise<number>

- Defined in packages/grid_client/src/modules/contracts.ts:126
Parameters
- options: ContractCancelModel
Returns Promise<number>

cancelMyContracts

cancelMyContracts(): Promise<Record<string, number>[]>

- Defined in packages/grid_client/src/modules/contracts.ts:206
WARNING: Please be careful when executing this method, it will delete all your contracts.

Returns Promise<Record<string, number>[]>
Promise

cancelServiceContract

cancelServiceContract(options: ServiceContractCancelModel): Promise<number>

- Defined in packages/grid_client/src/modules/contracts.ts:176
Parameters
- options: ServiceContractCancelModel
Returns Promise<number>

contractLock

contractLock(options: ContractLockModel): Promise<ContractLock>

- Defined in packages/grid_client/src/modules/contracts.ts:113
Parameters
- options: ContractLockModel
Returns Promise<ContractLock>

createServiceContract

createServiceContract(options: CreateServiceContractModel): Promise<ServiceContract>

- Defined in packages/grid_client/src/modules/contracts.ts:156
Parameters
- options: CreateServiceContractModel
Returns Promise<ServiceContract>

create_name

create_name(options: NameContractCreateModel): Promise<Contract>

- Defined in packages/grid_client/src/modules/contracts.ts:79
Parameters
- options: NameContractCreateModel
Returns Promise<Contract>

create_node

create_node(options: NodeContractCreateModel): Promise<Contract>

- Defined in packages/grid_client/src/modules/contracts.ts:65
Parameters
- options: NodeContractCreateModel
Returns Promise<Contract>

get

get(options: ContractGetModel): Promise<Contract>

- Defined in packages/grid_client/src/modules/contracts.ts:84
Parameters
- options: ContractGetModel
Returns Promise<Contract>

getConsumption

getConsumption(options: ContractConsumption): Promise<number>

- Defined in packages/grid_client/src/modules/contracts.ts:240
Get contract consumption per hour in TFT.

Parameters
- options: ContractConsumption
Returns Promise<number>

getDedicatedNodeExtraFee

getDedicatedNodeExtraFee(options: GetDedicatedNodePriceModel): Promise<number>

- Defined in packages/grid_client/src/modules/contracts.ts:101
Parameters
- options: GetDedicatedNodePriceModel
Returns Promise<number>

getDeletionTime

getDeletionTime(options: ContractGetModel): Promise<string | number>

- Defined in packages/grid_client/src/modules/contracts.ts:246
Parameters
- options: ContractGetModel
Returns Promise<string | number>

getServiceContract

getServiceContract(options: GetServiceContractModel): Promise<ServiceContract>

- Defined in packages/grid_client/src/modules/contracts.ts:196
Parameters
- options: GetServiceContractModel
Returns Promise<ServiceContract>

get_contract_id_by_node_id_and_hash

get_contract_id_by_node_id_and_hash(options: ContractGetByNodeIdAndHashModel): Promise<number>

- Defined in packages/grid_client/src/modules/contracts.ts:89
Parameters
- options: ContractGetByNodeIdAndHashModel
Returns Promise<number>

get_name_contract

get_name_contract(options: NameContractGetModel): Promise<number>

- Defined in packages/grid_client/src/modules/contracts.ts:95
Parameters
- options: NameContractGetModel
Returns Promise<number>

Private invalidateDeployment

invalidateDeployment(contractId: number): Promise<void>

- Defined in packages/grid_client/src/modules/contracts.ts:46
Parameters
- contractId: number
Returns Promise<void>

listContractsByAddress

listContractsByAddress(options: ContractsByAddress): Promise<unknown>

- Defined in packages/grid_client/src/modules/contracts.ts:146
Parameters
- options: ContractsByAddress
Returns Promise<unknown>

listContractsByTwinId

listContractsByTwinId(options: ContractsByTwinId): Promise<unknown>

- Defined in packages/grid_client/src/modules/contracts.ts:140
Parameters
- options: ContractsByTwinId
Returns Promise<unknown>

listMyContracts

listMyContracts(options?: ContractState): Promise<unknown>

- Defined in packages/grid_client/src/modules/contracts.ts:134
Parameters
- Optional options: ContractState
Returns Promise<unknown>

setDedicatedNodeExtraFee

setDedicatedNodeExtraFee(options: SetDedicatedNodeExtraFeesModel): Promise<unknown>

- Defined in packages/grid_client/src/modules/contracts.ts:228
Parameters
- options: SetDedicatedNodeExtraFeesModel
Returns Promise<unknown>

setFeesServiceContract

setFeesServiceContract(options: SetServiceContractFeesModel): Promise<ServiceContract>

- Defined in packages/grid_client/src/modules/contracts.ts:183
Parameters
- options: SetServiceContractFeesModel
Returns Promise<ServiceContract>

setMetadataServiceContract

setMetadataServiceContract(options: SetServiceContractMetadataModel): Promise<ServiceContract>

- Defined in packages/grid_client/src/modules/contracts.ts:190
Parameters
- options: SetServiceContractMetadataModel
Returns Promise<ServiceContract>

update_node

update_node(options: NodeContractUpdateModel): Promise<Contract>

- Defined in packages/grid_client/src/modules/contracts.ts:120
Parameters
- options: NodeContractUpdateModel
Returns Promise<Contract>

Generated using TypeDoc