ChaincodeMockStub | @theledger/fabric-mock-stub

Hierarchy

ChaincodeMockStub

Implements

MockStub

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ChaincodeMockStub(name: string, cc: ChaincodeInterface, usercert?: string): ChaincodeMockStub

- Defined in ChaincodeMockStub.ts:59
Parameters
- name: string
  
  Name of the mockstub
- cc: ChaincodeInterface
  
  Your chaincode
- Default value usercert: string = defaultUserCert
Returns ChaincodeMockStub

Properties

event

event: Map<string, Buffer> = new Map()

history

history: Map<string, KeyModification[]> = new Map()

privateCollections

privateCollections: Map<string, StateMap> = new Map()

state

state: StateMap = new Map()

transientMap

transientMap: StateMap = new Map()

Methods

createCompositeKey

createCompositeKey(objectType: string, attributes: string[]): string

- Defined in ChaincodeMockStub.ts:372
Parameters
- objectType: string
- attributes: string[]
Returns string

deletePrivateData

deletePrivateData(collection: string, key: string): Promise<any>

- Defined in ChaincodeMockStub.ts:515
DelState removes the specified key and its value from the ledger.

Parameters
- collection: string
- key: string
Returns Promise<any>

deleteState

deleteState(key: string): Promise<any>

- Defined in ChaincodeMockStub.ts:268
DelState removes the specified key and its value from the ledger.

Parameters
- key: string
Returns Promise<any>

getArgs

getArgs(): string[]

- Defined in ChaincodeMockStub.ts:82
Get the current arguments

Returns string[]

getBinding

getBinding(): string

- Defined in ChaincodeMockStub.ts:427
todo

Implement

Returns string

getChannelID

getChannelID(): string

- Defined in ChaincodeMockStub.ts:471
todo

Implement

Returns string

getCreator

getCreator(): ProposalCreator

- Defined in ChaincodeMockStub.ts:409
Returns ProposalCreator

getEvent

getEvent(name: string): Promise<Buffer>

- Defined in ChaincodeMockStub.ts:462
Get the stored payload for an event name in the local event map

Parameters
- name: string
Returns Promise<Buffer>

getFunctionAndParameters

getFunctionAndParameters(): object

- Defined in ChaincodeMockStub.ts:98
Returns object
- fcn: string
- params: string[]

getHistoryForKey

getHistoryForKey(key: string): Promise<HistoryQueryIterator>

- Defined in ChaincodeMockStub.ts:419
GetHistory for key

Parameters
- key: string
Returns Promise<HistoryQueryIterator>

getPrivateData

getPrivateData(collection: string, key: string): Promise<Buffer>

- Defined in ChaincodeMockStub.ts:482
Get a stored value for this key in the local state

Parameters
- collection: string
- key: string
Returns Promise<Buffer>

getPrivateDataByPartialCompositeKey

getPrivateDataByPartialCompositeKey(collection: string, objectType: string, attributes: string[]): Promise<StateQueryIterator>

- Defined in ChaincodeMockStub.ts:604
Parameters
- collection: string
- objectType: string
- attributes: string[]
Returns Promise<StateQueryIterator>

getPrivateDataByRange

getPrivateDataByRange(collection: string, startKey: string, endKey: string): Promise<StateQueryIterator>

- Defined in ChaincodeMockStub.ts:533
Get state by range of keys, empty keys will return everything

Parameters
- collection: string
- startKey: string
- endKey: string
Returns Promise<StateQueryIterator>

getPrivateDataQueryResult

getPrivateDataQueryResult(collection: string, query: string): Promise<StateQueryIterator>

- Defined in ChaincodeMockStub.ts:568
GetQueryResult function can be invoked by a chaincode to perform a rich query against state database. Only supported by state database implementations that support rich query. The query string is in the syntax of the underlying state database. An iterator is returned which can be used to iterate (next) over the query result set.

Blog post on writing rich queries - https://medium.com/wearetheledger/hyperledger-fabric-couchdb-fantastic-queries-and-where-to-find-them-f8a3aecef767

Parameters
- collection: string
- query: string
Returns Promise<StateQueryIterator>

getQueryResult

getQueryResult(query: string): Promise<StateQueryIterator>

- Defined in ChaincodeMockStub.ts:327
GetQueryResult function can be invoked by a chaincode to perform a rich query against state database. Only supported by state database implementations that support rich query. The query string is in the syntax of the underlying state database. An iterator is returned which can be used to iterate (next) over the query result set.

Blog post on writing rich queries - https://medium.com/wearetheledger/hyperledger-fabric-couchdb-fantastic-queries-and-where-to-find-them-f8a3aecef767

Parameters
- query: string
Returns Promise<StateQueryIterator>

getSignedProposal

getSignedProposal(): SignedProposal

- Defined in ChaincodeMockStub.ts:380
Returns SignedProposal

getState

getState(key: string): Promise<Buffer>

- Defined in ChaincodeMockStub.ts:230
Get a stored value for this key in the local state

Parameters
- key: string
Returns Promise<Buffer>

getStateByPartialCompositeKey

getStateByPartialCompositeKey(objectType: string, attributes: string[]): Promise<StateQueryIterator>

- Defined in ChaincodeMockStub.ts:366
Retrieve state by partial keys

Parameters
- objectType: string
- attributes: string[]
Returns Promise<StateQueryIterator>

getStateByRange

getStateByRange(startKey: string, endKey: string): Promise<StateQueryIterator>

- Defined in ChaincodeMockStub.ts:290
Get state by range of keys, empty keys will return everything

Parameters
- startKey: string
- endKey: string
Returns Promise<StateQueryIterator>

getStringArgs

getStringArgs(): string[]

- Defined in ChaincodeMockStub.ts:91
Same as getArgs()

Returns string[]

getTransient

getTransient(): StateMap

- Defined in ChaincodeMockStub.ts:436
Returns mocked transient values. These need to be set using the mockInvoke or mockTransactionStart

Returns StateMap

getTxID

getTxID(): string

- Defined in ChaincodeMockStub.ts:73
Returns string

getTxTimestamp

getTxTimestamp(): Timestamp

- Defined in ChaincodeMockStub.ts:392
Returns Timestamp

invokeChaincode

invokeChaincode(chaincodeName: string, args: Buffer[], channel: string): Promise<ChaincodeResponse>

- Defined in ChaincodeMockStub.ts:192
InvokeChaincode calls a peered chaincode.

Parameters
- chaincodeName: string
- args: Buffer[]
- channel: string
Returns Promise<ChaincodeResponse>

mockInit

mockInit(uuid: string, args: string[], transientMap?: StateMap): Promise<ChaincodeResponse>

- Defined in ChaincodeMockStub.ts:160
Initialise this chaincode, also starts and ends a transaction.

Parameters
- uuid: string
- args: string[]
- Optional transientMap: StateMap
Returns Promise<ChaincodeResponse>

mockInvoke

mockInvoke(uuid: string, args: string[], transientMap?: StateMap): Promise<ChaincodeResponse>

- Defined in ChaincodeMockStub.ts:176
Invoke this chaincode, also starts and ends a transaction.

Parameters
- uuid: string
- args: string[]
- Optional transientMap: StateMap
Returns Promise<ChaincodeResponse>

mockInvokeWithSignedProposal

mockInvokeWithSignedProposal(uuid: string, args: string[], sp: SignedProposal): Promise<ChaincodeResponse>

- Defined in ChaincodeMockStub.ts:215
Invoke this chaincode, also starts and ends a transaction.

Parameters
- uuid: string
- args: string[]
- sp: SignedProposal
Returns Promise<ChaincodeResponse>

mockPeerChaincode

mockPeerChaincode(invokableChaincodeName: string, otherStub: MockStub): void

- Defined in ChaincodeMockStub.ts:148
Register a peer chaincode with this MockStub invokableChaincodeName is the name or hash of the peer otherStub is a MockStub of the peer, already intialised

Parameters
- invokableChaincodeName: string
- otherStub: MockStub
Returns void

mockTransactionEnd

mockTransactionEnd(uuid: string): void

- Defined in ChaincodeMockStub.ts:134
End a mocked transaction, clearing the UUID.

Parameters
- uuid: string
Returns void

mockTransactionStart

mockTransactionStart(txid: string, transientMap?: StateMap): void

- Defined in ChaincodeMockStub.ts:122
Used to indicate to a chaincode that it is part of a transaction. This is important when chaincodes invoke each other. MockStub doesn't support concurrent transactions at present.

Parameters
- txid: string
- Optional transientMap: StateMap
Returns void

putPrivateData

putPrivateData(collection: string, key: string, value: Buffer): Promise<any>

- Defined in ChaincodeMockStub.ts:494
Store a value for this key in the local state

Parameters
- collection: string
- key: string
- value: Buffer
Returns Promise<any>

putState

putState(key: string, value: Buffer): Promise<any>

- Defined in ChaincodeMockStub.ts:241
Store a value for this key in the local state

Parameters
- key: string
- value: Buffer
Returns Promise<any>

setCreator

setCreator(mspId: string): void

- Defined in ChaincodeMockStub.ts:405
Store a mspId of the transaction's creator

Parameters
- mspId: string
Returns void

setEvent

setEvent(name: string, payload: Buffer): Promise<any>

- Defined in ChaincodeMockStub.ts:446
Store the payload corresponding to an event name to the local event map

Parameters
- name: string
- payload: Buffer
Returns Promise<any>

setSignedProposal

setSignedProposal(sp: SignedProposal): void

- Defined in ChaincodeMockStub.ts:384
Parameters
- sp: SignedProposal
Returns void

setTxTimestamp

setTxTimestamp(t: Timestamp): void

- Defined in ChaincodeMockStub.ts:388
Parameters
- t: Timestamp
Returns void

splitCompositeKey

splitCompositeKey(compositeKey: string): SplitCompositekey

- Defined in ChaincodeMockStub.ts:376
Parameters
- compositeKey: string
Returns SplitCompositekey

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

cc: ChaincodeInterface

Default value usercert: string = defaultUserCert

Returns ChaincodeMockStub

Properties

event

history

privateCollections

state

transientMap

Methods

createCompositeKey

Parameters

objectType: string

attributes: string[]

Returns string

deletePrivateData

Parameters

collection: string

key: string

Returns Promise<any>

deleteState

Parameters

key: string

Returns Promise<any>

getArgs

Returns string[]

getBinding

Returns string

getChannelID

Returns string

getCreator

Returns ProposalCreator

getEvent

Parameters

name: string

Returns Promise<Buffer>

getFunctionAndParameters

Returns object

fcn: string

params: string[]

getHistoryForKey

Parameters

key: string

Returns Promise<HistoryQueryIterator>

getPrivateData

Parameters

collection: string

key: string

Returns Promise<Buffer>

getPrivateDataByPartialCompositeKey

Parameters

collection: string

objectType: string

attributes: string[]

Returns Promise<StateQueryIterator>

getPrivateDataByRange

Parameters

collection: string

startKey: string

endKey: string

Returns Promise<StateQueryIterator>

getPrivateDataQueryResult

Parameters

collection: string

query: string

Returns Promise<StateQueryIterator>

getQueryResult

Parameters

query: string

Returns Promise<StateQueryIterator>