Initial draft of PBJ types for token state

services/state/token/account.proto

@@ -0,0 +1,175 @@
+syntax = "proto3";
+
+package proto;
+
+/*-
+ * ‌
+ * Hedera Network Services Protobuf
+ * ​
+ * Copyright (C) 2018 - 2023 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 "basic_types.proto";
+
+option java_package = "com.hederahashgraph.api.proto.java";
+// <<<pbj.java_package = "com.hedera.hapi.node.state.token">>> This comment is special code for setting PBJ Compiler java package
+option java_multiple_files = true;
+
+/**
+ * First-draft representation of a Hedera Token Service account entity in the network Merkle tree.
+ *
+ * As with all network entities, an account has a unique entity number, which is usually given along
+ * with the network's shard and realm in the form of a shard.realm.number id.
+ */
+
+message Account {
+    /**
+     * The unique entity number of the account.
+     */
+    int64 account_number = 1;
+    /**
+     * The public key bytes to be used as the account's alias, if any.
+     */
+    bytes alias = 2;
+    /**
+     * (Optional) The key to be used to sign transactions from the account, if any.
+     */
+    Key key = 3;
+    /**
+     * The expiration time of the account, in seconds since the epoch.
+     */
+    int64 expiry = 4;
+    /**
+     * The balance of the account, in tiny-bars.
+     */
+    int64 hbar_balance = 5;
+    /**
+     * An optional description of the topic with UTF-8 encoding up to 100 bytes.
+     */
+    string memo = 6;
+    /**
+     * A boolean marking if the account has been deleted.
+     */
+    bool deleted = 7;
+    /**
+     * A boolean marking if the account is a smart contract.
+     */
+    bool smart_contract = 8;
+    /**
+     * A boolean marking if the account requires a receiver signature.
+     */
+    bool receiver_sig_required = 9;
+    /**
+     * The number of NFTs owned by the account.
+     */
+    int64 number_owned_nfts = 10;
+    /**
+     * The maximum number of tokens that can be auto-associated with the account.
+     */
+    int32 max_auto_associations = 11;
+    /**
+     * The number of used auto-association slots.
+     */
+    int32 used_auto_associations = 12;
+    /**
+     * The number of tokens associated with the account.
+     */
+    int32 number_associations = 13;
+    /**
+     * The number of tokens with a positive balance associated with the account.
+     */
+    int32 number_positive_balances = 14;
+    /**
+     * The nonce of the account, used for Ethereum interoperability.
+     */
+    int64 ethereum_nonce = 15;
+    /**
+     * The amount of hbars staked to the account.
+     */
+    int64 staked_to_me = 16;
+    /**
+     * If this account stakes to another account, its value will be -1. It will
+     * be set to the time when the account starts staking to a node.
+     */
+    int64 stake_period_start = 17;
+    /**
+     * The node number or the account number this account is staked to.
+     * It is negative if staking to a node and positive if staking to an account and 0 if not staking to anyone.
+     * When staking to a node, it is stored as -node-1 to differentiate node 0.
+     */
+    int64 staked_number = 18;
+    /**
+     * A boolean marking if the account declines rewards.
+     */
+    bool decline_reward = 19;
+    /**
+     * The amount of hbars staked to the account at the start of the last rewarded period.
+     */
+    int64 stake_at_start_of_last_rewarded_period = 20;
+    /**
+     * (Optional) The number of an auto-renew account, in the same shard and realm as the topic, that
+     * has signed a transaction allowing the network to use its balance to automatically extend the topic's
+     * expiration time when it passes.
+     */
+    int64 auto_renew_account_number = 21;
+    /**
+     * The number of seconds the network should automatically extend the account's expiration by, if the
+     * account has a valid auto-renew account, and is not deleted upon expiration.
+     */
+    int64 auto_renew_secs = 22;
+    /**
+     * If this account is a smart-contract, number of key-value pairs stored on the contract.
+     */
+    int32 contract_kv_pairs_number = 23;
+    /**
+     * (Optional) List of crypto allowances approved by the account.
+     */
+    repeated CryptoAllowance crypto_allowances = 24;
+    /**
+     * (Optional) List of non-fungible token allowances approved by the account.
+     */
+    repeated NftAllowance nft_allowances = 25;
+
+    /**
+     * (Optional) List of fungible token allowances approved by the account.
+     */
+    repeated TokenAllowance token_allowances = 26;
+    /**
+     * The token ID of the head of the linked list from token relations map for the account.
+     */
+    uint64 head_token_number = 27;
+    /**
+     * The NftId of the head of the linked list from unique tokens map for the account.
+     */
+    uint64 head_nft_id = 28;
+    /**
+      * The serial number of the head NftId of the linked list from unique tokens map for the account.
+      */
+    uint64 head_nft_serial_number = 29;
+    /**
+     * The number of tokens for which this account is treasury
+     */
+    uint32 number_treasury_titles = 30;
+    /**
+     * A flag indicating if the account is expired and pending removal.
+     * Only the entity expiration system task toggles this flag when it reaches this account
+     * and finds it expired. Before setting the flag the system task checks if the account has
+     * an auto-renew account with balance. This is done to prevent a zero-balance account with a funded
+     * auto-renew account from being treated as expired in the interval between its expiration
+     * and the time the system task actually auto-renews it.
+     */
+    bool expired_and_pending_removal = 31;
+}

services/state/token/token.proto

@@ -0,0 +1,144 @@
+syntax = "proto3";
+
+package proto;
+
+/*-
+ * ‌
+ * Hedera Network Services Protobuf
+ * ​
+ * Copyright (C) 2018 - 2023 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 "basic_types.proto";
+import "custom_fees.proto";
+
+option java_package = "com.hederahashgraph.api.proto.java";
+// <<<pbj.java_package = "com.hedera.hapi.node.state.token">>> This comment is special code for setting PBJ Compiler java package
+option java_multiple_files = true;
+
+/**
+ * First-draft representation of a Hedera Token Service token entity in the network Merkle tree.
+ *
+ * As with all network entities, a token has a unique entity number, which is usually given along
+ * with the network's shard and realm in the form of a shard.realm.number id.
+ */
+
+message Token {
+    /**
+     * The unique entity number of this token.
+     */
+    int64 token_number = 1;
+    /**
+     * The name of this token.
+     */
+    string name = 2;
+    /**
+     * The symbol of this token.
+     */
+    string symbol = 3;
+    /**
+     * The number of decimal places of this token.
+     */
+    int32 decimals = 4;
+    /**
+     * The total supply of this token.
+     */
+    int64 total_supply = 5;
+    /**
+     * The treasury account number of this token.
+     */
+    int64 treasury_account_number = 6;
+    /**
+     * (Optional) The admin key of this token.
+     */
+    Key admin_key = 7;
+    /**
+     * (Optional) The kyc key of this token.
+     */
+    Key kyc_key = 8;
+    /**
+     * (Optional) The freeze key of this token.
+     */
+    Key freeze_key = 9;
+    /**
+     * (Optional) The wipe key of this token.
+     */
+    Key wipe_key = 10;
+    /**
+     * (Optional) The supply key of this token.
+     */
+    Key supply_key = 11;
+    /**
+     * (Optional) The fee schedule key of this token.
+     */
+    Key fee_schedule_key = 12;
+    /**
+     * (Optional) The pause key of this token.
+     */
+    Key pause_key = 13;
+    /**
+     * The last used serial number of this token.
+     */
+    int64 last_used_serial_number = 14;
+    /**
+     * The flag indicating if this token is deleted.
+     */
+    bool deleted = 15;
+    /**
+     * The auto renew account number of this token.
+     */
+    int64 auto_renew_account_number = 16;
+    /**
+     * The auto renew period of this token.
+     */
+    int64 auto_renew_secs = 17;
+    /**
+     * The expiration time of the token, in seconds since the epoch.
+     */
+    int64 expiry = 18;
+    /**
+     * An optional description of the token with UTF-8 encoding up to 100 bytes.
+     */
+    string memo = 19;
+    /**
+     * The maximum supply of this token.
+     */
+    int64 max_supply = 20;
+    /**
+     * The flag indicating if this token is paused.
+     */
+    bool paused = 21;
+    /**
+     * The flag indicating if this token has accounts associated to it that are frozen by default.
+     */
+    bool accounts_frozen_by_default = 22;
+    /**
+      * The flag indicating if this token has accounts associated to it that are KYC granted by default.
+     */
+    bool accounts_kyc_granted_by_default = 23;
+    /**
+     * The type of this token.
+     */
+    TokenType token_type = 24;
+    /**
+     * The supply type of this token.
+     */
+    TokenSupplyType supply_type = 25;
+    /**
+     * (Optional) The custom fees of this token.
+     */
+    repeated CustomFee custom_fees = 26;
+}

services/state/token/token_relation.proto

@@ -0,0 +1,73 @@
+syntax = "proto3";
+
+package proto;
+
+/*-
+ * ‌
+ * Hedera Network Services Protobuf
+ * ​
+ * Copyright (C) 2018 - 2023 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 "basic_types.proto";
+
+option java_package = "com.hederahashgraph.api.proto.java";
+// <<<pbj.java_package = "com.hedera.hapi.node.state.token">>> This comment is special code for setting PBJ Compiler java package
+option java_multiple_files = true;
+/**
+ * First-draft representation of a Hedera Token Service token relationship entity in the network Merkle tree.
+ *
+ * As with all network entities, a token relationship has a unique entity number pair, which is represented
+ * with the account and the token involved in the relationship.
+ */
+message TokenRelation {
+    /**
+     * The token involved in this relation.
+     */
+    uint64 token_number = 1;
+    /**
+     * The account involved in this association.
+     */
+    uint64 account_number = 2;
+    /**
+     * The balance of the token relationship.
+     */
+    int64 balance = 3;
+    /**
+     * The flags of the token relationship.
+     */
+    bool frozen = 4;
+    /**
+     * The flag indicating if the token relationship has been granted KYC.
+     */
+    bool kyc_granted = 5;
+    /**
+     * The flag indicating if the token relationship was deleted.
+     */
+    bool deleted = 6;
+    /**
+     * The flag indicating if the token relationship was created using automatic association.
+     */
+    bool automatic_association = 8;
+    /**
+     * The previous token number of account's association linked list
+     */
+    uint64 previous_token = 9;
+    /**
+     * The next token number of account's association linked list
+     */
+    uint64 next_token = 10;
+}