Class Batch

Hierarchy

Base
- Batch

Index

Constructors

constructor

Properties

Accessors

fromAddress

Methods

Constructors

constructor

new Batch(web3: default, _fromAddress: string, factoryContract: any, contractName: BaseContracts, contractAbi: any[]): Batch

Inherited from Base.constructor
- Defined in Base.ts:13
Parameters
- web3: default
- _fromAddress: string
- factoryContract: any
- contractName: BaseContracts
- contractAbi: any[]
Returns Batch

Properties

contract

contract: any = null

Protected contractAbi

contractAbi: any[]

Protected contractName

contractName: BaseContracts

Protected factoryContract

factoryContract: any

Protected web3

web3: default

Accessors

fromAddress

get fromAddress(): string

- Defined in Base.ts:22
Returns string

Methods

all

all(onlyExistingBatches?: boolean): Promise<(null | IBatch)[]>

- Defined in Batch.ts:129
Get all batches

Parameters
- onlyExistingBatches: boolean = true
  
  If set to true it will return only the batches owned by "fromAddress"
Returns Promise<(null | IBatch)[]>

Batches details

allBatchIds

allBatchIds(onlyExistingBatches?: boolean): Promise<number[]>

- Defined in Batch.ts:96
Get all batch ids

Parameters
- onlyExistingBatches: boolean = true
  
  If set to true it will return only the batches owned by "fromAddress"
Returns Promise<number[]>

Batch ids

burn

burn(options: { batchId: number; materialsUuid: number[] }): Transaction<{}>

- Defined in Batch.ts:66
Burn batch material uuid

Parameters
- options: { batchId: number; materialsUuid: number[] }
  
  Burn options
  - batchId: number
    
    The id of the batch
  - materialsUuid: number[]
    
    The uuids of the materials to be burned
Returns Transaction<{}>

Burn event

create

create(options: { code: string; materialsUuid: number[] }): Transaction<CreateTransactionEvents>

- Defined in Batch.ts:48
Create a new batch

Parameters
- options: { code: string; materialsUuid: number[] }
  
  Batch create options
  - code: string
  - materialsUuid: number[]
Returns Transaction<CreateTransactionEvents>

Batch create event

destroyBatch

destroyBatch(batchId: number): Transaction<BatchTransferEvent>

- Defined in Batch.ts:152
Destory batch and add existing materials to users balance

Parameters
- batchId: number
  
  Target batch id
Returns Transaction<BatchTransferEvent>

ensureContract

ensureContract(): Promise<any>

Inherited from Base.ensureContract
- Defined in Base.ts:38
Returns Promise<any>

getById

getById(batchId: number, full?: boolean): Promise<null | IBatch>

- Defined in Batch.ts:80
Get batch by id

Parameters
- batchId: number
  
  Batch id
- full: boolean = true
  
  Instead of return materials uuid, it will return the material instance details
Returns Promise<null | IBatch>

Batch informations

getContractAddress

getContractAddress(): Promise<any>

Inherited from Base.getContractAddress
- Defined in Base.ts:26
Returns Promise<any>

getPastEvents

getPastEvents<T>(eventName: string, filter?: object, includeBlockData?: boolean): Promise<T[]>

Inherited from Base.getPastEvents
- Defined in Base.ts:62
Type parameters
- T
Parameters
- eventName: string
- filter: object = {}
- includeBlockData: boolean = false
Returns Promise<T[]>

getRawPastEvents

getRawPastEvents(eventName: string, filter?: object): Promise<default[]>

Inherited from Base.getRawPastEvents
- Defined in Base.ts:50
Parameters
- eventName: string
- filter: object = {}
Returns Promise<default[]>

remove

remove(batchId: number): Transaction<{}>

- Defined in Batch.ts:143
Remove a batch (burn)

Parameters
- batchId: number
  
  The id of the batch
Returns Transaction<{}>

Generated using TypeDoc