Interface Gateway

Gateway represents the connection of a specific client identity to a Fabric Gateway. A Gateway is obtained using the connect function.

Hierarchy

Gateway

Index

Methods

close getIdentity getNetwork newBlockAndPrivateDataEventsRequest newBlockEventsRequest newChaincodeEventsRequest newCommit newFilteredBlockEventsRequest newProposal newSignedBlockAndPrivateDataEventsRequest newSignedBlockEventsRequest newSignedChaincodeEventsRequest newSignedCommit newSignedFilteredBlockEventsRequest newSignedProposal newSignedTransaction newTransaction

Methods

close

close(): void
Close the gateway when it is no longer required. This releases all resources associated with networks and contracts obtained using the Gateway, including removing event listeners.

Returns void
- Defined in src/gateway.ts:286

getIdentity

getIdentity(): Identity
Get the identity used by this gateway.

Returns Identity
- Defined in src/gateway.ts:167

getNetwork

getNetwork(channelName): Network
Get a network representing the named Fabric channel.
Parameters
- channelName: string
  
  Fabric channel name.
Returns Network
- Defined in src/gateway.ts:173

newBlockAndPrivateDataEventsRequest

newBlockAndPrivateDataEventsRequest(bytes): BlockAndPrivateDataEventsRequest
Recreate a block and private data events request from serialized data.
Parameters
- bytes: Uint8Array
  
  Serialized block and private data events request.
Returns BlockAndPrivateDataEventsRequest
A block and private data events request.
- Defined in src/gateway.ts:280

newBlockEventsRequest

newBlockEventsRequest(bytes): BlockEventsRequest
Recreate a block events request from serialized data.
Parameters
- bytes: Uint8Array
  
  Serialized block events request.
Returns BlockEventsRequest
A block events request.
- Defined in src/gateway.ts:249

newChaincodeEventsRequest

newChaincodeEventsRequest(bytes): ChaincodeEventsRequest
Recreate a chaincode events request from serialized data.
Parameters
- bytes: Uint8Array
  
  Serialized chaincode events request.
Returns ChaincodeEventsRequest
A chaincode events request.
- Defined in src/gateway.ts:234

newCommit

newCommit(bytes): Commit
Recreate a commit status request from serialized data.
Parameters
- bytes: Uint8Array
  
  Serialized commit status request.
Returns Commit
A commit status request.
- Defined in src/gateway.ts:219

newFilteredBlockEventsRequest

newFilteredBlockEventsRequest(bytes): FilteredBlockEventsRequest
Recreate a filtered block events request from serialized data.
Parameters
- bytes: Uint8Array
  
  Serialized filtered block events request.
Returns FilteredBlockEventsRequest
A filtered block events request.
- Defined in src/gateway.ts:264

newProposal

newProposal(bytes): Proposal
Recreate a proposal from serialized data.
Parameters
- bytes: Uint8Array
  
  Serialized proposal.
Returns Proposal
A proposal.
- Defined in src/gateway.ts:188

newSignedBlockAndPrivateDataEventsRequest

newSignedBlockAndPrivateDataEventsRequest(bytes, signature): BlockAndPrivateDataEventsRequest
Create a block and private data events request with the specified digital signature. Supports off-line signing flow.
Parameters
- bytes: Uint8Array
  
  Serialized block and private data events request.
- signature: Uint8Array
  
  Digital signature.
Returns BlockAndPrivateDataEventsRequest
A signed block and private data events request.
- Defined in src/gateway.ts:273

newSignedBlockEventsRequest

newSignedBlockEventsRequest(bytes, signature): BlockEventsRequest
Create a block events request with the specified digital signature. Supports off-line signing flow.
Parameters
- bytes: Uint8Array
  
  Serialized block events request.
- signature: Uint8Array
  
  Digital signature.
Returns BlockEventsRequest
A signed block events request.
- Defined in src/gateway.ts:242

newSignedChaincodeEventsRequest

newSignedChaincodeEventsRequest(bytes, signature): ChaincodeEventsRequest
Create a chaincode events request with the specified digital signature. Supports off-line signing flow.
Parameters
- bytes: Uint8Array
  
  Serialized chaincode events request.
- signature: Uint8Array
  
  Digital signature.
Returns ChaincodeEventsRequest
A signed chaincode events request.
- Defined in src/gateway.ts:227

newSignedCommit

newSignedCommit(bytes, signature): Commit
Create a commit with the specified digital signature, which can be used to access information about a transaction that is committed to the ledger. Supports off-line signing flow.
Parameters
- bytes: Uint8Array
  
  Serialized commit status request.
- signature: Uint8Array
  
  Digital signature.
Returns Commit
A signed commit status request.
- Defined in src/gateway.ts:212

newSignedFilteredBlockEventsRequest

newSignedFilteredBlockEventsRequest(bytes, signature): FilteredBlockEventsRequest
Create a filtered block events request with the specified digital signature. Supports off-line signing flow.
Parameters
- bytes: Uint8Array
  
  Serialized filtered block events request.
- signature: Uint8Array
  
  Digital signature.
Returns FilteredBlockEventsRequest
A signed filtered block events request.
- Defined in src/gateway.ts:257

newSignedProposal

newSignedProposal(bytes, signature): Proposal
Create a proposal with the specified digital signature. Supports off-line signing flow.
Parameters
- bytes: Uint8Array
  
  Serialized proposal.
- signature: Uint8Array
  
  Digital signature.
Returns Proposal
A signed proposal.
- Defined in src/gateway.ts:181

newSignedTransaction

newSignedTransaction(bytes, signature): Transaction
Create a transaction with the specified digital signature. Supports off-line signing flow.
Parameters
- bytes: Uint8Array
  
  Serialized proposal.
- signature: Uint8Array
  
  Digital signature.
Returns Transaction
A signed transaction.
- Defined in src/gateway.ts:196

newTransaction

newTransaction(bytes): Transaction
Recreate a transaction from serialized data.
Parameters
- bytes: Uint8Array
  
  Serialized proposal.
Returns Transaction
A transaction.
- Defined in src/gateway.ts:203

Interface Gateway

Hierarchy

Index

Methods

Methods

close

Returns void

getIdentity

Returns Identity

getNetwork

Parameters

channelName: string

Returns Network

newBlockAndPrivateDataEventsRequest

Parameters

bytes: Uint8Array

Returns BlockAndPrivateDataEventsRequest

newBlockEventsRequest

Parameters

bytes: Uint8Array

Returns BlockEventsRequest

newChaincodeEventsRequest

Parameters

bytes: Uint8Array

Returns ChaincodeEventsRequest

newCommit

Parameters

bytes: Uint8Array

Returns Commit

newFilteredBlockEventsRequest

Parameters

bytes: Uint8Array

Returns FilteredBlockEventsRequest

newProposal

Parameters

bytes: Uint8Array

Returns Proposal

newSignedBlockAndPrivateDataEventsRequest

Parameters

bytes: Uint8Array

signature: Uint8Array

Returns BlockAndPrivateDataEventsRequest

newSignedBlockEventsRequest

Parameters

bytes: Uint8Array

signature: Uint8Array

Returns BlockEventsRequest

newSignedChaincodeEventsRequest

Parameters

bytes: Uint8Array

signature: Uint8Array

Returns ChaincodeEventsRequest

newSignedCommit

Parameters

bytes: Uint8Array

signature: Uint8Array

Returns Commit

newSignedFilteredBlockEventsRequest

Parameters

bytes: Uint8Array

signature: Uint8Array

Returns FilteredBlockEventsRequest

newSignedProposal

Parameters

bytes: Uint8Array

signature: Uint8Array

Returns Proposal

newSignedTransaction

Parameters

bytes: Uint8Array

signature: Uint8Array

Returns Transaction

newTransaction

Parameters

bytes: Uint8Array

Returns Transaction

Settings

Member Visibility

Theme

On This Page