Class StubHelper

The StubHelper is a wrapper around the fabric-shim ChaincodeStub. Its a helper to automatically serialize and deserialize data being saved/retreived.

Hierarchy

StubHelper

Index

Constructors

constructor

Methods

Constructors

constructor

new StubHelper(stub: ChaincodeStub): StubHelper

- Defined in StubHelper.ts:21
Parameters
- stub: ChaincodeStub
Returns StubHelper

Methods

deleteAllByQuery

deleteAllByQuery(query: string | any, options?: DeleteAllByQueryOptions): Promise<void[]>

- Defined in StubHelper.ts:145
Deletes all objects returned by the query @param {Object} query the query

Parameters
- query: string | any
- Default value options: DeleteAllByQueryOptions = {}
Returns Promise<void[]>

generateUUID

generateUUID(name: string): string

- Defined in StubHelper.ts:62
Generate deterministic UUID

Parameters
- name: string
Returns string

getChaincodeCrypto

getChaincodeCrypto(): ShimCrypto

- Defined in StubHelper.ts:43
Return Fabric crypto library for signing and encryption

Returns ShimCrypto

getClientIdentity

getClientIdentity(): ClientIdentity

- Defined in StubHelper.ts:52
Return the Client Identity

Returns ClientIdentity

getHistoryForKeyAsList

getHistoryForKeyAsList(key: string): Promise<any[]>

- Defined in StubHelper.ts:131
Fetch a history for a specific key and return a list of results.

Parameters
- key: string
Returns Promise<any[]>

getQueryResultAsList

getQueryResultAsList(query: string | any, options?: GetQueryResultAsListOptions): Promise<any[] | KV[]>

- Defined in StubHelper.ts:76
Query the state and return a list of results.

Parameters
- query: string | any
  
  CouchDB query
- Default value options: GetQueryResultAsListOptions = {}
Returns Promise<any[] | KV[]>

getStateAsDate

getStateAsDate(key: string, options?: GetStateOptions): Promise<Date>

- Defined in StubHelper.ts:226
Parameters
- key: string
- Default value options: GetStateOptions = {}
Returns Promise<Date>

the state for the given key parsed as a Date

getStateAsObject

getStateAsObject(key: string, options?: GetStateOptions): Promise<Object>

- Defined in StubHelper.ts:180
Parameters
- key: string
- Default value options: GetStateOptions = {}
Returns Promise<Object>

the state for the given key parsed as an Object

getStateAsString

getStateAsString(key: string, options?: GetStateOptions): Promise<string>

- Defined in StubHelper.ts:203
Parameters
- key: string
- Default value options: GetStateOptions = {}
Returns Promise<string>

the state for the given key parsed as a String

getStateByRangeAsList

getStateByRangeAsList(startKey: string, endKey: string, options?: GetStateByRangeAsListOptions): Promise<KV[]>

- Defined in StubHelper.ts:110
Query the state by range

Parameters
- startKey: string
- endKey: string
- Default value options: GetStateByRangeAsListOptions = {}
Returns Promise<KV[]>

getStub

getStub(): ChaincodeStub

- Defined in StubHelper.ts:34
Returns ChaincodeStub

getTxDate

getTxDate(): Date

- Defined in StubHelper.ts:246
Returns Date

the Transaction date as a Javascript Date Object.

putState

putState(key: string, value: any, options?: PutStateOptions): Promise<any>

- Defined in StubHelper.ts:165
Serializes the value and store it on the state db.

Parameters
- key: string
- value: any
- Default value options: PutStateOptions = {}
Returns Promise<any>

setEvent

setEvent(name: string, payload: object): void

- Defined in StubHelper.ts:256
Publish an event to the Blockchain

Parameters
- name: string
- payload: object
Returns void

Generated using TypeDoc