Use this endpoint URL as an GraphQL to connect directly to the Ada node provided by Tatum. You can find full documentation on the Cardano GraphQL API.
*
* @param requestBody
* @returns any OK
* @throws ApiError
*/
public static adaGraphQl(
requestBody: any,
): CancelablePromise {
return __request({
method: 'POST',
path: `/v3/ada/graphql`,
body: requestBody,
mediaType: 'application/json',
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Generate Ada wallet
* Support for Cardano is deprecated.
* You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
* 1 credit per API call.
Tatum supports BIP44 HD wallets. Because they can generate 2^31 addresses from 1 mnemonic phrase, they are very convenient and secure. A mnemonic phrase consists of 24 special words in a defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
- Private Key - your secret value, which should never be revealed
- Public Key - public address to be published
- Derivation index - index of generated address
Tatum follows BIP44 specification and generates for ADA wallet with derivation path m/1852'/1815'/0'. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki.
* Generate BIP44 compatible Ada wallet.
*
* @param mnemonic Mnemonic to use for generation of extended public and private keys.
* @returns Wallet OK
* @throws ApiError
*/
public static adaGenerateWallet(
mnemonic?: string,
): CancelablePromise {
return __request({
method: 'GET',
path: `/v3/ada/wallet`,
query: {
'mnemonic': mnemonic,
},
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Generate Ada deposit address from Extended public key
* Support for Cardano is deprecated.
* You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
* 1 credit per API call.
* Generates a Ada deposit address from an Extended public key. The deposit address is generated for the specific index - each extended public key can generate
* up to 2^31 addresses starting from index 0 until 2^31 - 1.
*
* @param xpub Extended public key of a wallet.
* @param index Derivation index of the desired address to be generated.
* @returns any OK
* @throws ApiError
*/
public static adaGenerateAddress(
xpub: string,
index: number,
): CancelablePromise<{
/**
* Ada address
*/
address?: string;
}> {
return __request({
method: 'GET',
path: `/v3/ada/address/${xpub}/${index}`,
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Generate Ada private key
* Support for Cardano is deprecated.
* You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
* 1 credit per API call.
* Generates a private key for an address from a mnemonic for a given derivation path index. The private key is generated for the specific index - each mnemonic
* can generate up to 2^32 private keys starting from index 0 until 2^31 - 1.
*
* @param requestBody
* @returns PrivKey OK
* @throws ApiError
*/
public static adaGenerateAddressPrivateKey(
requestBody: PrivKeyRequest,
): CancelablePromise {
return __request({
method: 'POST',
path: `/v3/ada/wallet/priv`,
body: requestBody,
mediaType: 'application/json',
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Get Block by hash or height
* Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
1 credit per API call.
Gets Ada block detail by block hash or height.
* @param hash Block hash or height.
* @returns AdaBlock OK
* @throws ApiError
*/
public static adaGetBlock(
hash: string,
): CancelablePromise {
return __request({
method: 'GET',
path: `/v3/ada/block/${hash}`,
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
404: `Block not found.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Get transaction by hash
* Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
1 credit per API call.
Get Ada Transaction detail by transaction hash.
* @param hash Transaction hash
* @returns AdaTx OK
* @throws ApiError
*/
public static adaGetRawTransaction(
hash: string,
): CancelablePromise {
return __request({
method: 'GET',
path: `/v3/ada/transaction/${hash}`,
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Get transactions by address
* Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
1 credit per API call.
Gets a Ada transaction by address.
* @param address Address
* @param pageSize Max number of items per page is 50.
* @param offset Offset to obtain the next page of data.
* @returns AdaTx OK
* @throws ApiError
*/
public static adaGetTxByAddress(
address: string,
pageSize: number,
offset?: number,
): CancelablePromise> {
return __request({
method: 'GET',
path: `/v3/ada/transaction/address/${address}`,
query: {
'pageSize': pageSize,
'offset': offset,
},
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Get UTXOs by address
* Support for Cardano is deprecated.
You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
1 credit per API call.
Gets a Ada UTXOs by address.
* @param address Address
* @returns AdaUTXO OK
* @throws ApiError
*/
public static adaGetUtxoByAddress(
address: string,
): CancelablePromise> {
return __request({
method: 'GET',
path: `/v3/ada/${address}/utxos`,
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Send Ada to blockchain addresses
* Support for Cardano is deprecated.
* You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
* 2 credits per API call.
* Send Ada to blockchain addresses. It is possible to build a blockchain transaction in 2 ways:
*
* - fromAddress - assets will be sent from the list of addresses. For each of the addresses, the last 100 transactions will be scanned for any unspent UTXO to be included in the transaction.
* - fromUTXO - assets will be sent from the list of unspent UTXOs. Each of the UTXOs will be included in the transaction.
*
* In bitcoin-like blockchains, a transaction is created from the list of previously unspent UTXOs. Every UTXO contains the amount of funds that can be spent.
* When the UTXO is entered into the transaction, the whole amount is included and must be spent. For example, address A receives 2 transactions, T1 with 1 ADA and T2 with 2 ADA.
* The transaction, which will consume the UTXOs for T1 and T2, will have an available amount to spend of 3 ADA = 1 ADA (T1) + 2 ADA(T2).
* There can be multiple recipients of the transactions. In the to section, every recipient address has its own corresponding amount.
* When the amount of funds that the recipient should receive is lower than the amount of funds from the UTXOs, the difference is split as transaction fee and change, which will be send to change address..
* This operation requires the private key of the blockchain address. Every time the funds are transferred, the transaction must be signed with the corresponding private key.
* No one should ever send their private keys to the Internet because there is a strong possibility that they will be stolen and the funds will be lost. In this method, it is possible to enter a privateKey
* or signatureId. The privateKey should be used only for quick development on testnet versions of blockchains when there is no risk of losing funds. In production,
* Tatum KMS should be used to ensure the highest level of security, and the signatureId should be present in the request.
* Alternatively, it is also possible to use the Tatum Client Library for supported languages.
*
*
* @param requestBody
* @returns any OK
* @throws ApiError
*/
public static adaTransferBlockchain(
requestBody: (AdaTransactionFromAddress | AdaTransactionFromAddressKMS | AdaTransactionFromUTXO | AdaTransactionFromUTXOKMS),
): CancelablePromise<(TransactionHash | SignatureId)> {
return __request({
method: 'POST',
path: `/v3/ada/transaction`,
body: requestBody,
mediaType: 'application/json',
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Broadcast signed Ada transaction
* Support for Cardano is deprecated.
* You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
* 2 credits per API call.
* Broadcasts a signed transaction to the Ada blockchain. This method is used internally from Tatum KMS, Tatum Middleware or Tatum Client Libraries.
* It is possible to create a custom signing mechanism and only use this method for broadcasting data to the blockchain.
*
* @param requestBody
* @returns TransactionHash OK
* @throws ApiError
*/
public static adaBroadcast(
requestBody: BroadcastKMS,
): CancelablePromise {
return __request({
method: 'POST',
path: `/v3/ada/broadcast`,
body: requestBody,
mediaType: 'application/json',
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
/**
* @deprecated
* Gets a Ada account by address
* Support for Cardano is deprecated.
* You can work with Cardano by connecting directly to a blockchain node provided by Tatum.
* 2 credits per API call.
* Gets a Ada account by address.
*
* @param address Address
* @returns AdaAccount OK
* @throws ApiError
*/
public static adaGetAccount(
address: string,
): CancelablePromise> {
return __request({
method: 'GET',
path: `/v3/ada/account/${address}`,
errors: {
400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
403: `Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.`,
500: `Internal server error. There was an error on the server while processing the request.`,
},
});
}
}