The Java SDK for OKTC provides a robust set of tools for developers to interact with the OKTC blockchain. It simplifies complex operations like cryptographic key management, message signing, and address generation, enabling seamless integration of blockchain functionalities into Java applications.
This guide outlines the core components and utilities available within the SDK, offering a clear pathway for developers to build and deploy decentralized applications.
Package Overview and Key Utilities
Package: utils
The utils package contains essential helper classes that provide foundational functionalities required for various blockchain operations.
Class: Utils
This class offers utility methods that assist in data formatting and conversion, which are critical for accurate blockchain transactions.
Complement 18-bit Accuracy
This method ensures numerical values are formatted with 18 decimal places of precision. This level of accuracy is vital for handling token amounts and financial calculations on the blockchain, preventing rounding errors.
Convert BigInteger to Bytes
A utility for converting BigInteger objects into byte arrays. This conversion is often necessary for preparing data for cryptographic functions or for constructing raw transaction payloads.
Package: crypto
The crypto package is the core of the SDK's security and identity management, handling everything from key generation to address creation.
Class: AddressUtil
This class provides methods for generating and converting between different address formats used within the OKTC ecosystem.
Generate Bech32 Address from Pubkey
Creates a human-readable Bech32 address from a public key. This format includes a checksum to prevent errors when users input addresses manually.
Convert Pubkey to Bech32 Pubkey
Transforms a standard hexadecimal public key into a Bech32 encoded public key, which is often used for display purposes or specific blockchain operations.
Convert Hex String Address to Bech32 Address
This function takes a hexadecimal representation of an address and converts it into the more user-friendly Bech32 format, enhancing readability and reducing error rates.
Convert Bech32 Address to Hex String Address
Performs the reverse operation, converting a Bech32 address back to its raw hexadecimal form for processing or interoperability with other systems that require the hex format.
Class: Crypto
The Crypto class contains the fundamental cryptographic operations needed to secure transactions and manage identities on the blockchain.
Sign a Message with a Hex String Private Key
This method allows you to cryptographically sign a message or transaction using a private key represented as a hexadecimal string, ensuring authenticity and integrity.
Generate a Private Key Randomly
Creates a cryptographically secure random private key. This is the first step for users to generate a new wallet and identity on the blockchain.
Generate Hex String Pubkey from Hex String Private Key
Derives the corresponding public key from a given private key. This public key is used to generate addresses and verify signatures. 👉 Explore advanced key management strategies
Generate Mnemonic Randomly
Produces a random sequence of words (a mnemonic phrase) that can be used to backup and restore a wallet. This is a user-friendly way to manage private keys.
Generate Hex String Private Key from Mnemonic
This function derives a deterministic private key from a given mnemonic phrase. This allows users to regain access to their wallet and funds using their backup phrase.
Generate Bech32 Validator Operator Address from Hex String Pubkey
A specific method for validator operators within proof-of-stake networks. It generates a special Bech32 address used to identify a validator node from its public key.
Class: PrivateKey
This class encapsulates a private key and provides a constructor for easy initialization.
PrivateKey Constructor
The constructor accepts an input parameter that can be either a mnemonic phrase or a hexadecimal string private key, offering flexibility in how you initialize a key object.
Package: msg
The msg package defines the different types of messages (transactions) that can be sent to the OKTC blockchain, such as transferring tokens or interacting with smart contracts.
Each message type, like MsgSend for token transfers, is structured to meet the requirements of specific blockchain modules. To see a practical implementation, you can refer to the main function within the respective message class or the provided sample code.
Environment Setting
Before broadcasting a message, you must configure your environment. This typically involves setting up a client to connect to an OKTC network node, initializing your account with a private key, and defining chain parameters like the gas prices.
Transfer Tokens Between Accounts
This is a common operation where you construct a MsgSend transaction. The process involves specifying the sender, recipient, token amount, and other necessary details before signing and broadcasting the transaction to the network. 👉 Learn more about building transaction workflows
Frequently Asked Questions
What is the primary use of the OKTC Java SDK?
The SDK provides a comprehensive toolkit for Java developers to integrate OKTC blockchain functionalities into their applications. It handles complex tasks like key management, transaction signing, and message construction, simplifying the development of dApps and services.
How do I generate a new wallet with the SDK?
You can generate a new wallet by first creating a random mnemonic using Crypto.generateMnemonicRandomly(). Then, derive a private key from that mnemonic with Crypto.generateHexStringPrivateKeyFromMnemonic(). Finally, you can generate a public key and address from the private key.
What is the difference between a hex address and a Bech32 address?
A hex address is a raw, hexadecimal representation of a public key hash. A Bech32 address is a more user-friendly encoding that includes a human-readable prefix and a checksum to prevent errors, making it safer for sharing and inputting.
Why is 18-bit decimal precision important?
Blockchains often represent token values with high precision to accurately handle very small fractions. The 18-bit precision is a common standard that ensures calculations for transactions, fees, and rewards are mathematically accurate without floating-point errors.
How do I sign and broadcast a transaction?
After constructing your message (e.g., a transfer message), you must sign it with the sender's private key using the Crypto.sign method. The signed transaction is then broadcast to the network using a client connection to an OKTC node for processing.
Can I use an existing mnemonic to initialize a private key?
Yes, the PrivateKey constructor accepts an existing mnemonic phrase as a parameter. This allows you to import and manage wallets that were created outside of the immediate application, ensuring seamless account recovery and interoperability.