Skip to content

specialized-types.md

Latest commit

 

History

History
272 lines (217 loc) · 9 KB

specialized-types.md

File metadata and controls

272 lines (217 loc) · 9 KB
Raw

Specialized Types

AccountId

An AccountId is composed of a <shardNum>.<realmNum>.<accountNum> (eg. 0.0.10).

  • shardNum represents the shard number (shardId). It will default to 0 today, as Hedera only performs in one shard.
  • realmNum represents the realm number (realmId). It will default to 0 today, as realms are not yet supported.
  • accountNum represents the account number (accountId)

Together these values make up your AccountId. When an AccountId is requested, be sure all three values are included.

Constructor

Constructor Type Description
AccountId(<shardNum>,<realmNum>,<accountNum>) long, long, long Constructs an AccountId with 0 for shardNum and realmNum (e.g., 0.0.<accountNum>)

Methods

Methods Type Description
fromString(<account>) String Constructs an AccountId from a string formatted as <shardNum>.<realmNum>.<accountNum>
fromSolidityAddress(<address>) String Constructs an AccountId from a solidity address in string format

Example

{% tabs %} {% tab title="Java" %}

AccountId accountId = new AccountId(0 ,0 ,10);
System.out.println(accountId);

// Constructs an accountId from String
AccountId accountId = AccountId.fromString("0.0.10");
System.out.println(accountId);

{% endtab %}

{% tab title="JavaScript" %}

const acctId = new AccountId(100);
console.log(`${acctId}`);

// Construct accountId from String
const acctId = AccountId.fromString(`100`);
console.log(`${acctId}`);

{% endtab %} {% endtabs %}

FileId

A FileId is composed of a <shardNum>.<realmNum>.<fileNum> (eg. 0.0.15).

  • shardNum represents the shard number (shardId). It will default to 0 today, as Hedera only performs in one shard.
  • realmNum represents the realm number (realmId). It will default to 0 today, as realms are not yet supported.
  • fileNum represents the file number

Together these values make up your accountId. When an FileId is requested, be sure all three values are included.

Constructor

Constructor Type Description
FileId(<shardNum>,<realmNum>,<fileNum>) long, long, long Constructs an FileId with 0 for shardNum and realmNum (e.g., 0.0.<fileNum>)

Methods

Methods Type Description
fromString() String

Constructs an FileId from a string formatted as

<shardNum>.<realmNum>.<fileNum>
fromSolidityAddress() String Constructs an FileId from a solidity address in string format
FileId.ADDRESS_BOOK FileId The public node address book for the current network
FileId.EXCHANGE_RATES FileId The current exchange rate of HBAR to USD
FileId.FEE_SCHEDULE FileId The current fee schedule for the network
### Example

{% tabs %} {% tab title="Java" %}

FileId fileId = new FileId(0,0,15);
System.out.println(fileId);

//Contructs a FileId from string
FileId fileId = FileId.fromString("0.0.15");
System.out.println(fileId);

{% endtab %}

{% tab title="JavaScript" %}

const newFileId = new FileId(100);
console.log(`${newFileId}`);

//Construct a fileId from a String
const newFileIdFromString = FileId.fromString(`100`); 
console.log(`${newFileIdFromString}`);

{% endtab %} {% endtabs %}

ContractId

A ContractId is composed of a <shardNum>.<realmNum>.<contractNum> (eg. 0.0.20).

  • shardNum represents the shard number (shardId). It will default to 0 today, as Hedera only performs in one shard.
  • realmNum represents the realm number (realmId). It will default to 0 today, as realms are not yet supported.
  • contractNum represents the contract number

Together these values make up your ContractId. When an ContractId is requested, be sure all three values are included. ContractId's are automatically assigned when you create a new smart contract.

Constructor

Constructor Type Description
ContractId(<shardNum>,<realmNum>,<contractNum>) long, long, long Constructs a ContractId with 0 for shardNum and realmNum (e.g., 0.0.<contractNum>)

Methods

Methods Type Description
fromString(<account>) String

Constructs a ContractId from a string formatted as

<shardNum>.<realmNum>.<contractNum>
fromSolidityAddress(<address>) String Constructs a ContractId from a solidity address in string format
### Example

{% tabs %} {% tab title="Java" %}

ContractId contractId = new ContractId(0,0,20);
System.out.println(contractId);

// Constructs a ContractId from string
ContractId contractId = ContractId.fromString("0.0.20");
System.out.println(contractId);

{% endtab %}

{% tab title="JavaScript" %}

const newContractId = new ContractId(100);
console.log(`${newContractId}`);

// Construct a contractId from a String
const newContractId = ContractId.fromString(`100`); 
console.log(`${newContractId}`);

{% endtab %} {% endtabs %}

TransactionId

A TransactionId is composed of the current time and account that is primarily signing the transaction. Every transaction has an associated TransactionId. Transaction IDs are automatically assigned for every transaction that is submitted to the network.

Constructor

Constructor Type Description
TransactionId(<accountId>) AccountId Generates a new transaction ID for the given accountId.

Example

{% tabs %} {% tab title="Java" %}

TransactionId transactionId = new TransactionId(myAccountId);

{% endtab %}

{% tab title="JavaScript" %}

const txId = new TransactionId(newAccountId);
console.log(`${txId}`);

{% endtab %} {% endtabs %}

TopicId

A topicId is composed of a <shardNum>.<realmNum>.<topicNum> (eg. 0.0.100).

  • shardNum represents the shard number (shardId). It will default to 0 today, as Hedera only performs in one shard.
  • realmNum represents the realm number (realmId). It will default to 0 today, as realms are not yet supported.
  • topicNum represents the topic number (topicId)

Constructor

Constructor Type Description
ConsensusTopicId(<shardNum>,<realmNum>,<topicNum>) long, long, long Constructs an TopicId with 0 for shardNum and realmNum (e.g., 0.0.<topicNum>)
Methods Type Description
fromString(<topic>) String Constructs a topic ID from a String
ConsensusTopicId.toString() Constructs a topic ID to String format

Example

{% tabs %} {% tab title="Java" %}

ConsensusTopicId topicId = new ConsensusTopicId(0,0,100);
System.out.println(topicId)

{% endtab %}

{% tab title="JavaScript" %}

const txId = new TransactionId(newAccountId);
console.log(`${txId}`);

{% endtab %} {% endtabs %}