PHP WebShell
Текущая директория: /opt/BitGoJS/node_modules/@hashgraph/sdk/src/transaction
Просмотр файла: TransactionReceiptQuery.js
/*-
*
* Hedera JavaScript SDK
*
* Copyright (C) 2020 - 2022 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
import Query, { QUERY_REGISTRY } from "../query/Query.js";
import Status from "../Status.js";
import TransactionReceipt from "./TransactionReceipt.js";
import TransactionId from "./TransactionId.js";
import PrecheckStatusError from "../PrecheckStatusError.js";
import ReceiptStatusError from "../ReceiptStatusError.js";
import { ExecutionState } from "../Executable.js";
import * as HashgraphProto from "@hashgraph/proto";
const { proto } = HashgraphProto;
/**
* @typedef {import("../account/AccountId.js").default} AccountId
* @typedef {import("../channel/Channel.js").default} Channel
* @typedef {import("../client/Client.js").default<*, *>} Client
*/
/**
* @augments {Query<TransactionReceipt>}
*/
export default class TransactionReceiptQuery extends Query {
/**
* @param {object} [props]
* @param {TransactionId | string} [props.transactionId]
* @param {boolean} [props.includeDuplicates]
* @param {boolean} [props.includeChildren]
* @param {boolean} [props.validateStatus]
*/
constructor(props = {}) {
super();
/**
* @private
* @type {?TransactionId}
*/
this._transactionId = null;
/**
* @private
* @type {?boolean}
*/
this._includeChildren = null;
/**
* @private
* @type {?boolean}
*/
this._includeDuplicates = null;
this._validateStatus = true;
if (props.transactionId != null) {
this.setTransactionId(props.transactionId);
}
if (props.includeChildren != null) {
this.setIncludeChildren(props.includeChildren);
}
if (props.includeDuplicates != null) {
this.setIncludeDuplicates(props.includeDuplicates);
}
if (props.validateStatus != null) {
this.setValidateStatus(props.validateStatus);
}
}
/**
* @internal
* @param {HashgraphProto.proto.IQuery} query
* @returns {TransactionReceiptQuery}
*/
static _fromProtobuf(query) {
const receipt =
/** @type {HashgraphProto.proto.ITransactionGetReceiptQuery} */ (
query.transactionGetReceipt
);
return new TransactionReceiptQuery({
transactionId: receipt.transactionID
? TransactionId._fromProtobuf(receipt.transactionID)
: undefined,
includeDuplicates:
receipt.includeDuplicates != null
? receipt.includeDuplicates
: undefined,
includeChildren:
receipt.includeChildReceipts != null
? receipt.includeChildReceipts
: undefined,
});
}
/**
* @returns {?TransactionId}
*/
get transactionId() {
return this._transactionId;
}
/**
* Set the transaction ID for which the receipt is being requested.
*
* @param {TransactionId | string} transactionId
* @returns {this}
*/
setTransactionId(transactionId) {
this._transactionId =
typeof transactionId === "string"
? TransactionId.fromString(transactionId)
: transactionId.clone();
return this;
}
/**
* @param {boolean} includeDuplicates
* @returns {TransactionReceiptQuery}
*/
setIncludeDuplicates(includeDuplicates) {
this._includeDuplicates = includeDuplicates;
return this;
}
/**
* @returns {boolean}
*/
get includeDuplicates() {
return this._includeDuplicates != null
? this._includeDuplicates
: false;
}
/**
* @param {boolean} includeChildren
* @returns {TransactionReceiptQuery}
*/
setIncludeChildren(includeChildren) {
this._includeChildren = includeChildren;
return this;
}
/**
* @returns {boolean}
*/
get includeChildren() {
return this._includeChildren != null ? this._includeChildren : false;
}
/**
* @param {boolean} validateStatus
* @returns {this}
*/
setValidateStatus(validateStatus) {
this._validateStatus = validateStatus;
return this;
}
/**
* @returns {boolean}
*/
get validateStatus() {
return this._validateStatus;
}
/**
* @override
* @protected
* @returns {boolean}
*/
_isPaymentRequired() {
return false;
}
/**
* @override
* @internal
* @param {HashgraphProto.proto.IQuery} request
* @param {HashgraphProto.proto.IResponse} response
* @returns {[Status, ExecutionState]}
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars
_shouldRetry(request, response) {
const { nodeTransactionPrecheckCode } =
this._mapResponseHeader(response);
let status = Status._fromCode(
nodeTransactionPrecheckCode != null
? nodeTransactionPrecheckCode
: proto.ResponseCodeEnum.OK
);
if (this._logger) {
this._logger.debug(
`[${this._getLogId()}] received node precheck status ${status.toString()}`
);
}
switch (status) {
case Status.Busy:
case Status.Unknown:
case Status.ReceiptNotFound:
return [status, ExecutionState.Retry];
case Status.Ok:
break;
default:
return [status, ExecutionState.Error];
}
const transactionGetReceipt =
/** @type {HashgraphProto.proto.ITransactionGetReceiptResponse} */ (
response.transactionGetReceipt
);
const receipt =
/** @type {HashgraphProto.proto.ITransactionReceipt} */ (
transactionGetReceipt.receipt
);
const receiptStatusCode =
/** @type {HashgraphProto.proto.ResponseCodeEnum} */ (
receipt.status
);
status = Status._fromCode(receiptStatusCode);
if (this._logger) {
this._logger.debug(
`[${this._getLogId()}] received receipt status ${status.toString()}`
);
}
switch (status) {
case Status.Busy:
case Status.Unknown:
case Status.ReceiptNotFound:
return [status, ExecutionState.Retry];
case Status.Success:
return [status, ExecutionState.Finished];
default:
return [
status,
this._validateStatus
? ExecutionState.Error
: ExecutionState.Finished,
];
}
}
/**
* @returns {TransactionId}
*/
_getTransactionId() {
if (this._transactionId != null) {
return this._transactionId;
}
return super._getTransactionId();
}
/**
* @override
* @internal
* @param {HashgraphProto.proto.IQuery} request
* @param {HashgraphProto.proto.IResponse} response
* @returns {Error}
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars
_mapStatusError(request, response) {
const { nodeTransactionPrecheckCode } =
this._mapResponseHeader(response);
let status = Status._fromCode(
nodeTransactionPrecheckCode != null
? nodeTransactionPrecheckCode
: proto.ResponseCodeEnum.OK
);
switch (status) {
case Status.Ok:
// Do nothing
break;
default:
return new PrecheckStatusError({
status,
transactionId: this._getTransactionId(),
contractFunctionResult: null,
});
}
const transactionGetReceipt =
/** @type {HashgraphProto.proto.ITransactionGetReceiptResponse} */ (
response.transactionGetReceipt
);
const receipt =
/** @type {HashgraphProto.proto.ITransactionReceipt} */ (
transactionGetReceipt.receipt
);
const receiptStatusCode =
/** @type {HashgraphProto.proto.ResponseCodeEnum} */ (
receipt.status
);
status = Status._fromCode(receiptStatusCode);
if (this._transactionId == null) {
throw new Error(
"Failed to construct `ReceiptStatusError` because `transactionId` is `null`"
);
}
return new ReceiptStatusError({
status,
transactionId: this._transactionId,
transactionReceipt: TransactionReceipt._fromProtobuf(
transactionGetReceipt
),
});
}
/**
* @param {Client} client
*/
_validateChecksums(client) {
if (
this._transactionId != null &&
this._transactionId.accountId != null
) {
this._transactionId.accountId.validateChecksum(client);
}
}
/**
* @override
* @internal
* @param {Channel} channel
* @param {HashgraphProto.proto.IQuery} request
* @returns {Promise<HashgraphProto.proto.IResponse>}
*/
_execute(channel, request) {
return channel.crypto.getTransactionReceipts(request);
}
/**
* @override
* @internal
* @param {HashgraphProto.proto.IResponse} response
* @returns {HashgraphProto.proto.IResponseHeader}
*/
_mapResponseHeader(response) {
const transactionGetReceipt =
/** @type {HashgraphProto.proto.ITransactionGetReceiptResponse} */ (
response.transactionGetReceipt
);
return /** @type {HashgraphProto.proto.IResponseHeader} */ (
transactionGetReceipt.header
);
}
/**
* @protected
* @override
* @param {HashgraphProto.proto.IResponse} response
* @param {AccountId} nodeAccountId
* @param {HashgraphProto.proto.IQuery} request
* @returns {Promise<TransactionReceipt>}
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars
_mapResponse(response, nodeAccountId, request) {
const transactionGetReceipt =
/** @type {HashgraphProto.proto.ITransactionGetReceiptResponse} */ (
response.transactionGetReceipt
);
return Promise.resolve(
TransactionReceipt._fromProtobuf(transactionGetReceipt)
);
}
/**
* @override
* @internal
* @param {HashgraphProto.proto.IQueryHeader} header
* @returns {HashgraphProto.proto.IQuery}
*/
_onMakeRequest(header) {
return {
transactionGetReceipt: {
header,
transactionID:
this._transactionId != null
? this._transactionId._toProtobuf()
: null,
includeDuplicates: this._includeDuplicates,
includeChildReceipts: this._includeChildren,
},
};
}
/**
* @returns {string}
*/
_getLogId() {
return `TransactionReceiptQuery:${this._timestamp.toString()}`;
}
}
QUERY_REGISTRY.set(
"transactionGetReceipt",
// eslint-disable-next-line @typescript-eslint/unbound-method
TransactionReceiptQuery._fromProtobuf
);
Выполнить команду
Для локальной разработки. Не используйте в интернете!