Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation and fix broken links #107

Merged
merged 1 commit into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hedera™ Hashgraph SDK

![Hedera Hasgraph](https://www.hedera.com/logo-capital-hbar-wordmark.jpg)
![Hedera Hashgraph](https://www.hedera.com/logo-capital-hbar-wordmark.jpg)

This document is the primary reference for the Hedera™ Hashgraph SDKs.

Expand All @@ -20,22 +20,22 @@ semantic operation and classification of an **Official** Hedera™ Hashgraph SDK

---

* [`TransactionId`](reference/TransactionId.md)
* [`TransactionReceipt`](reference/TransactionReceipt.md)
* [`TransactionRecord`](reference/TransactionRecord.md)
* [`TransactionResponse`](reference/TransactionResponse.md)
* [`TransactionId`](reference/core/TransactionId.md)
* [`TransactionReceipt`](reference/core/TransactionReceipt.md)
* [`TransactionRecord`](reference/core/TransactionRecord.md)
* [`TransactionResponse`](reference/core/TransactionResponse.md)

---

* [`Query`](reference/core/Query.md)
* [`TransactionReceiptQuery`](reference/TransactionReceiptQuery.md)
* [`TransactionRecordQuery`](reference/TransactionRecordQuery.md)
* [`TransactionReceiptQuery`](reference/core/TransactionReceiptQuery.md)
* [`TransactionRecordQuery`](reference/core/TransactionRecordQuery.md)

### Errors

* [`PrecheckStatus`](reference/error/PrecheckStatus.md)
* [`ReceiptStatus`](reference/error/ReceiptStatus.md)
* [`MaxQueryPaymentExceeded`](reference/cryptography/MaxQueryPaymentExceeded.md)
* [`MaxQueryPaymentExceeded`](reference/error/MaxQueryPaymentExceeded.md)
* [`BadKey`](reference/error/BadKey.md)
* [`BadMnemonic`](reference/error/BadMnemonic.md)
* [`BadMnemonicReason`](reference/error/BadMnemonicReason.md)
Expand All @@ -50,41 +50,41 @@ semantic operation and classification of an **Official** Hedera™ Hashgraph SDK

### Cryptocurrency

* [`AccountId`](reference/AccountId.md)
* [`AccountInfo`](reference/AccountInfo.md)
* [`AccountId`](reference/cryptocurrency/AccountId.md)
* [`AccountInfo`](reference/cryptocurrency/AccountInfo.md)

---

* [`CryptoTransferTransaction`](reference/CryptoTransferTransaction.md)
* [`AccountCreateTransaction`](reference/AccountCreateTransaction.md)
* [`AccountUpdateTransaction`](reference/AccountUpdateTransaction.md)
* [`AccountDeleteTransaction`](reference/AccountDeleteTransaction.md)
* [`CryptoTransferTransaction`](reference/cryptocurrency/CryptoTransferTransaction.md)
* [`AccountCreateTransaction`](reference/cryptocurrency/AccountCreateTransaction.md)
* [`AccountUpdateTransaction`](reference/cryptocurrency/AccountUpdateTransaction.md)
* [`AccountDeleteTransaction`](reference/cryptocurrency/AccountDeleteTransaction.md)

---

* [`AccountBalanceQuery`](reference/AccountBalanceQuery.md)
* [`AccountInfoQuery`](reference/AccountInfoQuery.md)
* [`AccountRecordsQuery`](reference/AccountRecordsQuery.md)
* [`AccountStakersQuery`](reference/AccountStakersQuery.md)
* [`AccountBalanceQuery`](reference/cryptocurrency/AccountBalanceQuery.md)
* [`AccountInfoQuery`](reference/cryptocurrency/AccountInfoQuery.md)
* [`AccountRecordsQuery`](reference/cryptocurrency/AccountRecordsQuery.md)
* [`AccountStakersQuery`](reference/cryptocurrency/AccountStakersQuery.md)

### Smart Contract

* [`ContractId`](reference/ContractId.md)
* [`ContractInfo`](reference/ContractInfo.md)
* [`ContractId`](reference/contract/ContractId.md)
* [`ContractInfo`](reference/contract/ContractInfo.md)

---

* [`ContractCreateTransaction`](reference/ContractCreateTransaction.md)
* [`ContractUpdateTransaction`](reference/ContractUpdateTransaction.md)
* [`ContractDeleteTransaction`](reference/ContractDeleteTransaction.md)
* [`ContractExecuteTransaction`](reference/ContractExecuteTransaction.md)
* [`ContractCreateTransaction`](reference/contract/ContractCreateTransaction.md)
* [`ContractUpdateTransaction`](reference/contract/ContractUpdateTransaction.md)
* [`ContractDeleteTransaction`](reference/contract/ContractDeleteTransaction.md)
* [`ContractExecuteTransaction`](reference/contract/ContractExecuteTransaction.md)

---

* [`ContractBytecodeQuery`](reference/ContractBytecodeQuery.md)
* [`ContractCallQuery`](reference/ContractCallQuery.md)
* [`ContractInfoQuery`](reference/ContractInfoQuery.md)
* [`ContractRecordsQuery`](reference/ContractRecordsQuery.md)
* [`ContractBytecodeQuery`](reference/contract/ContractBytecodeQuery.md)
* [`ContractCallQuery`](reference/contract/ContractCallQuery.md)
* [`ContractInfoQuery`](reference/contract/ContractInfoQuery.md)
* [`ContractRecordsQuery`](reference/contract/ContractRecordsQuery.md)

### File

Expand Down Expand Up @@ -136,7 +136,7 @@ We welcome participation from all developers!
To propose a change to the specifications, submit a pull request making the
change; or, open an issue for general discussion.

Please check out
Please check out
[contributing guide](https://github.com/hashgraph/.github/blob/main/CONTRIBUTING.md)
to see how you can get involved.

Expand Down
44 changes: 44 additions & 0 deletions reference/Status.md
Original file line number Diff line number Diff line change
Expand Up @@ -1076,3 +1076,47 @@ An account set the staked\_account\_id to itself in CryptoUpdate or ContractUpda
##### INVALID\_STAKING\_ID

The staking account id or staking node id given is invalid or does not exist.

##### STAKING\_NOT\_ENABLED

Native staking, while implemented, has not yet enabled by the council.

##### INVALID\_PRNG\_RANGE

The range provided in UtilPrng transaction is negative.

##### MAX\_ENTITIES\_IN\_PRICE\_REGIME\_HAVE\_BEEN\_CREATED

The maximum number of entities allowed in the current price regime have been created.

##### INVALID\_FULL\_PREFIX\_SIGNATURE\_FOR\_PRECOMPILE

The full prefix signature for precompile is not valid

##### INSUFFICIENT\_BALANCES\_FOR\_STORAGE\_RENT

The combined balances of a contract and its auto-renew account (if any) did not cover
the rent charged for net new storage used in a transaction.

##### MAX\_CHILD\_RECORDS\_EXCEEDED

A contract transaction tried to use more than the allowed number of child records, via
either system contract records or internal contract creations.

##### INSUFFICIENT\_BALANCES\_FOR\_RENEWAL\_FEES

The combined balances of a contract and its auto-renew account (if any) or balance of an account did not cover
the auto-renewal fees in a transaction.

##### TRANSACTION\_HAS\_UNKNOWN\_FIELDS

A transaction's protobuf message includes unknown fields; could mean that a client
expects not-yet-released functionality to be available.

##### ACCOUNT\_IS\_IMMUTABLE

The account cannot be modified. Account's key is not set

##### ALIAS\_ALREADY\_ASSIGNED

An alias that is assigned to an account or contract cannot be assigned to another account or contract.
50 changes: 24 additions & 26 deletions reference/contract/ContractId.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,78 @@
> class `ContractId` implements [`Key`](reference/cryptography/Key.md)
> class `ContractId` extends [`Key`](../cryptography/Key.md)

An ID type that represents a contract on a Hedera Hashgraph network.

### Constructors

##### `constructor` ( `num` : `Uint64` )

Construct a [`ContractId`](#) with [`shard`](#shard-uint64) and [`realm`](#realm-uint64) being zero.
Construct a [`ContractId`](ContractId) with [`shard`](#shard--uint64) and [`realm`](#realm--uint64) being zero.

---

##### `constructor` ( `shard` : `Uint64`, `realm` : `Uint64`, `num` : `Uint64` )

Construct a [`ContractId`](#) with all fields explicitly set.
Construct a [`ContractId`](ContractId) with all fields explicitly set.

---

### Static Methods

##### `fromString` ( `str` : `String` ): [`ContractId`](#contractid)
##### `fromBytes` ( `data` : `bytes` ): [`ContractId`](ContractId)

Construct a [`ContractId`](#) from a string. The format of the string could be either just
a number "4" or dot separated numbers "0.0.4".
Deserialize a [`ContractId`](ContractId) from its protobuf representation.

---

##### `fromBytes` ( `data` : `bytes` ): [`ContractId`](#contractid)
##### `fromEvmAddress` ( `shard` : `Uint64`, `realm` : `Uint64`, `evmAddress` : `string` ): [`ContractId`](ContractId)

Deserialize a [`ContractId`](#) from its the protobuf representation.
Construct a [`ContractId`](ContractId) from a shard, realm, and evm address.

---

##### `fromSolidityAddress` ( `str` : `String` ): [`ContractId`](#contractid)
##### `fromSolidityAddress` ( `str` : `String` ): [`ContractId`](ContractId)

Construct a [`ContractId`](#) a solidity address.
Construct a [`ContractId`](ContractId) a solidity address.

Deprecated: Use `fromEvmAddress()` instead.

---

##### `fromEvmAddress` ( `shard` : `Uint64`, `realm` : `Uint64`, `evmAddress` : `string` ): [`ContractId`](#contractid)
##### `fromString` ( `str` : `String` ): [`ContractId`](ContractId)

Construct a [`ContractId`](#) from a shard, realm, and evm address.
Construct a [`ContractId`](ContractId) from a string. The format of the string could be either just
a number "4" or dot separated numbers "0.0.4".

---

### Methods

##### `toBytes` ( ): `bytes`

Serialize the [`ContractId`](#) into its protobuf representation.
Serialize the [`ContractId`](ContractId) into its protobuf representation.

---

##### `toString` ( ): `string`

Serialize the [`ContractId`](#) into a string form which follows `{shard}.{realm}.{num}` if `evmAddress` is not present
Serialize the [`ContractId`](ContractId) into a string form which follows `{shard}.{realm}.{num}` if `evmAddress` is not present
and `{shard}.{realm}.{evmAddress}` if `evmAddress` is present.

---

##### `toSolidityAddress` ( ): `string`

Serialize the [`ContractId`](#) into its solidity address form.
Serialize the [`ContractId`](ContractId) into its solidity address form.

---

### Properties

##### `shard`: `Uint64`

The shard of this ID.

---
##### `evmAddress`: `bytes?`

##### `realm`: `Uint64`
The evm address of this contract.

The realm of this ID.
Note: This field is only set when `fromEvmAddress()` is used. `fromSolidityAddress()` does not populate this field

---

Expand All @@ -86,10 +82,12 @@ The num of this ID.

---

##### `evmAddress`: `bytes?`

The evm address of this contract.
##### `realm`: `Uint64`

Note: This field is only set when `fromEvmAddress()` is used. `fromSolidityAddress()` does not populate this field
The realm of this ID.

---

##### `shard`: `Uint64`

The shard of this ID.
Loading