GalaChainStub.md

@gala-chain/chaincode ∙ API

---

API > GalaChainStub

Interface: GalaChainStub

Contents

• Extends
• Methods
  • createCompositeKey()
  • deletePrivateData()
  • deleteState()
  • flushWrites()
  • getArgs()
  • getBinding()
  • getCachedState()
  • getCachedStateByPartialCompositeKey()
  • getChannelID()
  • getCreator()
  • getDateTimestamp()
  • getFunctionAndParameters()
  • getHistoryForKey()
  • getMspID()
  • getPrivateData()
  • getPrivateDataByPartialCompositeKey()
  • getPrivateDataByRange()
  • getPrivateDataHash()
  • getPrivateDataQueryResult()
  • getPrivateDataValidationParameter()
  • getQueryResult()
  • getQueryResultWithPagination()
  • getSignedProposal()
  • getState()
  • getStateByPartialCompositeKey()
  • getStateByPartialCompositeKeyWithPagination()
  • getStateByRange()
  • getStateByRangeWithPagination()
  • getStateValidationParameter()
  • getStringArgs()
  • getTransient()
  • getTxID()
  • getTxTimestamp()
  • invokeChaincode()
  • putPrivateData()
  • putState()
  • setEvent()
  • setPrivateDataValidationParameter()
  • setStateValidationParameter()
  • splitCompositeKey()

Extends

• ChaincodeStub

Methods

createCompositeKey()

createCompositeKey(objectType, attributes): string

Parameters

▪ objectType: string

▪ attributes: string[]

Inherited from

ChaincodeStub.createCompositeKey

Source

node_modules/fabric-shim/types/index.d.ts:122

---

deletePrivateData()

deletePrivateData(collection, key): Promise<void>

Parameters

▪ collection: string

▪ key: string

Inherited from

ChaincodeStub.deletePrivateData

Source

node_modules/fabric-shim/types/index.d.ts:128

---

deleteState()

deleteState(key): Promise<void>

Parameters

▪ key: string

Inherited from

ChaincodeStub.deleteState

Source

node_modules/fabric-shim/types/index.d.ts:107

---

flushWrites()

flushWrites(): Promise<void>

Source

chaincode/src/types/GalaChainStub.ts:143

---

getArgs()

getArgs(): string[]

Inherited from

ChaincodeStub.getArgs

Source

node_modules/fabric-shim/types/index.d.ts:90

---

getBinding()

getBinding(): string

Inherited from

ChaincodeStub.getBinding

Source

node_modules/fabric-shim/types/index.d.ts:103

---

getCachedState()

getCachedState(key): Promise<Uint8Array>

Parameters

▪ key: string

Source

chaincode/src/types/GalaChainStub.ts:139

---

getCachedStateByPartialCompositeKey()

getCachedStateByPartialCompositeKey(objectType, attributes): FabricIterable<CachedKV>

Parameters

▪ objectType: string

▪ attributes: string[]

Source

chaincode/src/types/GalaChainStub.ts:141

---

getChannelID()

getChannelID(): string

Inherited from

ChaincodeStub.getChannelID

Source

node_modules/fabric-shim/types/index.d.ts:95

---

getCreator()

getCreator(): SerializedIdentity

Inherited from

ChaincodeStub.getCreator

Source

node_modules/fabric-shim/types/index.d.ts:96

---

getDateTimestamp()

getDateTimestamp(): Date

Inherited from

ChaincodeStub.getDateTimestamp

Source

node_modules/fabric-shim/types/index.d.ts:102

---

getFunctionAndParameters()

getFunctionAndParameters(): object

Returns

fcn

fcn: string

params

params: string[]

Inherited from

ChaincodeStub.getFunctionAndParameters

Source

node_modules/fabric-shim/types/index.d.ts:92

---

getHistoryForKey()

getHistoryForKey(key): Promise<HistoryQueryIterator> & AsyncIterable<KeyModification>

Parameters

▪ key: string

Inherited from

ChaincodeStub.getHistoryForKey

Source

node_modules/fabric-shim/types/index.d.ts:117

---

getMspID()

getMspID(): string

Inherited from

ChaincodeStub.getMspID

Source

node_modules/fabric-shim/types/index.d.ts:97

---

getPrivateData()

getPrivateData(collection, key): Promise<Uint8Array>

Parameters

▪ collection: string

▪ key: string

Inherited from

ChaincodeStub.getPrivateData

Source

node_modules/fabric-shim/types/index.d.ts:125

---

getPrivateDataByPartialCompositeKey()

getPrivateDataByPartialCompositeKey(collection, objectType, attributes): Promise<StateQueryIterator> & AsyncIterable<KV>

Parameters

▪ collection: string

▪ objectType: string

▪ attributes: string[]

Inherited from

ChaincodeStub.getPrivateDataByPartialCompositeKey

Source

node_modules/fabric-shim/types/index.d.ts:132

---

getPrivateDataByRange()

getPrivateDataByRange(collection, startKey, endKey): Promise<StateQueryIterator> & AsyncIterable<KV>

Parameters

▪ collection: string

▪ startKey: string

▪ endKey: string

Inherited from

ChaincodeStub.getPrivateDataByRange

Source

node_modules/fabric-shim/types/index.d.ts:131

---

getPrivateDataHash()

getPrivateDataHash(collection, key): Promise<Uint8Array>

Parameters

▪ collection: string

▪ key: string

Inherited from

ChaincodeStub.getPrivateDataHash

Source

node_modules/fabric-shim/types/index.d.ts:126

---

getPrivateDataQueryResult()

getPrivateDataQueryResult(collection, query): Promise<StateQueryIterator> & AsyncIterable<KV>

Parameters

▪ collection: string

▪ query: string

Inherited from

ChaincodeStub.getPrivateDataQueryResult

Source

node_modules/fabric-shim/types/index.d.ts:133

---

getPrivateDataValidationParameter()

getPrivateDataValidationParameter(collection, key): Promise<Uint8Array>

Parameters

▪ collection: string

▪ key: string

Inherited from

ChaincodeStub.getPrivateDataValidationParameter

Source

node_modules/fabric-shim/types/index.d.ts:130

---

getQueryResult()

getQueryResult(query): Promise<StateQueryIterator> & AsyncIterable<KV>

Parameters

▪ query: string

Inherited from

ChaincodeStub.getQueryResult

Source

node_modules/fabric-shim/types/index.d.ts:115

---

getQueryResultWithPagination()

getQueryResultWithPagination(query, pageSize, bookmark?): Promise<StateQueryResponse<StateQueryIterator>> & AsyncIterable<KV>

Parameters

▪ query: string

▪ pageSize: number

▪ bookmark?: string

Inherited from

ChaincodeStub.getQueryResultWithPagination

Source

node_modules/fabric-shim/types/index.d.ts:116

---

getSignedProposal()

getSignedProposal(): SignedProposal

Inherited from

ChaincodeStub.getSignedProposal

Source

node_modules/fabric-shim/types/index.d.ts:100

---

getState()

getState(key): Promise<Uint8Array>

Parameters

▪ key: string

Inherited from

ChaincodeStub.getState

Source

node_modules/fabric-shim/types/index.d.ts:105

---

getStateByPartialCompositeKey()

getStateByPartialCompositeKey(objectType, attributes): Promise<StateQueryIterator> & AsyncIterable<KV>

Parameters

▪ objectType: string

▪ attributes: string[]

Inherited from

ChaincodeStub.getStateByPartialCompositeKey

Source

node_modules/fabric-shim/types/index.d.ts:112

---

getStateByPartialCompositeKeyWithPagination()

getStateByPartialCompositeKeyWithPagination(objectType, attributes, pageSize, bookmark?): Promise<StateQueryResponse<StateQueryIterator>> & AsyncIterable<KV>

Parameters

▪ objectType: string

▪ attributes: string[]

▪ pageSize: number

▪ bookmark?: string

Inherited from

ChaincodeStub.getStateByPartialCompositeKeyWithPagination

Source

node_modules/fabric-shim/types/index.d.ts:113

---

getStateByRange()

getStateByRange(startKey, endKey): Promise<StateQueryIterator> & AsyncIterable<KV>

Parameters

▪ startKey: string

▪ endKey: string

Inherited from

ChaincodeStub.getStateByRange

Source

node_modules/fabric-shim/types/index.d.ts:110

---

getStateByRangeWithPagination()

getStateByRangeWithPagination(startKey, endKey, pageSize, bookmark?): Promise<StateQueryResponse<StateQueryIterator>> & AsyncIterable<KV>

Parameters

▪ startKey: string

▪ endKey: string

▪ pageSize: number

▪ bookmark?: string

Inherited from

ChaincodeStub.getStateByRangeWithPagination

Source

node_modules/fabric-shim/types/index.d.ts:111

---

getStateValidationParameter()

getStateValidationParameter(key): Promise<Uint8Array>

Parameters

▪ key: string

Inherited from

ChaincodeStub.getStateValidationParameter

Source

node_modules/fabric-shim/types/index.d.ts:109

---

getStringArgs()

getStringArgs(): string[]

Inherited from

ChaincodeStub.getStringArgs

Source

node_modules/fabric-shim/types/index.d.ts:91

---

getTransient()

getTransient(): Map<string, Uint8Array>

Inherited from

ChaincodeStub.getTransient

Source

node_modules/fabric-shim/types/index.d.ts:98

---

getTxID()

getTxID(): string

Inherited from

ChaincodeStub.getTxID

Source

node_modules/fabric-shim/types/index.d.ts:94

---

getTxTimestamp()

getTxTimestamp(): Timestamp

Inherited from

ChaincodeStub.getTxTimestamp

Source

node_modules/fabric-shim/types/index.d.ts:101

---

invokeChaincode()

invokeChaincode(chaincodeName, args, channel): Promise<ChaincodeResponse>

Parameters

▪ chaincodeName: string

▪ args: string[]

▪ channel: string

Inherited from

ChaincodeStub.invokeChaincode

Source

node_modules/fabric-shim/types/index.d.ts:119

---

putPrivateData()

putPrivateData(collection, key, value): Promise<void>

Parameters

▪ collection: string

▪ key: string

▪ value: Uint8Array

Inherited from

ChaincodeStub.putPrivateData

Source

node_modules/fabric-shim/types/index.d.ts:127

---

putState()

putState(key, value): Promise<void>

Parameters

▪ key: string

▪ value: Uint8Array

Inherited from

ChaincodeStub.putState

Source

node_modules/fabric-shim/types/index.d.ts:106

---

setEvent()

setEvent(name, payload): void

Parameters

▪ name: string

▪ payload: Uint8Array

Inherited from

ChaincodeStub.setEvent

Source

node_modules/fabric-shim/types/index.d.ts:120

---

setPrivateDataValidationParameter()

setPrivateDataValidationParameter(collection, key, ep): Promise<void>

Parameters

▪ collection: string

▪ key: string

▪ ep: Uint8Array

Inherited from

ChaincodeStub.setPrivateDataValidationParameter

Source

node_modules/fabric-shim/types/index.d.ts:129

---

setStateValidationParameter()

setStateValidationParameter(key, ep): Promise<void>

Parameters

▪ key: string

▪ ep: Uint8Array

Inherited from

ChaincodeStub.setStateValidationParameter

Source

node_modules/fabric-shim/types/index.d.ts:108

---

splitCompositeKey()

splitCompositeKey(compositeKey): SplitCompositekey

Parameters

▪ compositeKey: string

Inherited from

ChaincodeStub.splitCompositeKey

Source

node_modules/fabric-shim/types/index.d.ts:123