Usage
Contents
Methods
initialize
Init instance of BladeSDK for correct work with Blade API and Hedera network.
initialize (apiKey: String, dAppCode: String, network: String, bladeEnv: BladeEnv = BladeEnv.Prod, context: Context, force: Boolean = false, completion: (InfoData?, BladeJSError?) -> Unit)
Parameters
Returns
InfoData
- with information about Blade instance, including visitorId
Example
getInfo
Get SDK info and check if SDK initialized
getInfo (completion: (InfoData?, BladeJSError?) -> Unit)
Parameters
Returns
InfoData
- with information about Blade instance, including visitorId
Example
getBalance
Get balances by account id.
getBalance (id: String, completion: (BalanceData?, BladeJSError?) -> Unit)
Parameters
Returns
BalanceData
- with information about Hedera account balances (hbar and list of token balances)
Example
getCoinList
Get list of all available coins on CoinGecko.
getCoinList (completion: (CoinListData?, BladeJSError?) -> Unit)
Parameters
Returns
CoinListData
- with list of coins described by name, alias, platforms
Example
getCoinPrice
Get coin price and coin info from CoinGecko. Search can be coin id or address in one of the coin platforms.
In addition to the price in USD, the price in the currency you specified is returned
getCoinPrice (search: String, currency: String = "usd", completion: (CoinInfoData?, BladeJSError?) -> Unit)
Parameters
Returns
{CoinInfoData}
Example
transferHbars
Method to execute Hbar transfers from current account to receiver
transferHbars (accountId: String, accountPrivateKey: String, receiverId: String, amount: Double, memo: String, completion: (TransactionReceiptData?, BladeJSError?) -> Unit)
Parameters
Returns
TransactionReceiptData
- receipt
Example
transferTokens
Method to execute token transfers from current account to receiver
transferTokens (tokenId: String, accountId: String, accountPrivateKey: String, receiverId: String, amountOrSerial: Double, memo: String, usePaymaster: Boolean = true, completion: (TransactionReceiptData?, BladeJSError?) -> Unit)
Parameters
Returns
TransactionReceiptData
- receipt
Example
createScheduleTransaction
Create scheduled transaction
createScheduleTransaction ( accountId: String, accountPrivateKey: String, type: ScheduleTransactionType, transfers: List<ScheduleTransactionTransfer>, usePaymaster: Boolean = false, completion: (CreateScheduleData?, BladeJSError?) -> Unit )
Parameters
Returns
CreateScheduleData
- scheduleId
Example
signScheduleId
Method to sign scheduled transaction
signScheduleId ( scheduleId: String, accountId: String, accountPrivateKey: String, receiverAccountId: String = "", usePaymaster: Boolean = false, completion: (TransactionReceiptData?, BladeJSError?) -> Unit )
Parameters
Returns
TransactionReceiptData
- receipt
Example
createHederaAccount
Create new Hedera account (ECDSA). Only for configured dApps. Depending on dApp config Blade create account, associate tokens, etc.
In case of not using pre-created accounts pool and network high load, this method can return transactionId and no accountId.
In that case account creation added to queue, and you should wait some time and call
getPendingAccount()
method.
createHederaAccount (privateKey: String = "", deviceId: String = "", completion: (CreatedAccountData?, BladeJSError?) -> Unit)
Parameters
Returns
CreatedAccountData
- new account data, including private key and account id
Example
getPendingAccount
Get account from queue (read more at createAccount()
).
If account already created, return account data.
If account not created yet, response will be same as in
createAccount()
method if account in queue.
getPendingAccount (transactionId: String, seedPhrase: String, completion: (CreatedAccountData?, BladeJSError?) -> Unit)
Parameters
Returns
CreatedAccountData
- new account data
deleteHederaAccount
Delete Hedera account. This method requires account private key and operator private key. Operator is the one who paying fees
deleteHederaAccount (deleteAccountId: String, deletePrivateKey: String, transferAccountId: String, operatorAccountId: String, operatorPrivateKey: String, completion: (TransactionReceiptData?, BladeJSError?) -> Unit)
Parameters
Returns
TransactionReceiptData
- receipt
Example
getAccountInfo
Get account info.
EvmAddress is address of Hedera account if exists. Else accountId will be converted to solidity address.
CalculatedEvmAddress is calculated from account public key. May be different from evmAddress.
getAccountInfo (accountId: String, completion: (AccountInfoData?, BladeJSError?) -> Unit)
Parameters
Returns
{AccountInfoData}
Example
getNodeList
Get Node list and use it for choosing account stacking node
getNodeList (completion: (NodesData?, BladeJSError?) -> Unit)
Parameters
Returns
NodesData
- node list
Example
stakeToNode
Stake/unstake account
stakeToNode (accountId: String, accountPrivateKey: String, nodeId: Int, completion: (TransactionReceiptData?, BladeJSError?) -> Unit)
Parameters
Returns
TransactionReceiptData
- receipt
Example
getKeysFromMnemonic
Get private key and accountId from mnemonic. Supported standard and legacy key derivation.
If account not found, standard ECDSA key will be returned.
Keys returned with DER header. EvmAddress computed from Public key.
getKeysFromMnemonic (mnemonic: String, lookupNames: Boolean = false, completion: (PrivateKeyData?, BladeJSError?) -> Unit)
Parameters
Returns
PrivateKeyData
- private key derived from mnemonic and account id
Example
searchAccounts
Get accounts list and keys from private key or mnemonic
Supporting standard and legacy key derivation.
Every key with account will be returned.
searchAccounts (keyOrMnemonic: String, completion: (AccountPrivateData?, BladeJSError?) -> Unit)
Parameters
Returns
AccountPrivateData
- list of found accounts with private keys
Example
dropTokens
Bladelink drop to account
dropTokens (accountId: String, accountPrivateKey: String, secretNonce: String, completion: (TokenDropData?, BladeJSError?) -> Unit)
Parameters
Returns
TokenDropData
- status
Example
sign
Sign base64-encoded message with private key. Returns hex-encoded signature.
sign (messageString: String, privateKey: String, completion: (SignMessageData?, BladeJSError?) -> Unit)
Parameters
Returns
SignMessageData
- signature
Example
signVerify
Verify message signature with public key
signVerify (messageString: String, signature: String, publicKey: String, completion: (SignVerifyMessageData?, BladeJSError?) -> Unit)
Parameters
Returns
SignVerifyMessageData
- verification result
Example
contractCallFunction
Call contract function. Directly or via BladeAPI using paymaster account (fee will be paid by Paymaster account), depending on your dApp configuration.
contractCallFunction (contractId: String, functionName: String, params: ContractFunctionParameters, accountId: String, accountPrivateKey: String, gas: Int = 100000, usePaymaster: Boolean, completion: (TransactionReceiptData?, BladeJSError?) -> Unit)
Parameters
Returns
TransactionReceiptData
- receipt
Example
contractCallQueryFunction
Call query on contract function. Similar to {@link contractCallFunction} can be called directly or via BladeAPI using Paymaster account.
contractCallQueryFunction (contractId: String, functionName: String, params: ContractFunctionParameters, accountId: String, accountPrivateKey: String, gas: Int = 100000, usePaymaster: Boolean, returnTypes: List<String>, completion: (ContractQueryData?, BladeJSError?) -> Unit)
Parameters
Returns
ContractQueryData
- contract query call result
Example
ethersSign
Sign base64-encoded message with private key using ethers lib. Returns hex-encoded signature.
ethersSign (messageString: String, privateKey: String, completion: (SignMessageData?, BladeJSError?) -> Unit)
Parameters
Returns
SignMessageData
- signature
Example
splitSignature
Split signature to v-r-s format.
splitSignature (signature: String, completion: (SplitSignatureData?, BladeJSError?) -> Unit)
Parameters
Returns
SplitSignatureData
- v-r-s signature
Example
getParamsSignature
Get v-r-s signature of contract function params
getParamsSignature (params: ContractFunctionParameters, accountPrivateKey: String, completion: (SplitSignatureData?, BladeJSError?) -> Unit)
Parameters
Returns
SplitSignatureData
- v-r-s signature
Example
getTransactions
Get transactions history for account. Can be filtered by transaction type.
Transaction requested from mirror node. Every transaction requested for child transactions. Result are flattened.
If transaction type is not provided, all transactions will be returned.
If transaction type is CRYPTOTRANSFERTOKEN records will additionally contain plainData field with decoded data.
getTransactions (accountId: String, transactionType: String, nextPage: String = "", transactionsLimit: Int = 10, completion: (TransactionsHistoryData?, BladeJSError?) -> Unit)
Parameters
Returns
TransactionsHistoryData
- transactions list
Example
getC14url
Get configured url for C14 integration (iframe or popup)
getC14url (asset: String, account: String, amount: String = "", completion: (IntegrationUrlData?, BladeJSError?) -> Unit)
Parameters
Returns
IntegrationUrlData
- url to open
Example
exchangeGetQuotes
Get quotes from different services for buy, sell or swap
exchangeGetQuotes (sourceCode: String, sourceAmount: Double, targetCode: String, strategy: CryptoFlowServiceStrategy, completion: (SwapQuotesData?, BladeJSError?) -> Unit)
Parameters
Returns
SwapQuotesData
- quotes from different providers
Example
getTradeUrl
Get configured url to buy or sell tokens or fiat
getTradeUrl (strategy: CryptoFlowServiceStrategy, accountId: String, sourceCode: String, sourceAmount: Double, targetCode: String, slippage: Double, serviceId: String, redirectUrl: String = "", completion: (IntegrationUrlData?, BladeJSError?) -> Unit)
Parameters
Returns
IntegrationUrlData
- url to open
Example
getExchangeStatus
Get exchange order status
getExchangeStatus (serviceId: String, orderId: String, completion: (TransakOrderInfoData?, BladeJSError?) -> Unit)
Parameters
Returns
{TransakOrderInfoData}
Example
swapTokens
Swap tokens
swapTokens (accountId: String, accountPrivateKey: String, sourceCode: String, sourceAmount: Double, targetCode: String, slippage: Double, serviceId: String, completion: (SwapResultData?, BladeJSError?) -> Unit)
Parameters
Returns
SwapResultData
- swap result
Example
createToken
Create token (NFT or Fungible Token)
createToken ( treasuryAccountId: String, supplyPrivateKey: String, tokenName: String, tokenSymbol: String, isNft: Boolean, keys: List<KeyRecord>, decimals: Int, initialSupply: Int, maxSupply: Int, completion: (CreateTokenData?, BladeJSError?) -> Unit )
Parameters
Returns
CreateTokenData
- token id
Example
associateToken
Associate token to account. Association fee will be covered by PayMaster, if tokenId configured in dApp
associateToken ( tokenIdOrCampaign: String, accountId: String, accountPrivateKey: String, completion: (TransactionReceiptData?, BladeJSError?) -> Unit )
Parameters
Returns
TransactionReceiptData
- receipt
Example
brokenMnemonicEmergencyTransfer
Emergency balance transfer from broken mnemonic account to new account
Accounts with broken mnemonic sometimes were created because of hedera-sdk issue
To transfer funds from broken mnemonic account to new account a couple of steps required:
Create new account
Associate all tokens with new account that you want to transfer
Call this method to transfer funds to new account
Send some HBAR to broken mnemonic account to cover fees if needed
brokenMnemonicEmergencyTransfer ( seedPhrase: String, accountId: String, receiverId: String, hbarAmount: String, tokenList: List<String>, checkOnly: Boolean, completion: (EmergencyTransferData?, BladeJSError?) -> Unit )
Parameters
Returns
EmergencyTransferData
- receipt
Example
nftMint
Mint one NFT
nftMint ( tokenId: String, supplyAccountId: String, supplyPrivateKey: String, file: String, metadata: Map<String, Any>, storageConfig: IPFSProviderConfig, completion: (TransactionReceiptData?, BladeJSError?) -> Unit )
Parameters
Returns
TransactionReceiptData
- receipt
Example
cleanup
Method to clean-up webView
cleanup ()
postMessage
Method to handle JS responses. By technical reasons, must be public, but you can skip it :)
postMessage (jsonString: String)
Parameters
Last updated