@gala-chain/connect ∙ API
API > DryRunResult
Class: DryRunResult
Contents
- Description
- Extends
- Constructors
- new DryRunResult()
- Properties
- deletes
- dtoExpiresAt
- dtoOperation
- multisig
- prefix
- reads
- response
- signature
- signerAddress
- signerPublicKey
- uniqueKey
- writes
- Methods
- expiresInMs()
- getAllSignatures()
- isSignatureValid()
- serialize()
- sign()
- signed()
- validate()
- validateOrReject()
- withOperation()
- withSigner()
- deserialize()
Description
Data Transfer Object (DTO) representing the results of a successful DryRun execution,
to be sent back to the consuming client.
Extends
Constructors
new DryRunResult()
new DryRunResult():
DryRunResult
Inherited from
Properties
deletes
deletes:
Record\<string,true>
Description
The deletes from the Read/Write set that would have been deleted from
world state, if the provided inputs had been sent to the provided method with a
valid signature. See the Hyperledger Fabric documentation on
Valid Transactions
for more details on the importantce of Read/Write sets.
Source
chain-api/src/types/dtos.ts:540
dtoExpiresAt
dtoExpiresAt?:
number
Inherited from
Source
chain-api/src/types/dtos.ts:224
dtoOperation
dtoOperation?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:217
multisig
multisig?:
string[]
Inherited from
Source
chain-api/src/types/dtos.ts:206
prefix
prefix?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:169
reads
reads:
Record\<string,string>
Description
The reads from the Hyperledger Fabric Read/Write set that would have been
read from world state, if the provided inputs had been sent to the provided method
with a valid signature. See the Hyperledger Fabric documentation on
Valid Transactions
for more details on the importantce of Read/Write sets.
Source
chain-api/src/types/dtos.ts:530
response
response:
GalaChainResponse\<unknown>
Description
The GalaChainResponse that would have occurred if the provided inputs had been
sent to the provided method, with a valid signature.
Source
chain-api/src/types/dtos.ts:510
signature
signature?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:193
signerAddress
signerAddress?:
UserRef
Inherited from
Source
chain-api/src/types/dtos.ts:176
signerPublicKey
signerPublicKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:183
uniqueKey
uniqueKey?:
string
Inherited from
Source
chain-api/src/types/dtos.ts:160
writes
writes:
Record\<string,string>
Description
The writes from the Hyperledger Fabric Read/Write set that would have been
written to chain, if the provided inputs had been sent to the provided method
with a valid signature. See the Hyperledger Fabric documentation on
Valid Transactions
for more details on the importantce of Read/Write sets.
Source
chain-api/src/types/dtos.ts:520
Methods
expiresInMs()
expiresInMs(
ms):DryRunResult
Parameters
▪ ms: number
Inherited from
Source
chain-api/src/types/dtos.ts:339
getAllSignatures()
getAllSignatures():
string[]
Inherited from
Source
chain-api/src/types/dtos.ts:276
isSignatureValid()
isSignatureValid(
publicKey):boolean
Parameters
▪ publicKey: string
Inherited from
Source
chain-api/src/types/dtos.ts:357
serialize()
serialize():
string
Returns
string
Inherited from
Description
Serialze this object to string in a determinsitic fashion. See Hyperledger Fabric's documentation on JSON Determinism for more details.
Source
chain-api/src/types/dtos.ts:248
sign()
sign(
privateKey,useDer):void
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:280
signed()
signed(
privateKey,useDer):DryRunResult
Creates a signed copy of current object.
Parameters
▪ privateKey: string
▪ useDer: boolean= false
Inherited from
Source
chain-api/src/types/dtos.ts:333
validate()
validate():
Promise\<ValidationError[]>
Inherited from
Source
chain-api/src/types/dtos.ts:226
validateOrReject()
validateOrReject():
Promise\<void>
Inherited from
Source
chain-api/src/types/dtos.ts:230
withOperation()
withOperation(
operation):DryRunResult
Parameters
▪ operation: string
Inherited from
Source
chain-api/src/types/dtos.ts:345
withSigner()
withSigner(
ref):DryRunResult
Parameters
▪ ref: UserRef
Inherited from
Source
chain-api/src/types/dtos.ts:351
deserialize()
staticdeserialize\<T>(constructor,object):T
Type parameters
▪ T
Parameters
▪ constructor: ClassConstructor\<Inferred\<T, ChainCallDTO>>
ClassConstructor that extends ChainCallDTO
▪ object: string | Record\<string, unknown> | Record\<string, unknown>[]
serialized string or plain object to be instantiated via the provided ClassConstructor
Returns
An instantiated class created with the provided ClassConstructor
Inherited from
Description
Instantiate a class instance from a serialized object using the provided ClassConstructor.