shgraph.hapi.0.54.0.source-code.token_freeze_account.proto Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi Show documentation
Hedera API
The newest version!
syntax = "proto3";

package proto;

/*-
 * ‌
 * Hedera Network Services Protobuf
 * 
 * Copyright (C) 2018 - 2021 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.
 * ‍
 */

option java_package = "com.hederahashgraph.api.proto.java";
// <<>> This comment is special code for setting PBJ Compiler java package
option java_multiple_files = true;

import "basic_types.proto";

/**
 * Freezes transfers of the specified token for the account. Must be signed by the Token's freezeKey.
 * If the provided account is not found, the transaction will resolve to INVALID_ACCOUNT_ID.
 * If the provided account has been deleted, the transaction will resolve to ACCOUNT_DELETED.
 * If the provided token is not found, the transaction will resolve to INVALID_TOKEN_ID.
 * If the provided token has been deleted, the transaction will resolve to TOKEN_WAS_DELETED.
 * If an Association between the provided token and account is not found, the transaction will
 * resolve to TOKEN_NOT_ASSOCIATED_TO_ACCOUNT.
 * If no Freeze Key is defined, the transaction will resolve to TOKEN_HAS_NO_FREEZE_KEY.
 * Once executed the Account is marked as Frozen and will not be able to receive or send tokens
 * unless unfrozen. The operation is idempotent.
 */
message TokenFreezeAccountTransactionBody {
    /**
     * The token for which this account will be frozen. If token does not exist, transaction results
     * in INVALID_TOKEN_ID
     */
    TokenID token = 1;

    /**
     * The account to be frozen
     */
    AccountID account = 2;
}