From f2519f9998dcf621583ad980835fdf7ba278105b Mon Sep 17 00:00:00 2001
From: "juraj.bacovcin" Base is a secure, low-cost, builder-friendly Ethereum L2 built\
+ \ to bring the next billion users onchain..\n
\n Tatum supports 2 chains:\n\
+ \ \n
\n
Bitcoin Blockchain enables access to the most commonly used Bitcoin methods. These methods bring a small level of abstraction @@ -127,6 +136,16 @@ tags: \ it can generate 2^31 addresses from 1 mnemonic phrase. It is possible to generate\ \ this type of wallet with 1 simple API call.
\n" name: Celo + - description: + "Cronos is an EVM-based blockchain which gives developers secure\
+ \ decentralized access to high-integrity data from other chains and the internet.\n\
+ \
\n Tatum supports 2 chains:\n
Dogecoin Blockchain enables access to the most commonly used Dogecoin\ \ methods. These methods bring a small level of abstraction\n and are used for\ @@ -177,6 +196,10 @@ tags: The testnet cryptocurrency has no value, and you can obtain it from a faucet (for example, FaucETH). +
Flare is an EVM-based Layer 1 which gives developers secure decentralized\
+ \ access to high-integrity data from other chains and the internet.\n
\nTatum\
+ \ supports 4 chains:\n
Harmony.ONE is an Oneeum L2 scaling solution 100% EVM compatible, and is very good for decentralized application (Dapp) development within many @@ -465,6 +505,9 @@ paths: /v3/bitcoin/transaction/address/{address}: get: $ref: categories/blockchain/paths/v3_bitcoin_transaction_address_{address}_get.yml + /v3/bitcoin/transaction/address/batch: + post: + $ref: categories/blockchain/paths/v3_bitcoin_transaction_address_batch_post.yml /v3/bitcoin/transaction: post: $ref: categories/blockchain/paths/v3_bitcoin_transaction_post.yml @@ -922,6 +965,42 @@ paths: /v3/polygon/broadcast: post: $ref: categories/blockchain/paths/v3_polygon_broadcast_post.yml + /v3/cronos/wallet: + get: + $ref: categories/blockchain/paths/v3_cronos_wallet_get.yml + /v3/cronos/address/{xpub}/{index}: + get: + $ref: categories/blockchain/paths/v3_cronos_address_{xpub}_{index}_get.yml + /v3/cronos/wallet/priv: + post: + $ref: categories/blockchain/paths/v3_cronos_wallet_priv_post.yml + /v3/cronos/web3/{xApiKey}: + post: + $ref: categories/blockchain/paths/v3_cronos_web3_{xApiKey}_post.yml + /v3/cronos/block/current: + get: + $ref: categories/blockchain/paths/v3_cronos_block_current_get.yml + /v3/cronos/block/{hash}: + get: + $ref: categories/blockchain/paths/v3_cronos_block_{hash}_get.yml + /v3/cronos/account/balance/{address}: + get: + $ref: categories/blockchain/paths/v3_cronos_account_balance_{address}_get.yml + /v3/cronos/transaction/{hash}: + get: + $ref: categories/blockchain/paths/v3_cronos_transaction_{hash}_get.yml + /v3/cronos/transaction/count/{address}: + get: + $ref: categories/blockchain/paths/v3_cronos_transaction_count_{address}_get.yml + /v3/cronos/transaction: + post: + $ref: categories/blockchain/paths/v3_cronos_transaction_post.yml + /v3/cronos/smartcontract: + post: + $ref: categories/blockchain/paths/v3_cronos_smartcontract_post.yml + /v3/cronos/broadcast: + post: + $ref: categories/blockchain/paths/v3_cronos_broadcast_post.yml /v3/klaytn/wallet: get: $ref: categories/blockchain/paths/v3_klaytn_wallet_get.yml @@ -982,6 +1061,78 @@ paths: /v3/solana/broadcast/confirm: post: $ref: categories/blockchain/paths/v3_solana_broadcast_confirm_post.yml + /v3/flare/wallet: + get: + $ref: categories/blockchain/paths/v3_flare_wallet_get.yml + /v3/flare/address/{xpub}/{index}: + get: + $ref: categories/blockchain/paths/v3_flare_address_{xpub}_{index}_get.yml + /v3/flare/wallet/priv: + post: + $ref: categories/blockchain/paths/v3_flare_wallet_priv_post.yml + /v3/flare/web3/{xApiKey}: + post: + $ref: categories/blockchain/paths/v3_flare_web3_{xApiKey}_post.yml + /v3/flare/block/current: + get: + $ref: categories/blockchain/paths/v3_flare_block_current_get.yml + /v3/flare/block/{hash}: + get: + $ref: categories/blockchain/paths/v3_flare_block_{hash}_get.yml + /v3/flare/account/balance/{address}: + get: + $ref: categories/blockchain/paths/v3_flare_account_balance_{address}_get.yml + /v3/flare/transaction/{hash}: + get: + $ref: categories/blockchain/paths/v3_flare_transaction_{hash}_get.yml + /v3/flare/transaction/count/{address}: + get: + $ref: categories/blockchain/paths/v3_flare_transaction_count_{address}_get.yml + /v3/flare/transaction: + post: + $ref: categories/blockchain/paths/v3_flare_transaction_post.yml + /v3/flare/smartcontract: + post: + $ref: categories/blockchain/paths/v3_flare_smartcontract_post.yml + /v3/flare/broadcast: + post: + $ref: categories/blockchain/paths/v3_flare_broadcast_post.yml + /v3/base/wallet: + get: + $ref: categories/blockchain/paths/v3_base_wallet_get.yml + /v3/base/address/{xpub}/{index}: + get: + $ref: categories/blockchain/paths/v3_base_address_{xpub}_{index}_get.yml + /v3/base/wallet/priv: + post: + $ref: categories/blockchain/paths/v3_base_wallet_priv_post.yml + /v3/base/web3/{xApiKey}: + post: + $ref: categories/blockchain/paths/v3_base_web3_{xApiKey}_post.yml + /v3/base/block/current: + get: + $ref: categories/blockchain/paths/v3_base_block_current_get.yml + /v3/base/block/{hash}: + get: + $ref: categories/blockchain/paths/v3_base_block_{hash}_get.yml + /v3/base/account/balance/{address}: + get: + $ref: categories/blockchain/paths/v3_base_account_balance_{address}_get.yml + /v3/base/transaction/{hash}: + get: + $ref: categories/blockchain/paths/v3_base_transaction_{hash}_get.yml + /v3/base/transaction/count/{address}: + get: + $ref: categories/blockchain/paths/v3_base_transaction_count_{address}_get.yml + /v3/base/transaction: + post: + $ref: categories/blockchain/paths/v3_base_transaction_post.yml + /v3/base/smartcontract: + post: + $ref: categories/blockchain/paths/v3_base_smartcontract_post.yml + /v3/base/broadcast: + post: + $ref: categories/blockchain/paths/v3_base_broadcast_post.yml /v3/celo/wallet: get: $ref: categories/blockchain/paths/v3_celo_wallet_get.yml @@ -1263,4 +1414,4 @@ paths: components: securitySchemes: X-API-Key: - $ref: components/schemas.yml#/components/securitySchemes/X-API-Key + $ref: components/migrated.yml#/components/securitySchemes/X-API-Key diff --git a/categories/blockchain/paths/v3_base_account_balance_{address}_get.yml b/categories/blockchain/paths/v3_base_account_balance_{address}_get.yml new file mode 100644 index 0000000..f51c2c1 --- /dev/null +++ b/categories/blockchain/paths/v3_base_account_balance_{address}_get.yml @@ -0,0 +1,58 @@ +description: '
1 credit per API call
+ +Get the balance of BASE of an Base account.
+ +To get the balance of tokens, use the APIs for getting the balance of + fungible tokens (ERC-20) and NFTs (ERC-721).
+ + ' +operationId: BaseGetBalance +parameters: + - description: Account address you want to get balance of + in: path + name: address + required: true + schema: + type: string + example: "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/BaseBalance" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get the BASE balance of an Base account +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_address_{xpub}_{index}_get.yml b/categories/blockchain/paths/v3_base_address_{xpub}_{index}_get.yml new file mode 100644 index 0000000..7938739 --- /dev/null +++ b/categories/blockchain/paths/v3_base_address_{xpub}_{index}_get.yml @@ -0,0 +1,63 @@ +description: "Generates an Base account 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.
+ + " +operationId: BaseGenerateAddress +parameters: + - description: Extended public key of wallet. + in: path + name: xpub + required: true + schema: + type: string + example: xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid + - description: Derivation index of the address to be generated. + in: path + name: index + required: true + schema: + type: number + example: 0 +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/GeneratedAddressBase" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Base account address from Extended public key +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_block_current_get.yml b/categories/blockchain/paths/v3_base_block_current_get.yml new file mode 100644 index 0000000..d2fb2dc --- /dev/null +++ b/categories/blockchain/paths/v3_base_block_current_get.yml @@ -0,0 +1,37 @@ +description: +Gets the current Base block number. + This is the number of the latest block in the blockchain.
+operationId: BaseGetCurrentBlock +responses: + "200": + content: + application/json: + schema: + type: number + description: Current block number + example: 6491272 + description: OK + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get current block number +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_block_{hash}_get.yml b/categories/blockchain/paths/v3_base_block_{hash}_get.yml new file mode 100644 index 0000000..15ac2c1 --- /dev/null +++ b/categories/blockchain/paths/v3_base_block_{hash}_get.yml @@ -0,0 +1,51 @@ +description: +Gets an Base block-by-block hash + or block number.
+operationId: BaseGetBlock +parameters: + - description: Block hash or block number + in: path + name: hash + required: true + schema: + type: string + example: "6470657" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/BaseBlock" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get Base block by hash +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_broadcast_post.yml b/categories/blockchain/paths/v3_base_broadcast_post.yml new file mode 100644 index 0000000..9dc397f --- /dev/null +++ b/categories/blockchain/paths/v3_base_broadcast_post.yml @@ -0,0 +1,63 @@ +description: "2 credits per API call
+ +Broadcast signed transaction to Base blockchain. This method is used internally + from Tatum KMS or Tatum client libraries. + + It is possible to create custom signing mechanism and use this method only for broadcasting + data to the blockchain.
+ + " +operationId: BaseBroadcast +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/BroadcastKMS" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseBroadcast" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Broadcast signed Base transaction +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_smartcontract_post.yml b/categories/blockchain/paths/v3_base_smartcontract_post.yml new file mode 100644 index 0000000..36a2428 --- /dev/null +++ b/categories/blockchain/paths/v3_base_smartcontract_post.yml @@ -0,0 +1,119 @@ +description: '2 credits per API call
+ +Invoke a method in an existing smart contract on Base.
+ +You can call a read-only or write method.
+ +Troubleshooting a failed transaction
+
+ Tatum ensures that this API works against the blockchain (accesses the blockchain,
+ finds the specified smart contract, and executes the specified ABI method with the
+ provided parameters).
However, because this API can be run against any smart
+ contract on the blockchain, Tatum cannot in any way guarantee that the method itself
+ will be executed successfully.
If you have issues with invoking the method, refer to the user documentation + for this method, or contact the author of the smart contract.
+ +For more information about invoking methods in smart contracts, see this article on our Support Portal.
+ +Signing a transaction
+
+ When invoking a method in a smart contract, you are charged a fee for the transaction,
+ and you must sign the transaction with the private key of the blockchain address
+ from which the fee will be deducted.
If caller field is present instead of the private key, Tatum will sign + the transaction with the managed private key connected to the caller address. This + is applicable only for paid mainnet plans and all testnet plans. Keep in mind that + the caller address must have enough access right to perform the action in the smart + contract method.
+ +Providing the private key in the API is not a secure way of signing transactions, + because the private key can be stolen or exposed. Your private keys should never + leave your security perimeter. You should use the private keys only for testing + a solution you are building on the testnet of a blockchain.
+ +For signing transactions on the mainnet, we strongly recommend that you + use the Tatum Key + Management System (KMS) and provide the signature ID instead of the private + key in the API. Alternatively, you can use the Tatum JavaScript client.
+ + ' +operationId: BaseBlockchainSmartContractInvocation +requestBody: + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/CallSmartContractMethod" + - $ref: "../../../components/migrated.yml#/components/schemas/CallReadSmartContractMethod" + - $ref: "../../../components/migrated.yml#/components/schemas/CallBaseSmartContractMethodCaller" + - $ref: "../../../components/migrated.yml#/components/schemas/CallSmartContractMethodKMS" + required: true +responses: + "200": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + - $ref: "../../../components/migrated.yml#/components/schemas/SignatureId" + - $ref: "../../../components/migrated.yml#/components/schemas/Data" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseBroadcast" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseGasPrice" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseScBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseGasCalculation" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseTxHash" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseTxSign" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Invoke a method in a smart contract on Base +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_transaction_count_{address}_get.yml b/categories/blockchain/paths/v3_base_transaction_count_{address}_get.yml new file mode 100644 index 0000000..c5b7c47 --- /dev/null +++ b/categories/blockchain/paths/v3_base_transaction_count_{address}_get.yml @@ -0,0 +1,65 @@ +description: "Get a number of outgoing Base transactions for the address. When a transaction + is sent, there can be multiple outgoing transactions, + + which are not yet processed by the blockchain. To distinguish between them, there + is a counter called a nonce, which represents + + the order of the transaction in the list of outgoing transactions.
+ + " +operationId: BaseGetTransactionCount +parameters: + - description: address + in: path + name: address + required: true + schema: + type: string + maxLength: 42 + minLength: 42 + example: "0xdac17f958d2ee523a2206206994597c13d831ec7" +responses: + "200": + content: + application/json: + schema: + type: number + example: 5 + description: + Number of transactions, that were made from this address. Can + be used as a nonce parameter in send transaction calls. + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get count of outgoing Base transactions +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_transaction_post.yml b/categories/blockchain/paths/v3_base_transaction_post.yml new file mode 100644 index 0000000..6ac11b2 --- /dev/null +++ b/categories/blockchain/paths/v3_base_transaction_post.yml @@ -0,0 +1,89 @@ +description: '2 credits per API call
+ +Send BASE or Tatum-supported fungible tokens (ERC-20) from account to account.
+ +NOTE: Sending the fungible tokens + is supported only on the mainnet.
+ +Signing a transaction
+
+ When sending BASE, you are charged a fee for the transaction, and you must sign
+ the transaction with the private key of the blockchain address from which the fee
+ will be deducted.
Providing the private key in the API is not a secure way of signing transactions, + because the private key can be stolen or exposed. Your private keys should never + leave your security perimeter. You should use the private keys only for testing + a solution you are building on the testnet of a blockchain.
+ +For signing transactions on the mainnet, we strongly recommend that you + use the Tatum Key + Management System (KMS) and provide the signature ID instead of the private + key in the API. Alternatively, you can use the Tatum JavaScript client.
+ + ' +operationId: BaseBlockchainTransfer +requestBody: + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransferBaseBlockchain" + - $ref: "../../../components/migrated.yml#/components/schemas/TransferBaseBlockchainKMS" + required: true +responses: + "200": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + - $ref: "../../../components/migrated.yml#/components/schemas/SignatureId" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseBroadcast" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseGasPrice" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseTxBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseGasCalculation" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseTxHash" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseTxSign" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Send BASE or fungible tokens (ERC-20) from account to account +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_transaction_{hash}_get.yml b/categories/blockchain/paths/v3_base_transaction_{hash}_get.yml new file mode 100644 index 0000000..5cfd8e3 --- /dev/null +++ b/categories/blockchain/paths/v3_base_transaction_{hash}_get.yml @@ -0,0 +1,60 @@ +description: "1 credit per API call
+ +Get Base transaction by transaction hash.
+ + " +operationId: BaseGetTransaction +parameters: + - description: Transaction hash + in: path + name: hash + required: true + schema: + type: string + example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/BaseTx" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "404": + description: Transaction not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error404TxNotFound" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get Base Transaction +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_wallet_get.yml b/categories/blockchain/paths/v3_base_wallet_get.yml new file mode 100644 index 0000000..0354bb6 --- /dev/null +++ b/categories/blockchain/paths/v3_base_wallet_get.yml @@ -0,0 +1,62 @@ +description: + '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:
Tatum follows the BIP44 specification + and generates for Base wallets with the derivation path m/44''/60''/0''/0. More + about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki. + + Generates a BIP44 compatible Base wallet.
+ + ' +operationId: BaseGenerateWallet +parameters: + - description: Mnemonic to use for generating extended public and private keys. + in: query + name: mnemonic + required: false + schema: + type: string + maxLength: 500 +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Wallet" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Base wallet +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_wallet_priv_post.yml b/categories/blockchain/paths/v3_base_wallet_priv_post.yml new file mode 100644 index 0000000..f341de4 --- /dev/null +++ b/categories/blockchain/paths/v3_base_wallet_priv_post.yml @@ -0,0 +1,54 @@ +description: "Generates the private key of 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.
+ + " +operationId: BaseGenerateAddressPrivateKey +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/PrivKeyRequest" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/PrivKey" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Base private key +tags: + - Base diff --git a/categories/blockchain/paths/v3_base_web3_{xApiKey}_post.yml b/categories/blockchain/paths/v3_base_web3_{xApiKey}_post.yml new file mode 100644 index 0000000..e12a54e --- /dev/null +++ b/categories/blockchain/paths/v3_base_web3_{xApiKey}_post.yml @@ -0,0 +1,76 @@ +deprecated: true +description: '2 credits per API call
+ +This endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as an http-based web3 driver to connect directly to the + Base node provided by Tatum. + + To learn more about Base Web3, visit the Base + developers'' guide.
+ + ' +operationId: BaseWeb3Driver +parameters: + - description: Tatum X-API-Key used for authorization. + in: path + name: xApiKey + required: true + schema: + type: string + example: asdlkfjnqunalkwjfnq2oi303294857k +requestBody: + content: + application/json: + schema: + type: object + description: Any valid Web3 method content body. + example: + jsonrpc: "2.0" + method: web3_clientVersion + params: [] + id: 2 + required: true +responses: + "200": + content: + application/json: + schema: + type: object + description: Any valid Web3 response. + example: + jsonrpc: "2.0" + id: 2 + result: Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4 + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +x-codeSamples: [] +summary: Web3 HTTP driver +tags: + - Base diff --git a/categories/blockchain/paths/v3_bitcoin_transaction_address_batch_post.yml b/categories/blockchain/paths/v3_bitcoin_transaction_address_batch_post.yml new file mode 100644 index 0000000..0009170 --- /dev/null +++ b/categories/blockchain/paths/v3_bitcoin_transaction_address_batch_post.yml @@ -0,0 +1,70 @@ +description: "1 credit per address for each API call
+ +Retrieve transactions for multiple Bitcoin addresses in a batch.
+ + " +operationId: BtcGetTxByAddressBatch +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/BtcGetTxByAddressBatch" +responses: + "200": + content: + application/json: + schema: + items: + type: object + properties: + address: + type: string + description: Address + example: bc1qdj8dxppx6gyukpemsqx06a39877rt8kcc08uqs + transactions: + type: array + description: Transactions for address. + items: + $ref: "../../../components/migrated.yml#/components/schemas/BtcTx" + type: array + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + perform the required operation due to a logical error or invalid permissions. + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error403BtcBlockchain" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server while processing + the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get transactions for multiple Bitcoin addresses in a batch +tags: + - Bitcoin diff --git a/categories/blockchain/paths/v3_cronos_account_balance_{address}_get.yml b/categories/blockchain/paths/v3_cronos_account_balance_{address}_get.yml new file mode 100644 index 0000000..a1cf992 --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_account_balance_{address}_get.yml @@ -0,0 +1,58 @@ +description: '1 credit per API call
+ +Get the balance of CRO of an Cronos account.
+ +To get the balance of tokens, use the APIs for getting the balance of + fungible tokens (ERC-20) and NFTs (ERC-721).
+ + ' +operationId: CronosGetBalance +parameters: + - description: Account address you want to get balance of + in: path + name: address + required: true + schema: + type: string + example: "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/CronosBalance" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get the CRO balance of an Cronos account +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_address_{xpub}_{index}_get.yml b/categories/blockchain/paths/v3_cronos_address_{xpub}_{index}_get.yml new file mode 100644 index 0000000..9e27d50 --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_address_{xpub}_{index}_get.yml @@ -0,0 +1,64 @@ +description: "Generates an Cronos account 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.
+ + " +operationId: CronosGenerateAddress +parameters: + - description: Extended public key of wallet. + in: path + name: xpub + required: true + schema: + type: string + example: xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid + - description: Derivation index of the address to be generated. + in: path + name: index + required: true + schema: + type: number + example: 0 +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/GeneratedAddressCronos" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Cronos account address from Extended public key +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_block_current_get.yml b/categories/blockchain/paths/v3_cronos_block_current_get.yml new file mode 100644 index 0000000..82e72c4 --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_block_current_get.yml @@ -0,0 +1,37 @@ +description: +Gets the current Cronos block + number. This is the number of the latest block in the blockchain.
+operationId: CronosGetCurrentBlock +responses: + "200": + content: + application/json: + schema: + type: number + description: Current block number + example: 6491272 + description: OK + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get current block number +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_block_{hash}_get.yml b/categories/blockchain/paths/v3_cronos_block_{hash}_get.yml new file mode 100644 index 0000000..1084a4f --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_block_{hash}_get.yml @@ -0,0 +1,51 @@ +description: +Gets an Cronos block-by-block + hash or block number.
+operationId: CronosGetBlock +parameters: + - description: Block hash or block number + in: path + name: hash + required: true + schema: + type: string + example: "6470657" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/CronosBlock" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get Cronos block by hash +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_broadcast_post.yml b/categories/blockchain/paths/v3_cronos_broadcast_post.yml new file mode 100644 index 0000000..e35843e --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_broadcast_post.yml @@ -0,0 +1,63 @@ +description: "2 credits per API call
+ +Broadcast signed transaction to Cronos blockchain. This method is used internally + from Tatum KMS or Tatum client libraries. + + It is possible to create custom signing mechanism and use this method only for broadcasting + data to the blockchain.
+ + " +operationId: CronosBroadcast +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/BroadcastKMS" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosBroadcast" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Broadcast signed Cronos transaction +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_smartcontract_post.yml b/categories/blockchain/paths/v3_cronos_smartcontract_post.yml new file mode 100644 index 0000000..11e1bb8 --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_smartcontract_post.yml @@ -0,0 +1,119 @@ +description: '2 credits per API call
+ +Invoke a method in an existing smart contract on Cronos.
+ +You can call a read-only or write method.
+ +Troubleshooting a failed transaction
+
+ Tatum ensures that this API works against the blockchain (accesses the blockchain,
+ finds the specified smart contract, and executes the specified ABI method with the
+ provided parameters).
However, because this API can be run against any smart
+ contract on the blockchain, Tatum cannot in any way guarantee that the method itself
+ will be executed successfully.
If you have issues with invoking the method, refer to the user documentation + for this method, or contact the author of the smart contract.
+ +For more information about invoking methods in smart contracts, see this article on our Support Portal.
+ +Signing a transaction
+
+ When invoking a method in a smart contract, you are charged a fee for the transaction,
+ and you must sign the transaction with the private key of the blockchain address
+ from which the fee will be deducted.
If caller field is present instead of the private key, Tatum will sign + the transaction with the managed private key connected to the caller address. This + is applicable only for paid mainnet plans and all testnet plans. Keep in mind that + the caller address must have enough access right to perform the action in the smart + contract method.
+ +Providing the private key in the API is not a secure way of signing transactions, + because the private key can be stolen or exposed. Your private keys should never + leave your security perimeter. You should use the private keys only for testing + a solution you are building on the testnet of a blockchain.
+ +For signing transactions on the mainnet, we strongly recommend that you + use the Tatum Key + Management System (KMS) and provide the signature ID instead of the private + key in the API. Alternatively, you can use the Tatum JavaScript client.
+ + ' +operationId: CronosBlockchainSmartContractInvocation +requestBody: + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/CallSmartContractMethod" + - $ref: "../../../components/migrated.yml#/components/schemas/CallReadSmartContractMethod" + - $ref: "../../../components/migrated.yml#/components/schemas/CallCronosSmartContractMethodCaller" + - $ref: "../../../components/migrated.yml#/components/schemas/CallSmartContractMethodKMS" + required: true +responses: + "200": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + - $ref: "../../../components/migrated.yml#/components/schemas/SignatureId" + - $ref: "../../../components/migrated.yml#/components/schemas/Data" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosBroadcast" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosGasPrice" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosScBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosGasCalculation" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosTxHash" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosTxSign" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Invoke a method in a smart contract on Cronos +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_transaction_count_{address}_get.yml b/categories/blockchain/paths/v3_cronos_transaction_count_{address}_get.yml new file mode 100644 index 0000000..366a931 --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_transaction_count_{address}_get.yml @@ -0,0 +1,65 @@ +description: "Get a number of outgoing Cronos transactions for the address. When a transaction + is sent, there can be multiple outgoing transactions, + + which are not yet processed by the blockchain. To distinguish between them, there + is a counter called a nonce, which represents + + the order of the transaction in the list of outgoing transactions.
+ + " +operationId: CronosGetTransactionCount +parameters: + - description: address + in: path + name: address + required: true + schema: + type: string + maxLength: 42 + minLength: 42 + example: "0xdac17f958d2ee523a2206206994597c13d831ec7" +responses: + "200": + content: + application/json: + schema: + type: number + example: 5 + description: + Number of transactions, that were made from this address. Can + be used as a nonce parameter in send transaction calls. + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get count of outgoing Cronos transactions +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_transaction_post.yml b/categories/blockchain/paths/v3_cronos_transaction_post.yml new file mode 100644 index 0000000..d062b7f --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_transaction_post.yml @@ -0,0 +1,89 @@ +description: '2 credits per API call
+ +Send CRO or Tatum-supported fungible tokens (ERC-20) from account to account.
+ +NOTE: Sending the fungible tokens + is supported only on the mainnet.
+ +Signing a transaction
+
+ When sending CRO, you are charged a fee for the transaction, and you must sign the
+ transaction with the private key of the blockchain address from which the fee will
+ be deducted.
Providing the private key in the API is not a secure way of signing transactions, + because the private key can be stolen or exposed. Your private keys should never + leave your security perimeter. You should use the private keys only for testing + a solution you are building on the testnet of a blockchain.
+ +For signing transactions on the mainnet, we strongly recommend that you + use the Tatum Key + Management System (KMS) and provide the signature ID instead of the private + key in the API. Alternatively, you can use the Tatum JavaScript client.
+ + ' +operationId: CronosBlockchainTransfer +requestBody: + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransferCronosBlockchain" + - $ref: "../../../components/migrated.yml#/components/schemas/TransferCronosBlockchainKMS" + required: true +responses: + "200": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + - $ref: "../../../components/migrated.yml#/components/schemas/SignatureId" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosBroadcast" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosGasPrice" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosTxBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosGasCalculation" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosTxHash" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosTxSign" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Send CRO or fungible tokens (ERC-20) from account to account +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_transaction_{hash}_get.yml b/categories/blockchain/paths/v3_cronos_transaction_{hash}_get.yml new file mode 100644 index 0000000..e292372 --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_transaction_{hash}_get.yml @@ -0,0 +1,60 @@ +description: "1 credit per API call
+ +Get Cronos transaction by transaction hash.
+ + " +operationId: CronosGetTransaction +parameters: + - description: Transaction hash + in: path + name: hash + required: true + schema: + type: string + example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/CronosTx" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "404": + description: Transaction not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error404TxNotFound" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get Cronos Transaction +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_wallet_get.yml b/categories/blockchain/paths/v3_cronos_wallet_get.yml new file mode 100644 index 0000000..912bcde --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_wallet_get.yml @@ -0,0 +1,62 @@ +description: + '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:
Tatum follows the BIP44 specification + and generates for Cronos wallets with the derivation path m/44''/60''/0''/0. More + about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki. + + Generates a BIP44 compatible Cronos wallet.
+ + ' +operationId: CronosGenerateWallet +parameters: + - description: Mnemonic to use for generating extended public and private keys. + in: query + name: mnemonic + required: false + schema: + type: string + maxLength: 500 +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Wallet" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Cronos wallet +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_wallet_priv_post.yml b/categories/blockchain/paths/v3_cronos_wallet_priv_post.yml new file mode 100644 index 0000000..3e25cc6 --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_wallet_priv_post.yml @@ -0,0 +1,54 @@ +description: "Generates the private key of 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.
+ + " +operationId: CronosGenerateAddressPrivateKey +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/PrivKeyRequest" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/PrivKey" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Cronos private key +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_cronos_web3_{xApiKey}_post.yml b/categories/blockchain/paths/v3_cronos_web3_{xApiKey}_post.yml new file mode 100644 index 0000000..ea1850c --- /dev/null +++ b/categories/blockchain/paths/v3_cronos_web3_{xApiKey}_post.yml @@ -0,0 +1,76 @@ +deprecated: true +description: '2 credits per API call
+ +This endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as an http-based web3 driver to connect directly to the + Cronos node provided by Tatum. + + To learn more about Cronos Web3, visit the Cronos + developers'' guide.
+ + ' +operationId: CronosWeb3Driver +parameters: + - description: Tatum X-API-Key used for authorization. + in: path + name: xApiKey + required: true + schema: + type: string + example: asdlkfjnqunalkwjfnq2oi303294857k +requestBody: + content: + application/json: + schema: + type: object + description: Any valid Web3 method content body. + example: + jsonrpc: "2.0" + method: web3_clientVersion + params: [] + id: 2 + required: true +responses: + "200": + content: + application/json: + schema: + type: object + description: Any valid Web3 response. + example: + jsonrpc: "2.0" + id: 2 + result: Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4 + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +x-codeSamples: [] +summary: Web3 HTTP driver +tags: + - Cronos diff --git a/categories/blockchain/paths/v3_ethereum_account_balance_{address}_get.yml b/categories/blockchain/paths/v3_ethereum_account_balance_{address}_get.yml index 6fef84c..6fef5ac 100644 --- a/categories/blockchain/paths/v3_ethereum_account_balance_{address}_get.yml +++ b/categories/blockchain/paths/v3_ethereum_account_balance_{address}_get.yml @@ -17,15 +17,8 @@ parameters: schema: type: string example: "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" responses: "200": content: diff --git a/categories/blockchain/paths/v3_ethereum_address_{xpub}_{index}_get.yml b/categories/blockchain/paths/v3_ethereum_address_{xpub}_{index}_get.yml index ddd5f84..e084a89 100644 --- a/categories/blockchain/paths/v3_ethereum_address_{xpub}_{index}_get.yml +++ b/categories/blockchain/paths/v3_ethereum_address_{xpub}_{index}_get.yml @@ -23,15 +23,8 @@ parameters: schema: type: number example: 0 - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" responses: "200": content: diff --git a/categories/blockchain/paths/v3_ethereum_block_current_get.yml b/categories/blockchain/paths/v3_ethereum_block_current_get.yml index 0071472..f31bff9 100644 --- a/categories/blockchain/paths/v3_ethereum_block_current_get.yml +++ b/categories/blockchain/paths/v3_ethereum_block_current_get.yml @@ -3,15 +3,8 @@ description: number. This is the number of the latest block in the blockchain. operationId: EthGetCurrentBlock parameters: - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" responses: "200": content: diff --git a/categories/blockchain/paths/v3_ethereum_block_{hash}_get.yml b/categories/blockchain/paths/v3_ethereum_block_{hash}_get.yml index d88b334..f1fd4bd 100644 --- a/categories/blockchain/paths/v3_ethereum_block_{hash}_get.yml +++ b/categories/blockchain/paths/v3_ethereum_block_{hash}_get.yml @@ -10,15 +10,8 @@ parameters: schema: type: string example: "6470657" - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" responses: "200": content: diff --git a/categories/blockchain/paths/v3_ethereum_broadcast_post.yml b/categories/blockchain/paths/v3_ethereum_broadcast_post.yml index 12e0290..ca4a26f 100644 --- a/categories/blockchain/paths/v3_ethereum_broadcast_post.yml +++ b/categories/blockchain/paths/v3_ethereum_broadcast_post.yml @@ -9,15 +9,8 @@ description: "2 credits per API call
" operationId: EthBroadcast parameters: - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/blockchain/paths/v3_ethereum_smartcontract_post.yml b/categories/blockchain/paths/v3_ethereum_smartcontract_post.yml index f5da4e8..9877cd1 100644 --- a/categories/blockchain/paths/v3_ethereum_smartcontract_post.yml +++ b/categories/blockchain/paths/v3_ethereum_smartcontract_post.yml @@ -52,15 +52,8 @@ description: '2 credits per API call
' operationId: EthBlockchainSmartContractInvocation parameters: - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/blockchain/paths/v3_ethereum_transaction_count_{address}_get.yml b/categories/blockchain/paths/v3_ethereum_transaction_count_{address}_get.yml index 6edc99c..f53eeae 100644 --- a/categories/blockchain/paths/v3_ethereum_transaction_count_{address}_get.yml +++ b/categories/blockchain/paths/v3_ethereum_transaction_count_{address}_get.yml @@ -20,15 +20,8 @@ parameters: maxLength: 42 minLength: 42 example: "0xdac17f958d2ee523a2206206994597c13d831ec7" - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" responses: "200": content: diff --git a/categories/blockchain/paths/v3_ethereum_transaction_post.yml b/categories/blockchain/paths/v3_ethereum_transaction_post.yml index ca3398d..5684339 100644 --- a/categories/blockchain/paths/v3_ethereum_transaction_post.yml +++ b/categories/blockchain/paths/v3_ethereum_transaction_post.yml @@ -25,15 +25,8 @@ description: '2 credits per API call
' operationId: EthBlockchainTransfer parameters: - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/blockchain/paths/v3_ethereum_transaction_{hash}_get.yml b/categories/blockchain/paths/v3_ethereum_transaction_{hash}_get.yml index fb16f9b..417f760 100644 --- a/categories/blockchain/paths/v3_ethereum_transaction_{hash}_get.yml +++ b/categories/blockchain/paths/v3_ethereum_transaction_{hash}_get.yml @@ -12,15 +12,8 @@ parameters: schema: type: string example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" responses: "200": content: diff --git a/categories/blockchain/paths/v3_ethereum_wallet_get.yml b/categories/blockchain/paths/v3_ethereum_wallet_get.yml index 7ce889d..4ba5bbb 100644 --- a/categories/blockchain/paths/v3_ethereum_wallet_get.yml +++ b/categories/blockchain/paths/v3_ethereum_wallet_get.yml @@ -21,15 +21,8 @@ parameters: schema: type: string maxLength: 500 - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/EthTestnetTypeHeader" responses: "200": content: diff --git a/categories/blockchain/paths/v3_ethereum_wallet_priv_post.yml b/categories/blockchain/paths/v3_ethereum_wallet_priv_post.yml index c8fdaa0..59c2e64 100644 --- a/categories/blockchain/paths/v3_ethereum_wallet_priv_post.yml +++ b/categories/blockchain/paths/v3_ethereum_wallet_priv_post.yml @@ -8,15 +8,8 @@ description: "1 credit per API call
+ +Get the balance of FLR of an Flare account.
+ +To get the balance of tokens, use the APIs for getting the balance of + fungible tokens (ERC-20) and NFTs (ERC-721).
+ + ' +operationId: FlareGetBalance +parameters: + - description: Account address you want to get balance of + in: path + name: address + required: true + schema: + type: string + example: "0x3223AEB8404C7525FcAA6C512f91e287AE9FfE7B" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/FlareBalance" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get the FLR balance of an Flare account +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_address_{xpub}_{index}_get.yml b/categories/blockchain/paths/v3_flare_address_{xpub}_{index}_get.yml new file mode 100644 index 0000000..17963be --- /dev/null +++ b/categories/blockchain/paths/v3_flare_address_{xpub}_{index}_get.yml @@ -0,0 +1,65 @@ +description: "Generates an Flare account 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.
+ + " +operationId: FlareGenerateAddress +parameters: + - description: Extended public key of wallet. + in: path + name: xpub + required: true + schema: + type: string + example: xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid + - description: Derivation index of the address to be generated. + in: path + name: index + required: true + schema: + type: number + example: 0 + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/GeneratedAddressFlare" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Flare account address from Extended public key +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_block_current_get.yml b/categories/blockchain/paths/v3_flare_block_current_get.yml new file mode 100644 index 0000000..9a6a31d --- /dev/null +++ b/categories/blockchain/paths/v3_flare_block_current_get.yml @@ -0,0 +1,40 @@ +description: +Gets the current Flare block number. + This is the number of the latest block in the blockchain.
+operationId: FlareGetCurrentBlock +parameters: + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +responses: + "200": + content: + application/json: + schema: + type: number + description: Current block number + example: 6491272 + description: OK + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get current block number +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_block_{hash}_get.yml b/categories/blockchain/paths/v3_flare_block_{hash}_get.yml new file mode 100644 index 0000000..8d41d6d --- /dev/null +++ b/categories/blockchain/paths/v3_flare_block_{hash}_get.yml @@ -0,0 +1,53 @@ +description: +Gets an Flare block-by-block hash + or block number.
+operationId: FlareGetBlock +parameters: + - description: Block hash or block number + in: path + name: hash + required: true + schema: + type: string + example: "6470657" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/FlareBlock" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get Flare block by hash +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_broadcast_post.yml b/categories/blockchain/paths/v3_flare_broadcast_post.yml new file mode 100644 index 0000000..1ede945 --- /dev/null +++ b/categories/blockchain/paths/v3_flare_broadcast_post.yml @@ -0,0 +1,66 @@ +description: "2 credits per API call
+ +Broadcast signed transaction to Flare blockchain. This method is used internally + from Tatum KMS or Tatum client libraries. + + It is possible to create custom signing mechanism and use this method only for broadcasting + data to the blockchain.
+ + " +operationId: FlareBroadcast +parameters: + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/BroadcastKMS" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareBroadcast" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Broadcast signed Flare transaction +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_smartcontract_post.yml b/categories/blockchain/paths/v3_flare_smartcontract_post.yml new file mode 100644 index 0000000..9394499 --- /dev/null +++ b/categories/blockchain/paths/v3_flare_smartcontract_post.yml @@ -0,0 +1,122 @@ +description: '2 credits per API call
+ +Invoke a method in an existing smart contract on Flare.
+ +You can call a read-only or write method.
+ +Troubleshooting a failed transaction
+
+ Tatum ensures that this API works against the blockchain (accesses the blockchain,
+ finds the specified smart contract, and executes the specified ABI method with the
+ provided parameters).
However, because this API can be run against any smart
+ contract on the blockchain, Tatum cannot in any way guarantee that the method itself
+ will be executed successfully.
If you have issues with invoking the method, refer to the user documentation + for this method, or contact the author of the smart contract.
+ +For more information about invoking methods in smart contracts, see this article on our Support Portal.
+ +Signing a transaction
+
+ When invoking a method in a smart contract, you are charged a fee for the transaction,
+ and you must sign the transaction with the private key of the blockchain address
+ from which the fee will be deducted.
If caller field is present instead of the private key, Tatum will sign + the transaction with the managed private key connected to the caller address. This + is applicable only for paid mainnet plans and all testnet plans. Keep in mind that + the caller address must have enough access right to perform the action in the smart + contract method.
+ +Providing the private key in the API is not a secure way of signing transactions, + because the private key can be stolen or exposed. Your private keys should never + leave your security perimeter. You should use the private keys only for testing + a solution you are building on the testnet of a blockchain.
+ +For signing transactions on the mainnet, we strongly recommend that you + use the Tatum Key + Management System (KMS) and provide the signature ID instead of the private + key in the API. Alternatively, you can use the Tatum JavaScript client.
+ + ' +operationId: FlareBlockchainSmartContractInvocation +parameters: + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +requestBody: + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/CallSmartContractMethod" + - $ref: "../../../components/migrated.yml#/components/schemas/CallReadSmartContractMethod" + - $ref: "../../../components/migrated.yml#/components/schemas/CallFlareSmartContractMethodCaller" + - $ref: "../../../components/migrated.yml#/components/schemas/CallSmartContractMethodKMS" + required: true +responses: + "200": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + - $ref: "../../../components/migrated.yml#/components/schemas/SignatureId" + - $ref: "../../../components/migrated.yml#/components/schemas/Data" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareBroadcast" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareGasPrice" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareScBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareGasCalculation" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareTxHash" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareTxSign" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Invoke a method in a smart contract on Flare +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_transaction_count_{address}_get.yml b/categories/blockchain/paths/v3_flare_transaction_count_{address}_get.yml new file mode 100644 index 0000000..567c5b4 --- /dev/null +++ b/categories/blockchain/paths/v3_flare_transaction_count_{address}_get.yml @@ -0,0 +1,67 @@ +description: "Get a number of outgoing Flare transactions for the address. When a transaction + is sent, there can be multiple outgoing transactions, + + which are not yet processed by the blockchain. To distinguish between them, there + is a counter called a nonce, which represents + + the order of the transaction in the list of outgoing transactions.
+ + " +operationId: FlareGetTransactionCount +parameters: + - description: address + in: path + name: address + required: true + schema: + type: string + maxLength: 42 + minLength: 42 + example: "0xdac17f958d2ee523a2206206994597c13d831ec7" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +responses: + "200": + content: + application/json: + schema: + type: number + example: 5 + description: + Number of transactions, that were made from this address. Can + be used as a nonce parameter in send transaction calls. + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get count of outgoing Flare transactions +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_transaction_post.yml b/categories/blockchain/paths/v3_flare_transaction_post.yml new file mode 100644 index 0000000..eac646f --- /dev/null +++ b/categories/blockchain/paths/v3_flare_transaction_post.yml @@ -0,0 +1,92 @@ +description: '2 credits per API call
+ +Send FLR or Tatum-supported fungible tokens (ERC-20) from account to account.
+ +NOTE: Sending the fungible tokens + is supported only on the mainnet.
+ +Signing a transaction
+
+ When sending FLR, you are charged a fee for the transaction, and you must sign the
+ transaction with the private key of the blockchain address from which the fee will
+ be deducted.
Providing the private key in the API is not a secure way of signing transactions, + because the private key can be stolen or exposed. Your private keys should never + leave your security perimeter. You should use the private keys only for testing + a solution you are building on the testnet of a blockchain.
+ +For signing transactions on the mainnet, we strongly recommend that you + use the Tatum Key + Management System (KMS) and provide the signature ID instead of the private + key in the API. Alternatively, you can use the Tatum JavaScript client.
+ + ' +operationId: FlareBlockchainTransfer +parameters: + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +requestBody: + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransferFlareBlockchain" + - $ref: "../../../components/migrated.yml#/components/schemas/TransferFlareBlockchainKMS" + required: true +responses: + "200": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/TransactionHash" + - $ref: "../../../components/migrated.yml#/components/schemas/SignatureId" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareBroadcast" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareGasPrice" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareTxBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareGasCalculation" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareTxHash" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareTxSign" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Send FLR or fungible tokens (ERC-20) from account to account +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_transaction_{hash}_get.yml b/categories/blockchain/paths/v3_flare_transaction_{hash}_get.yml new file mode 100644 index 0000000..4b87841 --- /dev/null +++ b/categories/blockchain/paths/v3_flare_transaction_{hash}_get.yml @@ -0,0 +1,62 @@ +description: "1 credit per API call
+ +Get Flare transaction by transaction hash.
+ + " +operationId: FlareGetTransaction +parameters: + - description: Transaction hash + in: path + name: hash + required: true + schema: + type: string + example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/FlareTx" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "404": + description: Transaction not found. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error404TxNotFound" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get Flare Transaction +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_wallet_get.yml b/categories/blockchain/paths/v3_flare_wallet_get.yml new file mode 100644 index 0000000..27e93f8 --- /dev/null +++ b/categories/blockchain/paths/v3_flare_wallet_get.yml @@ -0,0 +1,64 @@ +description: + '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:
Tatum follows the BIP44 specification + and generates for Flare wallets with the derivation path m/44''/60''/0''/0. More + about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki. + + Generates a BIP44 compatible Flare wallet.
+ + ' +operationId: FlareGenerateWallet +parameters: + - description: Mnemonic to use for generating extended public and private keys. + in: query + name: mnemonic + required: false + schema: + type: string + maxLength: 500 + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Wallet" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Flare wallet +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_wallet_priv_post.yml b/categories/blockchain/paths/v3_flare_wallet_priv_post.yml new file mode 100644 index 0000000..cfff9fb --- /dev/null +++ b/categories/blockchain/paths/v3_flare_wallet_priv_post.yml @@ -0,0 +1,57 @@ +description: "Generates the private key of 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.
+ + " +operationId: FlareGenerateAddressPrivateKey +parameters: + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/PrivKeyRequest" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/PrivKey" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Generate Flare private key +tags: + - Flare diff --git a/categories/blockchain/paths/v3_flare_web3_{xApiKey}_post.yml b/categories/blockchain/paths/v3_flare_web3_{xApiKey}_post.yml new file mode 100644 index 0000000..15871ed --- /dev/null +++ b/categories/blockchain/paths/v3_flare_web3_{xApiKey}_post.yml @@ -0,0 +1,78 @@ +deprecated: true +description: '2 credits per API call
+ +This endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as an http-based web3 driver to connect directly to the + Flare node provided by Tatum. + + To learn more about Flare Web3, visit the Flare + developers'' guide.
+ + ' +operationId: FlareWeb3Driver +parameters: + - description: Tatum X-API-Key used for authorization. + in: path + name: xApiKey + required: true + schema: + type: string + example: asdlkfjnqunalkwjfnq2oi303294857k + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/FlareTestnetTypeHeader" +requestBody: + content: + application/json: + schema: + type: object + description: Any valid Web3 method content body. + example: + jsonrpc: "2.0" + method: web3_clientVersion + params: [] + id: 2 + required: true +responses: + "200": + content: + application/json: + schema: + type: object + description: Any valid Web3 response. + example: + jsonrpc: "2.0" + id: 2 + result: Geth/v1.9.9-omnibus-e320ae4c-20191206/linux-amd64/go1.13.4 + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +x-codeSamples: [] +summary: Web3 HTTP driver +tags: + - Flare diff --git a/categories/blockchain/paths/v3_kcs_block_{hash}_get.yml b/categories/blockchain/paths/v3_kcs_block_{hash}_get.yml index 057f38e..e62ab14 100644 --- a/categories/blockchain/paths/v3_kcs_block_{hash}_get.yml +++ b/categories/blockchain/paths/v3_kcs_block_{hash}_get.yml @@ -17,7 +17,7 @@ responses: content: application/json: schema: - $ref: "../../../components/migrated.yml#/components/schemas/EthBlock" + $ref: "../../../components/migrated.yml#/components/schemas/KcsBlock" description: OK "400": content: diff --git a/categories/blockchain_data/openapi.yml b/categories/blockchain_data/openapi.yml index 38f22ec..89aa734 100644 --- a/categories/blockchain_data/openapi.yml +++ b/categories/blockchain_data/openapi.yml @@ -1,45 +1,56 @@ openapi: 3.1.0 info: title: Blockchain Data - version: "1.0.0" + version: 1.0.0 paths: # NFT API /v4/data/collections: - $ref: "categories/blockchain_data/operations/nft.yml#/paths/~1v3~1data~1collections" + get: + $ref: ./paths/v1_data_collections_get.yml /v4/data/metadata: - $ref: "categories/blockchain_data/operations/nft.yml#/paths/~1v3~1data~1metadata" + get: + $ref: ./paths/v1_data_metadata_get.yml /v4/data/owners: - $ref: "categories/blockchain_data/operations/nft.yml#/paths/~1v3~1data~1owners" + get: + $ref: ./paths/v1_data_owners_get.yml /v4/data/owners/address: - $ref: "categories/blockchain_data/operations/nft.yml#/paths/~1v3~1data~1owners~1address" + get: + $ref: ./paths/v1_data_owners_address_get.yml # Token API /v4/data/tokens: - $ref: "categories/blockchain_data/operations/token.yml#/paths/~1v3~1data~1tokens" + get: + $ref: ./paths/v1_data_tokens_get.yml # Wallet API /v4/data/balances: - $ref: "categories/blockchain_data/operations/wallet.yml#/paths/~1v3~1data~1balances" + get: + $ref: ./paths/v1_data_balances_get.yml /v4/data/utxos: - $ref: "categories/blockchain_data/operations/wallet.yml#/paths/~1v3~1data~1utxos" + get: + $ref: ./paths/v1_data_utxos_get.yml + /v4/data/utxos/batch: + post: + $ref: ./paths/v1_data_utxos_batch_post.yml # Transactions API /v4/data/transactions: - $ref: "categories/blockchain_data/operations/transactions.yml#/paths/~1v3~1data~1transactions" + get: + $ref: ./paths/v1_data_transactions_get.yml /v4/data/transactions/hash: - $ref: "categories/blockchain_data/operations/transactions.yml#/paths/~1v3~1data~1transactions~1hash" - /v4/blockchain/fee/{chain}: - $ref: "categories/blockchain_data/operations/transactions.yml#/paths/~1v3~1blockchain~1fee~1{chain}" - /v4/blockchain/estimate: - $ref: "categories/blockchain_data/operations/transactions.yml#/paths/~1v3~1blockchain~1estimate" + get: + $ref: ./paths/v1_data_transactions_hash_get.yml # DeFi API /v4/data/events: - $ref: "categories/blockchain_data/operations/defi.yml#/paths/~1v3~1data~1events" + get: + $ref: ./paths/v1_data_events_get.yml /v4/data/blocks: - $ref: "categories/blockchain_data/operations/defi.yml#/paths/~1v3~1data~1blocks" + get: + $ref: ./paths/v1_data_blocks_get.yml /v4/data/blocks/latest: - $ref: "categories/blockchain_data/operations/defi.yml#/paths/~1v3~1data~1blocks~1latest" + get: + $ref: ./paths/v1_data_blocks_latest_get.yml # Data API (old) /v3/data/collections: @@ -78,9 +89,12 @@ paths: /v3/data/utxos: get: $ref: categories/blockchain_data/paths/v3_data_utxos_get.yml + /v3/data/utxos/batch: + post: + $ref: categories/blockchain_data/paths/v3_data_utxos_batch_post.yml servers: - url: https://api.tatum.io/ components: securitySchemes: X-API-Key: - $ref: components/schemas.yml#/components/securitySchemes/X-API-Key + $ref: components/migrated.yml#/components/securitySchemes/X-API-Key diff --git a/categories/blockchain_data/operations/defi.yml b/categories/blockchain_data/operations/defi.yml deleted file mode 100644 index 0c5635c..0000000 --- a/categories/blockchain_data/operations/defi.yml +++ /dev/null @@ -1,740 +0,0 @@ -components: - securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: x-api-key - description: t-645a26e22d0761001c811c84-645a26e32d0761001c811c8a -security: - - ApiKeyAuth: [] - -info: - title: Data API - version: "1.0.0" -openapi: 3.0.3 -paths: - /v3/data/events: - get: - description: > -20 credits per API call
- -Get all events on given addresses and / or in the requested block - range on the following blockchains:
- -To get started:
- -As noted above, aside from general info and hashed event data, the - API also decodes them for you in case you filter by one of the following - supported event types:
- -tokenTransfer
: All transfers of fungible tokens
- (including stablecoins) and NFTs as per ERC-20 and ERC-721
- standard.multitokenTransfer
: All transfers of multitokens (both
- single transfers and batch transfers) as per ERC-1155 standard.stablecoinTransfer
: Refers to the transfer of specific
- stablecoins on the mainnet. Typically, the top 10 to 16 stablecoins on
- each chain according to CoinMarketCap are included. If the
- contractAddresses
parameter is also used in the filter
- combination, any tokens specified in it will also be included in the
- list.uniswapTrade
: Provides all swap events that occur on
- both Uniswap V2 and V3. In some cases, it may not be possible to map the
- swapped amounts to specific tokens. As a result, certain decoded data
- such as token amounts might be missing or in the original big number
- format. This will be indicated by the response parameter
- partiallyRaw: true
.10 credits per API call
- -Get information about blocks (when they were added, how many NFTs and - events were ingested and list of transaction hashes that were processed - within them) on the following blockchains:
- -To get started, provide a chain and specify one of the filters listed - below (combination of these filters is not allowed):
- -1 credit per API call
- -Get information about latest added block on the following - blockchains:
- -To get started, you can just provide a chain.
- operationId: GetLatestBlock - parameters: - - description: The blockchain to work with. - in: query - name: chain - required: true - schema: - $ref: "../../../components/schemas.yml#/components/schemas/ChainEnum" - responses: - "200": - content: - application/json: - schema: - $ref: "../../../components/schemas.yml#/components/schemas/BlockItem" - description: Latest block added to a blockchain. - example: - blockNumber: 25987956 - blockTimestamp: 1677372871000 - hash: >- - 0x047a6ab09f86c760c145dc09b7a43b74d6ad957133ba4462a5530c642d4d9f17 - eventIngestedSize: 351 - nftIngestedSize: 7 - txHashes: - - >- - 0x01a7983d1391b74305840e4960ba6c61417a9398cb938c3522d0a4a9cedf488f - - >- - 0x0478fdae7e5e6f1eb522e6f43ba760c924b1f72d16e4dadc332f150829d09cbe - - >- - 0x05d00f08ae523e445c3b1e7bbabec1896091234643d50e8bcdb76ddd3ff3827a - - >- - 0x0b644c19257cf34ab98c509c7901af5a4ad8c6f537b625b46ee771a45f1940dc - - >- - 0x0c1016bf317946d9997588ee3b932bc8ba6033cfcb83eca4b5ebcc4f5eaa076d - description: OK - "400": - content: - application/json: - schema: - $ref: "../../../components/schemas.yml#/components/schemas/Error400" - description: >- - Bad Request. Validation failed for the given object in the HTTP Body - or Request parameters. - "401": - content: - application/json: - schema: - oneOf: - - $ref: "../../../components/schemas.yml#/components/schemas/Error401NotActive" - - $ref: "../../../components/schemas.yml#/components/schemas/Error401Invalid" - description: >- - Unauthorized. Not valid or inactive subscription key present in the - HTTP Header. - "403": - description: >- - Forbidden. The request is authenticated, but it is not possible to - required perform operation due to logical error or invalid - permissions. - content: - application/json: - schema: - $ref: "../../../components/schemas.yml#/components/schemas/Error403" - "500": - content: - application/json: - schema: - $ref: "../../../components/schemas.yml#/components/schemas/Error500" - description: >- - Internal server error. There was an error on the server during the - processing of the request. - security: - - X-API-Key: [] - x-codeSamples: [] - summary: Get latest block - tags: - - Defi API - -servers: - - url: https://api.tatum.io/ diff --git a/categories/blockchain_data/operations/nft.yml b/categories/blockchain_data/operations/nft.yml deleted file mode 100644 index 35904b9..0000000 --- a/categories/blockchain_data/operations/nft.yml +++ /dev/null @@ -1,522 +0,0 @@ -# components: -# securitySchemes: -# ApiKeyAuth: -# type: apiKey -# in: header -# name: x-api-key -# description: t-645a26e22d0761001c811c84-645a26e32d0761001c811c8a -# security: -# - ApiKeyAuth: [] - -info: - title: NFT API - version: "1.0.0" -openapi: 3.0.3 -paths: - /v3/data/collections: - get: - tags: - - NFT API - description: > -10 credits per API call
- -Get all NFTs (ERC-721 and ERC-1155) and multitokens (ERC-1155 only) - of your favorite collections! Our API lets you search for all tokens - on:
- -To get started:
- -excludeMetadata
to true
).tokenType
.excludeMetadata
- and tokenType
won't have any effect on filtering data.5 credits per API call
- -Get metadata of NFTs (ERC-721 and ERC-1155) or multitokens (ERC-1155 - only) by IDs for a given token address! Our API lets you search for all - tokens on:
- -To get started:
- -20 credits per API call
- -Get all addresses that own your favorite token (ERC-20, ERC-721 or - ERC-1155)! Our API lets you search for all token owners on:
- -To get started:
- -tokenId
. In case of multitoken, result is an array of
- addresses.1 credit per API call
- -Check if wallet address owns any specified token (ERC-20, ERC-721 or - ERC-1155) on the following blockchains:
- -To get started:
- -true
if provided wallet address owns them.false
and status code is 200
.tokenId
.20 credits per API call
- -Get all addresses that own your favorite token (ERC-20, ERC-721 or - ERC-1155)! Our API lets you search for all token owners on:
- -To get started:
- -tokenId
. In case of multitoken, result is an array of
- addresses.1 credit per API call
- -Get information about your favorite token! Our API lets you search - for all tokens on:
- -To get started:
- -tokenId
as a query
- parameter.20 credits per API call
- -Get transactions on the following blockchains:
- -To get started:
- -transactionTypes
and even
- transactionSubtype
(incoming, outgoing,
- zero-transfer).addresses
query parameter. Following query parameters won't
- have any effect on filtering data: transactionTypes
,
- transactionSubtype
, tokenId
,
- blockTo
.pageSize
and
- offset
query parameters.
-
- cursor
query parameter, by filling in the
- value from prevPage
or nextPage
field in the
- response body.5 credits per API call
- -Get transactions by hash on the following blockchains:
- -To get started:
- -1 credit per API call
- -Get the recommended fee/gas price for a blockchain.
- -Fee is in satoshis(meaning currency(BTC, DOGE,... / 100 000 000) per - byte - -
This API is supported for the following blockchains:
- -10 credits per API call
-Estimate the current fee for different types of transactions.
-This API is supported for the following blockchains:
-50 credits per API call
- -Get balances of fungible tokens (ERC-20), NFTs (ERC-721 and ERC-1155) - or multitokens (ERC-1155 only) for a specific wallet address on the - following blockchains:
- -To get started:
- -excludeMetadata
to true
).tokenTypes
.excludeMetadata
.20 credits per API call
- -Get transactions on the following blockchains:
- -To get started:
- -transactionTypes
and even
- transactionSubtype
(incoming, outgoing,
- zero-transfer).addresses
query parameter. Following query parameters won't
- have any effect on filtering data: transactionTypes
,
- transactionSubtype
, tokenId
,
- blockTo
.pageSize
and
- offset
query parameters.
-
- cursor
query parameter, by filling in the
- value from prevPage
or nextPage
field in the
- response body.100 credits per API call
- -Get unspent UTXOs for a specific address up to a specific total - amount. - - If you want to prepare a transaction on UTXO-based chains like Bitcoin, - you need to enter unspent UTXOs to be able to perform a transaction. By - providing ```totalValue``` as a total, our API will return a list of - UTXOs that will be enough to cover the transaction.
- - Our API lets you get the unpenst UTXOs for a specific address on: - -To get started:
- -50 credits per API call
+ +Get balances of fungible tokens (ERC-20), NFTs (ERC-721 and ERC-1155) or multitokens + (ERC-1155 only) for a specific wallet address on the following blockchains:
+ +To get started:
+ +excludeMetadata
+ to true
).tokenTypes
.excludeMetadata
.10 credits per API call
+ +Get information about blocks (when they were added, how many NFTs and events + were ingested and list of transaction hashes that were processed within them) on + the following blockchains:
+ +To get started, provide a chain and specify one of the filters listed below (combination + of these filters is not allowed):
+ +1 credit per API call
+ +Get information about latest added block on the following blockchains:
+ +To get started, you can just provide a chain.
+ + " +operationId: GetLatestBlock +parameters: + - description: The blockchain to work with. + in: query + name: chain + required: true + schema: + $ref: "../../../components/migrated_v1.yml#/components/schemas/ChainEnum" +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated_v1.yml#/components/schemas/BlockItem" + description: Latest block added to a blockchain. + example: + blockNumber: 25987956 + blockTimestamp: 1677372871000 + hash: "0x047a6ab09f86c760c145dc09b7a43b74d6ad957133ba4462a5530c642d4d9f17" + eventIngestedSize: 351 + nftIngestedSize: 7 + txHashes: + - "0x01a7983d1391b74305840e4960ba6c61417a9398cb938c3522d0a4a9cedf488f" + - "0x0478fdae7e5e6f1eb522e6f43ba760c924b1f72d16e4dadc332f150829d09cbe" + - "0x05d00f08ae523e445c3b1e7bbabec1896091234643d50e8bcdb76ddd3ff3827a" + - "0x0b644c19257cf34ab98c509c7901af5a4ad8c6f537b625b46ee771a45f1940dc" + - "0x0c1016bf317946d9997588ee3b932bc8ba6033cfcb83eca4b5ebcc4f5eaa076d" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated_v1.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated_v1.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated_v1.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + $ref: "../../../components/migrated_v1.yml#/components/schemas/Error403" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated_v1.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server during the + processing of the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Get latest block +tags: + - DeFi API diff --git a/categories/blockchain_data/paths/v1_data_collections_get.yml b/categories/blockchain_data/paths/v1_data_collections_get.yml new file mode 100644 index 0000000..ae98029 --- /dev/null +++ b/categories/blockchain_data/paths/v1_data_collections_get.yml @@ -0,0 +1,143 @@ +description: "10 credits per API call
+ +Get all NFTs (ERC-721 and ERC-1155) and multitokens (ERC-1155 only) of your favorite + collections! Our API lets you search for all tokens on:
+ +To get started:
+ +excludeMetadata
+ to true
).tokenType
.excludeMetadata
and tokenType
+ won't have any effect on filtering data.20 credits per API call
+ +Get all events on given addresses and / or in the requested block range on the + following blockchains:
+ +To get started:
+ +As noted above, aside from general info and hashed event data, the API also decodes + them for you in case you filter by one of the following supported event types:
+ +tokenTransfer
: All transfers of fungible tokens (including stablecoins)
+ and NFTs as per ERC-20 and ERC-721 standard.multitokenTransfer
: All transfers of multitokens (both single transfers
+ and batch transfers) as per ERC-1155 standard.stablecoinTransfer
: Refers to the transfer of specific stablecoins
+ on the mainnet. Typically, the top 10 to 16 stablecoins on each chain according
+ to CoinMarketCap are included. If the contractAddresses
parameter is
+ also used in the filter combination, any tokens specified in it will also be included
+ in the list.uniswapTrade
: Provides all swap events that occur on both Uniswap
+ V2 and V3. In some cases, it may not be possible to map the swapped amounts to specific
+ tokens. As a result, certain decoded data such as token amounts might be missing
+ or in the original big number format. This will be indicated by the response parameter
+ partiallyRaw: true
.5 credits per API call
+ +Get metadata of NFTs (ERC-721 and ERC-1155) or multitokens (ERC-1155 only) by + IDs for a given token address! Our API lets you search for all tokens on:
+ +To get started:
+ +1 credit per API call
+ +Check if wallet address owns any specified token (ERC-20, ERC-721 or ERC-1155) + on the following blockchains:
+ +To get started:
+ +true
if provided wallet
+ address owns them.false
+ and status code is 200
.tokenId
.20 credits per API call
+ +Get all addresses that own your favorite token (ERC-20, ERC-721 or ERC-1155)! + Our API lets you search for all token owners on:
+ +To get started:
+ +tokenId
.
+ In case of multitoken, result is an array of addresses.1 credit per API call
+ +Get information about your favorite token! Our API lets you search for all tokens + on:
+ +To get started:
+ +tokenId
as a query parameter.20 credits per API call
\nGet transactions on the following\ + \ blockchains:
\nTo get started:
\n\ +transactionTypes
and even\
+ \ transactionSubtype
(incoming, outgoing, zero-transfer).addresses
\
+ \ query parameter. Following query parameters won't have any effect on filtering\
+ \ data: transactionTypes
, transactionSubtype
, tokenId
,\
+ \ blockTo
.pageSize
\
+ \ and offset
query parameters. \ncursor
query parameter,\
+ \ by filling in the value from prevPage
or nextPage
field\
+ \ in the response body.5 credits per API call
+ +Get transactions by hash on the following blockchains:
+ +To get started:
+ +100 credits per address for each API call.
+ +Retrieve unspent UTXOs for each provided address, up to a specified total amount. + + If you want to prepare a transaction on UTXO-based chains like Bitcoin, you need + to enter unspent UTXOs to be able to perform a transaction. By providing ```totalValue``` + as a total, our API will return a list of UTXOs that will be enough to cover the + transaction.
+ + Our API lets you get the unpenst UTXOs for a specific address on: + +To get started:
+ +100 credits per API call
+ +Get unspent UTXOs for a specific address up to a specific total amount. + + If you want to prepare a transaction on UTXO-based chains like Bitcoin, you need + to enter unspent UTXOs to be able to perform a transaction. By providing ```totalValue``` + as a total, our API will return a list of UTXOs that will be enough to cover the + transaction.
+ + Our API lets you get the unpenst UTXOs for a specific address on: + +To get started:
+ +50 credits per API call
-Get balances of bring me backk fungible tokens (ERC-20), NFTs (ERC-721 and ERC-1155) or multitokens +
Get balances of fungible tokens (ERC-20), NFTs (ERC-721 and ERC-1155) or multitokens (ERC-1155 only) for a specific wallet address on the following blockchains:
offset
query parameters. \ncursor
query parameter,\
\ by filling in the value from prevPage
or nextPage
field\
- \ in the response body.100 credits per address for each API call.
+ +Retrieve unspent UTXOs for each provided address, up to a specified total amount. + + If you want to prepare a transaction on UTXO-based chains like Bitcoin, you need + to enter unspent UTXOs to be able to perform a transaction. By providing ```totalValue``` + as a total, our API will return a list of UTXOs that will be enough to cover the + transaction.
+ + Our API lets you get the unpenst UTXOs for a specific address on: + +To get started:
+ +2 credits per API call
+ +Get an estimated gas price and the number of gas units needed for a Base transaction.
+ +NOTE: The estimated gas price is + returned in wei. However, when making the transaction itself and providing the custom fee, + you have to provide the gas price in Gwei. Make sure to convert the estimated + gas price from wei to Gwei before submitting your transaction.
+ + ' +operationId: BaseEstimateGas +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/BaseEstimateGas" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/GasEstimated" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseTxBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403BaseGasCalculation" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server while processing + the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Estimate the fee for a Cronos transaction +tags: + - Blockchain fees diff --git a/categories/fee_estimation/paths/v3_cronos_gas_post.yml b/categories/fee_estimation/paths/v3_cronos_gas_post.yml new file mode 100644 index 0000000..297eb1b --- /dev/null +++ b/categories/fee_estimation/paths/v3_cronos_gas_post.yml @@ -0,0 +1,67 @@ +description: '2 credits per API call
+ +Get an estimated gas price and the number of gas units needed for a Cronos transaction.
+ +NOTE: The estimated gas price is + returned in wei. However, when making the transaction itself and providing the custom fee, + you have to provide the gas price in Gwei. Make sure to convert the estimated + gas price from wei to Gwei before submitting your transaction.
+ + ' +operationId: CronosEstimateGas +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/CronosEstimateGas" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/GasEstimated" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosTxBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403CronosGasCalculation" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server while processing + the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Estimate the fee for a Cronos transaction +tags: + - Blockchain fees diff --git a/categories/fee_estimation/paths/v3_flare_gas_post.yml b/categories/fee_estimation/paths/v3_flare_gas_post.yml new file mode 100644 index 0000000..341c4a3 --- /dev/null +++ b/categories/fee_estimation/paths/v3_flare_gas_post.yml @@ -0,0 +1,67 @@ +description: '2 credits per API call
+ +Get an estimated gas price and the number of gas units needed for a Flare transaction.
+ +NOTE: The estimated gas price is + returned in wei. However, when making the transaction itself and providing the custom fee, + you have to provide the gas price in Gwei. Make sure to convert the estimated + gas price from wei to Gwei before submitting your transaction.
+ + ' +operationId: FlareEstimateGas +requestBody: + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/FlareEstimateGas" + required: true +responses: + "200": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/GasEstimated" + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "403": + description: + Forbidden. The request is authenticated, but it is not possible to + required perform operation due to logical error or invalid permissions. + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareTxBody" + - $ref: "../../../components/migrated.yml#/components/schemas/Error403FlareGasCalculation" + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server while processing + the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Estimate the fee for a Flare transaction +tags: + - Blockchain fees diff --git a/categories/security/openapi.yml b/categories/security/openapi.yml index 9c0e801..e0e17a2 100644 --- a/categories/security/openapi.yml +++ b/categories/security/openapi.yml @@ -117,4 +117,4 @@ paths: components: securitySchemes: X-API-Key: - $ref: components/schemas.yml#/components/securitySchemes/X-API-Key + $ref: components/migrated.yml#/components/securitySchemes/X-API-Key diff --git a/categories/smart_contracts/openapi.yml b/categories/smart_contracts/openapi.yml index 992b56e..9a2dbc1 100644 --- a/categories/smart_contracts/openapi.yml +++ b/categories/smart_contracts/openapi.yml @@ -333,4 +333,4 @@ paths: components: securitySchemes: X-API-Key: - $ref: components/schemas.yml#/components/securitySchemes/X-API-Key + $ref: components/migrated.yml#/components/securitySchemes/X-API-Key diff --git a/categories/smart_contracts/paths/v3_blockchain_token_approve_post.yml b/categories/smart_contracts/paths/v3_blockchain_token_approve_post.yml index 753839c..fc67c21 100644 --- a/categories/smart_contracts/paths/v3_blockchain_token_approve_post.yml +++ b/categories/smart_contracts/paths/v3_blockchain_token_approve_post.yml @@ -19,6 +19,12 @@ description: '2 credits per API call
Signing a transaction
@@ -40,17 +46,8 @@ description: '
2 credits per API call
' parameters: - - description: - Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations - for testnet API Key. For mainnet API Key, this value is ignored. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" operationId: Erc20Approve requestBody: content: diff --git a/categories/smart_contracts/paths/v3_blockchain_token_balance_{chain}_{contractAddress}_{address}_get.yml b/categories/smart_contracts/paths/v3_blockchain_token_balance_{chain}_{contractAddress}_{address}_get.yml index 4410e71..c5003dc 100644 --- a/categories/smart_contracts/paths/v3_blockchain_token_balance_{chain}_{contractAddress}_{address}_get.yml +++ b/categories/smart_contracts/paths/v3_blockchain_token_balance_{chain}_{contractAddress}_{address}_get.yml @@ -30,6 +30,12 @@ description: "1 credit per API call
2 credits per API call
Signing a transaction
@@ -47,17 +53,8 @@ description: '
2 credits per API call
' parameters: - - description: - Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations - for testnet API Key. For mainnet API Key, this value is ignored. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" operationId: Erc20Burn requestBody: content: diff --git a/categories/smart_contracts/paths/v3_blockchain_token_deploy_post.yml b/categories/smart_contracts/paths/v3_blockchain_token_deploy_post.yml index 9046422..2d70169 100644 --- a/categories/smart_contracts/paths/v3_blockchain_token_deploy_post.yml +++ b/categories/smart_contracts/paths/v3_blockchain_token_deploy_post.yml @@ -32,6 +32,12 @@ description: '2 credits per API call
You can review the code of a deployed smart contract 2 credits per API call
' operationId: Erc20Deploy parameters: - - description: - Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations - for testnet API Key. For mainnet API Key, this value is ignored. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_blockchain_token_mint_post.yml b/categories/smart_contracts/paths/v3_blockchain_token_mint_post.yml index 4290e77..ccd9a43 100644 --- a/categories/smart_contracts/paths/v3_blockchain_token_mint_post.yml +++ b/categories/smart_contracts/paths/v3_blockchain_token_mint_post.yml @@ -26,6 +26,12 @@ description: '2 credits per API call
Signing a transaction
@@ -47,17 +53,8 @@ description: '
2 credits per API call
' parameters: - - description: - Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations - for testnet API Key. For mainnet API Key, this value is ignored. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" operationId: Erc20Mint requestBody: content: diff --git a/categories/smart_contracts/paths/v3_blockchain_token_transaction_post.yml b/categories/smart_contracts/paths/v3_blockchain_token_transaction_post.yml index 5bd0045..d294a8a 100644 --- a/categories/smart_contracts/paths/v3_blockchain_token_transaction_post.yml +++ b/categories/smart_contracts/paths/v3_blockchain_token_transaction_post.yml @@ -30,6 +30,12 @@ description: '2 credits per API call
Transferring fungible tokens on Algorand
@@ -90,17 +96,8 @@ description: '
2 credits per API call
' parameters: - - description: - Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations - for testnet API Key. For mainnet API Key, this value is ignored. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" operationId: Erc20Transfer requestBody: content: diff --git a/categories/smart_contracts/paths/v3_multitoken_balance_batch_{chain}_{contractAddress}_get.yml b/categories/smart_contracts/paths/v3_multitoken_balance_batch_{chain}_{contractAddress}_get.yml index 76cea14..20398d7 100644 --- a/categories/smart_contracts/paths/v3_multitoken_balance_batch_{chain}_{contractAddress}_get.yml +++ b/categories/smart_contracts/paths/v3_multitoken_balance_batch_{chain}_{contractAddress}_get.yml @@ -22,6 +22,12 @@ description: "1 credit per API call
1 credit per API call
2 credits per API call
Signing a transaction
@@ -43,15 +49,8 @@ description: '2 credits per API call
' operationId: BurnMultiTokenBatch parameters: - - description: Type of testnet. Defaults to Sepolia. Valid only for ETH invocations. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_multitoken_burn_post.yml b/categories/smart_contracts/paths/v3_multitoken_burn_post.yml index 6b06f4b..b020fbb 100644 --- a/categories/smart_contracts/paths/v3_multitoken_burn_post.yml +++ b/categories/smart_contracts/paths/v3_multitoken_burn_post.yml @@ -21,6 +21,12 @@ description: '2 credits per API call
Signing a transaction
@@ -43,15 +49,8 @@ description: '2 credits per API call
' operationId: BurnMultiToken parameters: - - description: Type of testnet. Defaults to Sepolia. Valid only for ETH invocations. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_multitoken_deploy_post.yml b/categories/smart_contracts/paths/v3_multitoken_deploy_post.yml index 1215cb7..469d43c 100644 --- a/categories/smart_contracts/paths/v3_multitoken_deploy_post.yml +++ b/categories/smart_contracts/paths/v3_multitoken_deploy_post.yml @@ -24,6 +24,12 @@ description: '2 credits per API call
Signing a transaction
@@ -46,15 +52,8 @@ description: '2 credits per API call
' operationId: DeployMultiToken parameters: - - description: Type of testnet. Defaults to Sepolia. Valid only for ETH invocations. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_multitoken_metadata_{chain}_{contractAddress}_{token}_get.yml b/categories/smart_contracts/paths/v3_multitoken_metadata_{chain}_{contractAddress}_{token}_get.yml index 84d92d6..25825f4 100644 --- a/categories/smart_contracts/paths/v3_multitoken_metadata_{chain}_{contractAddress}_{token}_get.yml +++ b/categories/smart_contracts/paths/v3_multitoken_metadata_{chain}_{contractAddress}_{token}_get.yml @@ -20,6 +20,12 @@ description: "1 credit per API call
2 credits per API call
Signing a transaction
@@ -42,15 +48,8 @@ description: '2 credits per API call
' operationId: AddMultiTokenMinter parameters: - - description: Type of testnet. Defaults to Sepolia. Valid only for ETH invocations. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_multitoken_mint_batch_post.yml b/categories/smart_contracts/paths/v3_multitoken_mint_batch_post.yml index 2de3fb1..84b0241 100644 --- a/categories/smart_contracts/paths/v3_multitoken_mint_batch_post.yml +++ b/categories/smart_contracts/paths/v3_multitoken_mint_batch_post.yml @@ -22,6 +22,12 @@ description: '2 credits per API call
Signing a transaction
@@ -44,15 +50,8 @@ description: '2 credits per API call
' operationId: MintMultiTokenBatch parameters: - - description: Type of testnet. Defaults to Sepolia. Valid only for ETH invocations. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_multitoken_mint_post.yml b/categories/smart_contracts/paths/v3_multitoken_mint_post.yml index b1f6936..0fc3449 100644 --- a/categories/smart_contracts/paths/v3_multitoken_mint_post.yml +++ b/categories/smart_contracts/paths/v3_multitoken_mint_post.yml @@ -23,6 +23,12 @@ description: '2 credits per API call
Signing a transaction
@@ -45,15 +51,8 @@ description: '2 credits per API call
' operationId: MintMultiToken parameters: - - description: Type of testnet. Defaults to Sepolia. Valid only for ETH invocations. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_multitoken_transaction_batch_post.yml b/categories/smart_contracts/paths/v3_multitoken_transaction_batch_post.yml index 683b54a..508f385 100644 --- a/categories/smart_contracts/paths/v3_multitoken_transaction_batch_post.yml +++ b/categories/smart_contracts/paths/v3_multitoken_transaction_batch_post.yml @@ -25,6 +25,12 @@ description: '2 credits per API call
Signing a transaction
@@ -47,15 +53,8 @@ description: '2 credits per API call
' operationId: TransferMultiTokenBatch parameters: - - description: Type of testnet. Defaults to Sepolia. Valid only for ETH invocations. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_multitoken_transaction_post.yml b/categories/smart_contracts/paths/v3_multitoken_transaction_post.yml index 0eb8a9d..0756026 100644 --- a/categories/smart_contracts/paths/v3_multitoken_transaction_post.yml +++ b/categories/smart_contracts/paths/v3_multitoken_transaction_post.yml @@ -25,6 +25,12 @@ description: '2 credits per API call
Signing a transaction
@@ -47,15 +53,8 @@ description: '2 credits per API call
' operationId: TransferMultiToken parameters: - - description: Type of testnet. Defaults to Sepolia. Valid only for ETH invocations. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_multitoken_transaction_{chain}_{hash}_get.yml b/categories/smart_contracts/paths/v3_multitoken_transaction_{chain}_{hash}_get.yml index 0a343ef..53924bd 100644 --- a/categories/smart_contracts/paths/v3_multitoken_transaction_{chain}_{hash}_get.yml +++ b/categories/smart_contracts/paths/v3_multitoken_transaction_{chain}_{hash}_get.yml @@ -20,6 +20,12 @@ description: "1 credit per API call
This endpoint is deprecated. Do not use it.
1 credit per API call
100 credits per API call on Flow
Burning NFTs on Algorand
@@ -68,17 +74,8 @@ description: '
100 credits per API call on Flow
'
operationId: NftBurnErc721
parameters:
- - description:
- Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations
- for testnet API Key. For mainnet API Key, this value is ignored.
- in: header
- name: x-testnet-type
- required: false
- schema:
- default: ethereum-sepolia
- type: string
- enum:
- - ethereum-sepolia
+ - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery"
+ - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader"
requestBody:
content:
application/json:
diff --git a/categories/smart_contracts/paths/v3_nft_deploy_post.yml b/categories/smart_contracts/paths/v3_nft_deploy_post.yml
index 0e17fb7..ae4296e 100644
--- a/categories/smart_contracts/paths/v3_nft_deploy_post.yml
+++ b/categories/smart_contracts/paths/v3_nft_deploy_post.yml
@@ -37,6 +37,12 @@ description: '
100 credits per API call on Flow
General NFT smart contracts
@@ -86,17 +92,8 @@ description: '
100 credits per API call on Flow
'
operationId: NftDeployErc721
parameters:
- - description:
- Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations
- for testnet API Key. For mainnet API Key, this value is ignored.
- in: header
- name: x-testnet-type
- required: false
- schema:
- default: ethereum-sepolia
- type: string
- enum:
- - ethereum-sepolia
+ - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery"
+ - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader"
requestBody:
content:
application/json:
diff --git a/categories/smart_contracts/paths/v3_nft_metadata_{chain}_{contractAddress}_{tokenId}_get.yml b/categories/smart_contracts/paths/v3_nft_metadata_{chain}_{contractAddress}_{tokenId}_get.yml
index 80b2875..a8e2eab 100644
--- a/categories/smart_contracts/paths/v3_nft_metadata_{chain}_{contractAddress}_{tokenId}_get.yml
+++ b/categories/smart_contracts/paths/v3_nft_metadata_{chain}_{contractAddress}_{tokenId}_get.yml
@@ -28,6 +28,12 @@ description: "
1 credit per API call
2 credits per API call
Signing a transaction
@@ -52,17 +58,8 @@ description: '
2 credits per API call
' operationId: NftAddMinter parameters: - - description: - Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations - for testnet API Key. For mainnet API Key, this value is ignored. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_nft_mint_batch_post.yml b/categories/smart_contracts/paths/v3_nft_mint_batch_post.yml index 5cf7630..d29f552 100644 --- a/categories/smart_contracts/paths/v3_nft_mint_batch_post.yml +++ b/categories/smart_contracts/paths/v3_nft_mint_batch_post.yml @@ -5,22 +5,23 @@ description: \ defined in contractAddress.\nThis API is supported for the following blockchains:
\n\{\n \ - \ \"to\": [\"0x80d8bac9a6901698b3749fe336bbd1385c1f98f2\"],\n \"url\": [\"ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj\"\ - ],\n \"tokenId\": [\"9876541124516\"],\n \"contractAddress\":\"0xcd2ada00c48a27faa5cc67f9a1ed55b89ddf7f77\"\ +
{\n \"to\": [\"0x80d8bac9a6901698b3749fe336bbd1385c1f98f2\"\ + ],\n \"url\": [\"ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj\"],\n \ + \ \"tokenId\": [\"9876541124516\"],\n \"contractAddress\":\"0xcd2ada00c48a27faa5cc67f9a1ed55b89ddf7f77\"\ ,\n \"minter\": \"0x542b9ac4945a3836fd12ad98acbc76a0c8b743f5\",\n \"chain\"\ : \"MATIC\"\n}\nThe blockchain fee of the performed transaction is paid from\ \ the address connected with built-in private key and is debited in form of credits.\ @@ -44,17 +45,8 @@ description: \ to send coins there.\n" operationId: NftMintMultipleErc721 parameters: - - description: - Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations - for testnet API Key. For mainnet API Key, this value is ignored. - in: header - name: x-testnet-type - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: diff --git a/categories/smart_contracts/paths/v3_nft_mint_post.yml b/categories/smart_contracts/paths/v3_nft_mint_post.yml index 3f6de14..2f76381 100644 --- a/categories/smart_contracts/paths/v3_nft_mint_post.yml +++ b/categories/smart_contracts/paths/v3_nft_mint_post.yml @@ -32,7 +32,7 @@ description: _blank\">our user documentation.\n
You can mint NFTs on the pre-built\ \ smart contract provided by Tatum on the following blockchains:
\nDepending on what blockchain you use,\ +
Depending on what blockchain you use,\ \ choose the request body schema to use in the API call.
\nMintNftExpress
\
@@ -136,13 +136,13 @@ description:
\ on the following blockchains:\nDepending on what blockchain\ - \ you use, choose the request body schema to use in the API call.
\nMintNftAlgorand
schema\
- \ of the request body.MintNftAlgorandKMS
schema of the request\
- \ body.Depending on what blockchain you use, choose the request body\ + \ schema to use in the API call.
\nMintNftAlgorand
schema of the request body.MintNftAlgorandKMS
\
+ \ schema of the request body.manager
parameter.100 credits per API call on Flow
For Ethereum, Celo, and BNB Smart Chain, transferring NFTs invokes the safeTransfer()
- method.
For Ethereum, Celo, Flare and BNB Smart Chain, transferring NFTs invokes the
+ safeTransfer()
method.
Transferring NFTs on Algorand
@@ -109,17 +115,8 @@ description: '100 credits per API call on Flow
'
operationId: NftTransferErc721
parameters:
- - description:
- Type of Ethereum testnet. Defaults to Sepolia. Valid only for ETH invocations
- for testnet API Key. For mainnet API Key, this value is ignored.
- in: header
- name: x-testnet-type
- required: false
- schema:
- default: ethereum-sepolia
- type: string
- enum:
- - ethereum-sepolia
+ - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery"
+ - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader"
requestBody:
content:
application/json:
diff --git a/categories/smart_contracts/paths/v3_nft_transaction_{chain}_{hash}_get.yml b/categories/smart_contracts/paths/v3_nft_transaction_{chain}_{hash}_get.yml
index 72e6db9..a3c5db4 100644
--- a/categories/smart_contracts/paths/v3_nft_transaction_{chain}_{hash}_get.yml
+++ b/categories/smart_contracts/paths/v3_nft_transaction_{chain}_{hash}_get.yml
@@ -24,6 +24,12 @@ description: "
1 credit per API call
{\n \"address\": \"\ - FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ\", // the address on which the transaction\ - \ occurs; for EVM-based chains, this is the sender's address\n \"txId\": \"2rdy3YCZHSwvpWtuDom1d4Jjy5UU9STLxF3ffXau6GToReDkfw8wEgX541fvzvh6btVC5D8iNapcKTXfPsoDBk7A\"\ + \ addresses across all blockchains\n25 credits / day / address \n\ + \ \n\nThe request body of the POST request is a JSON object with\ + \ the following structure:
\n{\n \"address\": \"FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ\"\ + , // the address on which the transaction occurs; for EVM-based chains, this is\ + \ the sender's address\n \"txId\": \"2rdy3YCZHSwvpWtuDom1d4Jjy5UU9STLxF3ffXau6GToReDkfw8wEgX541fvzvh6btVC5D8iNapcKTXfPsoDBk7A\"\ , // the transaction ID\n \"blockNumber\": 110827114, // the block number; does\ \ not appear if the transaction is in the mempool (for EVM-based blockchains)\n\ \ \"asset\": \"3gUeeR3BfVhukYJMwtHownRtRkGcf1bvwiV8TbKMZBVz\", // the asset of\ @@ -87,14 +97,19 @@ description: \ consumption:
\n
Chain | \nAvailable chains\ \ (the \"chain\" parameter in the response payload) | \nCredit consumption\ \ / day | \n|
---|---|---|---|
Ethereum | \nethereum-sepolia /\ - \ ethereum-goerli / ethereum-mainnet | \n500,000 credits / day | \n\ + \ ethereum-holesky / ethereum-mainnet\n500,000 credits / day | \n\ \
Polygon | \npolygon-mumbai / polygon-mainnet | \n\ \500,000 credits / day | \n|
Celo | \ncelo-testnet\ \ / celo-mainnet | \n500,000 credits / day | \n|
Klaytn | \nklaytn-baobab / klaytn-cypress | \n500,000\ - \ credits / day | \n|
BNB Smart Chain | \nbsc-testnet\ - \ / bsc-mainnet | \n500,000 credits / day | \n
{\n \"events\": [\n {\n \"timestamp\": 1661961758000,\n \"from\"\ : \"0x0000000000000000000000000000000000000000\",\n \"to\": \"0xfa4e7035b34294407e5df1603215983d65e5a773\"\ ,\n \"tokenId\": \"14671\",\n \"txId\": \"0x916fcf878656f7a3772317697e6d2740ac8b1b7dbe6d029aa79592fd72f3fb0b\"\ @@ -113,18 +128,22 @@ description: \ type on different blockchains and the credit consumption:
\n
Chain | \nAvailable chains (the \"chain\" parameter in the response\ \ payload) | \nCredit consumption / day | \n||
---|---|---|---|---|
Ethereum | \n\ - \ethereum-sepolia / ethereum-goerli / ethereum-mainnet | \n500,000\ + \ | ethereum-sepolia / ethereum-holesky / ethereum-mainnet | \n500,000\ \ credits / day | \n
Polygon | \npolygon-mumbai\ \ / polygon-mainnet | \n500,000 credits / day | \n||
Celo | \ncelo-testnet / celo-mainnet | \n500,000 credits\ \ / day | \n||
Klaytn | \nklaytn-baobab / klaytn-cypress | \n\ - \500,000 credits / day | \n||
BNB Smart Chain | \n\ - \bsc-testnet / bsc-mainnet | \n500,000 credits / day | \n
{\n \"events\": [\n {\n \"timestamp\": 1661961758000,\n\ - \ \"from\": \"0x85bd970cf0e49acd572f9c2d608713bc55b5ee0e\",\n \"to\": \"\ - 0x9ab31230d5413e4af01af9bb697651a3c70c95c9\",\n \"tokenId\": \"1450000023306\"\ - ,\n \"txId\": \"0x565b9ca6b7b5ff1b1ce0725acd785dbf5ff0930d5ff547bad044c0960291555f\"\ + \500,000 credits / day \n \n\n \nFlare \nflare-coston\ + \ / flare-coston2 / flare-songbird / flare-mainnet \n500,000 credits\ + \ / day \n\n \nBNB Smart Chain \nbsc-testnet\ + \ / bsc-mainnet \n500,000 credits / day \n\n \nCronos \n\ + \cronos-mainnet / cronos-testnet \n500,000 credits / day \n\ + \\n \n\nThe request\ + \ body of the POST request is a JSON object with the following structure:Base \nbase-mainnet / base-testnet \n\ + \500,000 credits / day \n
\n\ +{\n \"events\": [\n {\n \"timestamp\": 1661961758000,\n \"from\"\ + : \"0x85bd970cf0e49acd572f9c2d608713bc55b5ee0e\",\n \"to\": \"0x9ab31230d5413e4af01af9bb697651a3c70c95c9\"\ + ,\n \"tokenId\": \"1450000023306\",\n \"txId\": \"0x565b9ca6b7b5ff1b1ce0725acd785dbf5ff0930d5ff547bad044c0960291555f\"\ ,\n \"contractAddress\": \"0xdb6290f355a528a7284bdd528b05a78fb05226ca\",\n \ \ \"type\": \"erc1155\",\n \"amount\": \"1\",\n \"logIndex\": 571,\n\ \ \"metadataURI\": \"https://touhao.bj.bcebos.com/nft/metadata/1450000023306.json\"\ @@ -139,15 +158,20 @@ description: \ blockchains and the credit consumption:
\n
Chain | \n\ \Available chains (the \"chain\" parameter in the response payload) | \n\ \Credit consumption / day | \n||
---|---|---|---|---|
Ethereum | \n\ - \ethereum-sepolia / ethereum-goerli / ethereum-mainnet | \n50,000\ + \ | ethereum-sepolia / ethereum-holesky / ethereum-mainnet | \n50,000\ \ credits / day | \n
Polygon | \npolygon-mumbai\ \ / polygon-mainnet | \n50,000 credits / day | \n||
Celo | \ncelo-testnet / celo-mainnet | \n50,000 credits\ \ / day | \n||
Klaytn | \nklaytn-baobab / klaytn-cypress | \n\ - \50,000 credits / day | \n||
BNB Smart Chain | \n\ - \bsc-testnet / bsc-mainnet | \n50,000 credits / day | \n
{\n \"events\": [\n {\n \"txId\": \"0xc98307f09ed527d5cff8305e8f65226b790e3317ded10b9e58f6f07286dcf8f1\"\ + \50,000 credits / day \n \n\n \nFlare \nflare-coston\ + \ / flare-coston2 / flare-songbird / flare-mainnet \n500,000 credits\ + \ / day \n\n \n\ + \BNB Smart Chain \n \ + \bsc-testnet / bsc-mainnet \n50,000 credits / day \n\n \nCronos \ncronos-mainnet \n50,000 credits\ + \ / day \n\n \n\nThe request\ + \ body of the POST request is a JSON object with the following structure:Base \nbase-mainnet \n\ + \50,000 credits / day \n
\n\ +{\n \"events\": [\n {\n \"txId\": \"0xc98307f09ed527d5cff8305e8f65226b790e3317ded10b9e58f6f07286dcf8f1\"\ ,\n \"logIndex\": 326,\n \"timestamp\": 1661774265000,\n \"address\"\ : \"0xc2132d05d31c914a87c6611c10748aeb04b58e8f\",\n \"topic_0\": \"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef\"\ ,\n \"topic_1\": \"0x000000000000000000000000a91ab7d77892a559d2a95baaf1d748fc97c65d29\"\ @@ -256,18 +280,10 @@ description: \ web hook is fired.
\nResult of the operation is subscription ID, which can\ \ be used to cancel subscription or obtain additional data connected to it like\ \ reports.\n" -operationId: createSubscriptionOld +operationId: createSubscription parameters: - - description: Type of Ethereum testnet. Defaults to ethereum-sepolia. - in: query - name: testnetType - required: false - schema: - default: ethereum-sepolia - type: string - enum: - - ethereum-sepolia - - ethereum-goerli + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeQuery" + - $ref: "../../../components/migrated.yml#/components/parameters/TestnetTypeHeader" requestBody: content: application/json: @@ -337,6 +353,6 @@ responses: security: - X-API-Key: [] x-codeSamples: [] -summary: Create a subscription (old) +summary: Create a subscription tags: - Notification subscriptions diff --git a/categories/subscriptions/paths/v3_subscription_{id}_put.yml b/categories/subscriptions/paths/v3_subscription_{id}_put.yml new file mode 100644 index 0000000..76df134 --- /dev/null +++ b/categories/subscriptions/paths/v3_subscription_{id}_put.yml @@ -0,0 +1,58 @@ +description:1 credit for API call
Update subscription url.
+operationId: updateSubscription +parameters: + - description: Subscription ID + in: path + name: id + required: true + schema: + type: string + example: 5e68c66581f2ee32bc354087 +requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - url + properties: + url: + description: New webhook url + type: string + example: https://example.com/target/webhook +responses: + "204": + description: OK + "400": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error400" + description: + Bad Request. Validation failed for the given object in the HTTP Body + or Request parameters. + "401": + content: + application/json: + schema: + oneOf: + - $ref: "../../../components/migrated.yml#/components/schemas/Error401NotActive" + - $ref: "../../../components/migrated.yml#/components/schemas/Error401Invalid" + description: + Unauthorized. Not valid or inactive subscription key present in the + HTTP Header. + "500": + content: + application/json: + schema: + $ref: "../../../components/migrated.yml#/components/schemas/Error500" + description: + Internal server error. There was an error on the server while processing + the request. +security: + - X-API-Key: [] +x-codeSamples: [] +summary: Update subscription url +tags: + - Notification subscriptions diff --git a/categories/utils/openapi.yml b/categories/utils/openapi.yml index 6d930e9..ec2125b 100644 --- a/categories/utils/openapi.yml +++ b/categories/utils/openapi.yml @@ -41,4 +41,4 @@ paths: components: securitySchemes: X-API-Key: - $ref: components/schemas.yml#/components/securitySchemes/X-API-Key + $ref: components/migrated.yml#/components/securitySchemes/X-API-Key diff --git a/categories/virtual_accounts/openapi.yml b/categories/virtual_accounts/openapi.yml index dc633cd..31d38a8 100644 --- a/categories/virtual_accounts/openapi.yml +++ b/categories/virtual_accounts/openapi.yml @@ -416,4 +416,4 @@ paths: components: securitySchemes: X-API-Key: - $ref: components/schemas.yml#/components/securitySchemes/X-API-Key + $ref: components/migrated.yml#/components/securitySchemes/X-API-Key diff --git a/categories/virtual_accounts/paths/v3_offchain_withdrawal_{id}_{txId}_put.yml b/categories/virtual_accounts/paths/v3_offchain_withdrawal_{id}_{txId}_put.yml index c725b57..efe9d14 100644 --- a/categories/virtual_accounts/paths/v3_offchain_withdrawal_{id}_{txId}_put.yml +++ b/categories/virtual_accounts/paths/v3_offchain_withdrawal_{id}_{txId}_put.yml @@ -21,7 +21,7 @@ parameters: required: true schema: type: string - maxLength: 80 + maxLength: 88 minLength: 10 responses: "204": diff --git a/components/migrated.yml b/components/migrated.yml index b85a875..0e22e05 100644 --- a/components/migrated.yml +++ b/components/migrated.yml @@ -114,6 +114,8 @@ components: $ref: ./schemas/BtcTransactionFromUTXOKMS.yml BtcTransactionFromUTXOKMSSource: $ref: ./schemas/BtcTransactionFromUTXOKMSSource.yml + BtcGetTxByAddressBatch: + $ref: ./schemas/BtcGetTxByAddressBatch.yml BtcTransactionFromUTXOKMSTarget: $ref: ./schemas/BtcTransactionFromUTXOKMSTarget.yml BchBlock: @@ -1216,6 +1218,12 @@ components: $ref: ./schemas/NodeRpcGetChains.yml NodeRpcPostChains: $ref: ./schemas/NodeRpcPostChains.yml + EthTestnetType: + $ref: ./schemas/EthTestnetType.yml + TestnetType: + $ref: ./schemas/TestnetType.yml + FlareTestnetType: + $ref: ./schemas/FlareTestnetType.yml TransferManagedAddress: $ref: ./schemas/TransferManagedAddress.yml CustodialManagedAddress: @@ -1294,6 +1302,52 @@ components: $ref: ./schemas/DeployBep20.yml DeployBep20KMS: $ref: ./schemas/DeployBep20KMS.yml + CronosBlock: + $ref: ./schemas/CronosBlock.yml + CronosTx: + $ref: ./schemas/CronosTx.yml + Error403CronosBroadcast: + $ref: ./schemas/Error403CronosBroadcast.yml + Error403CronosBep20NotFound: + $ref: ./schemas/Error403CronosBep20NotFound.yml + Error403CronosBep20Set: + $ref: ./schemas/Error403CronosBep20Set.yml + Error403CronosMnemonicPrivateKey: + $ref: ./schemas/Error403CronosMnemonicPrivateKey.yml + Error403CronosBep20Unsupported: + $ref: ./schemas/Error403CronosBep20Unsupported.yml + Error403CronosTxHash: + $ref: ./schemas/Error403CronosTxHash.yml + Error403CronosTxSign: + $ref: ./schemas/Error403CronosTxSign.yml + Error403CronosErc20TxSign: + $ref: ./schemas/Error403CronosErc20TxSign.yml + Error403CronosGasCalculation: + $ref: ./schemas/Error403CronosGasCalculation.yml + Error403CronosTxBody: + $ref: ./schemas/Error403CronosTxBody.yml + Error403CronosScBody: + $ref: ./schemas/Error403CronosScBody.yml + Error403CronosGasPrice: + $ref: ./schemas/Error403CronosGasPrice.yml + CallCronosSmartContractMethod: + $ref: ./schemas/CallCronosSmartContractMethod.yml + CallCronosSmartContractReadMethod: + $ref: ./schemas/CallCronosSmartContractReadMethod.yml + CallCronosSmartContractMethodKMS: + $ref: ./schemas/CallCronosSmartContractMethodKMS.yml + TransferCronosBlockchain: + $ref: ./schemas/TransferCronosBlockchain.yml + CronosEstimateGas: + $ref: ./schemas/CronosEstimateGas.yml + TransferCronosBlockchainKMS: + $ref: ./schemas/TransferCronosBlockchainKMS.yml + GeneratedAddressCronos: + $ref: ./schemas/GeneratedAddressCronos.yml + CronosBalance: + $ref: ./schemas/CronosBalance.yml + CallCronosSmartContractMethodCaller: + $ref: ./schemas/CallCronosSmartContractMethodCaller.yml KlaytnBlock: $ref: ./schemas/KlaytnBlock.yml KlaytnTx: @@ -1384,6 +1438,98 @@ components: $ref: ./schemas/SolanaBroadcastConfirm.yml SolanaTransactionHashWithConfirm: $ref: ./schemas/SolanaTransactionHashWithConfirm.yml + FlareBlock: + $ref: ./schemas/FlareBlock.yml + FlareTx: + $ref: ./schemas/FlareTx.yml + Error403FlareBroadcast: + $ref: ./schemas/Error403FlareBroadcast.yml + Error403FlareBep20NotFound: + $ref: ./schemas/Error403FlareBep20NotFound.yml + Error403FlareBep20Set: + $ref: ./schemas/Error403FlareBep20Set.yml + Error403FlareMnemonicPrivateKey: + $ref: ./schemas/Error403FlareMnemonicPrivateKey.yml + Error403FlareBep20Unsupported: + $ref: ./schemas/Error403FlareBep20Unsupported.yml + Error403FlareTxHash: + $ref: ./schemas/Error403FlareTxHash.yml + Error403FlareTxSign: + $ref: ./schemas/Error403FlareTxSign.yml + Error403FlareErc20TxSign: + $ref: ./schemas/Error403FlareErc20TxSign.yml + Error403FlareGasCalculation: + $ref: ./schemas/Error403FlareGasCalculation.yml + Error403FlareTxBody: + $ref: ./schemas/Error403FlareTxBody.yml + Error403FlareScBody: + $ref: ./schemas/Error403FlareScBody.yml + Error403FlareGasPrice: + $ref: ./schemas/Error403FlareGasPrice.yml + CallFlareSmartContractMethod: + $ref: ./schemas/CallFlareSmartContractMethod.yml + CallFlareSmartContractReadMethod: + $ref: ./schemas/CallFlareSmartContractReadMethod.yml + CallFlareSmartContractMethodKMS: + $ref: ./schemas/CallFlareSmartContractMethodKMS.yml + TransferFlareBlockchain: + $ref: ./schemas/TransferFlareBlockchain.yml + FlareEstimateGas: + $ref: ./schemas/FlareEstimateGas.yml + TransferFlareBlockchainKMS: + $ref: ./schemas/TransferFlareBlockchainKMS.yml + GeneratedAddressFlare: + $ref: ./schemas/GeneratedAddressFlare.yml + FlareBalance: + $ref: ./schemas/FlareBalance.yml + CallFlareSmartContractMethodCaller: + $ref: ./schemas/CallFlareSmartContractMethodCaller.yml + BaseBlock: + $ref: ./schemas/BaseBlock.yml + BaseTx: + $ref: ./schemas/BaseTx.yml + Error403BaseBroadcast: + $ref: ./schemas/Error403BaseBroadcast.yml + Error403BaseBep20NotFound: + $ref: ./schemas/Error403BaseBep20NotFound.yml + Error403BaseBep20Set: + $ref: ./schemas/Error403BaseBep20Set.yml + Error403BaseMnemonicPrivateKey: + $ref: ./schemas/Error403BaseMnemonicPrivateKey.yml + Error403BaseBep20Unsupported: + $ref: ./schemas/Error403BaseBep20Unsupported.yml + Error403BaseTxHash: + $ref: ./schemas/Error403BaseTxHash.yml + Error403BaseTxSign: + $ref: ./schemas/Error403BaseTxSign.yml + Error403BaseErc20TxSign: + $ref: ./schemas/Error403BaseErc20TxSign.yml + Error403BaseGasCalculation: + $ref: ./schemas/Error403BaseGasCalculation.yml + Error403BaseTxBody: + $ref: ./schemas/Error403BaseTxBody.yml + Error403BaseScBody: + $ref: ./schemas/Error403BaseScBody.yml + Error403BaseGasPrice: + $ref: ./schemas/Error403BaseGasPrice.yml + CallBaseSmartContractMethod: + $ref: ./schemas/CallBaseSmartContractMethod.yml + CallBaseSmartContractReadMethod: + $ref: ./schemas/CallBaseSmartContractReadMethod.yml + CallBaseSmartContractMethodKMS: + $ref: ./schemas/CallBaseSmartContractMethodKMS.yml + TransferBaseBlockchain: + $ref: ./schemas/TransferBaseBlockchain.yml + BaseEstimateGas: + $ref: ./schemas/BaseEstimateGas.yml + TransferBaseBlockchainKMS: + $ref: ./schemas/TransferBaseBlockchainKMS.yml + GeneratedAddressBase: + $ref: ./schemas/GeneratedAddressBase.yml + BaseBalance: + $ref: ./schemas/BaseBalance.yml + CallBaseSmartContractMethodCaller: + $ref: ./schemas/CallBaseSmartContractMethodCaller.yml Error403Celo: $ref: ./schemas/Error403Celo.yml TransferErc721Celo: @@ -2068,6 +2214,8 @@ components: $ref: ./schemas/ChainEnumExtended.yml ChainUtxoEnum: $ref: ./schemas/ChainUtxoEnum.yml + Utxo: + $ref: ./schemas/Utxo.yml TokenId: $ref: ./schemas/TokenId.yml TokenIds: @@ -2090,6 +2238,67 @@ components: $ref: ./schemas/Cursor.yml Offset: $ref: ./schemas/Offset.yml + parameters: + EthTestnetTypeQuery: + in: query + name: testnetType + description: + Type of Ethereum testnet in query. Defaults to ethereum-sepolia. + For mainnet API Key, this value is ignored. + required: false + schema: + $ref: "#/components/schemas/EthTestnetType" + EthTestnetTypeHeader: + in: header + name: x-testnet-type + description: + Type of Ethereum testnet in header. Defaults to ethereum-sepolia. + For mainnet API Key, this value is ignored. + required: false + schema: + $ref: "#/components/schemas/EthTestnetType" + TestnetTypeQuery: + in: query + name: testnetType + description: + "Type of testnet in query. The default type is based on the currency: + ethereum-sepolia for ETH, and flare-coston for FLR. This parameter is valid + only for ETH or FLR invocations with a testnet API Key. For mainnet API Key, + this value is ignored. The currency/chain must be specified to determine the + applicable set of testnet types." + required: false + schema: + $ref: "#/components/schemas/TestnetType" + TestnetTypeHeader: + in: header + name: x-testnet-type + description: + "Type of testnet in header. The default type is based on the currency: + ethereum-sepolia for ETH, and flare-coston for FLR. This parameter is valid + only for ETH or FLR invocations with a testnet API Key. For mainnet API Key, + this value is ignored. The currency/chain must be specified to determine the + applicable set of testnet types." + required: false + schema: + $ref: "#/components/schemas/TestnetType" + FlareTestnetTypeQuery: + in: query + name: testnetType + description: + Type of Flare testnet in query. Defaults to flare-coston. For mainnet + API Key, this value is ignored. + required: false + schema: + $ref: "#/components/schemas/FlareTestnetType" + FlareTestnetTypeHeader: + in: header + name: x-testnet-type + description: + Type of Flare testnet in header. Defaults to flare-coston. For + mainnet API Key, this value is ignored. + required: false + schema: + $ref: "#/components/schemas/FlareTestnetType" securitySchemes: X-API-Key: type: apiKey diff --git a/components/responses.yml b/components/responses.yml deleted file mode 100644 index 9c0d1ba..0000000 --- a/components/responses.yml +++ /dev/null @@ -1,61 +0,0 @@ -components: - OK: - content: - application/json: - schema: - properties: - id: - description: The ID of the response - example: 5e68c66581f2ee32bc354087 - type: string - data: - type: array - items: - type: object - example: {} - description: OK - Error400: - content: - application/json: - schema: - properties: - errorCode: - example: validation.failed - description: validation.failed - type: string - message: - example: "Request validation failed. Please see data for additional information." - description: "Request validation failed. Please see data for additional information." - type: string - statusCode: - example: 400 - description: "400" - type: number - data: - type: array - items: - type: object - required: - - target - properties: - target: - type: object - additionalProperties: true - description: Request object present in the body of the HTTP request - example: - property: 12345 - value: - type: number - description: Value of the target object which validation is wrong. Can be of any data type, example here is using type number. - example: 12345 - property: - type: string - description: Property name of the target object which validation is wrong - example: property1 - constraints: - type: object - additionalProperties: true - description: Object of failed constraints for the target object. Key is the constraint, value is detailed description of the failed constraint. - example: - min: property1 must not be less than 50000 - description: Bad Request. Validation failed for the given object in the HTTP Body or Request parameters. diff --git a/components/schemas.yml b/components/schemas.yml deleted file mode 100644 index b1318ed..0000000 --- a/components/schemas.yml +++ /dev/null @@ -1,49435 +0,0 @@ -info: - title: Schemas - version: "1.0.0" -openapi: 3.0.3 -components: - schemas: - Account: - properties: - id: - description: The ID of the virtual account - example: 5e68c66581f2ee32bc354087 - type: string - balance: - $ref: "#/components/schemas/AccountBalance" - currency: - description: The currency of the virtual account - example: BTC - type: string - frozen: - description: If set to "true", the virtual account is frozen - example: false - type: boolean - active: - description: If set to "true", the virtual account is active - example: true - type: boolean - customerId: - description: >- - The ID of the customer (newly created or existing one) associated - with the virtual account - type: string - example: 5e68c66581f2ee32bc354087 - accountNumber: - description: The number associated with the virtual account in an external system - maxLength: 50 - minLength: 1 - example: "123456" - type: string - accountCode: - description: >- - The code associated with the virtual account in an external system - to designate the purpose of the account in bookkeeping - example: 03_ACC_01 - type: string - accountingCurrency: - description: >- - The currency in which all the transactions for all accounts will be - accounted - example: EUR - type: string - xpub: - description: >- - The extended public key of the blockchain wallet associated with the - virtual account; used to generate deposit addresses for the virtual - account - example: >- - xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka - type: string - required: - - id - - active - - frozen - - currency - - balance - type: object - Deposit: - required: - - txId - - address - - timestamp - - xpub - - derivationKey - - amount - - status - - accountId - - currency - - reference - - vout - - spent - - blockHeight - properties: - txId: - type: string - example: 6498A3BE7313FEF32C9C0130F321D7808439F7F59D41932122383CC9E109F534 - address: - description: Blockchain address. - example: 7c21ed165e294db78b95f0f181086d6f - type: string - timestamp: - type: number - minimum: 0 - example: 1613654998398 - description: End interval in UTC millis. - xpub: - description: Extended public key to derive address from. - example: >- - xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka - type: string - derivationKey: - description: Derivation key index for given address. - format: int32 - type: integer - maximum: 2147483647 - amount: - type: string - description: Amount of the trade - example: "15000" - status: - type: string - example: Done - description: Status of deposit - enum: - - InProgress - - Done - - Failed - accountId: - description: Account ID. - example: 5e68c66581f2ee32bc354087 - type: string - currency: - type: string - example: BTC - description: Currency - reference: - type: string - example: some reference - vout: - type: number - example: 0 - spent: - type: boolean - blockHeight: - type: number - minimum: 0 - description: Block of deposit - example: 228232166 - blockHash: - description: Hash of the block where this transaction was in. - type: string - example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137" - from: - description: Blockchain address. - example: 7c21ed165e294db78b95f0f181086d6f - type: string - EntitiesCount: - type: object - properties: - total: - description: Total entities - example: 20 - type: number - ChartRequest: - type: object - required: - - pair - - from - - to - - timeFrame - properties: - pair: - type: string - description: Trading pair - example: BTC/EUR - minLength: 3 - maxLength: 30 - pattern: ^[A-a-zZ0-9_\-]+\/[A-Za-z0-9_\-]+$ - from: - type: number - minimum: 0 - example: 1613654998398 - description: Start interval in UTC millis. - to: - type: number - minimum: 0 - example: 1613654998398 - description: End interval in UTC millis. - timeFrame: - type: string - example: MIN_5 - description: Time frame of the chart. - enum: - - MIN_1 - - MIN_3 - - MIN_5 - - MIN_15 - - MIN_30 - - HOUR_1 - - HOUR_4 - - HOUR_12 - - DAY - - WEEK - - MONTH - - YEAR - Chart: - type: object - description: >- - 1 point in the chart. This point represents the tick in the grapch based - on the specified time frame. - required: - - timestamp - - high - - low - - open - - close - - volume - properties: - timestamp: - type: number - description: Milliseconds in UTC of the time interval. - example: 1613654117167 - high: - type: string - description: Highest trade value in the current interval. - example: "54213.21" - low: - type: string - description: Lowest trade value in the current interval. - example: "53213.54" - open: - type: string - description: Open trade value in the current interval. - example: "53513" - close: - type: string - description: Close trade value in the current interval. - example: "54113" - volume: - type: string - description: >- - Total volume of assets traded in the current interval. Volume is in - currency1 asset. - example: "2.423" - AccountBalance: - properties: - accountBalance: - description: All assets on the account, both available and blocked - example: "1000000" - type: string - availableBalance: - description: >- - The account balance minus the blocked assets; use the available - balance to determine how much a customer can send or withdraw from - their virtual account - example: "1000000" - type: string - type: object - required: - - accountBalance - - availableBalance - Subscription: - type: object - required: - - type - - id - properties: - type: - type: string - description: Type of the subscription. - example: ACCOUNT_BALANCE_LIMIT - enum: - - ADDRESS_TRANSACTION - - CONTRACT_LOG_EVENT - - ACCOUNT_INCOMING_BLOCKCHAIN_TRANSACTION - - ACCOUNT_PENDING_BLOCKCHAIN_TRANSACTION - - CUSTOMER_TRADE_MATCH - - CUSTOMER_PARTIAL_TRADE_MATCH - - TRANSACTION_IN_THE_BLOCK - - KMS_FAILED_TX - - KMS_COMPLETED_TX - - ACCOUNT_BALANCE_LIMIT - - TRANSACTION_HISTORY_REPORT - id: - type: string - description: ID of the subscription - example: 7c21ed165e294db78b95f0f1 - attr: - type: object - description: Additional attributes based on the subscription type. - WebHook: - type: object - required: - - id - - type - - subscriptionId - - url - - data - - failed - - response - properties: - type: - type: string - description: Type of the subscription. - example: ACCOUNT_BALANCE_LIMIT - enum: - - INCOMING_BLOCKCHAIN_HOOK - - ADDRESS_TRANSACTION - - CONTRACT_LOG_EVENT - - TRADE_MATCH - - TRADE_PARTIAL_FILL - - PENDING_BLOCKCHAIN_HOOK - - TRANSACTION_IN_THE_BLOCK - - KMS_FAILED_TX - - KMS_COMPLETED_TX - id: - type: string - description: ID of the WebHook - example: 7c21ed165e294db78b95f0f1 - subscriptionId: - type: string - description: ID of the subscription - example: 7c21ed165e294db78b95f0f1 - url: - type: string - description: ID of the subscription - example: http://some-host.net/webhook - data: - type: object - description: Data of webhook - nextTime: - type: number - description: Next webhook execution try time - example: 1653320900353 - timestamp: - type: number - description: Webhook execution time - example: 1653320900353 - retryCount: - type: number - description: Number - example: 3 - failed: - type: boolean - description: Flag indicating whether this webhook was successful or not - example: false - response: - type: object - description: Response from the server in case the webhook was unsuccessful - required: - - networkError - properties: - code: - type: number - description: HTTP Status - example: 500 - data: - type: string - description: Response from the server - example: Internal server error - networkError: - type: boolean - description: Flag indicating whether an error has been caused by the network - example: false - CreateSubscriptionBalance: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: ACCOUNT_BALANCE_LIMIT - enum: - - ACCOUNT_BALANCE_LIMIT - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - limit - - typeOfBalance - properties: - limit: - type: string - description: Limit to filter accounts with balance above it. - example: "15000" - pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$ - maxLength: 38 - typeOfBalance: - type: string - description: Type of balance to filter. - enum: - - account - - available - CreateSubscriptionInterval: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: TRANSACTION_HISTORY_REPORT - enum: - - TRANSACTION_HISTORY_REPORT - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - interval - properties: - interval: - type: number - description: Number of hours to obtain transactions for. - example: 1 - minimum: 1 - maximum: 720 - CreateSubscriptionIncoming: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: ACCOUNT_INCOMING_BLOCKCHAIN_TRANSACTION - enum: - - ACCOUNT_INCOMING_BLOCKCHAIN_TRANSACTION - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - id - - url - properties: - id: - description: >- - ID of the account, on which the webhook will be applied, when - new incoming blockchain transaction will be credited. - example: 5e6be8e9e6aa436299950c41 - maxLength: 24 - minLength: 24 - type: string - url: - type: string - description: >- - URL of the endpoint, where HTTP POST request will be sent, when - new incoming blockchain transaction will be credited. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionNotification: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: ADDRESS_TRANSACTION - enum: - - ADDRESS_TRANSACTION - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - chain - - address - - url - properties: - address: - description: Blockchain address to watch. - example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ - maxLength: 128 - minLength: 13 - type: string - chain: - description: Blockchain of the address. - example: SOL - type: string - enum: - - SOL - - ETH - - MATIC - - CELO - - KLAY - - BTC - - LTC - - BCH - - DOGE - - TRON - - BSC - url: - type: string - description: >- - URL of the endpoint, where HTTP POST request will be sent, when - transaction is detected on the address. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionContractLogEvent: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: CONTRACT_LOG_EVENT - enum: - - CONTRACT_LOG_EVENT - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - chain - - event - - url - properties: - event: - description: >- - Hexadecimal data representing the event emitted from the smart - contract; represents "topic[0]" from the event log. - example: >- - 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef - maxLength: 66 - minLength: 66 - type: string - chain: - description: The blockchain on which events should be monitored. - example: MATIC - type: string - enum: - - ETH - - MATIC - - CELO - - KLAY - - BSC - url: - type: string - description: >- - The URL of the endpoint where an HTTP POST request will be sent - when the block where the events from the smart contracts are - reflected gets completed. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionMultiTokenTransferEvent: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: CONTRACT_MULTITOKEN_TXS_PER_BLOCK - enum: - - CONTRACT_MULTITOKEN_TXS_PER_BLOCK - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - chain - - url - properties: - chain: - description: The blockchain on which events should be monitored. - example: MATIC - type: string - enum: - - ETH - - MATIC - - CELO - - KLAY - - BSC - url: - type: string - description: >- - The URL of the endpoint where an HTTP POST request will be sent - when the block where the events from the smart contracts are - reflected gets completed. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionNftTransferEvent: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: CONTRACT_NFT_TXS_PER_BLOCK - enum: - - CONTRACT_NFT_TXS_PER_BLOCK - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - chain - - url - properties: - chain: - description: The blockchain on which events should be monitored. - example: MATIC - type: string - enum: - - ETH - - MATIC - - CELO - - KLAY - - BSC - url: - type: string - description: >- - The URL of the endpoint where an HTTP POST request will be sent - when the block where the events from the smart contracts are - reflected gets completed. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionTradeMatch: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: CUSTOMER_TRADE_MATCH - enum: - - CUSTOMER_TRADE_MATCH - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - id - - url - properties: - id: - description: >- - ID of the customer, on which the webhook will be applied, when - on any of his accounts trade will be matched and closed. - example: 5e6be8e9e6aa436299950c41 - maxLength: 24 - minLength: 24 - type: string - url: - type: string - description: >- - URL of the endpoint, where HTTP POST request will be sent, when - on any of his accounts trade will be matched and closed. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionPartialTradeMatch: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: CUSTOMER_PARTIAL_TRADE_MATCH - enum: - - CUSTOMER_PARTIAL_TRADE_MATCH - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - id - - url - properties: - id: - description: >- - ID of the customer, on which the webhook will be applied, when - on any of his accounts trade will be matched and closed. - example: 5e6be8e9e6aa436299950c41 - maxLength: 24 - minLength: 24 - type: string - url: - type: string - description: >- - URL of the endpoint, where HTTP POST request will be sent, when - on any of his accounts trade will be matched and closed. - example: https://webhook.tatum.io/trade - maxLength: 500 - CreateSubscriptionKMSError: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: KMS_FAILED_TX - enum: - - KMS_FAILED_TX - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - url - properties: - url: - type: string - description: >- - URL of the endpoint, where HTTP POST request will be sent, when - error occurs inside Tatum KMS. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionKMSSuccess: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: KMS_COMPLETED_TX - enum: - - KMS_COMPLETED_TX - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - url - properties: - url: - type: string - description: >- - URL of the endpoint, where HTTP POST request will be sent, when - tx is sucessfully broadcasted using Tatum KMS. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionTxInTheBlock: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: TRANSACTION_IN_THE_BLOCK - enum: - - TRANSACTION_IN_THE_BLOCK - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - url - properties: - url: - type: string - description: >- - URL of the endpoint, where HTTP POST request will be sent, when - outgoing ledger transaction is included in the block. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - CreateSubscriptionPending: - type: object - required: - - type - - attr - properties: - type: - type: string - description: Type of the subscription. - example: ACCOUNT_PENDING_BLOCKCHAIN_TRANSACTION - enum: - - ACCOUNT_PENDING_BLOCKCHAIN_TRANSACTION - attr: - type: object - description: Additional attributes based on the subscription type. - required: - - id - - url - properties: - id: - description: >- - ID of the account, on which the webhook will be applied, when - new incoming pending blockchain transaction with 0 confirmations - will be credited. - example: 5e6be8e9e6aa436299950c41 - maxLength: 24 - minLength: 24 - type: string - url: - type: string - description: >- - URL of the endpoint, where HTTP POST request will be sent, when - new incoming pending blockchain transaction with 0 confirmations - will be credited. - example: https://dashboard.tatum.io/webhook-handler - maxLength: 500 - OffchainAddresses: - type: object - required: - - addresses - properties: - addresses: - type: array - items: - type: object - required: - - accountId - properties: - accountId: - description: >- - ID of the account, for which blockchain address will be - created. - example: 5e6be8e9e6aa436299950c41 - maxLength: 24 - minLength: 24 - type: string - derivationKey: - description: >- - Derivation key index for given address to generate. If not - present, first not used address will be created. - format: int32 - type: integer - minimum: 0 - maximum: 2147483647 - Address: - required: - - address - - currency - properties: - address: - description: Blockchain address. - example: 7c21ed165e294db78b95f0f181086d6f - type: string - currency: - description: >- - Currency of generated address. BTC, LTC, DOGE, BCH, ETH, XRP, XLM, - BNB, TRX, ERC20, TRC20. - example: BTC - type: string - derivationKey: - description: Derivation key index for given address. - format: int32 - type: integer - maximum: 2147483647 - xpub: - description: >- - Extended public key to derive address from. In case of XRP, this is - account address, since address is defined as DestinationTag, which - is address field. In case of XLM, this is account address, since - address is defined as message, which is address field. - example: >- - xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka - type: string - destinationTag: - description: In case of XRP, destinationTag is the distinguisher of the account. - type: number - example: 5 - memo: - description: In case of BNB, message is the distinguisher of the account. - type: string - example: "5" - message: - description: In case of XLM, message is the distinguisher of the account. - type: string - example: "5" - type: object - Trade: - type: object - properties: - id: - type: string - description: ID of the trade - example: 7c21ed165e294db78b95f0f1 - type: - type: string - description: Type of the trade, BUY or SELL - example: BUY - enum: - - BUY - - SELL - price: - type: string - description: Price to buy / sell - example: "8650.4" - amount: - type: string - description: Amount of the trade to be bought / sold - example: "15000" - pair: - type: string - description: Trading pair - example: BTC/EUR - isMaker: - type: boolean - description: If closed trade was Maker or Taker trade - example: true - fill: - type: string - description: How much of the trade was already filled. - example: "1500" - feeAccountId: - type: string - description: >- - ID of the account where fee will be paid, if any. If trade is a BUY - or FUTURE_BUY type, feeAccountId must have same currency as a - currency of currency2AccountId, and vice versa if trade is a SELL or - FUTURE_SELL type, feeAccountId must have same currency as a currency - of currency1AccountId. - example: 7c21ed165e294db78b95f0f1 - minLength: 24 - maxLength: 24 - fee: - type: number - description: Percentage of the trade amount to be paid as a fee. - example: 1.5 - minimum: 0 - maximum: 100 - currency1AccountId: - type: string - description: ID of the account of the currenc 1 trade currency - example: 7c21ed165e294db78b95f0f1 - currency2AccountId: - type: string - description: ID of the account of the currenc 2 trade currency - example: 7c21ed165e294db78b95f0f1 - created: - type: number - description: Creation date, UTC millis - example: 1585170363103 - attr: - type: object - description: Additional attributes for the future type. - required: - - sealDate - properties: - sealDate: - type: number - description: Time in UTC when the future will be filled. - example: 1572031674384 - minimum: 0 - percentBlock: - description: >- - Percentage of the future amount which the selling or buying - account must have available for the future’s creation. This - amount will be blocked until the future is filled or expires. - type: number - example: 1.5 - minimum: 0 - maximum: 100 - percentPenalty: - description: >- - If one of the parties doesn’t have the full amount of the future - at the time of expiration filled, the party will be penalized. - type: number - example: 1.5 - minimum: 0 - maximum: 100 - CreateTrade: - type: object - required: - - type - - price - - amount - - pair - - currency1AccountId - - currency2AccountId - properties: - type: - type: string - description: Type of the regular trade, BUY, SELL - example: BUY - enum: - - BUY - - SELL - price: - type: string - description: Price to buy / sell - example: "8650.4" - maxLength: 38 - pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$ - amount: - type: string - description: Amount of the trade to be bought / sold - example: "15000" - maxLength: 38 - pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$ - pair: - type: string - description: Trading pair - example: BTC/EUR - minLength: 3 - maxLength: 30 - pattern: ^[A-a-zZ0-9_\-]+\/[A-Za-z0-9_\-]+$ - currency1AccountId: - type: string - description: ID of the account of the currency 1 trade currency - example: 7c21ed165e294db78b95f0f1 - minLength: 24 - maxLength: 24 - currency2AccountId: - type: string - description: ID of the account of the currency 2 trade currency - example: 7c21ed165e294db78b95f0f1 - minLength: 24 - maxLength: 24 - feeAccountId: - type: string - description: >- - ID of the account where fee will be paid, if any. If trade is a BUY - or FUTURE_BUY type, feeAccountId must have same currency as a - currency of currency2AccountId, and vice versa if trade is a SELL or - FUTURE_SELL type, feeAccountId must have same currency as a currency - of currency1AccountId. - example: 7c21ed165e294db78b95f0f1 - minLength: 24 - maxLength: 24 - fee: - type: number - description: Percentage of the trade amount to be paid as a fee. - example: 1.5 - minimum: 0 - maximum: 100 - CreateFutureTrade: - type: object - required: - - type - - price - - amount - - pair - - currency1AccountId - - currency2AccountId - - attr - properties: - type: - type: string - description: Type of future the trade, FUTURE_BUY, FUTURE_SELL - example: BUY - enum: - - FUTURE_BUY - - FUTURE_SELL - price: - type: string - description: Price to buy / sell - example: "8650.4" - maxLength: 38 - pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$ - amount: - type: string - description: Amount of the trade to be bought / sold - example: "15000" - maxLength: 38 - pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$ - pair: - type: string - description: Trading pair - example: BTC/EUR - minLength: 3 - maxLength: 30 - pattern: ^[A-a-zZ0-9_\-]+\/[A-Za-z0-9_\-]+$ - currency1AccountId: - type: string - description: ID of the account of the currency 1 trade currency - example: 7c21ed165e294db78b95f0f1 - minLength: 24 - maxLength: 24 - currency2AccountId: - type: string - description: ID of the account of the currency 2 trade currency - example: 7c21ed165e294db78b95f0f1 - minLength: 24 - maxLength: 24 - feeAccountId: - type: string - description: >- - ID of the account where fee will be paid, if any. If trade is a BUY - or FUTURE_BUY type, feeAccountId must have same currency as a - currency of currency2AccountId, and vice versa if trade is a SELL or - FUTURE_SELL type, feeAccountId must have same currency as a currency - of currency1AccountId. - example: 7c21ed165e294db78b95f0f1 - minLength: 24 - maxLength: 24 - fee: - type: number - description: Percentage of the trade amount to be paid as a fee. - example: 1.5 - minimum: 0 - maximum: 100 - attr: - type: object - description: Additional attributes for the future type. - required: - - sealDate - properties: - sealDate: - type: number - description: Time in UTC when the future will be filled. - example: 1572031674384 - minimum: 0 - percentBlock: - description: >- - Percentage of the future amount which selling or buying account - must have available on future creation. This amount will be - blocked till future is filled or expires. - example: 1.5 - minimum: 0 - maximum: 100 - percentPenalty: - description: >- - If one of the parties dont have filled full amount of the future - at the time of expiration, the party will be penalized. Penalty - is sent to opposite party in exchanged crypto. - example: 1.5 - minimum: 0 - maximum: 100 - BnbBlock: - type: object - properties: - timestamp: - type: number - example: 1651145988650 - blockHeight: - type: number - example: 44925860 - tx: - type: array - items: - $ref: "#/components/schemas/BnbTransaction" - BnbTransaction: - type: object - properties: - txHash: - type: string - example: 4B944BBF78F3ADE3A377551B5EA7AD0FEDBDA13165D932F94B106EF7A8E16C1A - blockHeight: - type: number - example: 44925860 - txType: - type: string - example: TRANSFER - timeStamp: - type: string - example: "2019-10-17T18:58:01.423Z" - fromAddr: - type: string - example: tbnb138u9djee6fwphhd2a3628q2h0j5w97yx48zqex - toAddr: - type: string - example: tbnb14wu3a8pmauj2kjswyvxtvhdrjktx60efq227uw - value: - type: string - example: "200.00000000" - txAsset: - type: string - example: BNB - txFee: - type: string - example: "0.00037500" - code: - type: number - example: 0 - memo: - type: string - example: "" - source: - type: number - example: 0 - sequence: - type: number - BnbTx: - type: object - properties: - code: - type: number - example: 0 - hash: - type: string - example: 4B944BBF78F3ADE3A377551B5EA7AD0FEDBDA13165D932F94B106EF7A8E16C1A - height: - type: string - example: "44925860" - log: - type: string - example: "Msg 0: " - ok: - type: boolean - example: true - tx: - properties: - type: - type: string - example: auth/StdTx - value: - properties: - memo: - type: string - example: "" - msg: - type: array - items: - type: object - properties: - type: - type: string - example: cosmos-sdk/Send - value: - properties: - inputs: - description: >- - List of transactions, from which assets are being - sent. - type: array - items: - type: object - properties: - address: - type: string - example: tbnb138u9djee6fwphhd2a3628q2h0j5w97yx48zqex - coins: - type: array - items: - type: object - properties: - amount: - type: string - example: "20000000000" - denom: - type: string - example: BNB - outputs: - description: >- - List of recipient addresses and amounts to send to - each of them. - type: array - items: - type: object - properties: - address: - type: string - example: tbnb14wu3a8pmauj2kjswyvxtvhdrjktx60efq227uw - coins: - type: array - items: - type: object - properties: - amount: - type: string - example: "20000000000" - denom: - type: string - example: BNB - type: object - signatures: - type: array - items: - type: object - properties: - account_number: - type: string - example: "14" - pub_key: - properties: - type: - type: string - example: tendermint/PubKeySecp256k1 - value: - type: string - example: A4q95eEn4cR1bbxVRqYc8pbLvKYyaMxjzaTSmkTJQUr6 - type: object - sequence: - type: string - example: "47816" - signature: - type: string - example: >- - VhewxOCPucjrtrpRbQMbl05i5MyJMrw12nUJ4ATssB1qvCqIO2+Fgqa/WTHaYpkhjJuIbpK620e0zpIQ56a5nw== - source: - type: string - example: "0" - type: object - type: object - BnbTxInAccount: - type: object - properties: - total: - type: number - example: 10 - tx: - type: array - items: - $ref: "#/components/schemas/BnbTransaction" - BnbAccount: - type: object - properties: - account_number: - type: number - example: 696215 - address: - type: string - example: tbnb185tqzq3j6y7yep85lncaz9qeectjxqe5054cgn - balances: - type: array - items: - type: object - properties: - free: - type: string - example: "207.00000000" - frozen: - type: string - example: "0.00000000" - locked: - type: string - example: "0.00000000" - symbol: - type: string - example: BNB - flags: - type: number - example: 0 - sequence: - type: number - example: 0 - BtcBlockHash: - type: object - properties: - hash: - type: string - description: Block hash - example: 0000000053f225e202cf27fe3046e06719efd3b31b5ab75fc5ef7f853c8b246f - BtcBlock: - type: object - properties: - hash: - type: string - description: Hash of block. - example: 00000000ca231a439a5c0a86a5a5dd6dc1918a8e897b96522fa9499288e70183 - height: - description: The number of blocks preceding a particular block on a block chain. - type: number - example: 15235 - depth: - description: >- - The number of blocks following a particular block on a block chain, - including current one. - type: number - example: 1567867 - version: - type: number - description: Block version. - example: 1 - prevBlock: - type: string - description: Hash of the previous block. - example: 000000006e79360d7b2519410fe5a73e8e08393fd7166620c73c711e4507d9fd - merkleRoot: - type: string - description: >- - The root node of a merkle tree, a descendant of all the hashed pairs - in the tree. - example: 480c227c5042377dbd54464d33e1f59c19fe02fe76d7f55b6955db438479aece - time: - type: number - description: Time of the block. - example: 1338861927 - bits: - type: number - example: 486604799 - nonce: - type: number - description: >- - Arbitrary number that is used in Bitcoin's proof of work consensus - algorithm. - example: 1193572362 - txs: - type: array - items: - $ref: "#/components/schemas/BtcTx" - BtcInfo: - type: object - properties: - chain: - type: string - description: Chain of the blockchain, main or test. - example: test - blocks: - type: number - description: Last block. - example: 1579820 - headers: - type: number - description: Last headers. - example: 1579820 - bestblockhash: - description: Hash of the last block. - type: string - example: 0000000000000106e4c03ca093ce0cf77e796ddff4f3cadc59ca6b0380e3eed4 - difficulty: - type: number - description: Difficulty of the algorithm. - example: 6522714.521250089 - BtcBasedBalance: - type: object - properties: - incoming: - type: string - description: >- - Total sum of the assets that arrives to the address. Both confirmed - transactions in the block and pending in the mempool are used for - calculating this value. - example: "0.1234" - outgoing: - type: string - description: >- - Total sum of the assets that leaves from the address. Both confirmed - transactions in the block and pending in the mempool are used for - calculating this value. - example: "0.1" - incomingPending: - type: string - description: >- - Total sum of the assets that arrives to the address and are pending - in the mempool. - example: "0.0004" - outgoingPending: - type: string - description: >- - Total sum of the assets that leaves from the address and are pending - in the mempool. - example: "0.05" - BtcTx: - type: object - properties: - hash: - type: string - description: Transaction hash. - example: 4c7846a8ff8415945e96937dea27bdb3144c15d793648d725602784826052586 - hex: - type: string - description: Transaction hex. - example: >- - 020000000001072840e4f49e088d9ab233f6209aede5d91c44ecb59f490dbf289e7ef5028bc6aa0000000000ffffffffada5ca08d78992fac3bd48e1ac197c2b4bbd98b349d706ba7dd38c7c3dceed940000000000ffffffff0265691f1374c79a164186b6290a6bdf785561dcf5e3c155599dbaa646e2f06e0000000000ffffffff4f0b53ff85e10ff33c3cf95a1b650729c83b75d6b894d8224b40ca00b944a3ff0000000000ffffffff30aa398d22fd3b60534389c926093863d560eaeca4c6f85454b5fa0222f96db30000000000ffffffff9c02daa47a879222fc7e9d3c0ec7158d4853d3cc4a4465001412e5fc0371e7470100000000ffffffff78bdc156966a07d09f9bdb45ccb2e21765657f806b7e2ab7b7bb9dad5d5b5bc30000000000ffffffff010c2845000000000016001490a446c7f165cfd99dd5dd87a6bb83a17fd9e9f1024730440220384fa3d7935db56a637cf6c662dfc6990957e2838afa5db29e7569c996ba24930220567d4ed8ec36a940d871bc26d292656690e55bd10567c823af2c6ffab9a7868f012103ccb40d87b4e847b970a9dd23c3d5078964213cf6a78257796d801316bb7bb60c0247304402206b6db0dd0dd158835618613b952056327113374a8dec6be5f41c41a8ce552fe2022027c356009488123c27c98aa66080f6898484b7c098dc366540be8f6935feeefe012103ccb40d87b4e847b970a9dd23c3d5078964213cf6a78257796d801316bb7bb60c0247304402200baf8a00f9f767cc83c35e3a29a03a4f054c886fc07828481b83ae858eb5853902202f6d82ef65f64ac5db1db947aa03e1ed5f3b19710cf4c3e4448cd5a7f25277df012103ccb40d87b4e847b970a9dd23c3d5078964213cf6a78257796d801316bb7bb60c02483045022100b7d574102ede6a4d556269129592faa8f7ff54ca846c2516804811e06aca380202206a0e519a911e3fe130f1d446f5fd16b951fd25136b2f9b2980dd9eefe4f3a860012103ccb40d87b4e847b970a9dd23c3d5078964213cf6a78257796d801316bb7bb60c02473044022008548dc3eff2713011d3fad3e661918f51cd4a3b688f90326f5febf4dbb34c8f0220245e37520b501a7c429f9428c4892034d398c8198006fedd9fdb45790c8d0d23012103ccb40d87b4e847b970a9dd23c3d5078964213cf6a78257796d801316bb7bb60c02473044022044bd3552b24b49b2c9bc2acee7a8d587407070cb80e7c65cdefff78fe7df0f99022067581ae9d54d2fdedb9bcf69c2281830e165f9df631f6c889f98dfb7c1e4a78a012103ccb40d87b4e847b970a9dd23c3d5078964213cf6a78257796d801316bb7bb60c02483045022100a141642697ba55407e4d6d2b6d3d1b2f93d5126794e77028c00307835a4c71ce02202658200b9d779d0f6f169bdd27dc81cbbb10718e57754349e57e020ea6bf5cfb012103ccb40d87b4e847b970a9dd23c3d5078964213cf6a78257796d801316bb7bb60c00000000 - witnessHash: - type: string - description: Witness hash in case of a SegWit transaction. - example: 4c7846a8ff8415945e96937dea27bdb3144c15d793648d725602784826052586 - fee: - type: number - description: Fee paid for this transaction, in satoshis. - example: 4540 - rate: - type: number - example: 20088 - mtime: - type: number - example: 1575663337 - blockNumber: - type: number - description: Height of the block this transaction belongs to. - example: 1611609 - block: - type: string - description: Hash of the block this transaction belongs to. - example: 00000000000001e13fe1eb3977f3379e3d0f6577fc6e087d27db46597ebddb8b - time: - type: number - description: Time of the transaction. - example: 1575663091 - index: - type: number - description: Index of the transaction in the block. - example: 1 - version: - type: number - description: Index of the transaction. - example: 2 - inputs: - description: List of transactions, from which assets are being sent. - type: array - items: - $ref: "#/components/schemas/BtcTxInput" - outputs: - type: array - description: List of recipient addresses and amounts to send to each of them. - items: - $ref: "#/components/schemas/BtcTxOutput" - locktime: - type: number - description: Block this transaction was included in. - example: 1611608 - BtcTxOutput: - type: object - properties: - value: - type: number - description: Sent amount in satoshis. - example: 2068942 - script: - type: string - description: Transaction script. - example: a914eaf2ad7e161c3ce7092bde14dc5842b642fe925187 - address: - type: string - description: Recipient address. - example: 2NEfWpiQwLEcHGbX2Fwij16NDxTEZwHk4BH - BtcTxInput: - type: object - properties: - prevout: - $ref: "#/components/schemas/BtcTxInputPrevOut" - script: - type: string - description: >- - Data generated by a spender which is almost always used as variables - to satisfy a pubkey script. - example: 1600148c65244f095f3689aebb70981d102e33036fe786 - witness: - type: string - description: Transaction witness. - example: >- - 0247304402207d7af97665ef5502c957f76a9fcdde2c228b6a8dc9951d45c318e6dfca0fcd2802207519528d6b61cc044800ab2cb499ef5f31d4decdc327c14fad4abbc3dd6e0190012102861d682cfd3bec8cbed98f5162299ba613bc5f352dd0d51961a5d81359fbc0af - sequence: - type: number - example: 4294967294 - coin: - $ref: "#/components/schemas/BtcTxInputCoin" - BtcTxInputCoin: - properties: - version: - type: number - example: 2 - blockNumber: - type: number - example: 1611608 - value: - type: number - description: >- - Amount of the transaction, in Satoshis (1 BTC = 100 000 000 - Satoshis) - example: 1341956178 - script: - type: string - example: 0014049a97d91d4e1123899bf48c5ba6ce3fd959664e - address: - type: string - description: Sender address. - example: tb1qqjdf0kgafcgj8zvm7jx9hfkw8lv4jejw6wsmjg - coinbase: - type: boolean - description: Coinbase transaction - miner fee. - example: false - type: object - BtcTxInputPrevOut: - properties: - hash: - type: string - description: Transaction hash of the input. - example: 60bc8445c11318e45a72a3259e65118d2f352568757e6ceb8bf1b527ce68379f - index: - type: number - description: Transaction index of the input. - example: 1 - type: object - BtcUTXO: - type: object - properties: - version: - type: number - description: The version of the transaction - example: 1 - height: - type: number - description: >- - The height (number) of the block where the transaction is included - in - example: 210000 - value: - type: number - description: The amount of the UTXO (in satoshis) - example: 30000000 - script: - type: string - description: >- - Data generated by the spender; is almost always used as variables to - satisfy the conditions in the pubkey script - example: 76a91400ba915c3d18907b79e6cfcd8b9fdf69edc7a7db88ac - address: - type: string - description: The blockchain address of the UTXO owner - example: R9M3aUWCcKoiqDPusJvqNkAbjffLgCqYip - coinbase: - type: boolean - description: >- - If set to "true", the transaction is a coinbase transaction (a - transaction created by a Bitcoin miner to collect their reward) - example: false - hash: - type: string - description: The hash of the transaction - example: 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - index: - type: number - description: The index of the transaction output checked for the UTXO - example: 0 - FeeAndChange: - type: object - required: - - changeAddress - properties: - changeAddress: - description: Address, where unspent funds will be transferred. - type: string - example: cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf - minimum: 30 - maximum: 110 - fee: - type: string - description: Fee to be paid. - example: "0.5" - AdaTransactionFromAddress: - type: object - required: - - to - - fromAddress - - fee - - changeAddress - properties: - fromAddress: - description: >- - The array of blockchain addresses to send the assets from and their - private keys. For each address, the last 100 transactions are - scanned for any UTXO to be included in the transaction. - type: array - items: - type: object - required: - - address - - privateKey - properties: - address: - description: The blockchain address to send the assets from - type: string - example: >- - addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - privateKey: - description: The private key of the address to send the assets from - type: string - minimum: 52 - maximum: 128 - example: >- - 38b75ee2a29049817b28633d700ea56602f87992bd4d78446053183d4374965622c5a90c347131936f2f317ae3e9416fbfed21096577cd9adbcff311e9680334 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in ADA). The difference - between the UTXOs calculated in thefromAddress
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: >- - addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - value: - description: The amount to receive (in ADA) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: number - description: The fee to be paid for the transaction (in ADA). - example: 0.0015 - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to. - type: string - example: addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - AdaTransactionFromUTXO: - type: object - required: - - to - - fromUTXO - - fee - - changeAddress - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - private keys of the associated blockchain addresses - type: array - items: - type: object - required: - - txHash - - index - - address - - amount - - privateKey - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - amount: - description: The amount of the UTXO to be spent, in ADA - type: number - example: 0 - minimum: 0 - maximum: 1.652 - privateKey: - description: >- - The private key of the blockchain address that holds the UTXO - to be spent - type: string - example: >- - 8873d5e84af86978f03b63d9ffc9c6f940bd8501d32e91980c904e8d81c305507dc95992faa5aefccb263b28b411eda2dde7882d922742663804a69d78182e34 - minLength: 128 - maxLength: 128 - address: - description: The address that holds the UTXO to be spent - type: string - example: >- - addr_test1vzfp68vn36ze5yz7x7evracmasuptjmz99qk4j23gun3pcqhlevq5 - minLength: 0 - maxLength: 128 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in ADA). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: >- - addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - value: - description: The amount to receive (in ADA) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: number - description: The fee to be paid for the transaction (in ADA). - example: 0.0015 - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee - type: string - example: addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - AdaTransactionFromAddressKMS: - type: object - required: - - to - - fromAddress - - fee - - changeAddress - properties: - fromAddress: - description: >- - The array of blockchain addresses to send the assets from and their - signature IDs. For each address, the last 100 transactions are - scanned for any UTXO to be included in the transaction. - type: array - items: - type: object - required: - - address - - signatureId - properties: - address: - description: The blockchain address to send the assets from - type: string - example: >- - addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the address to send - the assets from - index: - description: >- - (Only if the signature ID is mnemonic-based) The index of the - specific address from the mnemonic - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in ADA). The difference - between the UTXOs calculated in thefromAddress
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: >- - addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - value: - description: The amount to receive (in ADA) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: number - description: The fee to be paid for the transaction (in ADA). - example: 0.0015 - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to. - type: string - example: addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - AdaTransactionFromUTXOKMS: - type: object - required: - - to - - fromUTXO - - fee - - changeAddres - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - signature IDs of the associated blockchain addresses - type: array - items: - type: object - required: - - txHash - - signatureId - - index - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - amount: - description: The amount of the UTXO to be spent, in ADA - type: number - example: 0 - minimum: 0 - maximum: 1.652 - address: - description: The address that holds the UTXO to be spent - type: string - example: >- - addr_test1vzfp68vn36ze5yz7x7evracmasuptjmz99qk4j23gun3pcqhlevq5 - minLength: 0 - maxLength: 128 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the blockchain - address that holds the UTXO to be spent - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in ADA). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: >- - addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - value: - description: The amount to receive (in ADA) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: number - description: The fee to be paid for the transaction (in ADA). - example: 0.0015 - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee. - type: string - example: addr_test1vzdts2y4k47zwypzdh36azxx0w4v8tev6m6svtz9fud0emgchuswu - minimum: 30 - maximum: 128 - BtcTransactionFromAddress: - type: object - required: - - to - - fromAddress - properties: - fromAddress: - description: >- - The array of blockchain addresses to send the assets from and their - private keys. For each address, the last 100 transactions are - scanned for any UTXO to be included in the transaction. - type: array - items: - $ref: "#/components/schemas/BtcTransactionFromAddressSource" - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in BTC). The difference - between the UTXOs calculated in thefromAddress
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - $ref: "#/components/schemas/BtcTransactionFromAddressTarget" - fee: - type: string - description: >- - The fee to be paid for the transaction (in BTC); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to; if you are using this parameter, you have to - also use thefee
parameter because these two parameters - only work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - BtcTransactionFromAddressSource: - type: object - required: - - address - - privateKey - properties: - address: - description: The blockchain address to send the assets from - type: string - example: 2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS - minimum: 30 - maximum: 50 - privateKey: - description: The private key of the address to send the assets from - type: string - minimum: 52 - maximum: 52 - example: cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf - BtcTransactionFromAddressTarget: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in BTC) - type: number - minimum: 0 - example: 0.02969944 - BtcTransactionFromUTXO: - type: object - required: - - to - - fromUTXO - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - private keys of the associated blockchain addresses - type: array - items: - $ref: "#/components/schemas/BtcTransactionFromUTXOSource" - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in BTC). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - $ref: "#/components/schemas/BtcTransactionFromUTXOTarget" - fee: - type: string - description: >- - The fee to be paid for the transaction (in BTC); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaining after - covering the fee; if you are using this parameter, you have to also - use thefee
parameter because these two parameters only - work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - BtcTransactionFromUTXOSource: - type: object - required: - - txHash - - index - - privateKey - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - privateKey: - description: >- - The private key of the blockchain address that holds the UTXO to be - spent - type: string - example: cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf - minLength: 52 - maxLength: 52 - BtcTransactionFromUTXOTarget: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in BTC) - type: number - minimum: 0 - example: 0.02969944 - BtcTransactionFromAddressKMS: - type: object - required: - - to - - fromAddress - properties: - fromAddress: - description: >- - The array of blockchain addresses to send the assets from and their - signature IDs. For each address, the last 100 transactions are - scanned for any UTXO to be included in the transaction. - type: array - items: - $ref: "#/components/schemas/BtcTransactionFromAddressKMSSource" - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in BTC). The difference - between the UTXOs calculated in thefromAddress
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - $ref: "#/components/schemas/BtcTransactionFromAddressKMSTarget" - fee: - type: string - description: >- - The fee to be paid for the transaction (in BTC); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to; if you are using this parameter, you have to - also use thefee
parameter because these two parameters - only work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - BtcTransactionFromAddressKMSSource: - type: object - required: - - address - - signatureId - properties: - address: - description: The blockchain address to send the assets from - type: string - example: 2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS - minimum: 30 - maximum: 50 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the address to send the - assets from - index: - description: >- - (Only if the signature ID is mnemonic-based and you run KMS v6.2 or - later) The index of the address to send the assets from that was - generated from the mnemonic - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - BtcTransactionFromAddressKMSTarget: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in BTC) - type: number - minimum: 0 - example: 0.02969944 - BtcTransactionFromUTXOKMS: - type: object - required: - - to - - fromUTXO - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - signature IDs of the associated blockchain addresses - type: array - items: - $ref: "#/components/schemas/BtcTransactionFromUTXOKMSSource" - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in BTC). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - $ref: "#/components/schemas/BtcTransactionFromUTXOKMSTarget" - fee: - type: string - description: >- - The fee to be paid for the transaction (in BTC); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee; if you are using this parameter, you have to also - use thefee
parameter because these two parameters only - work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - BtcTransactionFromUTXOKMSSource: - type: object - required: - - txHash - - signatureId - - index - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the blockchain address that - holds the UTXO to be spent - signatureIdIndex: - description: >- - Index of the address in the wallet. Required when signatureId - represents the mnenomic. - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - BtcTransactionFromUTXOKMSTarget: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in BTC) - type: number - minimum: 0 - example: 0.02969944 - BchBlock: - type: object - properties: - hash: - type: string - description: Hash of block. - example: 000000000000000005e14d3f9fdfb70745308706615cfa9edca4f4558332b201 - size: - type: number - description: Block size. - example: 81577 - height: - type: number - description: The number of blocks preceding a particular block on a block chain. - example: 500000 - version: - type: number - description: Block version. - example: 536870912 - merkleroot: - type: string - description: >- - The root node of a merkle tree, a descendant of all the hashed pairs - in the tree. - example: 4af279645e1b337e655ae3286fc2ca09f58eb01efa6ab27adedd1e9e6ec19091 - tx: - type: array - description: List of transactions present in the block. - items: - $ref: "#/components/schemas/BchTx" - time: - type: number - description: Time of the block. - example: 1509343584 - nonce: - type: number - description: >- - Arbitrary number that is used in Bitcoin's proof of work consensus - algorithm. - example: 3604508752 - difficulty: - type: number - example: 113081236211.45331 - confirmations: - type: number - description: Number of blocks mined after this block. - example: 109602 - previousblockhash: - type: string - description: Hash of the previous block. - example: 0000000000000000043831d6ebb013716f0580287ee5e5687e27d0ed72e6e523 - nextblockhash: - type: string - description: Hash of the next block. - example: 00000000000000000568f0a96bf4348847bc84e455cbfec389f27311037a20f3 - BchInfo: - type: object - properties: - chain: - type: string - description: Chain of the blockchain, main or test. - example: main - blocks: - type: number - description: Last block. - example: 609604 - bestblockhash: - type: string - description: Hash of the last block. - example: 0000000000000000024997c878c5a90bd73cd50060877c4f70eef1f2e92243f5 - difficulty: - type: number - description: Difficulty of the PoW algorithm. - example: 375206303347.133 - BchTransaction: - type: object - required: - - to - - fromUTXO - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - private keys of the associated blockchain addresses - type: array - items: - type: object - required: - - txHash - - index - - privateKey - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - privateKey: - description: >- - The private key of the blockchain address that holds the UTXO - to be spent - type: string - example: cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf - minLength: 52 - maxLength: 52 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in BCH). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in BCH) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in BCH); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee; if you are using this parameter, you have to also - use thefee
parameter because these two parameters only - work together. - type: string - example: bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez - minimum: 30 - maximum: 60 - BchTransactionKMS: - type: object - required: - - to - - fromUTXO - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - signature IDs of the associated blockchain addresses - type: array - items: - type: object - required: - - txHash - - index - - signatureId - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the blockchain - address that holds the UTXO to be spent - signatureIdIndex: - description: >- - Index of the address in the wallet. Required when signatureId - represents the mnenomic. - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in BCH). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in BCH) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in BCH); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee; if you are using this parameter, you have to also - use thefee
parameter because these two parameters only - work together. - type: string - example: bitcoincash:qrd9khmeg4nqag3h5gzu8vjt537pm7le85lcauzez - minimum: 30 - maximum: 60 - BchTx: - type: object - properties: - txid: - type: string - example: fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33 - version: - type: number - example: 1 - locktime: - type: number - example: 0 - vin: - type: array - items: - type: object - properties: - txid: - type: string - example: >- - eea57285462dd70dadcd431fc814857b3f81fe4d0a059a8c02c12fd7d33c02d1 - vout: - type: number - example: 0 - scriptSig: - properties: - hex: - type: string - example: >- - 48304502210083753ff9954579f1062d60905650d5d07f50dedc96f9425403b80957f199e1ee022053625597b069c48ed29f8825bd3c8f66757ccaa21a7bb49314eae4eca1fb8d7041210299b1eedeb115b5880cd5e0df0717bd982748a8e003e34371dc36301e17ee0ed6 - asm: - type: string - example: >- - 304502210083753ff9954579f1062d60905650d5d07f50dedc96f9425403b80957f199e1ee022053625597b069c48ed29f8825bd3c8f66757ccaa21a7bb49314eae4eca1fb8d70[ALL|FORKID] - 0299b1eedeb115b5880cd5e0df0717bd982748a8e003e34371dc36301e17ee0ed6 - type: object - coinbase: - type: string - example: 04ffff001d02fd04 - sequence: - type: number - example: 2147483647 - vout: - type: array - items: - type: object - properties: - value: - type: number - example: 50 - "n": - type: number - example: 0 - scriptPubKey: - properties: - hex: - type: string - example: >- - 4104f5eeb2b10c944c6b9fbcfff94c35bdeecd93df977882babc7f3a2cf7f5c81d3b09a68db7f0e04f21de5d4230e75e6dbe7ad16eefe0d4325a62067dc6f369446aac - asm: - type: string - example: >- - 04f5eeb2b10c944c6b9fbcfff94c35bdeecd93df977882babc7f3a2cf7f5c81d3b09a68db7f0e04f21de5d4230e75e6dbe7ad16eefe0d4325a62067dc6f369446a - OP_CHECKSIG - addresses: - type: array - items: - type: string - example: - - 1BW18n7MfpU35q4MTBSk8pse3XzQF8XvzT - type: - type: string - example: pubkeyhash - type: object - DogeInfo: - type: object - properties: - chain: - type: string - description: Chain of the blockchain, main or test. - example: test - blocks: - type: number - description: Last block. - example: 1234314 - headers: - type: number - description: Last headers. - example: 1234314 - bestblockhash: - type: string - description: Hash of the last block. - example: 6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078 - difficulty: - type: number - description: Difficulty of the PoW algorithm. - example: 0.0018856935093586335 - DogeBlock: - type: object - properties: - hash: - type: string - description: Hash of block. - example: 6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078 - height: - type: number - description: The number of blocks preceding a particular block on a block chain. - example: 1234314 - size: - type: number - description: The size of the block. - example: 1234314 - confirmations: - type: number - description: Number of confirmations of that block. - example: 1234314 - weight: - type: number - description: The weight of the block. - example: 1234314 - version: - type: number - example: 536870912 - description: Block version. - previousblockhash: - type: string - description: Hash of the previous block. - example: a3047a060e5d586a9b26779ebe62fc57ce7323745da8f28761ab755454d89c52 - merkleRoot: - type: string - description: >- - The root node of a merkle tree, a descendant of all the hashed pairs - in the tree. - example: a1634a42a8e956a5fb5225d06c3af6207e7f6fe5a00fa45229edfd0ddfa587f0 - time: - type: number - description: Time of the block. - example: 1572865501 - bits: - type: number - example: 503452237 - nonce: - type: number - description: >- - Arbitrary number that is used in Litecoin's proof of work consensus - algorithm. - example: 2278594841 - txs: - type: array - items: - $ref: "#/components/schemas/DogeTx" - DogeTx: - type: object - properties: - hash: - type: string - description: Transaction hash. - example: 5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a - size: - type: number - description: Size of the transaction. - example: 145 - vsize: - type: number - example: 145 - version: - type: number - description: Index of the transaction. - example: 2 - vin: - description: List of transactions, from which assets are being sent. - type: array - items: - type: object - properties: - txid: - type: string - description: Transaction hash of the input. - example: >- - 0db5a2881f26f7dce20222f9c2538dc296ab562e134a72052596bdf4bb6913b4 - vout: - type: number - description: Transaction index of the input. - example: 1 - scriptSig: - type: object - properties: - asm: - type: string - hex: - type: string - sequence: - type: number - example: 4294967294 - vout: - description: List of recipient addresses and amounts to send to each of them. - type: array - items: - type: object - properties: - value: - type: number - description: Amount of UTXO in 1/1000000 DOGE. - example: 1000 - "n": - type: number - description: Transaction index of the output. - example: 1 - scriptPubKey: - type: object - properties: - asm: - type: string - example: >- - OP_HASH160 905c261d73922a21a16f505cefccaa07aaee50cd - OP_EQUAL - hex: - type: string - example: a914905c261d73922a21a16f505cefccaa07aaee50cd87 - type: - type: string - example: scripthash - addresses: - type: array - items: - type: string - description: Recipient address. - example: n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or - locktime: - type: number - example: 1233222 - DogeUTXO: - type: object - properties: - scriptPubKey: - type: object - properties: - asm: - type: string - example: OP_HASH160 905c261d73922a21a16f505cefccaa07aaee50cd OP_EQUAL - hex: - type: string - example: a914905c261d73922a21a16f505cefccaa07aaee50cd87 - type: - type: string - example: scripthash - addresses: - type: array - items: - type: string - description: Recipient address. - example: n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or - version: - type: number - description: The version of the transaction - example: 2 - height: - type: number - description: >- - The height (number) of the block where the transaction is included - in - example: 1233224 - value: - type: number - description: The amount of the UTXO (in 1/1000000 DOGE) - example: 1000 - coinbase: - type: boolean - description: >- - If set to "true", the transaction is a coinbase transaction (a - transaction created by a Bitcoin miner to collect their reward) - example: false - bestblock: - type: string - description: The block hash - example: 5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a - DogeTransactionUTXOKMS: - type: object - required: - - to - - fromUTXO - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - signature IDs of the associated blockchain addresses - type: array - items: - type: object - required: - - txHash - - value - - address - - index - - signatureId - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - value: - type: string - description: The amount to send (in DOGE) - example: "0.0015" - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the blockchain - address that holds the UTXO to be spent - signatureIdIndex: - description: >- - Index of the address in the wallet. Required when signatureId - represents the mnenomic. - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in DOGE). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in DOGE) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in DOGE); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee; if you are using this parameter, you have to also - use thefee
parameter because these two parameters only - work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - DogeTransactionUTXO: - type: object - required: - - to - - fromUTXO - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - private keys of the associated blockchain addresses - type: array - items: - type: object - required: - - txHash - - index - - privateKey - - value - - address - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - value: - type: string - description: The amount to send (in DOGE) - example: "0.0015" - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - privateKey: - description: >- - The private key of the blockchain address that holds the UTXO - to be spent - type: string - example: cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf - minLength: 52 - maxLength: 52 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in DOGE). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in DOGE) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in DOGE); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to; if you are using this parameter, you have to - also use thefee
parameter because these two parameters - only work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - DogeTransactionAddress: - type: object - required: - - to - - fromAddress - properties: - fromAddress: - description: >- - The array of blockchain addresses to send the assets from and their - private keys. For each address, the last 100 transactions are - scanned for any UTXO to be included in the transaction. - type: array - items: - type: object - required: - - privateKey - - address - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - privateKey: - description: >- - The private key of the blockchain address that holds the UTXO - to be spent - type: string - example: cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf - minLength: 52 - maxLength: 52 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in DOGE). The difference - between the UTXOs calculated in thefromAddress
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in DOGE) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in DOGE); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to; if you are using this parameter, you have to - also use thefee
parameter because these two parameters - only work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - DogeTransactionAddressKMS: - type: object - required: - - to - - fromAddress - properties: - fromAddress: - description: >- - The array of blockchain addresses to send the assets from and their - private keys. For each address, the last 100 transactions are - scanned for any UTXO to be included in the transaction. - type: array - items: - type: object - required: - - signatureId - - address - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the address to send - the assets from - index: - description: >- - (Only if the signature ID is mnemonic-based and you run KMS - v6.2 or later) The index of the address to send the assets - from that was generated from the mnemonic - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in DOGE). The difference - between the UTXOs calculated in thefromAddress
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in DOGE) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in DOGE); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to; if you are using this parameter, you have to - also use thefee
parameter because these two parameters - only work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - LtcInfo: - type: object - properties: - chain: - type: string - description: Chain of the blockchain, main or test. - example: test - blocks: - type: number - description: Last block. - example: 1234314 - headers: - type: number - description: Last headers. - example: 1234314 - bestblockhash: - type: string - description: Hash of the last block. - example: 6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078 - difficulty: - type: number - description: Difficulty of the PoW algorithm. - example: 0.0018856935093586335 - LtcBlock: - type: object - properties: - hash: - type: string - description: Hash of block. - example: 6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078 - blockNumber: - type: number - description: The number of blocks preceding a particular block on a block chain. - example: 1234314 - version: - type: number - example: 536870912 - description: Block version. - prevBlock: - type: string - description: Hash of the previous block. - example: a3047a060e5d586a9b26779ebe62fc57ce7323745da8f28761ab755454d89c52 - merkleRoot: - type: string - description: >- - The root node of a merkle tree, a descendant of all the hashed pairs - in the tree. - example: a1634a42a8e956a5fb5225d06c3af6207e7f6fe5a00fa45229edfd0ddfa587f0 - time: - type: number - description: Time of the block. - example: 1572865501 - bits: - type: number - example: 503452237 - nonce: - type: number - description: >- - Arbitrary number that is used in Litecoin's proof of work consensus - algorithm. - example: 2278594841 - txs: - type: array - items: - $ref: "#/components/schemas/LtcTx" - LtcTx: - type: object - properties: - hash: - type: string - description: Transaction hash. - example: 5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a - witnessHash: - type: string - description: Witness hash in case of a SegWit transaction. - example: d819688a3ac77cb6d2751808e5411baf7e20fa3eeeccf65867554a09beddd9a3 - fee: - type: string - description: Fee paid for this transaction, in LTC. - example: "0.00001682" - rate: - type: string - example: "0.00010011" - ps: - type: number - example: 1572703011 - blockNumber: - type: number - description: Height of the block this transaction belongs to. - example: 1233224 - block: - type: string - description: Hash of the block this transaction belongs to. - example: b540bf37450eae0fb9fb7f190009ca890f0dd17cb19521c6241a0dc5e70f67dc - time: - type: number - description: Time of the transaction. - example: 1572694484 - index: - type: number - description: Index of the transaction in the block. - example: 2 - version: - type: number - description: Index of the transaction. - example: 2 - flag: - type: number - example: 1 - inputs: - description: List of transactions, from which assets are being sent. - type: array - items: - type: object - properties: - prevout: - properties: - hash: - type: string - description: Transaction hash of the input. - example: >- - 0db5a2881f26f7dce20222f9c2538dc296ab562e134a72052596bdf4bb6913b4 - index: - type: number - description: Transaction index of the input. - example: 1 - type: object - script: - type: string - description: >- - Data generated by a spender which is almost always used as - variables to satisfy a pubkey script. - example: 1600148c65244f095f3689aebb70981d102e33036fe786 - witness: - type: string - description: Transaction witness. - example: >- - 0247304402202cad8f03fd061fbdd19d285f528dd7451c3818f4a1d0f5f9f559f141fb910c6e02203fb62fc770cf54ae53e4b488b589f9f096d28c1bd24dc8e4d80783dd58041826012102c44d21e840b24c786a7eff2980e35f51c4abcc9a032e7a132ca258f90ee4a19d - sequence: - type: number - example: 4294967294 - coin: - properties: - version: - type: number - example: 2 - height: - type: number - example: 1232869 - value: - type: string - description: Value of the transaction, in LTC. - example: "0.0989946" - script: - type: string - example: a91472593295cfe5e7ea466e43822167cabcb2cb103387 - address: - type: string - description: Sender address. - example: 2N3fqsiA5Nk4pZGWcfZApATGhXfn9B74oXK - coinbase: - type: boolean - description: Coinbase transaction - miner fee. - example: false - type: object - outputs: - description: List of recipient addresses and amounts to send to each of them. - type: array - items: - type: object - properties: - value: - type: string - description: Sent amount in LTC. - example: "0.0015" - script: - type: string - description: Transaction script. - example: 76a914fc8f50c952da910f473a0533561311ad140c989b88ac - address: - type: string - description: Recipient address. - example: n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or - locktime: - type: number - description: Block this transaction was included in. - example: 1233222 - DogeTxByAddress: - type: object - properties: - hash: - type: string - description: Transaction hash. - example: 5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a - witnessHash: - type: string - description: Witness hash in case of a SegWit transaction. - example: d819688a3ac77cb6d2751808e5411baf7e20fa3eeeccf65867554a09beddd9a3 - fee: - type: string - description: Fee paid for this transaction, in DOGE. - example: "0.00001682" - rate: - type: string - example: "0.00010011" - ps: - type: number - example: 1572703011 - blockNumber: - type: number - description: Height of the block this transaction belongs to. - example: 1233224 - block: - type: string - description: Hash of the block this transaction belongs to. - example: b540bf37450eae0fb9fb7f190009ca890f0dd17cb19521c6241a0dc5e70f67dc - time: - type: number - description: Time of the transaction. - example: 1572694484 - index: - type: number - description: Index of the transaction in the block. - example: 2 - version: - type: number - description: Index of the transaction. - example: 2 - flag: - type: number - example: 1 - inputs: - description: List of transactions, from which assets are being sent. - type: array - items: - type: object - properties: - prevout: - properties: - hash: - type: string - description: Transaction hash of the input. - example: >- - 0db5a2881f26f7dce20222f9c2538dc296ab562e134a72052596bdf4bb6913b4 - index: - type: number - description: Transaction index of the input. - example: 1 - type: object - script: - type: string - description: >- - Data generated by a spender which is almost always used as - variables to satisfy a pubkey script. - example: 1600148c65244f095f3689aebb70981d102e33036fe786 - witness: - type: string - description: Transaction witness. - example: >- - 0247304402202cad8f03fd061fbdd19d285f528dd7451c3818f4a1d0f5f9f559f141fb910c6e02203fb62fc770cf54ae53e4b488b589f9f096d28c1bd24dc8e4d80783dd58041826012102c44d21e840b24c786a7eff2980e35f51c4abcc9a032e7a132ca258f90ee4a19d - sequence: - type: number - example: 4294967294 - coin: - properties: - version: - type: number - example: 2 - height: - type: number - example: 1232869 - value: - type: string - description: Value of the transaction, in DOGE. - example: "0.0989946" - script: - type: string - example: a91472593295cfe5e7ea466e43822167cabcb2cb103387 - address: - type: string - description: Sender address. - example: 2N3fqsiA5Nk4pZGWcfZApATGhXfn9B74oXK - coinbase: - type: boolean - description: Coinbase transaction - miner fee. - example: false - type: object - outputs: - description: List of recipient addresses and amounts to send to each of them. - type: array - items: - type: object - properties: - value: - type: string - description: Sent amount in DOGE. - example: "0.0015" - script: - type: string - description: Transaction script. - example: 76a914fc8f50c952da910f473a0533561311ad140c989b88ac - address: - type: string - description: Recipient address. - example: n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or - locktime: - type: number - description: Block this transaction was included in. - example: 1233222 - LtcUTXO: - type: object - properties: - version: - type: number - description: The version of the transaction - example: 2 - height: - type: number - description: >- - The height (number) of the block where the transaction is included - in - example: 1233224 - value: - type: number - description: The amount of the UTXO - example: 30000000 - script: - type: string - description: >- - Data generated by the spender; is almost always used as variables to - satisfy the conditions in the pubkey script - example: 76a914fc8f50c952da910f473a0533561311ad140c989b88ac - address: - type: string - description: The blockchain address of the UTXO owner - example: n4YNG8q5JyxkeWf7zMi1bMyRZbRKK1W7or - coinbase: - type: boolean - description: >- - If set to "true", the transaction is a coinbase transaction (a - transaction created by a Bitcoin miner to collect their reward) - example: false - hash: - type: string - description: The hash of the transaction - example: 5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a - index: - type: number - description: The index of the transaction output checked for the UTXO - example: 0 - LtcTransactionAddress: - type: object - required: - - to - - fromAddress - properties: - fromAddress: - description: >- - The array of blockchain addresses to send the assets from and their - private keys. For each address, the last 100 transactions are - scanned for any UTXO to be included in the transaction. - type: array - items: - type: object - required: - - address - - privateKey - properties: - address: - description: The blockchain address to send the assets from - type: string - minimum: 30 - maximum: 50 - example: 2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS - privateKey: - description: The private key of the address to send the assets from - type: string - minimum: 52 - maximum: 52 - example: cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in LTC). The difference - between the UTXOs calculated in thefromAddress
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in LTC) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in LTC); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to; if you are using this parameter, you have to - also use thefee
parameter because these two parameters - only work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - LtcTransactionUTXO: - type: object - required: - - to - - fromUTXO - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - private keys of the associated blockchain addresses - type: array - items: - type: object - required: - - txHash - - index - - privateKey - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - privateKey: - description: >- - The private key of the blockchain address that holds the UTXO - to be spent - type: string - example: cVX7YtgL5muLTPncHFhP95oitV1mqUUA5VeSn8HeCRJbPqipzobf - minLength: 52 - maxLength: 52 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in LTC). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in LTC) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in LTC); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee; if you are using this parameter, you have to also - use thefee
parameter because these two parameters only - work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - LtcTransactionAddressKMS: - type: object - required: - - to - - fromAddress - properties: - fromAddress: - description: >- - The array of blockchain addresses to send the assets from and their - signature IDs. For each address, the last 100 transactions are - scanned for any UTXO to be included in the transaction. - type: array - items: - type: object - required: - - address - - signatureId - properties: - address: - description: The blockchain address to send the assets from - type: string - minimum: 30 - maximum: 50 - example: 2N9bBiH2qrTDrPCzrNhaFGdkNKS86PJAAAS - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the address to send - the assets from - index: - description: >- - (Only if the signature ID is mnemonic-based and you run KMS - v6.2 or later) The index of the address to send the assets - from that was generated from the mnemonic - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in LTC). The difference - between the UTXOs calculated in thefromAddress
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in LTC) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in LTC); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee to; if you are using this parameter, you have to - also use thefee
parameter because these two parameters - only work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - LtcTransactionUTXOKMS: - type: object - required: - - to - - fromUTXO - properties: - fromUTXO: - description: >- - The array of transaction hashes, indexes of its UTXOs, and the - signature IDs of the associated blockchain addresses - type: array - items: - type: object - required: - - txHash - - index - - signatureId - properties: - txHash: - description: The transaction hash of the UTXO to be spent - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: The index of the UTXO to be spent - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - The KMS identifier of the private key of the blockchain - address that holds the UTXO to be spent - signatureIdIndex: - description: >- - Index of the address in the wallet. Required when signatureId - represents the mnenomic. - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - to: - description: >- - The array of blockchain addresses to send the assets to and the - amounts that each address should receive (in LTC). The difference - between the UTXOs calculated in thefromUTXO
section - and the total amount to receive calculated in theto
- section will be used as the gas fee. To explicitly specify the fee - amount and the blockchain address where any extra funds remaining - after covering the fee will be sent, set thefee
and -changeAddress
parameters. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: The blockchain address to receive the assets - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - value: - description: The amount to receive (in LTC) - type: number - minimum: 0 - example: 0.02969944 - fee: - type: string - description: >- - The fee to be paid for the transaction (in LTC); if you are using - this parameter, you have to also use thechangeAddress
- parameter because these two parameters only work together. - example: "0.0015" - changeAddress: - description: >- - The blockchain address to send any extra assets remaning after - covering the fee; if you are using this parameter, you have to also - use thefee
parameter because these two parameters only - work together. - type: string - example: 2MzNGwuKvMEvKMQogtgzSqJcH2UW3Tc5oc7 - minimum: 30 - maximum: 60 - AdaBlock: - type: object - properties: - hash: - type: string - description: Hash of block. - example: 6178dda07b94becb118f67b21aa72f60d85c1029e9e9b8ae56a25d684de66078 - number: - type: number - description: The number of blocks preceding a particular block on a block chain. - example: 1234314 - epochNo: - type: number - example: 536870912 - description: Number of the epoch the block is included in. - slotNo: - type: number - description: Number of the slot the block is included in. - example: a3047a060e5d586a9b26779ebe62fc57ce7323745da8f28761ab755454d89c52 - forgedAt: - type: string - description: Time of the block. - example: "2020-10-20T08:21:50.107Z" - transactions: - type: array - items: - $ref: "#/components/schemas/AdaTx" - AdaTx: - type: object - properties: - hash: - type: string - description: Transaction hash. - example: 5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a - fee: - type: string - description: Fee paid for this transaction, in ADA. - example: "0.00001682" - block: - type: object - properties: - number: - type: number - description: Index of the block this transaction belongs to. - example: 1233224 - hash: - type: string - description: Block hash. - example: 5f83d51c8d3054012cea3011fa626b85d89442788721afd60719ab1f9ab8f78a - inputs: - description: List of transactions, from which assets are being sent. - type: array - items: - type: object - properties: - txHash: - type: string - description: Transaction hash of the input. - example: >- - 0db5a2881f26f7dce20222f9c2538dc296ab562e134a72052596bdf4bb6913b4 - value: - type: string - description: Value of the transaction, in Lovelace - 1/1000000 of ADA. - example: "989946" - address: - type: string - description: Sender address. - example: >- - addr1qxm3vd0msv9ph8elhy7xrv975z88y6lr3d8vdgy3fwr2e22uvu2ffa2ctx3pdl4rjjja5p7al2k356x5yx8cn03am88s2807d9 - outputs: - description: List of recipient addresses and amounts to send to each of them. - type: array - items: - $ref: "#/components/schemas/AdaUTXO" - AdaUTXO: - type: object - properties: - value: - type: string - description: Sent amount in ADA. - example: "1.5" - index: - type: number - description: Index of the output in the transaction. - example: 1 - txHash: - type: string - description: Transaction hash. - example: 76a914fc8f50c952da910f473a0533561311ad140c989b88ac - address: - type: string - description: Recipient address. - example: >- - addr1qxm3vd0msv9ph8elhy7xrv975z88y6lr3d8vdgy3fwr2e22uvu2ffa2ctx3pdl4rjjja5p7al2k356x5yx8cn03am88s2807d9 - AdaAccountBalance: - type: array - items: - type: object - properties: - currency: - type: object - properties: - symbol: - type: string - description: Name of the asset. - decimals: - type: number - description: Number of decimal places. - value: - type: string - description: Quantity of the asset. - AdaTransaction: - type: object - required: - - to - properties: - fromAddress: - description: >- - Array of addresses and corresponding private keys. Tatum will - automatically scan last unspent transactions for each address and - will use all of the unspent values. We advise to use this option if - you have 1 address per 1 transaction only. - type: array - items: - type: object - required: - - address - properties: - address: - description: Address to send assets from. - type: string - minimum: 30 - maximum: 150 - example: >- - addr1qxm3vd0msv9ph8elhy7xrv975z88y6lr3d8vdgy3fwr2e22uvu2ffa2ctx3pdl4rjjja5p7al2k356x5yx8cn03am88s2807d9 - privateKey: - description: >- - Private key of the address to send assets from. Private key, - or signature Id must be present. - type: string - minimum: 192 - maximum: 192 - example: >- - 7808a501e1bbc9926ac8ac6981e47cb0401288ae331a1f2333d1bed46c5b3051b5f875c39477b05bc3a43a3800b763f616ae3646f21df0ab5d95db944e71f5cfa8082d5c4e6241d49b17b2b6173f01bb3fd03be012cc8908ceea9e559e33e4fc - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - Identifier of the private key associated in signing - application. Private key, or signature Id must be present. - fromUTXO: - description: >- - Array of transaction hashes, index of UTXO in it and corresponding - private keys. Use this option if you want to calculate amount to - send manually. Either fromUTXO or fromAddress must be present. - type: array - items: - type: object - required: - - txHash - - index - properties: - txHash: - description: Transaction hash of the UTXO to be spent. - type: string - example: >- - 53faa103e8217e1520f5149a4e8c84aeb58e55bdab11164a95e69a8ca50f8fcc - minLength: 64 - maxLength: 64 - index: - description: Index of the UTXO to be spent. - type: number - example: 0 - minimum: 0 - maximum: 2147483647 - privateKey: - description: >- - Private key of the UTXO to be spent. Private key, or signature - Id must be present. - type: string - example: >- - 7808a501e1bbc9926ac8ac6981e47cb0401288ae331a1f2333d1bed46c5b3051b5f875c39477b05bc3a43a3800b763f616ae3646f21df0ab5d95db944e71f5cfa8082d5c4e6241d49b17b2b6173f01bb3fd03be012cc8908ceea9e559e33e4fc - minLength: 192 - maxLength: 192 - signatureId: - type: string - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - description: >- - Identifier of the private key associated in signing - application. Private key, or signature Id must be present. - to: - description: >- - Array of addresses and values to send Litecoins to. Values must be - set in LTC. Difference between from and to is transaction fee. - type: array - items: - type: object - required: - - address - - value - properties: - address: - description: Destination address. - type: string - example: >- - addr1qxm3vd0msv9ph8elhy7xrv975z88y6lr3d8vdgy3fwr2e22uvu2ffa2ctx3pdl4rjjja5p7al2k356x5yx8cn03am88s2807d9 - minimum: 30 - maximum: 150 - value: - description: Amount to be sent, in ADA. - type: number - minimum: 0 - example: 0.029609 - AdaInfo: - type: object - properties: - testnet: - type: string - description: Chain of the blockchain, main or test. - example: test - tip: - type: object - properties: - number: - type: number - description: Last block. - example: 2749845 - slotNo: - type: number - description: Last slot number. - example: 31798572 - epoch: - type: object - properties: - number: - type: number - description: Last epoch number. - example: 143 - Blockage: - properties: - id: - description: The ID of the blockage - type: string - example: 5e68c66581f2ee32bc354087 - accountId: - description: The ID of the account where the amount is blocked - type: string - example: 5e68c66581f2ee32bc354087 - amount: - description: The amount blocked on the account - example: "5" - type: string - type: - description: The type of the blockage - type: string - example: DEBIT_CARD_OP - description: - description: The description of the blockage - type: string - example: Card payment in the shop. - BlockAmount: - properties: - amount: - description: The amount to be blocked on the account - maxLength: 38 - pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$ - example: "5" - type: string - type: - description: >- - The type of the blockage that you are applying; can be a code or an - identifier from an external system or a short description of the - blockage - type: string - minLength: 1 - maxLength: 100 - example: DEBIT_CARD_OP - description: - description: The description of the blockage that you are applying - type: string - minLength: 1 - maxLength: 300 - example: Card payment in the shop. - required: - - amount - - type - type: object - BroadcastKMS: - properties: - txData: - description: Raw signed transaction to be published to network. - example: 62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D - maxLength: 500000 - minLength: 1 - type: string - signatureId: - description: >- - ID of prepared payment template to sign. Required only, when - broadcasting transaction signed by Tatum KMS. - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - type: string - index: - description: >- - (Only if the signature ID is mnemonic-based and you run KMS v6.2 or - later) The index of the address to send the assets from that was - generated from the mnemonic - type: number - minimum: 0 - maximum: 2147483647 - required: - - txData - type: object - HmacWebHook: - properties: - hmacSecret: - description: >- - Your HMAC secret password, which is used for signing the webhook - payload. - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - type: string - maxLength: 100 - required: - - hmacSecret - type: object - Broadcast: - properties: - txData: - description: Raw signed transaction to be published to network. - example: 62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D - maxLength: 500000 - minLength: 1 - type: string - signatureId: - type: string - minLength: 24 - maxLength: 24 - example: 5e68c66581f2ee32bc354087 - description: >- - Identifier of KMS pending transaction ID to be completed with the - broadcast. - required: - - txData - type: object - BroadcastResponse: - properties: - completed: - description: Flag, if withdrawal is successfully completed within Tatum systems. - example: true - type: boolean - txId: - description: Transaction ID of broadcast transaction and status - example: 62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D - type: string - type: object - BroadcastWithdrawal: - properties: - currency: - description: >- - Currency of signed transaction to be broadcast, BTC, LTC, DOGE, BNB, - XLM, TRX, BCH, ETH, XRP, ERC20, TRC20 - example: BTC - maxLength: 40 - minLength: 2 - type: string - txData: - description: Raw signed transaction to be published to network. - example: 62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D - maxLength: 500000 - minLength: 1 - type: string - withdrawalId: - description: Withdrawal ID to be completed by transaction broadcast - example: 5e68c66581f2ee32bc354087 - maxLength: 24 - minLength: 24 - type: string - signatureId: - description: >- - ID of prepared payment template to sign. This is should be stored on - a client side to retrieve ID of the blockchain transaction, when - signing application signs the transaction and broadcasts it to the - blockchain. - format: uuid - example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6 - type: string - required: - - txData - - currency - type: object - Id: - type: object - properties: - id: - type: string - description: ID of the entity. - example: 5e68c66581f2ee32bc354087 - CreateAccountBatch: - type: object - properties: - accounts: - type: array - items: - $ref: "#/components/schemas/CreateAccount" - required: - - accounts - CreateAccount: - properties: - currency: - description: > -The currency for the virtual account
- -
The currency for the virtual account
- -accountingCurrency
parameter at the account level.
- default: EUR
- example: USD
- $ref: "#/components/schemas/FiatCurrency"
- customerCountry:
- description: >-
- The ISO 3166-1 code of the country that the customer has to be
- compliant with
- example: US
- maxLength: 2
- minLength: 2
- type: string
- providerCountry:
- description: >-
- The ISO 3166-1 code of the country that the service provider has to
- be compliant with
- example: US
- maxLength: 2
- minLength: 2
- type: string
- required:
- - externalId
- type: object
- description: >-
- If a customer with the specified external ID does not exist, a new
- customer is created. If a customer with the specified external ID
- exists, it is updated with the provided information.
- CustomerUpdate:
- properties:
- externalId:
- description: External customer ID. If not set, it will not be updated.
- example: "123654"
- maxLength: 100
- minLength: 1
- type: string
- accountingCurrency:
- description: >-
- All transaction will be accounted in this currency for all accounts.
- Currency can be overridden per account level. If not set, it will
- not be updated. ISO-4217
- example: USD
- $ref: "#/components/schemas/FiatCurrency"
- customerCountry:
- description: >-
- Country customer has to be compliant with. If not set, it will not
- be updated. ISO-3166-1.
- example: US
- $ref: "#/components/schemas/CountryCode"
- type: string
- providerCountry:
- description: >-
- Country service provider has to be compliant with. If not set, it
- will not be updated. ISO-3166-1
- example: US
- $ref: "#/components/schemas/CountryCode"
- type: object
- required:
- - externalId
- DeployErc20OffchainMnemXpub:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- xpub:
- description: >-
- The extended public key from which a deposit address for the virtual
- account will be generated
- maxLength: 150
- minLength: 1
- example: >-
- xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
- type: string
- derivationIndex:
- description: >-
- The derivation index to use together with the extended public key to
- generate the deposit address
- format: int32
- example: 0
- type: integer
- maximum: 2147483647
- mnemonic:
- maxLength: 500
- minLength: 1
- description: >-
- The mnemonic to generate the private key for the blockchain address
- from which the fee for deploying the smart contract will be
- deducted; is used together with the derivation index of this address
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- type: string
- index:
- description: >-
- The derivation index of the blockchain address from which the fee
- for deploying the smart contract will be deducted; is used together
- with the mnemonic to generate the private key for this address
- example: 0
- type: integer
- maximum: 2147483647
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - xpub
- - derivationIndex
- - mnemonic
- - index
- DeployErc20OffchainMnemonicAddress:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- address:
- description: >-
- The blockchain address to be assigned to the virtual account as a
- deposit address
- maxLength: 42
- minLength: 42
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- mnemonic:
- maxLength: 500
- minLength: 1
- description: >-
- The mnemonic to generate the private key for the blockchain address
- from which the fee for deploying the smart contract will be
- deducted; is used together with the derivation index of this address
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- type: string
- index:
- description: >-
- The derivation index of the blockchain address from which the fee
- for deploying the smart contract will be deducted; is used together
- with the mnemonic to generate the private key for this address
- example: 0
- type: integer
- maximum: 2147483647
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - address
- - mnemonic
- - index
- DeployErc20OffchainPKXpub:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- xpub:
- description: >-
- The extended public key from which a deposit address for the virtual
- account will be generated
- maxLength: 150
- minLength: 1
- example: >-
- xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
- type: string
- derivationIndex:
- description: >-
- The derivation index to use together with the extended public key to
- generate the deposit address
- format: int32
- example: 0
- type: integer
- maximum: 2147483647
- privateKey:
- description: >-
- The private key of the blockchain address from which the fee for
- deploying the smart contract will be deducted
- type: string
- maxLength: 66
- minLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - xpub
- - derivationIndex
- - privateKey
- DeployErc20OffchainPKAddress:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- address:
- description: >-
- The blockchain address to be assigned to the virtual account as a
- deposit address
- maxLength: 42
- minLength: 42
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- privateKey:
- description: >-
- The private key of the blockchain address from which the fee for
- deploying the smart contract will be deducted
- type: string
- maxLength: 66
- minLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - privateKey
- - address
- DeployErc20OffchainKMSAddress:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- address:
- description: >-
- The blockchain address to be assigned to the virtual account as a
- deposit address
- maxLength: 42
- minLength: 42
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of either the private key of the
- blockchain address from which the fee for deploying the smart
- contract will be deducted, or the mnemonic to generate the
- private key for the blockchain address from which the fee will be
- deducted
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address from which the fee will be deducted that was generated from
- the mnemonic
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - address
- - signatureId
- DeployErc20OffchainKMSXpub:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- xpub:
- description: >-
- The extended public key from which a deposit address for the virtual
- account will be generated
- maxLength: 150
- minLength: 1
- example: >-
- xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
- type: string
- derivationIndex:
- description: >-
- The derivation index to use together with the extended public key to
- generate the deposit address
- format: int32
- example: 0
- type: integer
- maximum: 2147483647
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of either the private key of the
- blockchain address from which the fee for deploying the smart
- contract will be deducted, or the mnemonic to generate the
- private key for the blockchain address from which the fee will be
- deducted
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address from which the fee will be deducted that was generated from
- the mnemonic
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - xpub
- - derivationIndex
- - signatureId
- DeployKCSErc20OffchainMnemXpub:
- type: object
- properties:
- symbol:
- description: Name of the ERC20 token - stored as a symbol on Blockchain
- example: MT
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: Description of the ERC20 token
- example: My ERC20 Token
- maxLength: 100
- minLength: 1
- type: string
- basePair:
- description: >-
- Base pair for ERC20 token. 1 token will be equal to 1 unit of base
- pair. Transaction value will be calculated according to this base
- pair.
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- xpub:
- description: >-
- Extended public key (xpub), from which address, where all initial
- supply will be stored, will be generated. Either xpub and
- derivationIndex, or address must be present, not both.
- maxLength: 150
- minLength: 1
- example: >-
- xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
- type: string
- derivationIndex:
- description: Derivation index for xpub to generate specific deposit address.
- format: int32
- example: 0
- type: integer
- maximum: 2147483647
- mnemonic:
- maxLength: 500
- minLength: 1
- description: >-
- Mnemonic to generate private key for the deploy account of ERC20,
- from which the gas will be paid (index will be used). If address is
- not present, mnemonic is used to generate xpub and index is set to
- 1. Either mnemonic and index or privateKey and address must be
- present, not both.
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- type: string
- index:
- description: derivation index of address to pay for deployment of ERC20
- example: 0
- type: integer
- maximum: 2147483647
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- required:
- - description
- - supply
- - symbol
- - basePair
- - xpub
- - derivationIndex
- - mnemonic
- - index
- DeployKCSErc20OffchainMnemonicAddress:
- type: object
- properties:
- symbol:
- description: Name of the ERC20 token - stored as a symbol on Blockchain
- example: MT
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: Description of the ERC20 token
- example: My ERC20 Token
- maxLength: 100
- minLength: 1
- type: string
- basePair:
- description: >-
- Base pair for ERC20 token. 1 token will be equal to 1 unit of base
- pair. Transaction value will be calculated according to this base
- pair.
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- address:
- description: >-
- Address on Ethereum blockchain, where all initial supply will be
- stored. Either xpub and derivationIndex, or address must be present,
- not both.
- maxLength: 42
- minLength: 42
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- mnemonic:
- maxLength: 500
- minLength: 1
- description: >-
- Mnemonic to generate private key for the deploy account of ERC20,
- from which the gas will be paid (index will be used). If address is
- not present, mnemonic is used to generate xpub and index is set to
- 1. Either mnemonic and index or privateKey and address must be
- present, not both.
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- type: string
- index:
- description: derivation index of address to pay for deployment of ERC20
- example: 0
- type: integer
- maximum: 2147483647
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- required:
- - description
- - supply
- - symbol
- - basePair
- - address
- - mnemonic
- - index
- DeployKCSErc20OffchainPKXpub:
- type: object
- properties:
- symbol:
- description: Name of the ERC20 token - stored as a symbol on Blockchain
- example: MT
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: Description of the ERC20 token
- example: My ERC20 Token
- maxLength: 100
- minLength: 1
- type: string
- basePair:
- description: >-
- Base pair for ERC20 token. 1 token will be equal to 1 unit of base
- pair. Transaction value will be calculated according to this base
- pair.
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- xpub:
- description: >-
- Extended public key (xpub), from which address, where all initial
- supply will be stored, will be generated. Either xpub and
- derivationIndex, or address must be present, not both.
- maxLength: 150
- minLength: 1
- example: >-
- xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
- type: string
- derivationIndex:
- description: Derivation index for xpub to generate specific deposit address.
- format: int32
- example: 0
- type: integer
- maximum: 2147483647
- privateKey:
- description: >-
- Private key of Ethereum account address, from which gas for
- deployment of ERC20 will be paid. Private key, mnemonic or signature
- Id must be present.
- type: string
- maxLength: 66
- minLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- required:
- - description
- - supply
- - symbol
- - basePair
- - xpub
- - derivationIndex
- - privateKey
- DeployKCSErc20OffchainPKAddress:
- type: object
- properties:
- symbol:
- description: Name of the ERC20 token - stored as a symbol on Blockchain
- example: MT
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: Description of the ERC20 token
- example: My ERC20 Token
- maxLength: 100
- minLength: 1
- type: string
- basePair:
- description: >-
- Base pair for ERC20 token. 1 token will be equal to 1 unit of base
- pair. Transaction value will be calculated according to this base
- pair.
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- address:
- description: >-
- Address on Ethereum blockchain, where all initial supply will be
- stored. Either xpub and derivationIndex, or address must be present,
- not both.
- maxLength: 42
- minLength: 42
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- privateKey:
- description: >-
- Private key of Ethereum account address, from which gas for
- deployment of ERC20 will be paid. Private key, mnemonic or signature
- Id must be present.
- type: string
- maxLength: 66
- minLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- required:
- - description
- - supply
- - symbol
- - basePair
- - privateKey
- - address
- DeployKCSErc20OffchainKMSAddress:
- type: object
- properties:
- symbol:
- description: Name of the ERC20 token - stored as a symbol on Blockchain
- example: MT
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: Description of the ERC20 token
- example: My ERC20 Token
- maxLength: 100
- minLength: 1
- type: string
- basePair:
- description: >-
- Base pair for ERC20 token. 1 token will be equal to 1 unit of base
- pair. Transaction value will be calculated according to this base
- pair.
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- address:
- description: >-
- Address on Ethereum blockchain, where all initial supply will be
- stored. Either xpub and derivationIndex, or address must be present,
- not both.
- maxLength: 42
- minLength: 42
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >
- Identifier of the mnemonic / private key associated in signing
- application.
-
- When hash identifies mnemonic, index must be present to represent
- specific account to pay from.
-
- Private key, mnemonic or signature Id must be present.
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- required:
- - description
- - supply
- - symbol
- - basePair
- - address
- - signatureId
- DeployKCSErc20OffchainKMSXpub:
- type: object
- properties:
- symbol:
- description: Name of the ERC20 token - stored as a symbol on Blockchain
- example: MT
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: Description of the ERC20 token
- example: My ERC20 Token
- maxLength: 100
- minLength: 1
- type: string
- basePair:
- description: >-
- Base pair for ERC20 token. 1 token will be equal to 1 unit of base
- pair. Transaction value will be calculated according to this base
- pair.
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- xpub:
- description: >-
- Extended public key (xpub), from which address, where all initial
- supply will be stored, will be generated. Either xpub and
- derivationIndex, or address must be present, not both.
- maxLength: 150
- minLength: 1
- example: >-
- xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
- type: string
- derivationIndex:
- description: Derivation index for xpub to generate specific deposit address.
- format: int32
- example: 0
- type: integer
- maximum: 2147483647
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >
- Identifier of the mnemonic / private key associated in signing
- application.
-
- When hash identifies mnemonic, index must be present to represent
- specific account to pay from.
-
- Private key, mnemonic or signature Id must be present.
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- required:
- - description
- - supply
- - symbol
- - basePair
- - xpub
- - derivationIndex
- - signatureId
- DeployAlgoErc20OffchainMnemonicAddress:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 8
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- address:
- description: >-
- The blockchain address to be assigned to the virtual account as a
- deposit address
- maxLength: 58
- minLength: 58
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- type: string
- mnemonic:
- maxLength: 500
- minLength: 1
- description: >-
- The mnemonic to generate the private key for the blockchain address
- from which the fee for deploying the smart contract will be
- deducted; is used together with the derivation index of this address
- example: >-
- artist alarm clerk obscure timber firm reopen provide ankle vicious
- exhibit waste math toilet believe puppy lucky coast post kind black
- suspect mule able market
- type: string
- index:
- description: >-
- The derivation index of the blockchain address from which the fee
- for deploying the smart contract will be deducted; is used together
- with the mnemonic to generate the private key for this address
- example: 0
- type: integer
- maximum: 2147483647
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - address
- - mnemonic
- - index
- DeployAlgoErc20OffchainPKAddress:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 8
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- address:
- description: >-
- The blockchain address to be assigned to the virtual account as a
- deposit address
- maxLength: 58
- minLength: 58
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- type: string
- privateKey:
- description: >-
- The private key of the blockchain address from which the fee for
- deploying the smart contract will be deducted
- type: string
- maxLength: 103
- minLength: 103
- example: >-
- NBYMCVEEDFYV3TPWVRE6APE7PKHUJD4XAKXCKNCLKGUXOC3LFNJGZQCJCRA53HB7ZAHF6NFJH2QIVQ5USQNWG35QCJLD4KZ5IWMB24Q
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - privateKey
- - address
- DeployAlgoErc20OffchainKMSAddress:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 8
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- address:
- description: >-
- The blockchain address to be assigned to the virtual account as a
- deposit address
- maxLength: 58
- minLength: 58
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of either the private key of the
- blockchain address from which the fee for deploying the smart
- contract will be deducted, or the mnemonic to generate the
- private key for the blockchain address from which the fee will be
- deducted
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address from which the fee will be deducted that was generated from
- the mnemonic
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- required:
- - description
- - supply
- - symbol
- - basePair
- - address
- - signatureId
- TransferAlgoErc20:
- type: object
- properties:
- senderAccountId:
- maxLength: 24
- minLength: 24
- description: >-
- The ID of the virtual account to send the ERC-20-equivalent Algorand
- tokens from
- example: 61b3bffddfb389cde19c73be
- type: string
- address:
- description: >-
- The blockchain address to send the ERC-20-equivalent Algorand tokens
- to
- example: 5YVZBUH3STSQ5ABCTLEIEIJ7QOZFILM2DLAEEA4ZL6CU55ODZIQXO5EMYM
- maxLength: 58
- minLength: 58
- type: string
- amount:
- description: The amount of the ERC-20-equivalent Algorand tokens to send
- maxLength: 38
- example: "10000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- privateKey:
- maxLength: 103
- minLength: 103
- description: >-
- The secret of the Algorand wallet (account). Secret, or signature Id
- must be present.
- example: >-
- NBYMCVEEDFYV3TPWVRE6APE7PKHUJD4XAKXCKNCLKGUXOC3LFNJGZQCJCRA53HB7ZAHF6NFJH2QIVQ5USQNWG35QCJLD4KZ5IWMB24Q
- type: string
- compliant:
- description: >-
- Compliance check; if the withdrawal is not compliant, it will not be
- processed
- example: false
- type: boolean
- paymentId:
- description: >-
- The identifier of the token transfer that is shown on the virtual
- account for the created transaction
- example: "1234"
- maxLength: 100
- minLength: 1
- type: string
- senderNote:
- maxLength: 500
- minLength: 1
- description: The note for the recipient; must not contain spaces
- example: Helloworld
- type: string
- required:
- - senderAccountId
- - address
- - privateKey
- - amount
- - fee
- DeployTrcOffchainMnemXpub:
- type: object
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchain
- example: MY_TOKEN
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- decimals:
- description: The number of decimal places that the token has
- example: 6
- minimum: 0
- type: number
- type:
- description: The type of the token
- example: TRC10
- type: string
- enum:
- - TRC10
- - TRC20
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- xpub:
- description: >-
- The extended public key of the TRON wallet from which a deposit
- address for the virtual account will be generated
- maxLength: 130
- minLength: 130
- example: >-
- 0244b3f40c6e570ae0032f6d7be87737a6c4e5314a4a1a82e22d0460a0d0cd794936c61f0c80dc74ace4cd04690d4eeb1aa6555883be006e1748306faa7ed3a26a
- type: string
- derivationIndex:
- description: >-
- The derivation index to use together with the extended public key to
- generate the deposit address
- format: int32
- example: 0
- type: integer
- maximum: 2147483647
- mnemonic:
- maxLength: 500
- minLength: 1
- description: >-
- The mnemonic of the TRON wallet to generate the private key for the
- blockchain address from which the fee for deploying the smart
- contract will be deducted; is used together with the derivation
- index of this address
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- type: string
- index:
- description: >-
- The derivation index of the blockchain address from which the fee
- for deploying the smart contract will be deducted; is used together
- with the mnemonic to generate the private key for this address
- example: 0
- type: integer
- maximum: 2147483647
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- example: EUR
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- url:
- description: >-
- (TRC-10 tokens only) The URL of the project that the token is
- created forbasePair
*baseRate
- url:
- description: >-
- (TRC-10 tokens only) The URL of the project that the token is
- created forbasePair
*baseRate
- url:
- description: >-
- (TRC-10 tokens only) The URL of the project that the token is
- created forbasePair
*baseRate
- url:
- description: >-
- (TRC-10 tokens only) The URL of the project that the token is
- created forbasePair
*baseRate
- url:
- description: >-
- (TRC-10 tokens only) The URL of the project that the token is
- created forbasePair
*baseRate
- url:
- description: >-
- (TRC-10 tokens only) The URL of the project that the token is
- created forbasePair
*baseRate
- url:
- description: >-
- (TRC-10 tokens only) The URL of the project that the token is
- created forbasePair
*baseRate
- url:
- description: >-
- (TRC-10 tokens only) The URL of the project that the token is
- created forsymbol
parameter of the smart contract that you are going to deploy or have already deployed for
- this token.
- example: MY_TOKEN
- maxLength: 30
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "1000000.0"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- decimals:
- description: The number of decimal places that the token has
- minimum: 0
- example: 8
- type: number
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- xpub:
- description: >-
- The extended public key of the wallet from which a deposit address
- for the virtual account will be generatedErc20Address
schema of this API.
- maxLength: 150
- minLength: 1
- example: >-
- xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
- type: string
- derivationIndex:
- description: >-
- The derivation index to use together with the extended public key to
- generate the deposit address
- format: int32
- example: 0
- type: integer
- maximum: 2147483647
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- example: EUR
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- accountingCurrency:
- description: >-
- The ISO 4217 code of the currency in which all transactions for the
- created virtual account will be billed
- default: USD
- $ref: "#/components/schemas/FiatCurrency"
- example: USD
- required:
- - symbol
- - supply
- - decimals
- - description
- - basePair
- - derivationIndex
- - xpub
- type: object
- Erc20Address:
- properties:
- symbol:
- description: >-
- The name of the token; used as an identifier within the Tatum
- platform and as a currency symbol on the blockchainsymbol
parameter of the smart contract that you are going to deploy or have already deployed for
- this token.
- example: MY_TOKEN
- maxLength: 30
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- supply:
- description: The supply of the token
- maxLength: 38
- example: "1000000.0"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- decimals:
- description: The number of decimal places that the token has
- minimum: 0
- example: 8
- type: number
- description:
- description: >-
- The description of the token; used as a description within the Tatum
- platform and as a currency name on the blockchain
- example: My Public Token
- maxLength: 100
- minLength: 1
- type: string
- address:
- description: >-
- The blockchain address to be assigned to the virtual account as a
- deposit address
- maxLength: 44
- minLength: 42
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- basePair:
- description: >-
- The base pair for the virtual currency that represents the token;
- used to calculate the value of a transaction
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- example: EUR
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- The exchange rate for the base pair; one unit of the created virtual
- currency equals 1 unit of
- basePair
*baseRate
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- accountingCurrency:
- description: >-
- AThe ISO 4217 code of the currency in which all transactions for the
- created virtual account will be billed
- default: USD
- $ref: "#/components/schemas/FiatCurrency"
- example: USD
- required:
- - symbol
- - supply
- - decimals
- - description
- - basePair
- - address
- type: object
- Erc20Response:
- properties:
- accountId:
- description: >-
- The ID of the created virtual account with the currency set to the
- token name (the symbol
parameter of the request
- body)symbol
parameter of the request body)
- type: string
- example: 5e68c66581f2ee32bc354087
- address:
- description: The deposit address of the virtual account
- example: TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW
- type: string
- type: object
- DeployErc20Response:
- properties:
- accountId:
- description: >-
- Account ID with the type of currency as created ERC20/BEP20 token
- symbol. Account will be unfrozen when ERC20/BEP20 contract address
- will be set.
- type: string
- example: 5e68c66581f2ee32bc354087
- txId:
- description: >-
- TX hash of successful transaction. From this transaction receipt
- contract address can be obtained.
- example: c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9
- type: string
- type: object
- required:
- - accountId
- - txId
- DeployErc20SignatureResponse:
- properties:
- accountId:
- description: >-
- Account ID with the type of currency as created ERC20/BEP20 token
- symbol. Account will be unfrozen when ERC20/BEP20 contract address
- will be set.
- type: string
- example: 5e68c66581f2ee32bc354087
- signatureId:
- description: >-
- ID of prepared payment template to sign. This is should be stored on
- a client side to retrieve ID of the blockchain transaction, when
- signing application signs the transaction and broadcasts it to the
- blockchain.
- format: uuid
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- type: string
- type: object
- required:
- - accountId
- - signatureId
- DeployAlgoErc20Response:
- properties:
- accountId:
- description: >-
- Account ID with the type of currency as created ERC20 token symbol.
- Account will be unfrozen when ERC20 contract address will be set.
- type: string
- example: 5e68c66581f2ee32bc354087
- txId:
- description: >-
- TX hash of successful transaction. From this transaction receipt
- contract address can be obtained.
- example: JGDMW6F6BUWQLFXDEPZIUO5WCTQOL3QV7KZ2SBV44K5WE6SSNN7Q
- type: string
- type: object
- required:
- - accountId
- - txId
- DeployAlgoErc20SignatureResponse:
- properties:
- accountId:
- description: >-
- Account ID with the type of currency as created ERC20 token symbol.
- Account will be unfrozen when ERC20 contract address will be set.
- type: string
- example: 5e68c66581f2ee32bc354087
- signatureId:
- description: >-
- ID of prepared payment template to sign. This is should be stored on
- a client side to retrieve ID of the blockchain transaction, when
- signing application signs the transaction and broadcasts it to the
- blockchain.
- format: uuid
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- type: string
- type: object
- required:
- - accountId
- - signatureId
- Error:
- properties:
- errorCode:
- description: payment.amount.notNull
- type: string
- message:
- description: Payment amount must be greater than 0.
- type: string
- statusCode:
- description: "403"
- type: number
- required:
- - errorCode
- - message
- type: object
- Error400:
- properties:
- errorCode:
- example: validation.failed
- description: validation.failed
- type: string
- message:
- example: >-
- Request validation failed. Please see data for additional
- information.
- description: >-
- Request validation failed. Please see data for additional
- information.
- type: string
- statusCode:
- example: 400
- description: "400"
- type: number
- data:
- type: array
- items:
- type: object
- required:
- - target
- properties:
- target:
- type: object
- additionalProperties: true
- description: Request object present in the body of the HTTP request
- example:
- property: 12345
- value:
- type: number
- description: >-
- Value of the target object which validation is wrong. Can be
- of any data type, example here is using type number.
- example: 12345
- property:
- type: string
- description: Property name of the target object which validation is wrong
- example: property1
- constraints:
- type: object
- additionalProperties: true
- description: >-
- Object of failed constraints for the target object. Key is the
- constraint, value is detailed description of the failed
- constraint.
- example:
- min: property1 must not be less than 50000
- required:
- - errorCode
- - message
- - statusCode
- - data
- type: object
- Error401Invalid:
- properties:
- errorCode:
- example: subscription.invalid
- description: subscription.invalid
- type: string
- message:
- example: Unable to find valid subscription for '${apiKey}'
- description: Unable to find valid subscription for '${apiKey}'
- type: string
- statusCode:
- example: 401
- description: "401"
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error401NotActive:
- properties:
- errorCode:
- example: subscription.not.active
- description: subscription.not.active
- type: string
- message:
- example: Subscription not active anymore.
- description: Subscription not active anymore.
- type: string
- statusCode:
- example: 401
- description: "401"
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403ComplianceBtc:
- properties:
- errorCode:
- description: compliance.country.btc.not.supported
- example: compliance.country.btc.not.supported
- type: string
- message:
- description: Customer country not supported for BTC.
- example: Customer country not supported for BTC.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403Libra:
- properties:
- errorCode:
- description: libra.request.failed
- example: libra.request.failed
- type: string
- message:
- description: ${error}
- example: ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthBroadcast:
- properties:
- errorCode:
- description: ethereum.broadcast.failed
- example: ethereum.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthErc20NotFound:
- properties:
- errorCode:
- description: erc20.token.notFound
- example: erc20.token.notFound
- type: string
- message:
- description: No such ERC20 currency ${name}.
- example: No such ERC20 currency ${name}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxNotFound:
- properties:
- errorCode:
- description: tx.missing
- example: tx.missing
- type: string
- message:
- description: No such tx.
- example: No such tx.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error404TxNotFound:
- properties:
- errorCode:
- description: tx.not.found
- example: tx.not.found
- type: string
- message:
- description: Transaction not found. Possible not exists or is still pending.
- example: Transaction not found. Possible not exists or is still pending.
- type: string
- statusCode:
- description: "404"
- example: 404
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthErc20Set:
- properties:
- errorCode:
- description: erc20.address.set
- example: erc20.address.set
- type: string
- message:
- description: ERC20 address was already set.
- example: ERC20 address was already set.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthMnemonicPrivateKey:
- properties:
- errorCode:
- description: private.mnemonic.missing
- example: private.mnemonic.missing
- type: string
- message:
- description: Either mnemonic and index or private key must be present.
- example: Either mnemonic and index or private key must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthErc20Unsupported:
- properties:
- errorCode:
- description: eth.erc20.unsupported
- example: eth.erc20.unsupported
- type: string
- message:
- description: Unsupported ETH ERC20 blockchain.
- example: Unsupported ETH ERC20 blockchain.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthTxHash:
- properties:
- errorCode:
- description: eth.transaction.hash
- example: eth.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthTxSign:
- properties:
- errorCode:
- description: eth.transaction.sign
- example: eth.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthErc20TxSign:
- properties:
- errorCode:
- description: eth.erc20.sign
- example: eth.erc20.sign
- type: string
- message:
- description: Unable to sign transaction for contract creation. ${error}
- example: Unable to sign transaction for contract creation. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthErc721TxSign:
- properties:
- errorCode:
- description: eth.erc721.sign
- example: eth.erc721.sign
- type: string
- message:
- description: Unable to sign transaction for contract creation. ${error}
- example: Unable to sign transaction for contract creation. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthErc721Call:
- properties:
- errorCode:
- description: eth.erc721.failed
- example: eth.erc721.failed
- type: string
- message:
- description: Unable to obtain information for token. ${error}
- example: Unable to obtain information for token. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthGasCalculation:
- properties:
- errorCode:
- description: eth.transaction.gas
- example: eth.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthTxBody:
- properties:
- errorCode:
- description: ethereum.transaction.body
- example: ethereum.transaction.body
- type: string
- message:
- description: Either currency, or tokenAddress must be defined.
- example: Either currency, or tokenAddress must be defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthScBody:
- properties:
- errorCode:
- description: ethereum.sc.invalid
- example: ethereum.sc.invalid
- type: string
- message:
- description: Invalid parameters for smart contract invocation.
- example: Invalid parameters for smart contract invocation.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EthGasPrice:
- properties:
- errorCode:
- description: gas.price.failed
- example: gas.price.failed
- type: string
- message:
- description: Unable to obtain current GAS price.
- example: Unable to obtain current GAS price.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403ComplianceEth:
- properties:
- errorCode:
- description: compliance.country.eth.not.supported
- example: compliance.country.eth.not.supported
- type: string
- message:
- description: Customer country not supported for ETH.
- example: Customer country not supported for ETH.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountTestnet:
- properties:
- errorCode:
- description: account.blockchain.testnet
- example: account.blockchain.testnet
- type: string
- message:
- description: Unable to create account, unsupported testnet blockchain.
- example: Unable to create account, unsupported testnet blockchain.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountXpub:
- properties:
- errorCode:
- description: account.xpub.present
- example: account.xpub.present
- type: string
- message:
- description: Unable to create ${account.currency} account with xpub.
- example: Unable to create ${account.currency} account with xpub.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AddressXpub:
- properties:
- errorCode:
- description: account.xpub.present
- example: account.xpub.present
- type: string
- message:
- description: >-
- Xpub assigned to account, it is not possible to assign address. Use
- generateAddress method instead.
- example: >-
- Xpub assigned to account, it is not possible to assign address. Use
- generateAddress method instead.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountCurrency:
- properties:
- errorCode:
- description: ledger.currency.invalid
- example: ledger.currency.invalid
- type: string
- message:
- description: Unable to create an account, unsupported currency.
- example: Unable to create an account, unsupported currency.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountIncompatibleXpub:
- properties:
- errorCode:
- description: account.xpub.incompatible
- example: account.xpub.incompatible
- type: string
- message:
- description: Xpub not compatible with account currency.
- example: Xpub not compatible with account currency.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountIncompatibleXpubBtc:
- properties:
- errorCode:
- description: Address.generation.failed.wrong.xpub
- example: address.generation.failed.wrong.xpub
- type: string
- message:
- description: Unable to generate address, wrong xpub and account type.
- example: Unable to generate address, wrong xpub and account type.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountAddressGeneral:
- properties:
- errorCode:
- description: Address.generation.failed
- example: address.generation.failed
- type: string
- message:
- description: Unable to generate address.
- example: Unable to generate address.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BnbFailed:
- properties:
- errorCode:
- description: bnb.failed
- example: bnb.failed
- type: string
- message:
- description: Unable to communicate with blockchain. ${error}
- example: Unable to communicate with blockchain. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BnbAddressFailed:
- properties:
- errorCode:
- description: Address.bnb.generation.failed.wrong.xpub
- example: address.bnb.generation.failed.wrong.xpub
- type: string
- message:
- description: Unable to generate BNB address, wrong xpub and account type.
- example: Unable to generate BNB address, wrong xpub and account type.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BnbBroadcatSigFailed:
- properties:
- errorCode:
- description: bnb.broadcast.bad.signature
- example: bnb.broadcast.bad.signature
- type: string
- message:
- description: Unable to broadcast BNB transaction, bad signature.
- example: Unable to broadcast BNB transaction, bad signature.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BnbTxStateFailed:
- properties:
- errorCode:
- description: bnb.broadcast.failed.tx.state
- example: bnb.broadcast.failed.tx.state
- type: string
- message:
- description: Unable to broadcast BNB transaction, tx ${hash} state not OK.
- example: Unable to broadcast BNB transaction, tx ${hash} state not OK.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BnbTxFailed:
- properties:
- errorCode:
- description: bnb.transfer.failed
- example: bnb.transfer.failed
- type: string
- message:
- description: Unable to transfer funds. ${error}
- example: Unable to transfer funds. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BtcTxFailed:
- properties:
- errorCode:
- description: transaction.failed
- example: transaction.failed
- type: string
- message:
- description: No spendable inputs.
- example: No spendable inputs.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BtcTx:
- properties:
- errorCode:
- description: transaction.invalid.body
- example: transaction.invalid.body
- type: string
- message:
- description: Either UTXO, or addresses must be present.
- example: Either UTXO, or addresses must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountNotExists:
- properties:
- errorCode:
- description: account.not.exists
- example: account.not.exists
- type: string
- message:
- description: No such account.
- example: No such account.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BlockageNotExists:
- properties:
- errorCode:
- description: blockage.not.exists
- example: blockage.not.exists
- type: string
- message:
- description: No such blockage.
- example: No such blockage.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BlockageAmount:
- properties:
- errorCode:
- description: blockage.amount.exceeded
- example: blockage.amount.exceeded
- type: string
- message:
- description: Amount to transfer is greater then amount of the blockage.
- example: Amount to transfer is greater then amount of the blockage.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SubscriptionNotExists:
- properties:
- errorCode:
- description: subscription.not.exists
- example: subscription.not.exists
- type: string
- message:
- description: No such subscription.
- example: No such subscription.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SubscriptionType:
- properties:
- errorCode:
- description: subscription.type.invalid
- example: subscription.type.invalid
- type: string
- message:
- description: Invalid subscription type.
- example: Invalid subscription type.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SubscriptionCurrency:
- properties:
- errorCode:
- description: subscription.attr.currency.invalid
- example: subscription.attr.currency.invalid
- type: string
- message:
- description: Invalid subscription attribute 'currency'.
- example: Invalid subscription attribute 'currency'.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SubscriptionInterval:
- properties:
- errorCode:
- description: subscription.attr.interval.invalid
- example: subscription.attr.interval.invalid
- type: string
- message:
- description: Invalid subscription attribute 'interval'.
- example: Invalid subscription attribute 'interval'.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SubscriptionBalance:
- properties:
- errorCode:
- description: subscription.attr.balance.invalid
- example: subscription.attr.balance.invalid
- type: string
- message:
- description: Invalid subscription attribute 'limit' or 'typeOfBalance'.
- example: Invalid subscription attribute 'limit' or 'typeOfBalance'.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SubscriptionId:
- properties:
- errorCode:
- description: subscription.attr.incoming.invalid
- example: subscription.attr.incoming.invalid
- type: string
- message:
- description: Invalid subscription attribute 'id' or 'url'.
- example: Invalid subscription attribute 'id' or 'url'.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SubscriptionPendingId:
- properties:
- errorCode:
- description: subscription.attr.pending.invalid
- example: subscription.attr.pending.invalid
- type: string
- message:
- description: Invalid subscription attribute 'id' or 'url'.
- example: Invalid subscription attribute 'id' or 'url'.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403ReportNotAvailable:
- properties:
- errorCode:
- description: report.invalid
- example: report.invalid
- type: string
- message:
- description: Unsupported report type.
- example: Unsupported report type.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountInactive:
- properties:
- errorCode:
- description: account.inactive
- example: account.inactive
- type: string
- message:
- description: Unable to deactivate inactive account.
- example: Unable to deactivate inactive account.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountActive:
- properties:
- errorCode:
- description: account.active
- example: account.active
- type: string
- message:
- description: Unable to activate active account.
- example: Unable to activate active account.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountFrozen:
- properties:
- errorCode:
- description: account.frozen
- example: account.frozen
- type: string
- message:
- description: Unable to freeze frozen account.
- example: Unable to freeze frozen account.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountNotFrozen:
- properties:
- errorCode:
- description: account.not.frozen
- example: account.not.frozen
- type: string
- message:
- description: Unable to unfreeze unfrozen account.
- example: Unable to unfreeze unfrozen account.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CustomerInternalNotExists:
- properties:
- errorCode:
- description: customer.internal.not.exists
- example: customer.internal.not.exists
- type: string
- message:
- description: No such customer.
- example: No such customer.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CustomerActive:
- properties:
- errorCode:
- description: customer.active
- example: customer.active
- type: string
- message:
- description: Unable to activate active customer.
- example: Unable to activate active customer.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CustomerInactive:
- properties:
- errorCode:
- description: customer.inactive
- example: customer.inactive
- type: string
- message:
- description: Unable to perform operation on inactive customer.
- example: Unable to perform operation on inactive customer.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CustomerDisabled:
- properties:
- errorCode:
- description: customer.disabled
- example: customer.disabled
- type: string
- message:
- description: Unable to disable disabled customer.
- example: Unable to disable disabled customer.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CustomerEnabled:
- properties:
- errorCode:
- description: customer.enabled
- example: customer.enabled
- type: string
- message:
- description: Unable to enable enabled customer.
- example: Unable to enable enabled customer.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CustomerDeactivateActiveAccounts:
- properties:
- errorCode:
- description: customer.deactivate.account.active
- example: customer.deactivate.account.active
- type: string
- message:
- description: Unable to deactivate customer, accounts not deactivated.
- example: Unable to deactivate customer, accounts not deactivated.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CustomerNotExists:
- properties:
- errorCode:
- description: customer.not.exists
- example: customer.not.exists
- type: string
- message:
- description: No customer with given external ID ${externalId} exists.
- example: No customer with given external ID ${externalId} exists.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BlockDelete:
- properties:
- errorCode:
- description: customer.blockage.inactive
- example: customer.blockage.inactive
- type: string
- message:
- description: Unable to delete blockages on account for inactive customer.
- example: Unable to delete blockages on account for inactive customer.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CustomerNotActive:
- properties:
- errorCode:
- description: customer.not.active
- example: customer.not.active
- type: string
- message:
- description: Customer not active.
- example: Customer not active.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VCNoAccount:
- properties:
- errorCode:
- description: virtual.account.notValid
- example: virtual.account.notValid
- type: string
- message:
- description: >-
- Unable to perform operation on virtual currency, account does not
- exists.
- example: >-
- Unable to perform operation on virtual currency, account does not
- exists.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VCTxFailed:
- properties:
- errorCode:
- description: virtual.tx.failed
- example: virtual.tx.failed
- type: string
- message:
- description: >-
- Unable to perform operation on virtual currency, impossible to store
- transaction.
- example: >-
- Unable to perform operation on virtual currency, impossible to store
- transaction.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VCRevokeBalance:
- properties:
- errorCode:
- description: virtual.account.balance
- example: virtual.account.balance
- type: string
- message:
- description: Insufficient balance to revoke virtual currency on account.
- example: Insufficient balance to revoke virtual currency on account.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VCCreateFailed:
- properties:
- errorCode:
- description: virtual.creation.error
- example: virtual.creation.error
- type: string
- message:
- description: It is not possible to create virtual currency.
- example: It is not possible to create virtual currency.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VCPrefix:
- properties:
- errorCode:
- description: virtual.name.prefix
- example: virtual.name.prefix
- type: string
- message:
- description: Virtual currency has wrong name, must start with VC_.
- example: Virtual currency has wrong name, must start with VC_.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VCDuplicate:
- properties:
- errorCode:
- description: virtual.duplicate
- example: virtual.duplicate
- type: string
- message:
- description: Virtual currency with given name already exists.
- example: Virtual currency with given name already exists.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountCustomerInactive:
- properties:
- errorCode:
- description: account.customer.inactive
- example: account.customer.inactive
- type: string
- message:
- description: Unable to activate account, customer inactive.
- example: Unable to activate account, customer inactive.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountBalanceNonZero:
- properties:
- errorCode:
- description: account.balance.non.zero
- example: account.balance.non.zero
- type: string
- message:
- description: Unable to deactivate account with non-zero balance.
- example: Unable to deactivate account with non-zero balance.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TradeBalanceNonZero:
- properties:
- errorCode:
- description: account.trade.non.zero
- example: account.trade.non.zero
- type: string
- message:
- description: Unable to deactivate account with non-zero exchange trades.
- example: Unable to deactivate account with non-zero exchange trades.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AmountFormat:
- properties:
- errorCode:
- description: amount.format
- example: amount.format
- type: string
- message:
- description: Amount has incorrect format.
- example: Amount has incorrect format.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403RecipientFormat:
- properties:
- errorCode:
- description: withdrawal.recipient.format
- example: withdrawal.recipient.format
- type: string
- message:
- description: Recipient blockchain address has incorrect format.
- example: Recipient blockchain address has incorrect format.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AccountCurrencyVC:
- properties:
- errorCode:
- description: account.currency.missing
- example: account.currency.missing
- type: string
- message:
- description: No such virtual currency ${currency} for account ${account}.
- example: No such virtual currency ${currency} for account ${account}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VCNotFound:
- properties:
- errorCode:
- description: vc.not.found
- example: vc.not.found
- type: string
- message:
- description: No such virtual currency.
- example: No such virtual currency.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AddressUsed:
- properties:
- errorCode:
- description: Address.used
- example: address.used
- type: string
- message:
- description: Address and currency already in use.
- example: Address and currency already in use.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AddressNotFound:
- properties:
- errorCode:
- description: Address.not.found
- example: address.not.found
- type: string
- message:
- description: No such address exists.
- example: No such address exists.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AddressAccountXpubMissing:
- properties:
- errorCode:
- description: account.xpub.missing
- example: account.xpub.missing
- type: string
- message:
- description: >-
- No xpub assigned to account, it is not possible to generate address.
- Use assignAddress method instead.
- example: >-
- No xpub assigned to account, it is not possible to generate address.
- Use assignAddress method instead.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AddressIndexUsed:
- properties:
- errorCode:
- description: Address.index.used
- example: address.index.used
- type: string
- message:
- description: Unable to create address, derivation index is already used.
- example: Unable to create address, derivation index is already used.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BtcBlockchain:
- properties:
- errorCode:
- description: blockchain.error.code
- example: blockchain.error.code
- type: string
- message:
- description: "${error.message} Code: ${error.code}"
- example: "${error.message} Code: ${error.code}"
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error404BlockNotExists:
- properties:
- errorCode:
- description: block.hash.not.exists
- example: block.hash.not.exists
- type: string
- message:
- description: No such block.
- example: No such block.
- type: string
- statusCode:
- description: "404"
- example: 404
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403Broadcast:
- properties:
- errorCode:
- description: blockchain.broadcast.error
- example: blockchain.broadcast.error
- type: string
- message:
- description: Unable to broadcast transaction, wrong input data.
- example: Unable to broadcast transaction, wrong input data.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BlockchainPrivateFailed:
- properties:
- errorCode:
- description: key.generation.failed.wrong.mnemonic
- example: key.generation.failed.wrong.mnemonic
- type: string
- message:
- description: Unable to generate address, wrong mnemonic and index.
- example: Unable to generate address, wrong mnemonic and index.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BtcUTXO:
- properties:
- errorCode:
- description: tx.hash.index.spent
- example: tx.hash.index.spent
- type: string
- message:
- description: No such UTXO for transaction and index.
- example: No such UTXO for transaction and index.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BcashBroadcast:
- properties:
- errorCode:
- description: bch.broadcast.failed
- example: bch.broadcast.failed
- type: string
- message:
- description: "Unable to broadcast transaction. Error from blockchain: ${error}"
- example: "Unable to broadcast transaction. Error from blockchain: ${error}"
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403WithdrawalNotFound:
- properties:
- errorCode:
- description: withdrawal.missing
- example: withdrawal.missing
- type: string
- message:
- description: No such withdrawal.
- example: No such withdrawal.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KMSNotExists:
- properties:
- errorCode:
- description: kms.missing
- example: kms.missing
- type: string
- message:
- description: No such KMS signature with id '{id}'.
- example: No such KMS signature with id '{id}'.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OffchainNotCancelled:
- properties:
- errorCode:
- description: withdrawal.not.cancelled.transaction.failed
- example: withdrawal.not.cancelled.transaction.failed
- type: string
- message:
- description: >-
- Unable to broadcast transaction, and impossible to cancel
- withdrawal. ID is attached, "${withdrawalId}", cancel it manually.
- example: >-
- Unable to broadcast transaction, and impossible to cancel
- withdrawal. ID is attached, "${withdrawalId}", cancel it manually.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XlmFailed:
- properties:
- errorCode:
- description: xlm.failed
- example: xlm.failed
- type: string
- message:
- description: Unable to communicate with blockchain. ${error}
- example: Unable to communicate with blockchain. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XrpFailed:
- properties:
- errorCode:
- description: xrp.failed
- example: xrp.failed
- type: string
- message:
- description: Unable to communicate with blockchain. ${error}
- example: Unable to communicate with blockchain. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XrpCode:
- properties:
- errorCode:
- description: xrp.account.failed
- example: xrp.account.failed
- type: string
- message:
- description: "${error} Code: ${code}"
- example: "${error} Code: ${code}"
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XrpLedger:
- properties:
- errorCode:
- description: xrp.ledger.failed
- example: xrp.ledger.failed
- type: string
- message:
- description: "${error} Code: ${code}"
- example: "${error} Code: ${code}"
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XrpBroadcast:
- properties:
- errorCode:
- description: xrp.broadcast.failed
- example: xrp.broadcast.failed
- type: string
- message:
- description: Xrp submit tx failed. ${error}
- example: Xrp submit tx failed. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XrpMultiple:
- properties:
- errorCode:
- description: xrp.settings.multiple
- example: xrp.settings.multiple
- type: string
- message:
- description: It is possible to set 1 parameter at a time.
- example: It is possible to set 1 parameter at a time.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XrpAttr:
- properties:
- errorCode:
- description: attr.wrong.format
- example: attr.wrong.format
- type: string
- message:
- description: Wrong attr of withdrawal, should be of uint32 type.
- example: Wrong attr of withdrawal, should be of uint32 type.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XrpFee:
- properties:
- errorCode:
- description: xrp.fee
- example: xrp.fee
- type: string
- message:
- description: Unable to calculate fee.
- example: Unable to calculate fee.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XrpSign:
- properties:
- errorCode:
- description: xrp.sign.failed
- example: xrp.sign.failed
- type: string
- message:
- description: Unable to sign tx. ${error}
- example: Unable to sign tx. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XlmTxFailed:
- properties:
- errorCode:
- description: xlm.tx.failed
- example: xlm.tx.failed
- type: string
- message:
- description: Unable to construct transaction. ${error}
- example: Unable to construct transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VetFailed:
- properties:
- errorCode:
- description: vet.failed
- example: vet.failed
- type: string
- message:
- description: Unable to communicate with blockchain. ${error}
- example: Unable to communicate with blockchain. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VetGas:
- properties:
- errorCode:
- description: vet.transaction.gas
- example: vet.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403VetTxHash:
- properties:
- errorCode:
- description: vet.transaction.hash
- example: vet.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash.
- example: Unable to calculate transaction hash.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- TransactionFeeEgldBlockchain:
- type: object
- properties:
- sender:
- description: Account address of the sender
- example: erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7
- maxLength: 62
- minLength: 62
- type: string
- receiver:
- description: Account address of the receiver or smart contract
- example: erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq6
- maxLength: 62
- minLength: 62
- type: string
- value:
- type: string
- description: Value to be sent.
- example: "0.1"
- data:
- type: string
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- required:
- - sender
- - receiver
- - value
- Error403EgldGasCalculation:
- properties:
- errorCode:
- description: egld.transaction.gas
- example: egld.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OffchainBroadcastState:
- properties:
- errorCode:
- description: withdrawal.unexpected.state
- example: withdrawal.unexpected.state
- type: string
- message:
- description: Unable to complete withdrawal, which is not in InProgress state.
- example: Unable to complete withdrawal, which is not in InProgress state.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OffchainCancelled:
- properties:
- errorCode:
- description: withdrawal.prepare.failed
- example: withdrawal.prepare.failed
- type: string
- message:
- description: Unable to prepare transaction, withdrawal cancelled.
- example: Unable to prepare transaction, withdrawal cancelled.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OffchainNotSupported:
- properties:
- errorCode:
- description: offchain.not.supported
- example: offchain.not.supported
- type: string
- message:
- description: >-
- Offchain not supported for account with ${account.currency}
- currency.
- example: >-
- Offchain not supported for account with ${account.currency}
- currency.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403AddressAccountXpubUsed:
- properties:
- errorCode:
- description: xpub.used
- example: xpub.used
- type: string
- message:
- description: XPub already used registered within Tatum
- example: XPub already used registered within Tatum
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403RateNotFound:
- properties:
- errorCode:
- description: rate.not.found
- example: rate.not.found
- type: string
- message:
- description: No such currency rate.
- example: No such currency rate.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OffchainBroadcast:
- properties:
- errorCode:
- description: broadcast.failed.withdrawalId
- example: broadcast.failed.withdrawalId
- type: string
- message:
- description: WithdrawalId must be present.
- example: WithdrawalId must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OffchainCheck:
- properties:
- errorCode:
- description: withdrawal.check.currency
- example: withdrawal.check.currency
- type: string
- message:
- description: Withdrawal check available only for ETH based currencies.
- example: Withdrawal check available only for ETH based currencies.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BtcTxUtxoFailed:
- properties:
- errorCode:
- description: transaction.preparation.failed.utxo
- example: transaction.preparation.failed.utxo
- type: string
- message:
- description: Impossible to find last UTXO.
- example: Impossible to find last UTXO.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BtcMnemonicTxFailed:
- properties:
- errorCode:
- description: transaction.preparation.failed
- example: transaction.preparation.failed
- type: string
- message:
- description: >-
- Impossible to prepare transaction. Either mnemonic or keyPair and
- attr must be present.
- example: >-
- Impossible to prepare transaction. Either mnemonic or keyPair and
- attr must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403WithdrawalFailed:
- properties:
- errorCode:
- description: withdrawal.failed.transaction.failed
- example: withdrawal.failed.transaction.failed
- type: string
- message:
- description: Unable to store withdrawal, it is impossible to create transaction.
- example: Unable to store withdrawal, it is impossible to create transaction.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403WithdrawalCancelled:
- properties:
- errorCode:
- description: withdrawal.not.cancelled.transaction.failed
- example: withdrawal.not.cancelled.transaction.failed
- type: string
- message:
- description: >-
- Unable to cancel withdrawal ${id}, it is impossible to create refund
- transaction.
- example: >-
- Unable to cancel withdrawal ${id}, it is impossible to create refund
- transaction.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403FeeFormat:
- properties:
- errorCode:
- description: fee.format
- example: fee.format
- type: string
- message:
- description: Fee has incorrect format.
- example: Fee has incorrect format.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxSenderNotFound:
- properties:
- errorCode:
- description: senderAccount.not.exists
- example: senderAccount.not.exists
- type: string
- message:
- description: Unable to find sender account ${transaction.senderAccountId}.
- example: Unable to find sender account ${transaction.senderAccountId}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxSenderFrozen:
- properties:
- errorCode:
- description: senderAccount.frozen
- example: senderAccount.frozen
- type: string
- message:
- description: >-
- Sender account ${transaction.senderAccountId} is frozen, unable to
- perform payment.
- example: >-
- Sender account ${transaction.senderAccountId} is frozen, unable to
- perform payment.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxSenderCustomerDisabled:
- properties:
- errorCode:
- description: senderAccount.customer.disabled
- example: senderAccount.customer.disabled
- type: string
- message:
- description: >-
- Sender accounts customer ${senderAccount.customerId} is disabled,
- unable to perform payment.
- example: >-
- Sender accounts customer ${senderAccount.customerId} is disabled,
- unable to perform payment.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxRecipientNotFound:
- properties:
- errorCode:
- description: recipientAccount.not.exists
- example: recipientAccount.not.exists
- type: string
- message:
- description: Unable to find recipient account ${transaction.recipientAccountId}.
- example: Unable to find recipient account ${transaction.recipientAccountId}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxCurrency:
- properties:
- errorCode:
- description: transaction.currency.incompatible
- example: transaction.currency.incompatible
- type: string
- message:
- description: >-
- Incompatible currencies for sender account
- ${transaction.senderAccountId} and recipient account
- ${transaction.recipientAccountId}.
- example: >-
- Incompatible currencies for sender account
- ${transaction.senderAccountId} and recipient account
- ${transaction.recipientAccountId}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxBalance:
- properties:
- errorCode:
- description: balance.insufficient
- example: balance.insufficient
- type: string
- message:
- description: >-
- Insufficient balance for account ${transaction.senderAccountId} and
- payment amount ${transaction.amount}. Sender balance is
- ${senderAccount.balance.availableBalance as string}, amount is
- ${amount}
- example: >-
- Insufficient balance for account ${transaction.senderAccountId} and
- payment amount ${transaction.amount}. Sender balance is
- ${senderAccount.balance.availableBalance as string}, amount is
- ${amount}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxAmountBtc:
- properties:
- errorCode:
- description: amount.btc
- example: amount.btc
- type: string
- message:
- description: >-
- BTC|LTC|BCH|DOGE payment amount must be at least 0.00000001, not
- ${transaction.amount}.
- example: >-
- BTC|LTC|BCH|DOGE payment amount must be at least 0.00000001, not
- ${transaction.amount}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxAmountBtcOffchain:
- properties:
- errorCode:
- description: transaction.amount.btc
- example: transaction.amount.btc
- type: string
- message:
- description: >-
- BTC|LTC|BCH|DOGE payment amount must be at least 0.00000001, not
- ${transaction.amount}.
- example: >-
- BTC|LTC|BCH|DOGE payment amount must be at least 0.00000001, not
- ${transaction.amount}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxAmountAda:
- properties:
- errorCode:
- description: transaction.amount.ada
- example: transaction.amount.ada
- type: string
- message:
- description: >-
- ADA payment amount must be at least 0.000001, not
- ${transaction.amount}.
- example: >-
- ADA payment amount must be at least 0.000001, not
- ${transaction.amount}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxAmountAdaOffchain:
- properties:
- errorCode:
- description: amount.ada
- example: amount.ada
- type: string
- message:
- description: >-
- ADA payment amount must be at least 0.000000000001, not
- ${transaction.amount}.
- example: >-
- ADA payment amount must be at least 0.000000000001, not
- ${transaction.amount}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403WithdrawalPending:
- properties:
- errorCode:
- description: withdrawal.pending
- example: withdrawal.pending
- type: string
- message:
- description: >-
- Unable to prepare withdrawal, last withdrawal with id ${id} is not
- yet processed by blockchain.
- example: >-
- Unable to prepare withdrawal, last withdrawal with id ${id} is not
- yet processed by blockchain.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxAmountEth:
- properties:
- errorCode:
- description: amount.eth
- example: amount.eth
- type: string
- message:
- description: >-
- ETH payment amount must be at least 0.000000000001, not
- ${transaction.amount}.
- example: >-
- ETH payment amount must be at least 0.000000000001, not
- ${transaction.amount}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxAmountEthOffchain:
- properties:
- errorCode:
- description: transaction.amount.eth
- example: transaction.amount.eth
- type: string
- message:
- description: >-
- ETH payment amount must be at least 0.000000000000000001, not
- ${transaction.amount}.
- example: >-
- ETH payment amount must be at least 0.000000000000000001, not
- ${transaction.amount}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403TxNotCompliant:
- properties:
- errorCode:
- description: transaction.not.compliant
- example: transaction.not.compliant
- type: string
- message:
- description: >-
- Transaction not compliant, recipient account customer country is not
- defined.
- example: >-
- Transaction not compliant, recipient account customer country is not
- defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403WithdrawalVC:
- properties:
- errorCode:
- description: withdrawal.account.virtual
- example: withdrawal.account.virtual
- type: string
- message:
- description: Sender account cannot be virtual.
- example: Sender account cannot be virtual.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403Erc20Prefix:
- properties:
- errorCode:
- description: erc20.symbol.prefix
- example: erc20.symbol.prefix
- type: string
- message:
- description: ERC20 token cannot start with VC_.
- example: ERC20 token cannot start with VC_.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403Erc20XpubBoth:
- properties:
- errorCode:
- description: erc20.address.xpub.both
- example: erc20.address.xpub.both
- type: string
- message:
- description: Either xpub or address must be present, not both.
- example: Either xpub or address must be present, not both.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403Erc20XpubMissing:
- properties:
- errorCode:
- description: erc20.address.xpub.missing
- example: erc20.address.xpub.missing
- type: string
- message:
- description: Either xpub or address must be present.
- example: Either xpub or address must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403Erc20NameDuplicate:
- properties:
- errorCode:
- description: erc20.duplicate.name
- example: erc20.duplicate.name
- type: string
- message:
- description: ERC20 token with given name already exists.
- example: ERC20 token with given name already exists.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency1NotFound:
- properties:
- errorCode:
- description: trade.currency1AccountId.not.exists
- example: trade.currency1AccountId.not.exists
- type: string
- message:
- description: Unable to find currency1 account ${trade.currency1AccountId}.
- example: Unable to find currency1 account ${trade.currency1AccountId}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderFeeNotFound:
- properties:
- errorCode:
- description: trade.feeAccount
- example: trade.feeAccount
- type: string
- message:
- description: Unable to find fee account ${trade.feeAccountId}.
- example: Unable to find fee account ${trade.feeAccountId}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderFeeIncompatible:
- properties:
- errorCode:
- description: trade.currency.fee
- example: trade.currency.fee
- type: string
- message:
- description: Incompatible currencies for currency1 and fee account.
- example: Incompatible currencies for currency1 and fee account.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency1Frozen:
- properties:
- errorCode:
- description: trade.currency1AccountId.frozen
- example: trade.currency1AccountId.frozen
- type: string
- message:
- description: >-
- Currency1 account ${trade.currency1AccountId} is frozen, unable to
- perform trade.
- example: >-
- Currency1 account ${trade.currency1AccountId} is frozen, unable to
- perform trade.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency1CustomerDisabled:
- properties:
- errorCode:
- description: trade.currency1AccountId.customer.disabled
- example: trade.currency1AccountId.customer.disabled
- type: string
- message:
- description: >-
- Currency1 account's customer ${currency1Account.customerId} is
- disabled, unable to perform exchange trade.
- example: >-
- Currency1 account's customer ${currency1Account.customerId} is
- disabled, unable to perform exchange trade.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency2NotFound:
- properties:
- errorCode:
- description: trade.currency2AccountId.not.exists
- example: trade.currency2AccountId.not.exists
- type: string
- message:
- description: Unable to find currency2 account ${trade.currency2AccountId}.
- example: Unable to find currency2 account ${trade.currency2AccountId}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency2Frozen:
- properties:
- errorCode:
- description: trade.currency2AccountId.frozen
- example: trade.currency2AccountId.frozen
- type: string
- message:
- description: >-
- Currency2 account ${trade.currency2AccountId} is frozen, unable to
- perform trade.
- example: >-
- Currency2 account ${trade.currency2AccountId} is frozen, unable to
- perform trade.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency2CustomerDisabled:
- properties:
- errorCode:
- description: trade.currency2AccountId.customer.disabled
- example: trade.currency2AccountId.customer.disabled
- type: string
- message:
- description: >-
- Currency2 account's customer ${currency2Account.customerId} is
- disabled, unable to perform exchange trade.
- example: >-
- Currency2 account's customer ${currency2Account.customerId} is
- disabled, unable to perform exchange trade.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency1Pair:
- properties:
- errorCode:
- description: trade.currency1.pair
- example: trade.currency1.pair
- type: string
- message:
- description: >-
- Incompatible currencies for currency1 account
- ${trade.currency1AccountId} and trading pair.
- example: >-
- Incompatible currencies for currency1 account
- ${trade.currency1AccountId} and trading pair.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency2Pair:
- properties:
- errorCode:
- description: trade.currency2.pair
- example: trade.currency2.pair
- type: string
- message:
- description: >-
- Incompatible currencies for currency2 account
- ${trade.currency2AccountId} and trading pair.
- example: >-
- Incompatible currencies for currency2 account
- ${trade.currency2AccountId} and trading pair.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency1Balance:
- properties:
- errorCode:
- description: trade.currency1.balance
- example: trade.currency1.balance
- type: string
- message:
- description: >-
- Insufficient balance on currency1 account
- ${trade.currency1AccountId}.
- example: >-
- Insufficient balance on currency1 account
- ${trade.currency1AccountId}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OrderCurrency2Balance:
- properties:
- errorCode:
- description: trade.currency2.balance
- example: trade.currency2.balance
- type: string
- message:
- description: >-
- Insufficient balance on currency2 account
- ${trade.currency2AccountId}.
- example: >-
- Insufficient balance on currency2 account
- ${trade.currency2AccountId}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error500:
- properties:
- message:
- example: Internal server error
- description: Internal server error
- type: string
- statusCode:
- example: 500
- description: "500"
- type: number
- required:
- - statusCode
- - message
- type: object
- Error403:
- properties:
- message:
- example: Forbidden
- description: Forbidden
- type: string
- statusCode:
- example: 403
- description: "403"
- type: number
- required:
- - statusCode
- - message
- type: object
- Error401:
- properties:
- message:
- example: Unauthorized
- description: Unauthorized
- type: string
- statusCode:
- example: 401
- description: "401"
- type: number
- required:
- - statusCode
- - message
- type: object
- FeeEvmBased:
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: number
- description: Gas limit for transaction in gas price.
- example: 40000
- gasPrice:
- type: number
- description: Gas price in Gwei.
- example: 20
- FeeBtcBased:
- type: object
- required:
- - fast
- - medium
- - slow
- properties:
- fast:
- type: string
- description: >-
- Transaction fee in BTC|LTC to be paid, if transaction should be
- included in next 1-2 blocks.
- example: "0.006584"
- medium:
- type: string
- description: >-
- Transaction fee in BTC|LTC to be paid, if transaction should be
- included in next 5-6 blocks.
- example: "0.004584"
- slow:
- type: string
- description: >-
- Transaction fee in BTC|LTC to be paid, if transaction should be
- included in next 7+ blocks.
- example: "0.002584"
- EstimateFee:
- type: object
- required:
- - chain
- - type
- properties:
- chain:
- type: string
- description: The blockchain to estimate the fee for
- enum:
- - CELO
- - ETH
- - BSC
- - XDC
- - ONE
- - MATIC
- - KLAY
- type:
- type: string
- description: The type of the transaction
- enum:
- - DEPLOY_ERC20
- - DEPLOY_NFT
- - MINT_NFT
- - BURN_NFT
- - TRANSFER_NFT
- - TRANSFER_ERC20
- - DEPLOY_AUCTION
- - DEPLOY_MARKETPLACE
- sender:
- type: string
- maxLength: 42
- minLength: 42
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- description: >-
- (Only if type=TRANSFER_ERC20
) The blockchain address of
- the sender address
- recipient:
- description: >-
- (Only if type=TRANSFER_ERC20
) The blockchain address of
- the recipient address
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- contractAddress:
- description: >-
- (Only if type=TRANSFER_ERC20
) The blockchain address of
- the smart address of the fungible token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- amount:
- description: >-
- (Only if type=TRANSFER_ERC20
) The amount of the
- fungible token to be sent
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- EstimateFeeDeployCustodialWallet:
- type: object
- required:
- - chain
- - type
- - batchCount
- properties:
- chain:
- type: string
- description: Blockchain to estimate fee for.
- enum:
- - CELO
- - ETH
- - BSC
- - XDC
- - ONE
- - MATIC
- - KLAY
- type:
- type: string
- description: Type of transaction
- enum:
- - DEPLOY_CUSTODIAL_WALLET_BATCH
- batchCount:
- description: Number of addresses to create
- example: 10
- minimum: 1
- maximum: 300
- type: number
- EstimateFeeBatchMintNft:
- type: object
- required:
- - chain
- - type
- - sender
- - recipients
- - tokenIds
- - urls
- - contractAddress
- properties:
- chain:
- type: string
- description: Blockchain to estimate fee for.
- enum:
- - CELO
- - ETH
- - BSC
- - XDC
- - ONE
- - MATIC
- - KLAY
- type:
- type: string
- description: Type of transaction
- enum:
- - MINT_NFT_BATCH
- sender:
- type: string
- maxLength: 42
- minLength: 43
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- description: Address of the minter
- recipients:
- type: array
- description: Blockchain addresses to mint tokens to
- items:
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 43
- type: string
- contractAddress:
- description: Contract address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 43
- type: string
- tokenIds:
- type: array
- description: Token IDs
- items:
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- urls:
- type: array
- description: Metadata URLs
- items:
- example: ipfs://QmXJJ6UF5WkF4WTJvsdhiA1etGwBLfpva7Vr9AudGMe3pj
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- EstimateFeeTransferFromCustodial:
- type: object
- required:
- - chain
- - type
- - sender
- - recipient
- - custodialAddress
- - amount
- - tokenType
- properties:
- chain:
- type: string
- description: The blockchain to estimate the fee for
- enum:
- - CELO
- - ETH
- - BSC
- - XDC
- - KLAY
- - ONE
- - MATIC
- type:
- type: string
- description: The type of the transaction
- enum:
- - TRANSFER_CUSTODIAL
- sender:
- type: string
- maxLength: 42
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- minLength: 42
- description: The blockchain address of the sender
- recipient:
- description: The blockchain address of the recipient
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- contractAddress:
- description: Contract address of the token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- custodialAddress:
- description: The blockchain address of the custodial wallet contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- tokenType:
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- example: 0
- type: number
- minimum: 0
- maximum: 3
- enum:
- - 0
- - 1
- - 2
- - 3
- amount:
- description: >
- 1
.100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - feeRecipient
- - chain
- - marketplaceFee
- - fromPrivateKey
- GenerateMarketplaceSolana:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- from:
- description: The address that will be the owner of the marketplace
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- treasuryMint:
- description: Address of a SPL token contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- treasuryWithdrawalDestination:
- description: >-
- The address that will be able to withdraw funds from the marketplace
- treasury account to own address
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- feeWithdrawalDestination:
- description: >-
- The address that will be able to withdraw funds from the marketplace
- fee account to own address
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- requiresSignOff:
- description: >-
- Set to "false" if you do not want the marketplace to sign all
- operations related to the listings and sales; if not set, defaults
- to "true" (the marketplace must sign all the operations)
- example: true
- type: boolean
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- required:
- - chain
- - marketplaceFee
- - from
- - fromPrivateKey
- GenerateMarketplaceSolanaKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- from:
- description: The address that will be the owner of the marketplace
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- treasuryMint:
- description: Address of a SPL token contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- treasuryWithdrawalDestination:
- description: >-
- The address that will be able to withdraw funds from the marketplace
- treasury account to own address
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- feeWithdrawalDestination:
- description: >-
- The address that will be able to withdraw funds from the marketplace
- fee account to own address
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- requiresSignOff:
- description: >-
- Set to "false" if you do not want the marketplace to sign all
- operations related to the listings and sales; if not set, defaults
- to "true" (the marketplace must sign all the operations)
- example: true
- type: boolean
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- required:
- - chain
- - marketplaceFee
- - from
- - signatureId
- GenerateMarketplaceCelo:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- feeRecipient:
- maxLength: 42
- minLength: 42
- description: Address of the recipient of the fee for the trade.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - feeRecipient
- - marketplaceFee
- - chain
- - feeCurrency
- - fromPrivateKey
- GenerateMarketplaceKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - KLAY
- - BSC
- - MATIC
- example: ETH
- type: string
- feeRecipient:
- maxLength: 42
- minLength: 42
- description: Address of the recipient of the fee for the trade.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - feeRecipient
- - chain
- - marketplaceFee
- - signatureId
- GenerateMarketplaceCeloKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- feeRecipient:
- maxLength: 42
- minLength: 42
- description: Address of the recipient of the fee for the trade.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - feeRecipient
- - marketplaceFee
- - chain
- - feeCurrency
- - signatureId
- GenerateAuction:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - KLAY
- - BSC
- - MATIC
- example: ETH
- type: string
- feeRecipient:
- maxLength: 42
- minLength: 42
- description: Address of the recipient of the fee for the trade.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- auctionFee:
- type: number
- description: Percentage of the selling amount of the NFT asset. 100 - 1%
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - feeRecipient
- - chain
- - auctionFee
- - fromPrivateKey
- GenerateAuctionCelo:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- feeRecipient:
- maxLength: 42
- minLength: 42
- description: Address of the recipient of the fee for the trade.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- auctionFee:
- type: number
- description: Percentage of the selling amount of the NFT asset. 100 - 1%
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - feeRecipient
- - auctionFee
- - chain
- - feeCurrency
- - fromPrivateKey
- GenerateAuctionKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - KLAY
- - BSC
- - MATIC
- example: ETH
- type: string
- feeRecipient:
- maxLength: 42
- minLength: 42
- description: Address of the recipient of the fee for the trade.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- auctionFee:
- type: number
- description: Percentage of the selling amount of the NFT asset. 100 - 1%
- example: 150
- minimum: 0
- maximum: 10000
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - feeRecipient
- - chain
- - auctionFee
- - signatureId
- GenerateAuctionCeloKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- feeRecipient:
- maxLength: 42
- minLength: 42
- description: Address of the recipient of the fee for the trade.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- auctionFee:
- type: number
- description: Percentage of the selling amount of the NFT asset. 100 - 1%
- example: 150
- minimum: 0
- maximum: 10000
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - feeRecipient
- - auctionFee
- - chain
- - feeCurrency
- - signatureId
- GenerateMarketplaceTron:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - TRON
- example: TRON
- type: string
- feeRecipient:
- maxLength: 34
- minLength: 34
- description: Address of the recipient of the fee for the trade.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- required:
- - feeLimit
- - from
- - feeRecipient
- - marketplaceFee
- - fromPrivateKey
- GenerateMarketplaceTronKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - TRON
- example: TRON
- type: string
- feeRecipient:
- maxLength: 34
- minLength: 34
- description: Address of the recipient of the fee for the trade.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- from:
- maxLength: 34
- minLength: 34
- description: Address of the recipient of the fee for the trade.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- required:
- - feeLimit
- - from
- - feeRecipient
- - marketplaceFee
- - signatureId
- SellAssetOnMarketplace:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the marketplace smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- nftAddress:
- maxLength: 42
- minLength: 42
- description: Address of the NFT asset to sell smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- seller:
- maxLength: 42
- minLength: 42
- description: Address of the seller of the NFT asset.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: >-
- Amount of the assets to be sent. For ERC-721 tokens, enter amount
- only in case of native currency cashback. In case of ERC-1155 this
- field is required and must be greater than 0
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- price:
- description: >-
- Price of the asset to sell. Marketplace fee will be obtained on top
- of this price.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: The private key of the seller's blockchain address
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - listingId
- - seller
- - price
- - fromPrivateKey
- SellAssetOnMarketplaceSolana:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- nftAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the asset to sell
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- from:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the seller
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- price:
- description: >-
- Price of the asset to sell. Marketplace fee will be obtained on top
- of this price.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- authorityPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: >-
- The private key used for signing transactions as authority; required
- if requiresSignOff
is set to "true" for the marketplace
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: The private key of the seller
- required:
- - chain
- - contractAddress
- - nftAddress
- - price
- - from
- - fromPrivateKey
- SellAssetOnMarketplaceSolanaKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- nftAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the asset to sell
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- from:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the seller
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- price:
- description: >-
- Price of the asset to sell. Marketplace fee will be obtained on top
- of this price.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- authoritySignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key used for signing transactions
- as authority; required if requiresSignOff
is set to
- "true" for the marketplace
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: The KMS identifier of the private key of the seller
- required:
- - chain
- - contractAddress
- - nftAddress
- - price
- - from
- - signatureId
- SellAssetOnMarketplaceCelo:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the marketplace smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- nftAddress:
- maxLength: 42
- minLength: 42
- description: Address of the NFT asset to sell smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- seller:
- maxLength: 42
- minLength: 42
- description: Address of the seller of the NFT asset.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: >-
- Amount of the assets to be sent. For ERC-721 tokens, enter amount
- only in case of native currency cashback.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- price:
- description: >-
- Price of the asset to sell. Marketplace fee will be obtained on top
- of this price.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: The private key of the seller's blockchain address
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - listingId
- - seller
- - price
- - feeCurrency
- - fromPrivateKey
- SellAssetOnMarketplaceKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the marketplace smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- nftAddress:
- maxLength: 42
- minLength: 42
- description: Address of the NFT asset to sell smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- seller:
- maxLength: 42
- minLength: 42
- description: Address of the seller of the NFT asset.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: >-
- Amount of the assets to be sent. For ERC-721 tokens, enter amount
- only in case of natiev currency cashback.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- price:
- description: >-
- Price of the asset to sell. Marketplace fee will be obtained on top
- of this price.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the seller's blockchain
- address
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - listingId
- - seller
- - price
- - signatureId
- SellAssetOnMarketplaceCeloKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the marketplace smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- nftAddress:
- maxLength: 42
- minLength: 42
- description: Address of the NFT asset to sell smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- seller:
- maxLength: 42
- minLength: 42
- description: Address of the seller of the NFT asset.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: >-
- Amount of the assets to be sent. For ERC-721 tokens, enter amount
- only in case of natiev currency cashback.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- price:
- description: >-
- Price of the asset to sell. Marketplace fee will be obtained on top
- of this price.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the seller's blockchain
- address
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - listingId
- - seller
- - price
- - feeCurrency
- - signatureId
- WithdrawFromMarketplaceSolana:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- from:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the marketplace fee recipient
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- amount:
- description: Amount of funds to withdraw.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: The private key of the marketplace fee recipient
- required:
- - chain
- - contractAddress
- - nftAddress
- - amount
- - from
- - fromPrivateKey
- WithdrawFromMarketplaceSolanaKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- from:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the marketplace fee recipient
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- amount:
- description: Amount of funds to withdraw.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the marketplace fee
- recipient
- required:
- - chain
- - contractAddress
- - nftAddress
- - amount
- - from
- - signatureId
- CreateAuction:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the auction smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- nftAddress:
- maxLength: 42
- minLength: 42
- description: Address of the NFT asset to sell smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- seller:
- maxLength: 42
- minLength: 42
- description: Address of the seller of the NFT asset.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- id:
- type: string
- description: ID of the auction. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: Amount of the assets to be sent. For ERC-721 tokens, enter 1.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- endedAt:
- description: Last block, where auction accepts bids.
- example: 100000
- minimum: 0
- type: number
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - id
- - seller
- - endedAt
- - fromPrivateKey
- CreateAuctionCelo:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the auction smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- nftAddress:
- maxLength: 42
- minLength: 42
- description: Address of the NFT asset to sell smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- seller:
- maxLength: 42
- minLength: 42
- description: Address of the seller of the NFT asset.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- id:
- type: string
- description: ID of the auction. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: Amount of the assets to be sent. For ERC-721 tokens, enter 1.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- endedAt:
- description: Last block, where auction accepts bids.
- example: 100000
- minimum: 0
- type: number
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - id
- - seller
- - endedAt
- - feeCurrency
- - fromPrivateKey
- CreateAuctionKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the auction smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- nftAddress:
- maxLength: 42
- minLength: 42
- description: Address of the NFT asset to sell smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- seller:
- maxLength: 42
- minLength: 42
- description: Address of the seller of the NFT asset.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- id:
- type: string
- description: ID of the auction. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: Amount of the assets to be sent. For ERC-721 tokens, enter 1.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- endedAt:
- description: Last block, where auction accepts bids.
- example: 100000
- minimum: 0
- type: number
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - id
- - seller
- - endedAt
- - signatureId
- CreateAuctionCeloKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the auction smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- nftAddress:
- maxLength: 42
- minLength: 42
- description: Address of the NFT asset to sell smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- seller:
- maxLength: 42
- minLength: 42
- description: Address of the seller of the NFT asset.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- id:
- type: string
- description: ID of the auction. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: Amount of the assets to be sent. For ERC-721 tokens, enter 1.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- endedAt:
- description: Last block, where auction accepts bids.
- example: 100000
- minimum: 0
- type: number
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - id
- - seller
- - endedAt
- - feeCurrency
- - signatureId
- SellAssetOnMarketplaceTron:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - TRON
- example: TRON
- type: string
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of the marketplace smart contract.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- nftAddress:
- maxLength: 34
- minLength: 34
- description: Address of the NFT asset to sell smart contract.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- seller:
- maxLength: 34
- minLength: 34
- description: Address of the seller of the NFT asset.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- erc20Address:
- maxLength: 34
- minLength: 34
- description: >-
- Optional address of the TRC20 token, which will be used as a selling
- currency of the NFT.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: Amount of the assets to be sent. For ERC-721 tokens, enter 1.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- price:
- description: >-
- Price of the asset to sell. Marketplace fee will be obtained on top
- of this price.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- required:
- - feeLimit
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - listingId
- - seller
- - price
- - fromPrivateKey
- SellAssetOnMarketplaceTronKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - TRON
- example: TRON
- type: string
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of the marketplace smart contract.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- from:
- maxLength: 34
- minLength: 34
- description: Address of the recipient of the fee for the trade.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nftAddress:
- maxLength: 34
- minLength: 34
- description: Address of the NFT asset to sell smart contract.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- seller:
- maxLength: 34
- minLength: 34
- description: Address of the seller of the NFT asset.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- erc20Address:
- maxLength: 34
- minLength: 34
- description: >-
- Optional address of the TRC20 token, which will be used as a selling
- currency of the NFT.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- amount:
- description: Amount of the assets to be sent. For ERC-721 tokens, enter 1.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: ID of token, if transaction is for ERC-721 or ERC-1155.
- example: "100000"
- type: string
- maxLength: 256
- price:
- description: >-
- Price of the asset to sell. Marketplace fee will be obtained on top
- of this price.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155.
- example: true
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- required:
- - feeLimit
- - nftAddress
- - chain
- - contractAddress
- - tokenId
- - isErc721
- - listingId
- - seller
- - price
- - from
- - signatureId
- BuyAssetOnMarketplace:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - BSC
- - ETH
- - KLAY
- - MATIC
- - ONE
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the marketplace smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: The ID of the listing with the asset that you want to buy
- minLength: 1
- maxLength: 200
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- amount:
- description: >-
- (Only if you pay with the native blockchain currency) The price of
- the asset that you want to buy plus the marketplace fee. Do not use
- if you pay with fungible tokens.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- (Only if you pay with the fungible tokens) The blockchain address of
- the fungible tokens. Do not use if you pay with the native
- blockchain currency.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- buyer:
- maxLength: 42
- minLength: 42
- description: >-
- (Only if you want to buy the asset on behalf of someone else and
- this person wants to pay with the fungible tokens; for example, for
- buying the asset from a custodial wallet address) The blockchain
- address of the buyer on whose behalf you are buying the
- assetrequiresSignOff
is set to "true" for the marketplace
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: The private key of the buyer
- required:
- - chain
- - contractAddress
- - listingId
- - from
- - fromPrivateKey
- BuyAssetOnMarketplaceSolanaKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the marketplace smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- listingId:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the listing with the asset that you want
- to buy
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- from:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the buyer
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- authoritySignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key used for signing transactions
- as authority; required if requiresSignOff
is set to
- "true" for the marketplace
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: The KMS identifier of the private key of the buyer
- required:
- - chain
- - contractAddress
- - listingId
- - from
- - signatureId
- BuyAssetOnMarketplaceCelo:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the marketplace smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: The ID of the listing with the asset that you want to buy
- minLength: 1
- maxLength: 200
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- amount:
- description: >-
- (Only if you pay with the native blockchain currency) The price of
- the asset that you want to buy plus the marketplace fee. Do not use
- if you pay with fungible tokens.
- example: "1"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- (Only if you pay with the fungible tokens) The blockchain address of
- the fungible tokens. Do not use if you pay with the native
- blockchain currency.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- buyer:
- maxLength: 42
- minLength: 42
- description: >-
- (Only if you want to buy the asset on behalf of someone else and
- this person wants to pay with the fungible tokens; for example, for
- buying the asset from a custodial wallet address) The blockchain
- address of the buyer on whose behalf you are buying the
- asset100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - marketplaceFee
- - fromPrivateKey
- UpdateFeeSolana:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the marketplace smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- marketplaceFee:
- type: number
- description: >-
- The new percentage of the amount that an NFT was sold for that will
- be sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- from:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the marketplace authority
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: The private key of the marketspace authority
- required:
- - chain
- - contractAddress
- - marketplaceFee
- - from
- - fromPrivateKey
- UpdateFeeSolanaKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the marketplace smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- marketplaceFee:
- type: number
- description: >-
- The new percentage of the amount that an NFT was sold for that will
- be sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- from:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the marketplace authority
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: The KMS identifier of the private key of the marketspace authority
- required:
- - chain
- - contractAddress
- - marketplaceFee
- - from
- - signatureId
- UpdateFeeCelo:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the marketplace smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - marketplaceFee
- - feeCurrency
- - fromPrivateKey
- UpdateFeeKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the marketplace smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address from which the fee will be deducted that was generated from
- the mnemonic
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - nftAddress
- - chain
- - marketplaceFee
- - signatureId
- - contractAddress
- UpdateFeeCeloKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the marketplace smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address from which the fee will be deducted that was generated from
- the mnemonic
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - marketplaceFee
- - feeCurrency
- - signatureId
- UpdateFeeTron:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - TRON
- example: TRON
- type: string
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of the marketplace smart contract.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- required:
- - feeLimit
- - chain
- - contractAddress
- - marketplaceFee
- - fromPrivateKey
- UpdateFeeTronKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - TRON
- example: TRON
- type: string
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of the marketplace smart contract.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- from:
- maxLength: 34
- minLength: 34
- description: Address of the recipient of the fee for the trade.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- required:
- - feeLimit
- - chain
- - contractAddress
- - marketplaceFee
- - from
- - signatureId
- UpdateFeeAuction:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the auction smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- auctionFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the auction as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - auctionFee
- - fromPrivateKey
- UpdateFeeAuctionKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the auction smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- auctionFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the auction as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address from which the fee will be deducted that was generated from
- the mnemonic
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - nftAddress
- - chain
- - auctionFee
- - signatureId
- - contractAddress
- UpdateFeeAuctionCelo:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the auction smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- auctionFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the auction as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - auctionFee
- - feeCurrency
- - fromPrivateKey
- UpdateFeeAuctionCeloKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the auction smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- auctionFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the auction as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address from which the fee will be deducted that was generated from
- the mnemonic
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - auctionFee
- - feeCurrency
- - signatureId
- UpdateMarketplaceSolana:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- from:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the marketplace authority
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- treasuryWithdrawalDestination:
- description: >-
- The address that will be able to withdraw funds from the marketplace
- treasury account to own address
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- feeWithdrawalDestination:
- description: >-
- The address that will be able to withdraw funds from the marketplace
- fee account to own address
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- requiresSignOff:
- description: >-
- Set to "false" if you do not want the marketplace to sign all
- operations related to the listings and sales; if not set, defaults
- to "true" (the marketplace must sign all the operations)
- example: true
- type: boolean
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: The private key of the marketplace authority
- required:
- - chain
- - contractAddress
- - from
- - fromPrivateKey
- UpdateMarketplaceSolanaKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- marketplaceFee:
- type: number
- description: >-
- The percentage of the amount that an NFT was sold for that will be
- sent to the marketplace as a fee. To set the fee to 1%, set this
- parameter to 100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.
- example: 150
- minimum: 0
- maximum: 10000
- from:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the marketplace authority
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- treasuryWithdrawalDestination:
- description: >-
- The address that will be able to withdraw funds from the marketplace
- treasury account to own address
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- feeWithdrawalDestination:
- description: >-
- The address that will be able to withdraw funds from the marketplace
- fee account to own address
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- requiresSignOff:
- description: >-
- Set to "false" if you do not want the marketplace to sign all
- operations related to the listings and sales; if not set, defaults
- to "true" (the marketplace must sign all the operations)
- example: true
- type: boolean
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: The KMS identifier of the private key of the marketplace authority
- required:
- - chain
- - contractAddress
- - from
- - signatureId
- CancelSellAssetOnMarketplace:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the marketplace smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - chain
- - contractAddress
- - listingId
- - fromPrivateKey
- CancelSellAssetOnMarketplaceSolana:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- listingId:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the listing
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- from:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the asset owner
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- authorityPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: >-
- The private key used for signing transactions as authority; required
- if requiresSignOff
is set to "true" for the marketplace
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: The private key of the asset owner
- required:
- - chain
- - contractAddress
- - listingId
- - from
- - fromPrivateKey
- CancelSellAssetOnMarketplaceSolanaKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - SOL
- example: SOL
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the smart contract
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- type: string
- listingId:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the listing
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- from:
- maxLength: 44
- minLength: 32
- description: Blockchain address of the asset owner
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- authoritySignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key used for signing transactions
- as authority; required if requiresSignOff
is set to
- "true" for the marketplace
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: The KMS identifier of the private key of the asset owner
- required:
- - chain
- - contractAddress
- - listingId
- - from
- - signatureId
- CancelSellAssetOnMarketplaceCelo:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the marketplace smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - listingId
- - feeCurrency
- - fromPrivateKey
- CancelSellAssetOnMarketplaceKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - ETH
- - ONE
- - BSC
- - KLAY
- - MATIC
- example: ETH
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the marketplace smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - nftAddress
- - chain
- - listingId
- - signatureId
- - contractAddress
- CancelSellAssetOnMarketplaceCeloKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - CELO
- example: CELO
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of the marketplace smart contract.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- erc20Address:
- maxLength: 42
- minLength: 42
- description: >-
- Optional address of the ERC20 token, which will be used as a selling
- currency of the NFT.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- listingId:
- type: string
- description: ID of the listing. It's up to the developer to generate unique ID
- minLength: 1
- maxLength: 200
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - listingId
- - feeCurrency
- - signatureId
- CancelSellAssetOnMarketplaceTron:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - TRON
- example: TRON
- type: string
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of the marketplace smart contract.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- erc20Address:
- maxLength: 34
- minLength: 34
- description: >-
- Optional address of the TRC20 token, which will be used as a selling
- currency of the NFT.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- required:
- - feeLimit
- - chain
- - contractAddress
- - listingId
- - fromPrivateKey
- CancelSellAssetOnMarketplaceTronKMS:
- type: object
- properties:
- chain:
- description: Blockchain to work with.
- enum:
- - TRON
- example: TRON
- type: string
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of the marketplace smart contract.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- from:
- maxLength: 34
- minLength: 34
- description: Address of the recipient of the fee for the trade.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- erc20Address:
- maxLength: 34
- minLength: 34
- description: >-
- Optional address of the TRC20 token, which will be used as a selling
- currency of the NFT.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- required:
- - feeLimit
- - chain
- - contractAddress
- - listingId
- - from
- - signatureId
- ApproveTransferCustodialWallet:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - BSC
- - ETH
- - KLAY
- - MATIC
- - ONE
- - XDC
- example: ETH
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: The gas pump address that holds the asset
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- spender:
- maxLength: 42
- minLength: 42
- description: >-
- The blockchain address to allow the transfer of the asset from the
- gas pump address
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), or 2
for Multi Tokens (ERC-1155 or
- equivalent).
- example: 0
- enum:
- - 0
- - 1
- - 2
- tokenAddress:
- maxLength: 42
- minLength: 42
- description: The address of the asset to transfer
- example: "0x782919AFc85eEA2cB736874225456bB5d3e242bA"
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token or Multi Token) The amount of
- the asset to transfer. Do not use if the asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is a Multi Token or NFT) The ID of the token to
- transfer. Do not use if the asset is a fungible token.
- example: "100000"
- type: string
- maxLength: 256
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address that owns the gas pump
- address ("master address")
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transfer transaction; if not present, the
- last known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - custodialAddress
- - chain
- - contractType
- - spender
- - fromPrivateKey
- - tokenAddress
- ApproveTransferCustodialWalletCelo:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: The gas pump address that holds the asset
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- spender:
- maxLength: 42
- minLength: 42
- description: >-
- The blockchain address to allow the transfer of the asset from the
- gas pump address
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), or 2
for Multi Tokens (ERC-1155 or
- equivalent).
- example: 0
- enum:
- - 0
- - 1
- - 2
- tokenAddress:
- maxLength: 42
- minLength: 42
- description: The address of the asset to transfer
- example: "0x782919AFc85eEA2cB736874225456bB5d3e242bA"
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token or Multi Token) The amount of
- the asset to transfer. Do not use if the asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is a Multi Token or NFT) The ID of the token to
- transfer. Do not use if the asset is a fungible token.
- example: "100000"
- type: string
- maxLength: 256
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address that owns the gas pump
- address ("master address")
- feeCurrency:
- type: string
- default: CELO
- description: The currency in which the gas fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transfer transaction; if not present, the
- last known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - custodialAddress
- - chain
- - contractType
- - spender
- - fromPrivateKey
- - tokenAddress
- ApproveTransferCustodialWalletCeloKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: The gas pump address that holds the asset
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- spender:
- maxLength: 42
- minLength: 42
- description: >-
- The blockchain address to allow the transfer of the asset from the
- gas pump address
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), or 2
for Multi Tokens (ERC-1155 or
- equivalent).
- example: 0
- enum:
- - 0
- - 1
- - 2
- tokenAddress:
- maxLength: 42
- minLength: 42
- description: The address of the asset to transfer
- example: "0x782919AFc85eEA2cB736874225456bB5d3e242bA"
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token or Multi Token) The amount of
- the asset to transfer. Do not use if the asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is a Multi Token or NFT) The ID of the token to
- transfer. Do not use if the asset is a fungible token.
- example: "100000"
- type: string
- maxLength: 256
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- owns the gas pump address key ("master address")
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- "master address"
- feeCurrency:
- type: string
- default: CELO
- description: The currency in which the gas fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transfer transaction; if not present, the
- last known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - custodialAddress
- - chain
- - contractType
- - spender
- - signatureId
- - tokenAddress
- ApproveTransferCustodialWalletKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - BSC
- - ETH
- - KLAY
- - MATIC
- - ONE
- - XDC
- example: ETH
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: The gas pump address that holds the asset
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- spender:
- maxLength: 42
- minLength: 42
- description: >-
- The blockchain address to allow the transfer of the asset from the
- gas pump address
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), or 2
for Multi Tokens (ERC-1155 or
- equivalent).
- example: 0
- enum:
- - 0
- - 1
- - 2
- tokenAddress:
- maxLength: 42
- minLength: 42
- description: The address of the asset to transfer
- example: "0x782919AFc85eEA2cB736874225456bB5d3e242bA"
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token or Multi Token) The amount of
- the asset to transfer. Do not use if the asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is a Multi Token or NFT) The ID of the token to
- transfer. Do not use if the asset is a fungible token.
- example: "100000"
- type: string
- maxLength: 256
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- owns the gas pump address key ("master address")
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- "master address"
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transfer transaction; if not present, the
- last known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - custodialAddress
- - chain
- - contractType
- - spender
- - signatureId
- - tokenAddress
- TransferCustodialWallet:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - BSC
- - ETH
- - KLAY
- - MATIC
- - ONE
- - XDC
- example: ETH
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: >-
- The gas pump address that transfers the asset; this is the address
- that you precalculated and
- activated earlier
- and that is assigned to a customer in your custodial application;
- this is not the "master address"
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- recipient:
- maxLength: 42
- minLength: 42
- description: The blockchain address that receives the asset
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- example: 0
- enum:
- - 0
- - 1
- - 2
- - 3
- tokenAddress:
- maxLength: 42
- minLength: 42
- description: >-
- (Only if the asset is a fungible token, NFT, or Multi Token) The
- address of the token to transfer. Do not use if the asset is a
- native blockchain currency.
- example: "0x782919AFc85eEA2cB736874225456bB5d3e242bA"
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token, Multi Token, or native
- blockchain currency) The amount of the asset to transfer. Do not use
- if the asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is a Multi Token or NFT) The ID of the token to
- transfer. Do not use if the asset is a fungible token or native
- blockchain currency.
- example: "100000"
- type: string
- maxLength: 256
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address that owns the gas pump
- address ("master address")
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transfer transaction; if not present, the
- last known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - custodialAddress
- - chain
- - contractType
- - recipient
- - fromPrivateKey
- TransferCustodialWalletCelo:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: >-
- The gas pump address that transfers the asset; this is the address
- that you precalculated and
- activated earlier
- and that is assigned to a customer in your custodial application;
- this is not the "master address"
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- recipient:
- maxLength: 42
- minLength: 42
- description: The blockchain address that receives the asset
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- example: 0
- enum:
- - 0
- - 1
- - 2
- - 3
- tokenAddress:
- maxLength: 42
- minLength: 42
- description: >-
- (Only if the asset is a fungible token, NFT, or Multi Token) The
- address of the token to transfer. Do not use if the asset is a
- native blockchain currency.
- example: "0x782919AFc85eEA2cB736874225456bB5d3e242bA"
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token, Multi Token, or native
- blockchain currency) The amount of the asset to transfer. Do not use
- if the asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is a Multi Token or NFT) The ID of the token to
- transfer. Do not use if the asset is a fungible token or native
- blockchain currency.
- example: "100000"
- type: string
- maxLength: 256
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address that owns the gas pump
- address ("master address")
- feeCurrency:
- type: string
- default: CELO
- description: The currency in which the gas fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transfer transaction; if not present, the
- last known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - custodialAddress
- - chain
- - contractType
- - recipient
- - fromPrivateKey
- TransferCustodialWalletCeloKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - CELO
- example: CELO
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: >-
- The gas pump address that transfers the asset; this is the address
- that you precalculated and
- activated earlier
- and that is assigned to a customer in your custodial application;
- this is not the "master address"
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- recipient:
- maxLength: 42
- minLength: 42
- description: The blockchain address that receives the asset
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- example: 0
- enum:
- - 0
- - 1
- - 2
- - 3
- tokenAddress:
- maxLength: 42
- minLength: 42
- description: >-
- (Only if the asset is a fungible token, NFT, or Multi Token) The
- address of the token to transfer. Do not use if the asset is a
- native blockchain currency.
- example: "0x782919AFc85eEA2cB736874225456bB5d3e242bA"
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token, Multi Token, or native
- blockchain currency) The amount of the asset to transfer. Do not use
- if the asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is a Multi Token or NFT) The ID of the token to
- transfer. Do not use if the asset is a fungible token or native
- blockchain currency.
- example: "100000"
- type: string
- maxLength: 256
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- owns the gas pump address key ("master address")
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- "master address"
- feeCurrency:
- type: string
- default: CELO
- description: The currency in which the gas fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transfer transaction; if not present, the
- last known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - custodialAddress
- - chain
- - contractType
- - recipient
- - signatureId
- TransferCustodialWalletKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - BSC
- - ETH
- - KLAY
- - MATIC
- - ONE
- - XDC
- example: ETH
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: >-
- The gas pump address that transfers the asset; this is the address
- that you precalculated and
- activated earlier
- and that is assigned to a customer in your custodial application;
- this is not the "master address"
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- recipient:
- maxLength: 42
- minLength: 42
- description: The blockchain address that receives the asset
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- example: 0
- enum:
- - 0
- - 1
- - 2
- - 3
- tokenAddress:
- maxLength: 42
- minLength: 42
- description: >-
- (Only if the asset is a fungible token, NFT, or Multi Token) The
- address of the token to transfer. Do not use if the asset is a
- native blockchain currency.
- example: "0x782919AFc85eEA2cB736874225456bB5d3e242bA"
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token, Multi Token, or native
- blockchain currency) The amount of the asset to transfer. Do not use
- if the asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is a Multi Token or NFT) The ID of the token to
- transfer. Do not use if the asset is a fungible token or native
- blockchain currency.
- example: "100000"
- type: string
- maxLength: 256
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- owns the gas pump address key ("master address")
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- "master address"
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transfer transaction; if not present, the
- last known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - custodialAddress
- - chain
- - contractType
- - recipient
- - signatureId
- TransferCustodialWalletTronKMS:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - TRON
- example: TRON
- type: string
- custodialAddress:
- maxLength: 34
- minLength: 34
- description: >-
- The gas pump address that transfers the asset; this is the address
- that you precalculated and
- activated earlier
- and that is assigned to a customer in your custodial application;
- this is not the "master address"
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- from:
- type: string
- minLength: 34
- maxLength: 34
- description: >-
- The blockchain address that owns the gas pump address ("master
- address") in the Base58 format
- example: TBAYy8ykFZqdzxMwaqacHvUvUzUTp6ZR5U
- recipient:
- maxLength: 34
- minLength: 34
- description: The blockchain address that receives the asset
- example: TYMcTVBz48okKLRczhwiDu22V6XG3yk6W9
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), or 3
for native blockchain currencies.
- example: 0
- enum:
- - 0
- - 1
- - 3
- tokenAddress:
- maxLength: 34
- minLength: 34
- description: >-
- (Only if the asset is a fungible token or NFT) The address of the
- token to transfer. Do not use if the asset is a native blockchain
- currency.
- example: TYMG3ykLRczh6W9cTVBz48wiDu22V6XokK
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token or native blockchain
- currency) The amount of the asset to transfer. Do not use if the
- asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is an NFT) The ID of the token to transfer. Do
- not use if the asset is a fungible token or native blockchain
- currency.
- example: "100000"
- type: string
- maxLength: 256
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- owns the gas pump address key ("master address")
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- "master address"
- feeLimit:
- type: number
- minimum: 0
- description: The maximum amount to be paid as the gas fee (in TRX)
- example: 10
- required:
- - custodialAddress
- - chain
- - contractType
- - feeLimit
- - from
- - recipient
- - signatureId
- TransferCustodialWalletTron:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - TRON
- example: TRON
- type: string
- custodialAddress:
- maxLength: 34
- minLength: 34
- description: >-
- The gas pump address that transfers the asset; this is the address
- that you precalculated and
- activated earlier
- and that is assigned to a customer in your custodial application;
- this is not the "master address"
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- type: string
- recipient:
- maxLength: 34
- minLength: 34
- description: The blockchain address that receives the asset
- example: TYMcTVBz48okKLRczhwiDu22V6XG3yk6W9
- type: string
- contractType:
- type: number
- description: >-
- The type of the asset to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), or 3
for native blockchain currencies.
- example: 0
- enum:
- - 0
- - 1
- - 3
- tokenAddress:
- maxLength: 34
- minLength: 34
- description: >-
- (Only if the asset is a fungible token or NFT) The address of the
- token to transfer. Do not use if the asset is a native blockchain
- currency.
- example: TYMG3ykLRczh6W9cTVBz48wiDu22V6XokK
- type: string
- amount:
- description: >-
- (Only if the asset is a fungible token or native blockchain
- currency) The amount of the asset to transfer. Do not use if the
- asset is an NFT.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- tokenId:
- description: >-
- (Only if the asset is an NFT) The ID of the token to transfer. Do
- not use if the asset is a fungible token or native blockchain
- currency.
- example: "100000"
- type: string
- maxLength: 256
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- The private key of the blockchain address that owns the gas pump
- address ("master address")
- feeLimit:
- type: number
- minimum: 0
- description: The maximum amount to be paid as the gas fee (in TRX)
- example: 10
- required:
- - custodialAddress
- - chain
- - contractType
- - feeLimit
- - recipient
- - fromPrivateKey
- TransferCustodialWalletBatch:
- type: object
- properties:
- chain:
- description: The blockchain to work with
- enum:
- - BSC
- - ETH
- - KLAY
- - MATIC
- - ONE
- - XDC
- example: ETH
- type: string
- custodialAddress:
- maxLength: 42
- minLength: 42
- description: >-
- The gas pump address that transfers the assets; this is the address
- that you precalculated and
- activated earlier
- and that is assigned to a customer in your custodial application;
- this is not the "master address"
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- recipient:
- type: array
- description: The blockchain address that receives the assets
- items:
- maxLength: 42
- minLength: 42
- example: "0xe242bA5456b782919AFc85687422eEA2cB73B5d3"
- type: string
- contractType:
- type: array
- description: >-
- The type of the assets to transfer. Set 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- items:
- type: number
- example: 0
- enum:
- - 0
- - 1
- - 2
- - 3
- tokenAddress:
- type: array
- description: >
- "tokenAddress":
- ["0x782919AFc85eEA2cB736874225456bB5d3e242bA","0x74225456bB5d3e242bA782919AFc85eEA2cB7368",...,"0x3e242bA78274225456bB52cB7368d919AFc85eEA"]
-
- "tokenAddress": ["0","0",...,"0"]
-
- "amount": ["100000","15000",...,"250000"]
-
- "amount": ["0","0",...,"0"]
-
- "tokenId": ["12","13",...,"24"]
- "tokenId": ["0","0",...,"0"]
-
- 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- items:
- type: number
- example: 0
- enum:
- - 0
- - 1
- - 2
- - 3
- tokenAddress:
- type: array
- description: >
- "tokenAddress":
- ["0x782919AFc85eEA2cB736874225456bB5d3e242bA","0x74225456bB5d3e242bA782919AFc85eEA2cB7368",...,"0x3e242bA78274225456bB52cB7368d919AFc85eEA"]
-
- "tokenAddress": ["0","0",...,"0"]
-
- "amount": ["100000","15000",...,"250000"]
-
- "amount": ["0","0",...,"0"]
-
- "tokenId": ["12","13",...,"24"]
- "tokenId": ["0","0",...,"0"]
-
- 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), or 3
for native blockchain currencies.
- items:
- type: number
- example: 0
- enum:
- - 0
- - 1
- - 3
- tokenAddress:
- type: array
- description: >
- "tokenAddress":
- ["0x782919AFc85eEA2cB736874225456bB5d3e242bA","0x74225456bB5d3e242bA782919AFc85eEA2cB7368",...,"0x3e242bA78274225456bB52cB7368d919AFc85eEA"]
-
- "tokenAddress": ["0","0",...,"0"]
-
- "amount": ["100000","15000",...,"250000"]
-
- "amount": ["0","0",...,"0"]
-
- "tokenId": ["12","13",...,"24"]
- "tokenId": ["0","0",...,"0"]
-
- 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- items:
- type: number
- example: 0
- enum:
- - 0
- - 1
- - 2
- - 3
- tokenAddress:
- type: array
- description: >
- "tokenAddress":
- ["0x782919AFc85eEA2cB736874225456bB5d3e242bA","0x74225456bB5d3e242bA782919AFc85eEA2cB7368",...,"0x3e242bA78274225456bB52cB7368d919AFc85eEA"]
-
- "tokenAddress": ["0","0",...,"0"]
-
- "amount": ["100000","15000",...,"250000"]
-
- "amount": ["0","0",...,"0"]
-
- "tokenId": ["12","13",...,"24"]
- "tokenId": ["0","0",...,"0"]
-
- 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), or 3
for native blockchain currencies.
- items:
- type: number
- example: 0
- enum:
- - 0
- - 1
- - 3
- tokenAddress:
- type: array
- description: >
- "tokenAddress":
- ["0x782919AFc85eEA2cB736874225456bB5d3e242bA","0x74225456bB5d3e242bA782919AFc85eEA2cB7368",...,"0x3e242bA78274225456bB52cB7368d919AFc85eEA"]
-
- "tokenAddress": ["0","0",...,"0"]
-
- "amount": ["100000","15000",...,"250000"]
-
- "amount": ["0","0",...,"0"]
-
- "tokenId": ["12","13",...,"24"]
- "tokenId": ["0","0",...,"0"]
-
- 0
for fungible
- tokens (ERC-20 or equivalent), 1
for NFTs (ERC-721 or
- equivalent), 2
for Multi Tokens (ERC-1155 or
- equivalent), or 3
for native blockchain currencies.
- items:
- type: number
- example: 0
- enum:
- - 0
- - 1
- - 2
- - 3
- tokenAddress:
- type: array
- description: >
- "tokenAddress":
- ["0x782919AFc85eEA2cB736874225456bB5d3e242bA","0x74225456bB5d3e242bA782919AFc85eEA2cB7368",...,"0x3e242bA78274225456bB52cB7368d919AFc85eEA"]
-
- "tokenAddress": ["0","0",...,"0"]
-
- "amount": ["100000","15000",...,"250000"]
-
- "amount": ["0","0",...,"0"]
-
- "tokenId": ["12","13",...,"24"]
- "tokenId": ["0","0",...,"0"]
-
- signatureId
parameter that you provided in the request
- body. The signatureId
parameter in the request body
- specifies the signature ID associated with the private key in KMS.
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- type: string
- required:
- - signatureId
- OffchainTransactionResult:
- type: object
- properties:
- id:
- description: >-
- ID of withdrawal. If transaction is not valid in blockchain, use
- this id to cancel withdrawal.
- example: 5e68c66581f2ee32bc354087
- type: string
- txId:
- description: TX hash of successful transaction.
- example: c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9
- type: string
- completed:
- description: >-
- If set to "true", the withdrawal has been completed in the virtual
- account; if set to "false", the withdrawal has not been completed
- and you have to complete it manually
- example: true
- type: boolean
- required:
- - txId
- - id
- - completed
- OffchainTransactionSignatureResult:
- type: object
- properties:
- signatureId:
- description: >-
- ID of prepared payment template to sign. This is should be stored on
- a client side to retrieve ID of the blockchain transaction, when
- signing application signs the transaction and broadcasts it to the
- blockchain.
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- format: uuid
- type: string
- required:
- - id
- - signatureId
- Url:
- properties:
- url:
- description: QR Code as data URL
- type: string
- type: object
- VirtualCurrency:
- properties:
- name:
- description: Virtual currency name. Must be prefixed with 'VC_'.
- example: VC_VIRTUAL
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- supply:
- description: Supply of virtual currency.
- maxLength: 38
- minLength: 1
- example: "1000000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- basePair:
- description: >-
- Base pair for virtual currency. Transaction value will be calculated
- according to this base pair. e.g. 1 VC_VIRTUAL is equal to 1 BTC, if
- basePair is set to BTC.
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- example: BTC
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- customer:
- $ref: "#/components/schemas/CustomerRegistration"
- description:
- description: Used as a description within Tatum system.
- example: My Virtual Token description.
- maxLength: 100
- minLength: 1
- type: string
- accountCode:
- description: For bookkeeping to distinct account purpose.
- maxLength: 50
- example: AC_1011_B
- minLength: 1
- type: string
- accountNumber:
- description: Account number from external system.
- example: "1234567890"
- type: string
- minLength: 1
- maxLength: 50
- accountingCurrency:
- description: >-
- All transaction will be billed in this currency for created account
- associated with this currency. If not set, EUR is used. ISO-4217
- $ref: "#/components/schemas/FiatCurrency"
- example: USD
- required:
- - basePair
- - name
- - supply
- type: object
- VC:
- properties:
- name:
- description: Virtual currency name. Must be prefixed with 'VC_'.
- example: VC_VIRTUAL
- type: string
- supply:
- description: Supply of virtual currency.
- example: "1000000"
- type: string
- accountId:
- description: Virtual currency account.
- example: 5e68c66581f2ee32bc354087
- type: string
- baseRate:
- type: number
- default: 1
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- precision:
- type: number
- example: 6
- description: Number of decimal places of this virtual currency.
- trcType:
- type: string
- example: TRC20
- description: Type of Tron token.
- enum:
- - TRC10
- - TRC20
- basePair:
- description: >-
- Base pair for virtual currency. Transaction value will be calculated
- according to this base pair. e.g. 1 VC_VIRTUAL is equal to 1 BTC, if
- basePair is set to BTC.
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- example: BTC
- type: string
- customerId:
- description: ID of customer associated with virtual currency.
- type: string
- example: 5e68c66581f2ee32bc354087
- description:
- description: Used as a description within Tatum system.
- example: My Virtual Token description.
- type: string
- erc20Address:
- description: >-
- Address of ERC20 token, when virtual currency is based on the
- Ethereum blockchain.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- issuerAccount:
- description: >-
- Blockchain account for XLM or XRP based virtual currencies, which is
- marked as the issuer of the custom blockchain asset.
- example: GDKYMXOAJ5MK4EVIHHNWRGAAOUZMNZYAETMHFCD6JCVBPZ77TUAZFPKT
- type: string
- chain:
- description: >-
- Blockchain, on which this virtual currency is paired on. Not
- present, when Tatum's private ledger is used as a base ledger.
- example: ETH
- type: string
- enum:
- - ETH
- - XRP
- - XLM
- initialAddress:
- description: >-
- Ethereum address, where initial supply was minted, when virtual
- currency is based on the Ethereum blockchain.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- required:
- - basePair
- - baseRate
- - name
- - accountId
- - supply
- type: object
- VirtualCurrencyUpdate:
- properties:
- name:
- description: >-
- Virtual currency name, which will be updated. It is not possible to
- update the name of the virtual currency.
- example: VC_VIRTUAL
- maxLength: 30
- pattern: ^[a-zA-Z0-9_]+$
- minLength: 1
- type: string
- baseRate:
- type: number
- example: 1
- default: 1
- minimum: 0
- description: >-
- Exchange rate of the base pair. Each unit of the created curency
- will represent value of baseRate*1 basePair.
- basePair:
- description: >-
- Base pair for virtual currency. Transaction value will be calculated
- according to this base pair. e.g. 1 VC_VIRTUAL is equal to 1 BTC, if
- basePair is set to BTC.
- $ref: "#/components/schemas/FiatOrCryptoCurrency"
- example: EUR
- required:
- - name
- type: object
- VirtualCurrencyOperation:
- properties:
- accountId:
- description: >-
- Ledger account with currency of the virtual currency, on which the
- operation will be performed.
- example: 5e68c66581f2ee32bc354087
- maxLength: 24
- minLength: 24
- type: string
- amount:
- description: Amount of virtual currency to operate within this operation.
- maxLength: 38
- example: "1.5"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- paymentId:
- description: >-
- Identifier of the payment, shown for created Transaction within
- Tatum sender account.
- example: My Payment
- maxLength: 100
- minLength: 1
- type: string
- reference:
- description: Reference of the payment.
- example: akjsndakjsdn-asd-kjasnd-asdkn-asdjnasjkdn
- maxLength: 100
- minLength: 1
- type: string
- transactionCode:
- description: For bookkeeping to distinct transaction purpose.
- example: 1_01_EXTERNAL_CODE
- maxLength: 100
- minLength: 1
- type: string
- recipientNote:
- description: >-
- Note visible to both, sender and recipient. Available for both Mint
- and Revoke operations
- example: Private note
- maxLength: 500
- minLength: 1
- type: string
- counterAccount:
- description: >-
- External account identifier. By default, there is no counterAccount
- present in the transaction.
- example: 5e6645712b55823de7ea82f1
- maxLength: 24
- minLength: 24
- type: string
- senderNote:
- description: Note visible to sender. Available in Revoke operation.
- example: Sender note
- maxLength: 500
- minLength: 1
- type: string
- required:
- - accountId
- - amount
- type: object
- Wallet:
- type: object
- required:
- - mnemonic
- - xpub
- properties:
- mnemonic:
- description: Generated mnemonic for wallet.
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- type: string
- xpub:
- description: >-
- Generated Extended public key for wallet with derivation path
- according to BIP44. This key can be used to generate addresses.
- example: >-
- xpub6EsCk1uU6cJzqvP9CdsTiJwT2rF748YkPnhv5Qo8q44DG7nn2vbyt48YRsNSUYS44jFCW9gwvD9kLQu9AuqXpTpM1c5hgg9PsuBLdeNncid
- type: string
- GeneratedAddressEth:
- type: object
- properties:
- address:
- type: string
- description: Ethereum address
- example: "0xa7673161CbfE0116A4De9E341f8465940c2211d4"
- GeneratedAddressBtc:
- type: object
- properties:
- address:
- type: string
- description: Bitcoin address
- example: "0xa7673161CbfE0116A4De9E341f8465940c2211d4"
- Withdrawal:
- properties:
- senderAccountId:
- description: Sender account ID
- example: 5e68c66581f2ee32bc354087
- maxLength: 24
- minLength: 24
- type: string
- address:
- description: >-
- Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it
- is possible to enter list of multiple recipient blockchain addresses
- as a comma separated string.
- example: mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7
- maxLength: 10000
- minLength: 1
- type: string
- amount:
- description: Amount to be withdrawn to blockchain.
- maxLength: 38
- example: "0.001"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- attr:
- description: >
- Used to parametrize withdrawal. Used for XRP withdrawal to define
- destination tag of recipient, or XLM memo of the recipient, if
- needed.
-
- For Bitcoin, Litecoin, Bitcoin Cash, used as a change address for
- left coins from transaction.
Used to parametrize withdrawal. Used for XRP withdrawal to define
- destination tag of recipient, or XLM memo of the recipient, if
- needed.
-
- For Bitcoin, Litecoin, Bitcoin Cash, used as a change address for
- left coins from transaction.
from
- parameter
- minimum: 0
- example: 200
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address that will pay the gas fee
- for the activation transaction
- required:
- - chain
- - owner
- - from
- - to
- - fromPrivateKey
- ActivateGasPumpTatum:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - BSC
- - CELO
- - ETH
- - MATIC
- - KLAY
- - ONE
- owner:
- type: string
- description: >-
- The blockchain address that owns the precalculated gas pump
- addresses and is used to pay gas fees for operations made on the gas
- pump addresses; can be referred to as "master address"
- example: "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
- from:
- type: integer
- description: The start index of the range of gas pump addresses to activate
- minimum: 0
- example: 0
- to:
- type: integer
- description: >-
- The end index of the range of gas pump addresses to activate; must
- be greater than or equal to the value in the from
- parameter
- minimum: 0
- example: 200
- feesCovered:
- type: boolean
- example: true
- description: >-
- Set to "true" to cover the gas fee by credits from your monthly
- credit allowance.
- required:
- - chain
- - owner
- - from
- - to
- - feesCovered
- ActivateGasPumpKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - BSC
- - ETH
- - KLAY
- - MATIC
- - ONE
- owner:
- type: string
- description: >-
- The blockchain address that owns the precalculated gas pump
- addresses and is used to pay gas fees for operations made on the gas
- pump addresses; can be referred to as "master address"
- example: "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
- from:
- type: integer
- description: The start index of the range of gas pump addresses to activate
- minimum: 0
- example: 0
- to:
- type: integer
- description: >-
- The end index of the range of gas pump addresses to activate; must
- be greater than or equal to the value in the from
- parameter
- minimum: 0
- example: 200
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- will pay the gas fee for the activation transaction
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- specific address from the mnemonic
- required:
- - chain
- - owner
- - from
- - to
- - signatureId
- ActivateGasPumpCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- owner:
- type: string
- description: >-
- The blockchain address that owns the precalculated gas pump
- addresses and is used to pay gas fees for operations made on the gas
- pump addresses; can be referred to as "master address"
- example: "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
- from:
- type: integer
- description: The start index of the range of gas pump addresses to activate
- minimum: 0
- example: 0
- to:
- type: integer
- description: >-
- The end index of the range of gas pump addresses to activate; must
- be greater than or equal to the value in the from
- parameter
- minimum: 0
- example: 200
- feeCurrency:
- type: string
- description: The currency in which the gas fee will be paid
- example: CELO
- enum:
- - CELO
- - CUSD
- - CEUR
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address that will pay the gas fee
- for the activation transaction
- required:
- - chain
- - owner
- - from
- - to
- - fromPrivateKey
- - feeCurrency
- ActivateGasPumpCeloKMS:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- owner:
- type: string
- description: >-
- The blockchain address that owns the precalculated gas pump
- addresses and is used to pay gas fees for operations made on the gas
- pump addresses; can be referred to as "master address"
- example: "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
- from:
- type: integer
- description: The start index of the range of gas pump addresses to activate
- minimum: 0
- example: 0
- to:
- type: integer
- description: >-
- The end index of the range of gas pump addresses to activate; must
- be greater than or equal to the value in the from
- parameter
- minimum: 0
- example: 200
- feeCurrency:
- type: string
- description: The currency in which the gas fee will be paid
- example: CELO
- enum:
- - CELO
- - CUSD
- - CEUR
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- will pay the gas fee for the activation transaction
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address that will pay the gas fee that was generated from the
- mnemonic
- required:
- - chain
- - owner
- - from
- - to
- - signatureId
- - feeCurrency
- ActivateGasPumpTron:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- owner:
- type: string
- description: >-
- The blockchain address that owns the precalculated gas pump
- addresses and is used to pay gas fees for operations made on the gas
- pump addresses; can be referred to as "master address"
- example: "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
- from:
- type: integer
- description: The start index of the range of gas pump addresses to activate
- minimum: 0
- example: 0
- to:
- type: integer
- description: >-
- The end index of the range of gas pump addresses to activate; must
- be greater than or equal to the value in the from
- parameter
- minimum: 0
- example: 200
- feeLimit:
- type: number
- description: The maximum amount to be paid as the gas fee (in TRX)
- example: 600
- fromPrivateKey:
- type: string
- maxLength: 64
- example: e26c1595086cd52f2bc61774c7228b841db66b4b9b0ed36dc29dbc90595dd5b6
- minLength: 64
- description: >-
- The private key of the blockchain address that will pay the gas fee
- for the activation transaction
- required:
- - chain
- - owner
- - from
- - to
- - feeLimit
- - fromPrivateKey
- ActivateGasPumpTronKMS:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- owner:
- type: string
- description: >-
- The blockchain address that owns the precalculated gas pump
- addresses and is used to pay gas fees for operations made on the gas
- pump addresses; can be referred to as "master address"
- example: "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
- from:
- type: integer
- description: The start index of the range of gas pump addresses to activate
- minimum: 0
- example: 0
- to:
- type: integer
- description: >-
- The end index of the range of gas pump addresses to activate; must
- be greater than or equal to the value in the from
- parameter
- minimum: 0
- example: 200
- feeLimit:
- type: number
- description: The maximum amount to be paid as the gas fee (in TRX)
- example: 600
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- will pay the gas fee for the activation transaction
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- specific address from the mnemonic
- required:
- - chain
- - owner
- - from
- - to
- - feeLimit
- - signatureId
- CreateGasPump:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - BSC
- - CELO
- - ETH
- - MATIC
- - KLAY
- - ONE
- - TRON
- owner:
- type: string
- description: >-
- The blockchain address that will own the precalculated gas pump
- addresses and will be used to pay gas fees for operations made on
- the gas pump addresses; can be referred to as "master address"
- example: "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
- from:
- type: integer
- description: The start index of the range of gas pump addresses to precalculate
- minimum: 0
- example: 0
- to:
- type: integer
- description: >-
- The end index of the range of gas pump addresses to precalculate;
- must be greater than or equal to the value in the from
- parameter
- minimum: 0
- example: 1000
- required:
- - chain
- - owner
- - from
- - to
- GasPumpTrxOut:
- type: object
- properties:
- valid:
- type: array
- description: Activated gas pump addresses
- items:
- $ref: "#/components/schemas/ValidGasPumpAddress"
- invalid:
- type: array
- description: Not activated gas pump addresses
- items:
- $ref: "#/components/schemas/InvalidGasPumpAddress"
- ValidGasPumpAddress:
- type: object
- properties:
- index:
- type: number
- description: The index of the activated gas pump address
- example: 1
- address:
- type: string
- description: The activated gas pump address
- example: "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea"
- InvalidGasPumpAddress:
- type: object
- properties:
- address:
- type: string
- description: The not activated gas pump address
- example: "0x2b5a0bE5940B63dE1eDdCCCa7bd977357e2488eD"
- reason:
- type: string
- description: The reason why the gas pump address did not get activated
- example: Wallet already exists
- SolanaMarketplaceTransactionHash:
- type: object
- properties:
- txId:
- description: The hash (ID) of the transaction
- example: c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9
- type: string
- contractAddress:
- description: The address of deployed marketplace contract
- example: 9qhKAgVRebMnjVM4AHdHcseYQG47Mns3U8e7dRz24kg5
- type: string
- feeAccount:
- description: The blockchain address of the fee account
- example: B2va8BWefHKhKnejxiKxLxWYbpzwJWPsNGzEPCiYHQDH
- type: string
- treasuryAccount:
- description: The blockchain address of the treasury account
- example: 9MLntRkghAgC7ZR1RQouE9EkXwjTfZxbi9nBziofPTjM
- type: string
- required:
- - txId
- - contractAddress
- - feeAccount
- - treasuryAccount
- SolanaMarketplaceSellTransactionHash:
- type: object
- properties:
- txId:
- description: The hash (ID) of the transaction
- example: c83f8818db43d9ba4accfe454aa44fc33123d47a4f89d47b314d6748eb0e9bc9
- type: string
- listingId:
- description: The ID of the listing
- example: 9qhKAgVRebMnjVM4AHdHcseYQG47Mns3U8e7dRz24kg5
- type: string
- required:
- - txId
- - listingId
- EvmListingData:
- type: object
- properties:
- amount:
- type: string
- description: >-
- Amount of NFTs to sold in this listing. Valid only for ERC1155
- listings.
- example: "1"
- buyer:
- type: string
- description: Address of the buyer, if exists.
- example: "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8"
- erc20Address:
- type: string
- description: >-
- Address of the ERC20 token smart contract, which should be used for
- paying for the asset
- example: "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8"
- isErc721:
- type: boolean
- description: True if asset is NFT of type ERC721, false if ERC1155
- example: true
- listingId:
- type: string
- description: ID of the listing.
- example: "12345"
- nftAddress:
- type: string
- description: Address of the NFT smart contract.
- example: "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8"
- price:
- type: string
- description: >-
- Price of the NFT asset in native currency or ERC20 token based on
- the presence of erc20Address field.
- example: "1.234"
- seller:
- type: string
- description: Address of the seller.
- example: "0xc21C81ef03f98898Fb155E00C364e8a7b9D158b8"
- state:
- type: string
- description: State of the listing. 0 - available, 1 - sold, 2 - cancelled
- enum:
- - "0"
- - "1"
- - "2"
- example: "1"
- SolanaListingData:
- type: object
- required:
- - amount
- - listingId
- - nft
- - price
- - seller
- - state
- - createdAt
- properties:
- amount:
- type: string
- description: Amount of NFTs to sold in this listing.
- example: "1"
- buyer:
- type: string
- description: Address of the buyer, if exists.
- example: 9qhKAgVRebMnjVM4AHdHcseYQG47Mns3U8e7dRz24kg5
- listingId:
- type: string
- description: ID of the listing
- example: 9qhKAgVRebMnjVM4AHdHcseYQG47Mns3U8e7dRz24kg5
- nft:
- type: object
- required:
- - address
- - data
- properties:
- address:
- type: string
- description: NFT Address
- example: 9qhKAgVRebMnjVM4AHdHcseYQG47Mns3U8e7dRz24kg5
- data:
- $ref: "#/components/schemas/SolanaNftMetadata"
- price:
- type: string
- description: >-
- Price of the NFT asset in native currency or ERC20 token based on
- the presence of erc20Address field.
- example: "1.234"
- seller:
- type: string
- description: Address of the seller.
- example: 9qhKAgVRebMnjVM4AHdHcseYQG47Mns3U8e7dRz24kg5
- state:
- type: string
- description: State of the listing. 0 - available, 1 - sold, 2 - cancelled
- enum:
- - "0"
- - "1"
- - "2"
- example: "1"
- createdAt:
- type: number
- description: Timestamp when this listing was created
- example: 1669751911
- purchasedAt:
- type: number
- description: Timestamp when this listing was purchased
- example: 1669751911
- cancelledAt:
- type: number
- description: Timestamp when this listing was cancelled
- example: 1669751911
- FlowAddressXpub:
- type: object
- properties:
- txId:
- type: string
- example: d1c75a84e4bdf0dd9bf1bcd0ce4fb25f89e2ed3c5e9574dbca2760b52c428717
- description: The ID of the transaction
- address:
- type: string
- example: 5695321609876367000
- description: The generated blockchain address
- required:
- - txId
- - address
- CountryCode:
- type: string
- enum:
- - AD
- - AE
- - AF
- - AG
- - AI
- - AL
- - AM
- - AO
- - AR
- - AS
- - AT
- - AU
- - AW
- - AX
- - AZ
- - BA
- - BB
- - BD
- - BE
- - BF
- - BG
- - BH
- - BI
- - BJ
- - BL
- - BM
- - BN
- - BO
- - BQ
- - BR
- - BS
- - BT
- - BV
- - BW
- - BY
- - BZ
- - CA
- - CC
- - CD
- - CF
- - CG
- - CH
- - CI
- - CK
- - CL
- - CM
- - CN
- - CO
- - CR
- - CU
- - CV
- - CW
- - CX
- - CY
- - CZ
- - DE
- - DJ
- - DK
- - DM
- - DO
- - DZ
- - EC
- - EE
- - EG
- - EH
- - ER
- - ES
- - ET
- - FI
- - FJ
- - FK
- - FM
- - FO
- - FR
- - GA
- - GB
- - GD
- - GE
- - GF
- - GG
- - GH
- - GI
- - GL
- - GM
- - GN
- - GP
- - GQ
- - GR
- - GS
- - GT
- - GU
- - GW
- - GY
- - HK
- - HM
- - HN
- - HR
- - HT
- - HU
- - ID
- - IE
- - IL
- - IM
- - IN
- - IO
- - IQ
- - IR
- - IS
- - IT
- - JE
- - JM
- - JO
- - JP
- - KE
- - KG
- - KH
- - KI
- - KM
- - KN
- - KP
- - KR
- - KW
- - KY
- - KZ
- - LA
- - LB
- - LC
- - LI
- - LK
- - LR
- - LS
- - LT
- - LU
- - LV
- - LY
- - MA
- - MC
- - MD
- - ME
- - MF
- - MG
- - MH
- - MK
- - ML
- - MM
- - MN
- - MO
- - MP
- - MQ
- - MR
- - MS
- - MT
- - MU
- - MV
- - MW
- - MX
- - MY
- - MZ
- - NA
- - NC
- - NE
- - NF
- - NG
- - NI
- - NL
- - "NO"
- - NP
- - NR
- - NU
- - NZ
- - OM
- - PA
- - PE
- - PF
- - PG
- - PH
- - PK
- - PL
- - PM
- - PN
- - PR
- - PS
- - PT
- - PW
- - PY
- - QA
- - RE
- - RO
- - RS
- - RU
- - RW
- - SA
- - SB
- - SC
- - SD
- - SE
- - SG
- - SH
- - SI
- - SJ
- - SK
- - SL
- - SM
- - SN
- - SO
- - SR
- - SS
- - ST
- - SV
- - SX
- - SY
- - SZ
- - TC
- - TD
- - TF
- - TG
- - TH
- - TJ
- - TK
- - TL
- - TM
- - TN
- - TO
- - TR
- - TT
- - TV
- - TW
- - TZ
- - UA
- - UG
- - UM
- - US
- - UY
- - UZ
- - VA
- - VC
- - VE
- - VG
- - VI
- - VN
- - VU
- - WF
- - WS
- - YE
- - YT
- - ZA
- - ZM
- - ZW
- FiatCurrency:
- type: string
- enum:
- - AED
- - AFN
- - ALL
- - AMD
- - ANG
- - AOA
- - ARS
- - AUD
- - AWG
- - AZN
- - BAM
- - BBD
- - BDT
- - BGN
- - BHD
- - BIF
- - BMD
- - BND
- - BOB
- - BRL
- - BSD
- - BTN
- - BWP
- - BYN
- - BYR
- - BZD
- - CAD
- - CDF
- - CHF
- - CLF
- - CLP
- - CNY
- - COP
- - CRC
- - CUC
- - CUP
- - CVE
- - CZK
- - DJF
- - DKK
- - DOP
- - DOGE
- - DZD
- - EGP
- - ERN
- - ETB
- - ETH
- - EUR
- - FJD
- - FKP
- - FLOW
- - FUSD
- - GBP
- - GEL
- - GGP
- - GHS
- - GIP
- - GMD
- - GNF
- - GTQ
- - GYD
- - HKD
- - HNL
- - HRK
- - HTG
- - HUF
- - IDR
- - ILS
- - IMP
- - INR
- - IQD
- - IRR
- - ISK
- - JEP
- - JMD
- - JOD
- - JPY
- - KES
- - KGS
- - KHR
- - KMF
- - KPW
- - KRW
- - KWD
- - KYD
- - KZT
- - LAK
- - LBP
- - LKR
- - LRD
- - LSL
- - LTL
- - LVL
- - LYD
- - MAD
- - MDL
- - MGA
- - MKD
- - MMK
- - MNT
- - MOP
- - MRO
- - MUR
- - MVR
- - MWK
- - MXN
- - MYR
- - MZN
- - NAD
- - NGN
- - NIO
- - NOK
- - NPR
- - NZD
- - OMR
- - PAB
- - PEN
- - PGK
- - PHP
- - PKR
- - PLN
- - PYG
- - QAR
- - RON
- - RSD
- - RUB
- - RWF
- - SAR
- - SBD
- - SCR
- - SDG
- - SEK
- - SGD
- - SHP
- - SLL
- - SOS
- - SRD
- - STD
- - SVC
- - SYP
- - SZL
- - THB
- - TJS
- - TMT
- - TND
- - TOP
- - TRY
- - TTD
- - TWD
- - TZS
- - UAH
- - UGX
- - USD
- - UYU
- - UZS
- - VEF
- - VND
- - VUV
- - WST
- - XAF
- - XAG
- - XAU
- - XCD
- - XDR
- - XOF
- - XPF
- - YER
- - ZAR
- - ZMK
- - ZMW
- - ZWL
- FiatOrCryptoCurrency:
- type: string
- enum:
- - AED
- - AFN
- - ALL
- - AMD
- - ANG
- - AOA
- - ARS
- - AUD
- - AWG
- - AZN
- - ALGO
- - ADA
- - BAM
- - BAT
- - BBD
- - BCH
- - BDT
- - BGN
- - BHD
- - BIF
- - BMD
- - BNB
- - BND
- - BOB
- - BRL
- - BSD
- - BTC
- - BTN
- - BWP
- - BYN
- - BYR
- - BZD
- - CAD
- - CDF
- - CHF
- - CLF
- - CLP
- - CNY
- - COP
- - CRC
- - CUC
- - CUP
- - CVE
- - CZK
- - DJF
- - DKK
- - DOP
- - DOGE
- - DZD
- - EGP
- - ERN
- - ETB
- - ETH
- - EUR
- - FJD
- - FKP
- - FLOW
- - FUSD
- - FREE
- - GMC
- - GMC_BSC
- - RMD
- - GBP
- - GEL
- - GGP
- - GHS
- - GIP
- - GMD
- - GNF
- - GTQ
- - GYD
- - HKD
- - HNL
- - HRK
- - HTG
- - HUF
- - IDR
- - ILS
- - IMP
- - INR
- - IQD
- - IRR
- - ISK
- - JEP
- - JMD
- - JOD
- - JPY
- - KES
- - KGS
- - KHR
- - KMF
- - KPW
- - KRW
- - KWD
- - KYD
- - KZT
- - LAK
- - LBP
- - LEO
- - LINK
- - LKR
- - LRD
- - LSL
- - LTC
- - LTL
- - LVL
- - LYD
- - MAD
- - MATIC
- - MDL
- - MGA
- - MKD
- - MKR
- - MMK
- - MMY
- - MNT
- - MOP
- - MRO
- - MUR
- - MVR
- - MWK
- - MXN
- - MYR
- - MZN
- - NAD
- - NGN
- - NIO
- - NOK
- - NPR
- - NZD
- - OMR
- - PAB
- - PAX
- - PAXG
- - PEN
- - PGK
- - PHP
- - PKR
- - PLN
- - PYG
- - QAR
- - RON
- - RSD
- - RUB
- - RWF
- - SAR
- - SBD
- - SCR
- - SDG
- - SEK
- - SGD
- - SHP
- - SLL
- - SOS
- - SRD
- - STD
- - SVC
- - SYP
- - SZL
- - THB
- - TJS
- - TMT
- - TND
- - TOP
- - TRY
- - TTD
- - TRON
- - TUSD
- - BUSD
- - TWD
- - TZS
- - UAH
- - UGX
- - UNI
- - USD
- - USDC
- - USDC_MATIC
- - USDC_MATIC_NATIVE
- - USDT
- - USDT_TRON
- - USDT_MATIC
- - UYU
- - UZS
- - VEF
- - VND
- - VUV
- - WBTC
- - WST
- - XAF
- - XAG
- - XAU
- - XCD
- - XCON
- - XDR
- - XOF
- - XPF
- - XRP
- - YER
- - ZAR
- - ZMK
- - ZMW
- - ZWL
- GasEstimated:
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasPrice:
- type: string
- description: The estimated price for one gas unit (in wei)
- example: "10000000000"
- gasLimit:
- type: number
- description: >-
- The number of the gas units needed to process the transaction at the
- estimated gas price
- example: "21000"
- Erc20Currency:
- enum:
- - BAT
- - BUSD
- - COIIN
- - ETH
- - FREE
- - GMC
- - LATOKEN
- - LEO
- - LINK
- - MATIC_ETH
- - MKR
- - MMY
- - PAX
- - PAXG
- - PLTC
- - REVV
- - SAND
- - TUSD
- - UNI
- - USDC
- - USDT
- - WBTC
- - XCON
- example: ETH
- type: string
- NodeRpcPutChains:
- type: string
- example: algorand-testnet-algod
- enum:
- - algorand-testnet-algod
- - algorand-mainnet-algod
- - algorand-testnet-indexer
- - algorand-mainnet-indexer
- - egld-mainnet
- - egld-testnet
- - stellar-mainnet
- - stellar-testnet
- - bnb-mainnet
- - bnb-testnet
- NodeRpcGetChains:
- type: string
- example: algorand-testnet-algod
- enum:
- - algorand-testnet-algod
- - algorand-mainnet-algod
- - algorand-testnet-indexer
- - algorand-mainnet-indexer
- - egld-mainnet
- - egld-testnet
- - lisk-mainnet
- - lisk-testnet
- - stellar-mainnet
- - stellar-testnet
- - tezos-mainnet
- - tezos-testnet
- - tron-mainnet
- - tron-testnet
- - flow-mainnet
- - flow-testnet
- - bnb-mainnet
- - bnb-testnet
- NodeRpcPostChains:
- type: string
- example: ethereum-sepolia
- enum:
- - ethereum-sepolia
- - ethereum-mainnet
- - ethereum-goerli
- - ethereum-holesky
- - polygon-mumbai
- - polygon-mainnet
- - klaytn-baobab
- - klaytn-cypress
- - solana-devnet
- - solana-mainnet
- - celo-mainnet
- - celo-testnet
- - lisk-mainnet
- - lisk-testnet
- - algorand-testnet-algod
- - algorand-mainnet-algod
- - algorand-testnet-indexer
- - algorand-mainnet-indexer
- - bitcoin-mainnet
- - bitcoin-testnet
- - litecoin-core-mainnet
- - litecoin-core-testnet
- - kcs-testnet
- - kcs-mainnet
- - cardano-preprod
- - cardano-mainnet
- - vechain-testnet
- - vechain-mainnet
- - ripple-mainnet
- - ripple-testnet
- - flow-mainnet
- - flow-testnet
- - xdc-mainnet
- - xdc-testnet
- - tron-mainnet
- - tron-testnet
- - bsc-mainnet
- - bsc-testnet
- - bch-mainnet
- - bch-testnet
- - stellar-mainnet
- - stellar-testnet
- - bnb-mainnet
- - bnb-testnet
- - egld-mainnet
- - egld-testnet
- - doge-mainnet
- - doge-testnet
- - one-mainnet-s0
- - one-testnet-s0
- - eos-mainnet
- - eos-testnet
- - avax-mainnet
- - avax-testnet
- - avax-x-mainnet
- - avax-x-testnet
- - avax-p-mainnet
- - avax-p-testnet
- - fantom-mainnet
- - fantom-testnet
- - arb-nova-mainnet
- - arb-one-mainnet
- - arb-testnet
- - optimism-mainnet
- - optimism-testnet
- - near-mainnet
- - near-testnet
- - cro-mainnet
- - cro-testnet
- - rsk-mainnet
- - rsk-testnet
- - aurora-mainnet
- - aurora-testnet
- - gno-mainnet
- - gno-testnet
- - dot-mainnet
- - dot-testnet
- - ksm-mainnet
- - ksm-testnet
- - oasis-mainnet
- - oasis-testnet
- - tezos-mainnet
- - tezos-testnet
- - zcash-mainnet
- - zcash-testnet
- - palm-mainnet
- - palm-testnet
- - zilliqa-mainnet
- - zilliqa-testnet
- - ethereum-classic-mainnet
- TransferManagedAddress:
- type: object
- properties:
- chain:
- type: string
- description: Blockchain to work on
- example: SOL
- enum:
- - SOL
- txData:
- type: string
- minLength: 1
- maxLength: 500000
- description: >-
- Hex serialized data representing transaction, which should be signed
- using one of the managed wallets.
- example: >-
- 020001044a22af97a838a504e6f7c0b18d779afcea612da50794cc1dac641861fc1ab14afa5cacaf91c298694e64bb5496916c3c68a32affb92d4bcd2736fbb00169d57bd840de2a454960308f688cd3ee308c1fa01ecfa0b03770aaaf3b52d71d46c31d000000000000000000000000000000000000000000000000000000000000000060d38e0da20dc5900b7e902c918eae6a95e2d90af154b53a422f4ab26b050f4f01030201020c02000000e803000000000000
- walletIds:
- type: array
- items:
- type: object
- required:
- - key
- - type
- properties:
- key:
- type: string
- description: >-
- Wallet ID of wallet, which should be used for signing. In case
- of RAW type of the wallet, this represents the private key
- which will be used for signatures.
- example: 0b1eae3d-2520-4903-8bbf-5dec3ad2a5d4
- type:
- type: string
- example: MANAGED
- description: >-
- Type of the wallet to be used - RAW represents native private
- key, MANAGED represents ID of the managed wallet.
- enum:
- - MANAGED
- - RAW
- required:
- - chain
- - txData
- - walletIds
- CustodialManagedAddress:
- type: object
- required:
- - address
- - walletId
- - chain
- properties:
- address:
- type: string
- description: Blockchain address
- example: 8oJ8KRL87ja7DjPSsmBG1KtfrpsfLGDMJDGzev68DGqx
- walletId:
- type: string
- format: uuid
- example: 52901013-94ab-4124-8645-acba4ee90bb8
- description: Unique identifier of the managed address
- chain:
- type: string
- description: Blockchain of the address
- example: SOL
- enum:
- - BSC
- - ETH
- - KLAY
- - ONE
- - CELO
- - MATIC
- - SOL
- - LTC
- - BTC
- privateKey:
- type: string
- example: >-
- 4jCFiqh3tLxKxt3vYW478qodivkCkSzqtpG4wqEaYkgdVC1o79a1VJTc5UiCmCmZBwoJmjaenfYH1ML7ra8vbNpA
- description: Private key of the address. Not present by default.
- AlgoWallet:
- type: object
- properties:
- address:
- maxLength: 58
- minLength: 58
- description: address of Algorand account.
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- type: string
- secret:
- maxLength: 103
- minLength: 103
- description: secretKey can generate Mnemonic, similar to private Key.
- type: string
- example: >-
- NBYMCVEEDFYV3TPWVRE6APE7PKHUJD4XAKXCKNCLKGUXOC3LFNJGZQCJCRA53HB7ZAHF6NFJH2QIVQ5USQNWG35QCJLD4KZ5IWMB24Q
- mnemonic:
- description: Mnemonic of the wallet.
- type: string
- example: >-
- work syrup plug fluid moon regret wolf visa muffin supply erode
- lemon absurd voyage plastic blade baby stable burger glue dynamic
- expire cabin abandon pilot
- AlgoBlock:
- type: object
- properties:
- genesisHash:
- description: hash to which this block belongs
- type: string
- example: SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=
- genesisId:
- description: ID to which this block belongs
- type: string
- example: testnet-v1.0
- previousBlockHash:
- description: Previous block hash
- type: string
- example: JeLGQTbqnBsD3NXE8Bf1TpPFMFadEVVyHhkcD61ljAU=
- rewards:
- description: rewards
- type: object
- example:
- fee-sink: A7NMWS3NT3IUDMLVO26ULGXGIIOUQ3ND2TXSER6EBGRZNOBOUIQXHIBGDE
- rewards-calculation-round: 17000000
- rewards-level: 27521
- rewards-pool: 7777777777777777777777777777777777777777777777777774MSJUVU
- rewards-rate: 0
- rewards-residue: 2020197303
- round:
- description: Current round on which this block was appended to the chain
- type: number
- example: 16775567
- seed:
- description: Sortition seed.
- type: string
- example: VPBpyrHyqbfqrHqJ3l39LXGN4qgEdNnE5kpJfk3vJtA=
- timestamp:
- description: Block creation timestamp in seconds since eposh
- type: number
- example: 1632167753
- txns:
- description: Array of transactions
- type: array
- items:
- $ref: "#/components/schemas/AlgoTx"
- txn:
- description: >-
- TransactionsRoot authenticates the set of transactions appearing in
- the block.
- type: string
- example: ++MWW82yIvYQ0AEoPP0aDGGHGk/dSp5WHlbkf9SVU1U=
- txnc:
- description: TxnCounter counts the number of transations committed in the ledger
- type: number
- example: 27814470
- upgradeState:
- description: upgrade state
- type: object
- example:
- current-protocol: >-
- https://github.com/algorandfoundation/specs/tree/abc54f79f9ad679d2d22f0fb9909fb005c16f8a1
- next-protocol-approvals: 0
- next-protocol-switch-on: 0
- next-protocol-vote-before: 0
- upgradeVote:
- description: upgrade vote
- type: object
- example:
- upgrade-approve: false
- upgrade-delay: 0
- AlgoTx:
- type: object
- properties:
- closeRewards:
- description: rewards applied to close-remainder-to account.
- type: number
- example: 0
- closingAmount:
- description: closing amount for transaction.
- type: number
- example: 0
- confirmedRound:
- description: Round when the transaction was confirmed.
- type: number
- example: 16775567
- fee:
- description: Transaction fee
- type: number
- example: 0.001
- firstValid:
- description: First valid round for this transaction.
- type: number
- example: 16775565
- genesisHash:
- description: Hash of genesis block
- type: string
- example: SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=
- genesisId:
- description: genesis block ID.
- type: string
- example: testnet-v1.0
- id:
- description: transaction ID
- type: string
- example: HNIQ76UTJYPOLZP5FWODYABBJPYPGJNEM2QEJSMDMQRWEKHEYJHQ
- intraRoundOffset:
- description: Offset into the round where this transaction was confirmed.
- type: number
- example: 1
- lastValid:
- description: Last valid round for this transaction.
- type: number
- example: 16775571
- note:
- description: Free form data
- type: string
- example: cGluZ3Bvbmf0Jyl21QrtLw==
- paymentTransaction:
- description: payment Transaction
- type: object
- receiverRewards:
- description: rewards applied to receiver account.
- type: number
- example: 0
- roundTime:
- description: Time when the block this transaction is in was confirmed.
- type: number
- example: 1632167753
- sender:
- description: Sender's address
- type: string
- example: U6QEM4KM7KKGCLH4FELZBGJEVVSF556ELXHUOZC4ESPFS4O4V4VQXKQRXQ
- senderRewards:
- description: rewards applied to sender account.
- type: number
- example: 0
- signature:
- description: signature
- type: object
- txType:
- description: >-
- indicates what type of transaction this is. Different types have
- differnet fields.
- type: string
- example: pay
- AlgoTxsWithPagination:
- type: object
- properties:
- nextToken:
- description: >-
- Used for pagination, when making another request provide this token
- with the next parameter.
- type: string
- example: ywAAAAAAAAAAAAAA
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/AlgoTx"
- TransferAlgorandBlockchain:
- type: object
- properties:
- from:
- description: The blockchain address of the sender
- type: string
- example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
- to:
- description: The blockchain address of the recipient
- type: string
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- amount:
- description: The amount to send in Algos
- type: string
- example: "1"
- note:
- description: The note for the recipient; must not contain spaces
- type: string
- example: Helloworld
- fromPrivateKey:
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- type: string
- example: >-
- 72TCV5BRQPBMSAFPYO3CPWVDBYWNGAYNMTW5QHENOMQF7I6QLNMJWCJZ7A3V5YKD7QD6ZZPEHG2PV2ZVVEDDO6BCRGXWIL3DIUMSUCI
- required:
- - from
- - to
- - amount
- - fromPrivateKey
- ReceiveAlgorandAsset:
- type: object
- properties:
- assetId:
- description: AssetID of the asset you wanna enable for the sender.
- type: number
- example: 116363571
- fromPrivateKey:
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- type: string
- example: >-
- 72TCV5BRQPBMSAFPYO3CPWVDBYWNGAYNMTW5QHENOMQF7I6QLNMJWCJZ7A3V5YKD7QD6ZZPEHG2PV2ZVVEDDO6BCRGXWIL3DIUMSUCI
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- required:
- - assetId
- - fromPrivateKey
- ReceiveAlgorandAssetKMS:
- type: object
- properties:
- from:
- description: Blockchain sender address.
- type: string
- minLength: 58
- maxLength: 58
- example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
- assetId:
- description: AssetID of the asset you wanna enable for the sender.
- type: number
- example: 98745612
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- required:
- - assetId
- - from
- - signatureId
- AlgoTransactionHashKMS:
- type: object
- properties:
- txId:
- description: TX hash of transaction.
- example: GTNOIDCIHZLESKNQPJXOXE476ODYDNNQBA3N2Q75MYQ4SI4XL5SA
- type: string
- assetIndex:
- description: >-
- If transaction created new ASA asset, this value is the index of the
- asset on the network.
- example: 87751984
- type: number
- confirmed:
- example: false
- type: boolean
- description: If transaction was not confirmed within 5 rounds, result is false.
- default: false
- failed:
- description: >-
- In case of the transaction was broadcast to the blockchain, but it
- was not possible to complete Tatum KMS signature, reponse is marked
- as failed and must be marked manually.
- example: false
- type: boolean
- required:
- - txId
- TransferAlgorandBlockchainKMS:
- type: object
- properties:
- from:
- description: The blockchain address of the sender
- type: string
- example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
- to:
- description: The blockchain address of the recipient
- type: string
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- amount:
- description: The amount to send in Algos
- type: string
- example: "1"
- note:
- description: The note for the recipient; must not contain spaces
- type: string
- example: Helloworld
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- required:
- - from
- - to
- - amount
- - signatureId
- MaticBalance:
- type: object
- properties:
- balance:
- type: string
- description: Balance in MATIC
- example: "10.52"
- GeneratedAddressMatic:
- type: object
- properties:
- address:
- type: string
- description: Polygon address
- example: "0xa7673161CbfE0116A4De9E341f8465940c2211d4"
- PolygonBlock:
- type: object
- properties:
- difficulty:
- description: Difficulty for this block.
- type: string
- example: "3296820833"
- extraData:
- description: The 'extra data' field of this block.
- type: string
- example: 0x
- gasLimit:
- description: The maximum gas allowed in this block.
- type: number
- example: 8000000
- gasUsed:
- description: The total used gas by all transactions in this block.
- type: number
- example: 7985124
- hash:
- description: Hash of the block. 'null' when its pending block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- logsBloom:
- description: >-
- The bloom filter for the logs of the block. 'null' when its pending
- block.
- type: string
- example: >-
- 0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000
- miner:
- description: >-
- The address of the beneficiary to whom the mining rewards were
- given.
- type: string
- example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
- mixHash:
- description: ""
- type: string
- example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
- nonce:
- description: Hash of the generated proof-of-work. 'null' when its pending block.
- type: string
- example: "0xfa1692f52a7ac672"
- number:
- description: The block number. 'null' when its pending block.
- type: number
- example: 6470657
- parentHash:
- description: Hash of the parent block.
- type: string
- example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
- receiptsRoot:
- description: ""
- type: string
- example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
- sha3Uncles:
- description: SHA3 of the uncles data in the block.
- type: string
- example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
- size:
- description: The size of this block in bytes.
- type: number
- example: 15296
- stateRoot:
- description: The root of the final state trie of the block.
- type: string
- example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
- timestamp:
- description: The unix timestamp for when the block was collated.
- type: number
- example: 1569600592
- totalDifficulty:
- description: Total difficulty of the chain until this block.
- type: string
- example: "23329673338013873"
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/PolygonTx"
- transactionsRoot:
- description: The root of the transaction trie of the block.
- type: string
- example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
- baseFeePerGas:
- description: >-
- Represents the current per-unit gas price, set by the Ethereum
- protocol, to be burned for transaction processing.
- type: number
- example: 78890946115
- PolygonTx:
- type: object
- properties:
- blockHash:
- description: Hash of the block where this transaction was in.
- type: string
- example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
- status:
- type: boolean
- example: true
- description: >-
- TRUE if the transaction was successful, FALSE, if the EVM reverted
- the transaction.
- blockNumber:
- type:
- - number
- - "null"
- description: >-
- The number of the block that the transaction is included in; if not
- returned, the transaction has not been included in a block yet.
- example: 6470854
- from:
- type: string
- description: Address of the sender.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- gas:
- type: number
- description: Gas provided by the sender.
- example: 21000
- gasPrice:
- type: string
- description: Gas price provided by the sender in wei.
- example: "1000000000"
- transactionHash:
- type: string
- description: Hash of the transaction.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- input:
- type: string
- description: The data sent along with the transaction.
- example: 0x
- nonce:
- type: number
- description: The number of transactions made by the sender prior to this one.
- example: 26836405
- to:
- type: string
- description: >-
- Address of the receiver. 'null' when its a contract creation
- transaction.
- example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
- transactionIndex:
- type:
- - number
- - "null"
- description: >-
- The integer of the transactions index position in the block; if not
- returned, the transaction has not been included in a block yet.
- example: 3
- value:
- type: string
- description: Value transferred in wei.
- example: "1000000000000000000"
- gasUsed:
- type:
- - number
- - "null"
- description: >-
- The amount of gas used by this specific transaction alone; if not
- returned, the transaction has not been included in a block yet.
- example: 21000
- cumulativeGasUsed:
- type:
- - number
- - "null"
- description: >-
- The total amount of gas used when this transaction was executed in
- the block; if not returned, the transaction has not been included in
- a block yet.
- example: 314159
- contractAddress:
- type: string
- description: >-
- The contract address created, if the transaction was a contract
- creation, otherwise null.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- logs:
- type: array
- description: Log events, that happened in this transaction.
- items:
- $ref: "#/components/schemas/PolygonTxLog"
- PolygonTxLog:
- type: object
- properties:
- address:
- type: string
- description: From which this event originated from.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- topics:
- type: array
- description: >-
- An array with max 4 32 Byte topics, topic 1-3 contains indexed
- parameters of the log.
- items:
- type: string
- example: "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
- data:
- type: string
- description: The data containing non-indexed log parameter.
- logIndex:
- type: number
- description: Integer of the event index position in the block.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- blockHash:
- description: Hash of the block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- transactionIndex:
- type: number
- description: >-
- Integer of the transaction’s index position, the event was created
- in.
- transactionHash:
- type: string
- description: Hash of the transaction this event was created in.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- Error403PolygonBroadcast:
- properties:
- errorCode:
- description: polygon.broadcast.failed
- example: polygon.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonBep20NotFound:
- properties:
- errorCode:
- description: erc20.token.notFound
- example: erc20.token.notFound
- type: string
- message:
- description: No such ERC20 currency ${name}.
- example: No such ERC20 currency ${name}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonBep20Set:
- properties:
- errorCode:
- description: erc20.address.set
- example: erc20.address.set
- type: string
- message:
- description: ERC20 address was already set.
- example: ERC20 address was already set.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonMnemonicPrivateKey:
- properties:
- errorCode:
- description: private.mnemonic.missing
- example: private.mnemonic.missing
- type: string
- message:
- description: Either mnemonic and index or private key must be present.
- example: Either mnemonic and index or private key must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonBep20Unsupported:
- properties:
- errorCode:
- description: polygon.bep20.unsupported
- example: polygon.bep20.unsupported
- type: string
- message:
- description: Unsupported ETH ERC20 blockchain.
- example: Unsupported ETH ERC20 blockchain.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonTxHash:
- properties:
- errorCode:
- description: polygon.transaction.hash
- example: polygon.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonTxSign:
- properties:
- errorCode:
- description: polygon.transaction.sign
- example: polygon.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonErc20TxSign:
- properties:
- errorCode:
- description: polygon.bep20.sign
- example: polygon.bep20.sign
- type: string
- message:
- description: Unable to sign transaction for contract creation. ${error}
- example: Unable to sign transaction for contract creation. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonGasCalculation:
- properties:
- errorCode:
- description: polygon.transaction.gas
- example: polygon.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonTxBody:
- properties:
- errorCode:
- description: polygon.transaction.body
- example: polygon.transaction.body
- type: string
- message:
- description: Either currency, or tokenAddress must be defined.
- example: Either currency, or tokenAddress must be defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonScBody:
- properties:
- errorCode:
- description: polygon.sc.invalid
- example: polygon.sc.invalid
- type: string
- message:
- description: Invalid parameters for smart contract invocation.
- example: Invalid parameters for smart contract invocation.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403PolygonGasPrice:
- properties:
- errorCode:
- description: gas.price.failed
- example: gas.price.failed
- type: string
- message:
- description: Unable to obtain current GAS price.
- example: Unable to obtain current GAS price.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- TransferBep20Blockchain:
- type: object
- properties:
- to:
- maxLength: 50
- minLength: 1
- description: Blockchain address to send HRM20 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: Amount to be sent.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of HRM20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- digits:
- description: Number of decimal points that HRM20 token has.
- example: 18
- maximum: 30
- minimum: 1
- type: number
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to ONE transaction. If not present, last known nonce
- will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - contractAddress
- - digits
- - fromPrivateKey
- - amount
- TransferBep20BlockchainKMS:
- type: object
- properties:
- to:
- maxLength: 50
- minLength: 1
- description: Blockchain address to send HRM20 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: Amount to be sent.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of HRM20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- digits:
- description: Number of decimal points that HRM20 token has.
- example: 18
- maximum: 30
- minimum: 1
- type: number
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to ONE transaction. If not present, last known nonce
- will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - contractAddress
- - signatureId
- - digits
- - amount
- CallPolygonSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0xC9c8ba8C7e2EAF43e84330Db08915A8106d7bD74"
- type: string
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Polygon transaction. If not present, last known
- nonce will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- CallPolygonSmartContractMethodCaller:
- type: object
- properties:
- caller:
- maxLength: 42
- minLength: 42
- description: >-
- The address of the account, which will be sender and fee payer of
- this transaction
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0xC9c8ba8C7e2EAF43e84330Db08915A8106d7bD74"
- type: string
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- - caller
- CallPolygonSmartContractReadMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0xC9c8ba8C7e2EAF43e84330Db08915A8106d7bD74"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- required:
- - contractAddress
- - params
- - methodABI
- - methodName
- CallPolygonSmartContractMethodKMS:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0xC9c8ba8C7e2EAF43e84330Db08915A8106d7bD74"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Polygon transaction. If not present, last known
- nonce will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - signatureId
- - methodName
- TransferPolygonBlockchain:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Polygon transaction. If not present, last known
- nonce will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- description: >-
- Currency to transfer from Polygon Blockchain Account. ERC20 tokens
- like USDC_MATIC, USDT_MATIC, GAMEE, INTENT, EURTENT, GOLDAX are
- available only for mainnet use.
- enum:
- - MATIC
- - USDC_MATIC
- - USDT_MATIC
- - GAMEE
- - INTENT
- - EURTENT
- - GOLDAX
- example: MATIC
- type: string
- fee:
- $ref: "#/components/schemas/CustomFee"
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- required:
- - to
- - amount
- - currency
- - fromPrivateKey
- PolygonEstimateGas:
- type: object
- properties:
- from:
- type: string
- maxLength: 42
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- minLength: 42
- description: Sender address.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- amount:
- description: Amount to be sent in MATIC.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- pattern: ^(0x|0h)?[0-9A-F]+$
- required:
- - to
- - amount
- - from
- TransferPolygonBlockchainKMS:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Polygon transaction. If not present, last known
- nonce will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- description: >-
- Currency to transfer from Polygon Blockchain Account. ERC20 tokens
- like USDC_MATIC, USDT_MATIC, GAMEE, INTENT, EURTENT, GOLDAX are
- available only for mainnet use.
- enum:
- - MATIC
- - USDC_MATIC
- - USDT_MATIC
- - GAMEE
- - INTENT
- - EURTENT
- - GOLDAX
- example: MATIC
- type: string
- fee:
- $ref: "#/components/schemas/CustomFee"
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- required:
- - to
- - amount
- - currency
- - signatureId
- DeployBep20:
- type: object
- properties:
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Kcs blockchain, where all created ERC20 tokens will be
- transferred.
- maxLength: 42
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- fromPrivateKey:
- description: >-
- Private key of Kcs account address, from which the fee for the
- deployment of ERC20 will be paid. Private key, or signature Id must
- be present.
- type: string
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- maxLength: 66
- minLength: 66
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Kcs transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - name
- - symbol
- - address
- - supply
- - fromPrivateKey
- - digits
- DeployBep20KMS:
- type: object
- properties:
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Kcs blockchain, where all created ERC20 tokens will be
- transferred.
- maxLength: 42
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Kcs transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - name
- - symbol
- - address
- - supply
- - signatureId
- - digits
- KlaytnBlock:
- type: object
- properties:
- difficulty:
- description: Difficulty for this block.
- type: string
- example: "3296820833"
- extraData:
- description: The 'extra data' field of this block.
- type: string
- example: 0x
- gasLimit:
- description: The maximum gas allowed in this block.
- type: number
- example: 8000000
- gasUsed:
- description: The total used gas by all transactions in this block.
- type: number
- example: 7985124
- hash:
- description: Hash of the block. 'null' when its pending block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- logsBloom:
- description: >-
- The bloom filter for the logs of the block. 'null' when its pending
- block.
- type: string
- example: >-
- 0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000
- miner:
- description: >-
- The address of the beneficiary to whom the mining rewards were
- given.
- type: string
- example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
- mixHash:
- description: ""
- type: string
- example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
- nonce:
- description: Hash of the generated proof-of-work. 'null' when its pending block.
- type: string
- example: "0xfa1692f52a7ac672"
- number:
- description: The block number. 'null' when its pending block.
- type: number
- example: 6470657
- parentHash:
- description: Hash of the parent block.
- type: string
- example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
- receiptsRoot:
- description: ""
- type: string
- example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
- sha3Uncles:
- description: SHA3 of the uncles data in the block.
- type: string
- example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
- size:
- description: The size of this block in bytes.
- type: number
- example: 15296
- stateRoot:
- description: The root of the final state trie of the block.
- type: string
- example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
- timestamp:
- description: The unix timestamp for when the block was collated.
- type: number
- example: 1569600592
- totalDifficulty:
- description: Total difficulty of the chain until this block.
- type: string
- example: "23329673338013873"
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/KlaytnTx"
- transactionsRoot:
- description: The root of the transaction trie of the block.
- type: string
- example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
- KlaytnTx:
- type: object
- properties:
- blockHash:
- description: Hash of the block where this transaction was in.
- type: string
- example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
- type:
- description: Type of Klaytn Transaction
- type: string
- example: TxTypeLegacyTransaction
- typeInt:
- description: Type of Klaytn Transaction
- type: number
- example: 0
- status:
- type: boolean
- example: true
- description: >-
- TRUE if the transaction was successful, FALSE, if the EVM reverted
- the transaction.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- from:
- type: string
- description: Address of the sender.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- gas:
- type: number
- description: Gas provided by the sender.
- example: 21000
- gasPrice:
- type: string
- description: Gas price provided by the sender in peb.
- example: "1000000000"
- transactionHash:
- type: string
- description: Hash of the transaction.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- input:
- type: string
- description: The data sent along with the transaction.
- example: 0x
- nonce:
- type: number
- description: The number of transactions made by the sender prior to this one.
- example: 26836405
- to:
- type: string
- description: >-
- Address of the receiver. 'null' when its a contract creation
- transaction.
- example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
- transactionIndex:
- type: number
- description: Integer of the transactions index position in the block.
- example: 3
- value:
- type: string
- description: Value transferred in peb.
- example: "1000000000000000000"
- gasUsed:
- type: number
- description: The amount of gas used by this specific transaction alone.
- example: 21000
- cumulativeGasUsed:
- type: number
- description: >-
- The total amount of gas used when this transaction was executed in
- the block.
- example: 314159
- contractAddress:
- type: string
- description: >-
- The contract address created, if the transaction was a contract
- creation, otherwise null.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- logs:
- type: array
- description: Log events, that happened in this transaction.
- items:
- type: object
- properties:
- address:
- type: string
- description: From which this event originated from.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- topics:
- type: array
- description: >-
- An array with max 4 32 Byte topics, topic 1-3 contains indexed
- parameters of the log.
- items:
- type: string
- example: >-
- 0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234
- data:
- type: string
- description: The data containing non-indexed log parameter.
- logIndex:
- type: number
- description: Integer of the event index position in the block.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- blockHash:
- description: Hash of the block.
- type: string
- example: >-
- 0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc
- transactionIndex:
- type: number
- description: >-
- Integer of the transaction’s index position, the event was
- created in.
- transactionHash:
- type: string
- description: Hash of the transaction this event was created in.
- example: >-
- 0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7
- Error403KlaytnBroadcast:
- properties:
- errorCode:
- description: klaytn.broadcast.failed
- example: klaytn.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnKlay20NotFound:
- properties:
- errorCode:
- description: erc20.token.notFound
- example: erc20.token.notFound
- type: string
- message:
- description: No such ERC20 currency ${name}.
- example: No such ERC20 currency ${name}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnKlay20Set:
- properties:
- errorCode:
- description: erc20.address.set
- example: erc20.address.set
- type: string
- message:
- description: ERC20 address was already set.
- example: ERC20 address was already set.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnMnemonicPrivateKey:
- properties:
- errorCode:
- description: private.mnemonic.missing
- example: private.mnemonic.missing
- type: string
- message:
- description: Either mnemonic and index or private key must be present.
- example: Either mnemonic and index or private key must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnKlay20Unsupported:
- properties:
- errorCode:
- description: klaytn.bep20.unsupported
- example: klaytn.bep20.unsupported
- type: string
- message:
- description: Unsupported ETH ERC20 blockchain.
- example: Unsupported ETH ERC20 blockchain.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnTxHash:
- properties:
- errorCode:
- description: klaytn.transaction.hash
- example: klaytn.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnTxSign:
- properties:
- errorCode:
- description: klaytn.transaction.sign
- example: klaytn.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnErc20TxSign:
- properties:
- errorCode:
- description: klaytn.bep20.sign
- example: klaytn.bep20.sign
- type: string
- message:
- description: Unable to sign transaction for contract creation. ${error}
- example: Unable to sign transaction for contract creation. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnGasCalculation:
- properties:
- errorCode:
- description: klaytn.transaction.gas
- example: klaytn.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnTxBody:
- properties:
- errorCode:
- description: klaytn.transaction.body
- example: klaytn.transaction.body
- type: string
- message:
- description: Either currency, or tokenAddress must be defined.
- example: Either currency, or tokenAddress must be defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnScBody:
- properties:
- errorCode:
- description: klaytn.sc.invalid
- example: klaytn.sc.invalid
- type: string
- message:
- description: Invalid parameters for smart contract invocation.
- example: Invalid parameters for smart contract invocation.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KlaytnGasPrice:
- properties:
- errorCode:
- description: gas.price.failed
- example: gas.price.failed
- type: string
- message:
- description: Unable to obtain current GAS price.
- example: Unable to obtain current GAS price.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- TransferKlay20Blockchain:
- type: object
- properties:
- to:
- maxLength: 50
- minLength: 1
- description: Blockchain address to send ERC20 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: Amount to be sent.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- digits:
- description: Number of decimal points that ERC20 token has.
- example: 18
- maximum: 30
- minimum: 1
- type: number
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Klaytn transaction. If not present, last known
- nonce will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gpeb.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - contractAddress
- - digits
- - fromPrivateKey
- - amount
- CallKlaytnSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Klaytn transaction. If not present, last known
- nonce will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gpeb.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- CallKlaytnSmartContractReadMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- required:
- - contractAddress
- - params
- - methodABI
- - methodName
- CallKlaytnSmartContractMethodKMS:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Klaytn transaction. If not present, last known
- nonce will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gpeb.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - contractAddress
- - params
- - methodABI
- - signatureId
- - methodName
- TransferKlaytnBlockchain:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Klaytn transaction. If not present, last known
- nonce will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- description: Currency to transfer from Klaytn Blockchain Account.
- enum:
- - KLAY
- example: KLAY
- type: string
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- example: "40000"
- pattern: ^[+]?\d+$
- gasPrice:
- type: string
- description: Gas price in Gpeb.
- example: "20"
- pattern: ^[+]?\d+$
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- required:
- - to
- - amount
- - currency
- - fromPrivateKey
- KlaytnEstimateGas:
- type: object
- properties:
- from:
- type: string
- maxLength: 42
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- minLength: 42
- description: Sender address.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- amount:
- description: Amount to be sent in KLAY.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- pattern: ^(0x|0h)?[0-9A-F]+$
- required:
- - to
- - amount
- - from
- TransferKlaytnBlockchainKMS:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Klaytn transaction. If not present, last known
- nonce will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- description: Currency to transfer from Klaytn Blockchain Account.
- enum:
- - KLAY
- example: KLAY
- type: string
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- example: "40000"
- pattern: ^[+]?\d+$
- gasPrice:
- type: string
- description: Gas price in Gpeb.
- example: "20"
- pattern: ^[+]?\d+$
- amount:
- description: Amount to be sent in Ether.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- required:
- - to
- - amount
- - currency
- - signatureId
- SolBalance:
- type: object
- properties:
- balance:
- type: string
- description: Balance in SOL
- example: "10.52"
- SolanaWallet:
- type: object
- properties:
- mnemonic:
- description: Generated mnemonic for wallet.
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- type: string
- address:
- description: Generated account address.
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- privateKey:
- description: Generated private key for account.
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- type: string
- SolanaBlockReward:
- type: object
- properties:
- commission:
- type: string
- format: nullable
- lamports:
- type: number
- example: 7
- postBalance:
- type: number
- example: 10149491708073344
- pubkey:
- type: string
- example: ETSKPSzESbVdmtUn67LA2p9J1gPCSEgYvmJS9pNNWQqR
- rewardType:
- type: string
- example: Rent
- TokenBalance:
- type: object
- properties:
- accountIndex:
- description: Index of the account in which the token balance is provided for.
- type: number
- example: 1
- mint:
- description: Pubkey of the token's mint.
- type: string
- example: So11111111111111111111111111111111111111112
- owner:
- description: Pubkey of token balance's owner.
- type: string
- example: BYM81n8HvTJuqZU1PmTVcwZ9G8uoji7FKM6EaPkwphPt
- programId:
- description: Pubkey of the Token program that owns the account.
- type: string
- example: TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA
- uiTokenAmount:
- $ref: "#/components/schemas/UiTokenAmount"
- UiTokenAmount:
- type: object
- properties:
- amount:
- description: Raw amount of tokens as a string, ignoring decimals.
- type: string
- example: 2653579503
- decimals:
- description: Number of decimals configured for token's mint.
- type: number
- example: 9
- uiAmount:
- description: Token amount as a float, accounting for decimals.
- type:
- - number
- - "null"
- example: 2.653579503
- uiAmountString:
- description: Token amount as a string, accounting for decimals.
- type: string
- example: 2.653579503
- SolanaTxMeta:
- type: object
- properties:
- err:
- type: object
- fee:
- type: number
- example: 5000
- innerInstructions:
- type: array
- items:
- type: object
- logMessages:
- type: array
- items:
- type: string
- example: Program Vote111111111111111111111111111111111111111 invoke [1]
- postBalances:
- type: array
- items:
- type: number
- example: 1101768559544744
- postTokenBalances:
- type: array
- items:
- $ref: "#/components/schemas/TokenBalance"
- preBalances:
- type: array
- items:
- type: number
- example: 1101768559549744
- preTokenBalances:
- type: array
- items:
- $ref: "#/components/schemas/TokenBalance"
- rewards:
- type: array
- items:
- type: object
- status:
- type: object
- properties:
- Ok:
- type: string
- format: nullable
- SolanaTxMessageHeader:
- type: object
- properties:
- numReadonlySignedAccounts:
- type: number
- example: 0
- numReadonlyUnsignedAccounts:
- type: number
- example: 3
- numRequiredSignatures:
- type: number
- example: 1
- SolanaTxMessageInstruction:
- type: object
- properties:
- accounts:
- type: array
- items:
- type: number
- example: 1
- data:
- type: string
- example: >-
- 2ZjTR1vUs2pHXyTM4rXnJowxekwfBcBJwsE4EameG3Sapvgfit27vrBd8k8QYCoTtMgfHEJLDqWEWBYUYVd
- programIdIndex:
- type: number
- example: 4
- SolanaTxMessage:
- type: object
- properties:
- header:
- $ref: "#/components/schemas/SolanaTxMessageHeader"
- accountKeys:
- type: array
- items:
- type: string
- example: 0974de54f77afa9ad3d474909f6ce095b9623a359a5d08cc807b8a92dd5e1f96
- recentBlockhash:
- type: string
- example: C3vsoVwVWx7yPRhsNoKpcm2CJTrnVcvimdC4bd3jTPbj
- instructions:
- type: array
- items:
- $ref: "#/components/schemas/SolanaTxMessageInstruction"
- indexToProgramIds:
- type: object
- SolanaTxTransaction:
- type: object
- properties:
- message:
- $ref: "#/components/schemas/SolanaTxMessage"
- signatures:
- type: array
- items:
- type: string
- example: >-
- 5FPSzkTsjZDBigU3ZagvkcwSPimt4K6voqrN9uUNVzWDBeRXWVH3uMarDPpSfrS7sFQeyKyDd5KpbdCrL3EWEP59
- SolanaBlockTx:
- type: object
- properties:
- meta:
- $ref: "#/components/schemas/SolanaTxMeta"
- transaction:
- $ref: "#/components/schemas/SolanaTxTransaction"
- SolanaTx:
- type: object
- properties:
- blockTime:
- type: number
- example: 1638279975
- meta:
- $ref: "#/components/schemas/SolanaTxMeta"
- transaction:
- $ref: "#/components/schemas/SolanaTxTransaction"
- slot:
- type: number
- example: 97744333
- SolanaBlock:
- type: object
- properties:
- blockHeight:
- type: number
- example: 94778421
- blockTime:
- type: number
- example: 1638279333
- blockhash:
- type: string
- example: Ch7qVhCkSqEvhWE8xzJZbJKRcsH6wtTjfiMJdt9eKiD7
- parentSlot:
- type: number
- example: 97742681
- previousBlockhash:
- type: string
- example: C3vsoVwVWx7yPRhsNoKpcm2CJTrnVcvimdC4bd3jTPbj
- rewards:
- type: array
- items:
- $ref: "#/components/schemas/SolanaBlockReward"
- transactions:
- type: array
- items:
- $ref: "#/components/schemas/SolanaBlockTx"
- Error403SolanaBroadcast:
- properties:
- errorCode:
- description: solana.broadcast.failed
- example: Solana.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SolanaBroadcastConfirm:
- properties:
- errorCode:
- description: solana.broadcast.confirm.failed
- example: Solana.broadcast.confirm.failed
- type: string
- message:
- description: "Unexpected error occurred. Reason: ${error}."
- example: "Unexpected error occurred. Reason: ${error}."
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SolanaBep20NotFound:
- properties:
- errorCode:
- description: erc20.token.notFound
- example: erc20.token.notFound
- type: string
- message:
- description: No such ERC20 currency ${name}.
- example: No such ERC20 currency ${name}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SolanaTxHash:
- properties:
- errorCode:
- description: solana.transaction.hash
- example: solana.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SolanaTxSign:
- properties:
- errorCode:
- description: solana.transaction.sign
- example: solana.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403SolanaTxBody:
- properties:
- errorCode:
- description: solana.transaction.body
- example: Solana.transaction.body
- type: string
- message:
- description: Either currency, or tokenAddress must be defined.
- example: Either currency, or tokenAddress must be defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- TransferSolanaBlockchain:
- type: object
- properties:
- from:
- description: Blockchain address to send assets from
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- maxLength: 44
- minLength: 32
- type: string
- to:
- description: Blockchain address to send assets to
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- amount:
- description: Amount to be sent in SOL.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- zgsAKfjuXrAxEyuYRxbbxPM3rdsPbJPnGreaGMbcdUApJ6wHnCqQnf9b1RNPdeZxsRMkezh4VgXQ7YrbpndGtEv
- minLength: 87
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feePayer:
- description: >-
- Address on the Solana blockchain, from which the fee will be paid
- for transaction. Defaults to from.
- maxLength: 44
- minLength: 32
- example: BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs
- type: string
- feePayerPrivateKey:
- type: string
- maxLength: 87
- example: >-
- YdQ1iy2NYs93dtkHdz3ijDuhRJj6uXYAUZmixirCrgCsTMj42BN1Q1buYcGZaMxw5buk9VU5ogQ6zuzn8DMsGaf
- minLength: 128
- description: Private key of the fee payer address.
- required:
- - to
- - amount
- - from
- - fromPrivateKey
- TransferSolanaBlockchainKMS:
- type: object
- properties:
- from:
- description: Blockchain address to send assets from
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- maxLength: 44
- minLength: 32
- type: string
- to:
- description: Blockchain address to send assets to
- example: FZAS4mtPvswgVxbpc117SqfNgCDLTCtk5CoeAtt58FWU
- maxLength: 44
- minLength: 32
- type: string
- amount:
- description: Amount to be sent in SOL.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- feePayer:
- description: Blockchain address to pay the fee for the transaction from
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- maxLength: 44
- minLength: 32
- type: string
- feePayerSignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key used for paying the gas costs in
- signing application. Defaults to the signatureId.
- required:
- - to
- - amount
- - from
- - signatureId
- SolanaBroadcastConfirmOptions:
- description: Options for sending and waiting for a transaction
- type: object
- properties:
- commitment:
- type: string
- description: Commitment to waiting for transaction confirmation
- example: confirmed
- enum:
- - confirmed
- - finalized
- preflightCommitment:
- type: string
- description: Preflight Commitment.
- example: finalized
- enum:
- - confirmed
- - finalized
- - processed
- - recent
- - single
- - singleGossip
- - max
- SolanaBroadcastConfirm:
- properties:
- txData:
- description: Raw signed transaction to be published to network.
- example: >-
- 01de391b34567fc65080dfe9e27170e2f9ac1cd1719878719feb74bb422d1795201df71fcf7349f5
- maxLength: 500000
- minLength: 1
- type: string
- options:
- $ref: "#/components/schemas/SolanaBroadcastConfirmOptions"
- required:
- - txData
- type: object
- SolanaTransactionHashWithConfirm:
- type: object
- properties:
- txId:
- description: TX hash of successful transaction.
- example: >-
- 5Sh63rNFg6iR9YUGPwEkbAg4kYSWnf5eRS2wcLG1Gc6psj27SGK3LNuN9jNSPKn3JoChgmq8pSirHWsPPWzy2PFw
- type: string
- confirmed:
- description: >-
- Indicates whether or not the transferred commitment has been
- fulfilled
- example: false
- type: boolean
- required:
- - txId
- - confirmed
- Error403Celo:
- properties:
- errorCode:
- description: celo.error
- example: celo.error
- type: string
- message:
- description: "Unexpected error occurred. Reason: ${reason}"
- example: "Unexpected error occurred. Reason: ${reason}"
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- TransferErc721Celo:
- type: object
- properties:
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send ERC721 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example: "100000"
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - contractAddress
- - tokenId
- - fromPrivateKey
- TransferErc721KMSCelo:
- type: object
- properties:
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send ERC721 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example: "100000"
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - contractAddress
- - feeCurrency
- - signatureId
- - tokenId
- MintErc721Celo:
- type: object
- properties:
- tokenId:
- description: ID of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send ERC721 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- url:
- description: >-
- Metadata of the token. See
- https://eips.ethereum.org/EIPS/eip-721#specification for more
- details.
- example: https://my_token_data.com
- type: string
- maxLength: 256
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - url
- - feeCurrency
- - contractAddress
- - fromPrivateKey
- - tokenId
- MintErc721KMSCelo:
- type: object
- properties:
- tokenId:
- description: ID of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send ERC721 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- url:
- description: >-
- Metadata of the token. See
- https://eips.ethereum.org/EIPS/eip-721#specification for more
- details.
- example: https://my_token_data.com
- type: string
- maxLength: 256
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - url
- - feeCurrency
- - contractAddress
- - signatureId
- - tokenId
- MintErc20Celo:
- type: object
- properties:
- amount:
- description: Amount to be minted and transfered to the recipient.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send ERC-20 tokens to.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC-20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - amount
- - feeCurrency
- - contractAddress
- - fromPrivateKey
- MintErc20KMSCelo:
- type: object
- properties:
- amount:
- description: Amount to be minted and transfered to the recipient.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send ERC-20 tokens to.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC-20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - amount
- - feeCurrency
- - contractAddress
- - signatureId
- MintMultipleErc721Celo:
- type: object
- properties:
- to:
- type: array
- description: Blockchain address to send ERC721 token to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "100000"
- items:
- type: string
- maxLength: 32
- url:
- description: >-
- Metadata of the token. See
- https://eips.ethereum.org/EIPS/eip-721#specification for more
- details.
- type: array
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - contractAddress
- - url
- - fromPrivateKey
- - feeCurrency
- - tokenId
- MintMultipleErc721KMSCelo:
- type: object
- properties:
- to:
- type: array
- description: Blockchain address to send ERC721 token to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "100000"
- items:
- type: string
- maxLength: 32
- url:
- description: >-
- Metadata of the token. See
- https://eips.ethereum.org/EIPS/eip-721#specification for more
- details.
- type: array
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - contractAddress
- - feeCurrency
- - tokenId
- - url
- - signatureId
- BurnErc721Celo:
- type: object
- properties:
- tokenId:
- description: ID of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - feeCurrency
- - fromPrivateKey
- - tokenId
- BurnErc721KMSCelo:
- type: object
- properties:
- tokenId:
- description: ID of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - feeCurrency
- - contractAddress
- - tokenId
- - signatureId
- BurnErc20Celo:
- type: object
- properties:
- amount:
- description: Amount of tokens to be destroyed.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - feeCurrency
- - fromPrivateKey
- - amount
- BurnErc20KMSCelo:
- type: object
- properties:
- amount:
- description: Amount of tokens to be destroyed.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC721 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - feeCurrency
- - contractAddress
- - tokenId
- - amount
- TransferCeloBlockchain:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- type: string
- description: Currency of the transaction.
- enum:
- - CELO
- - CUSD
- - CEUR
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- required:
- - to
- - amount
- - fromPrivateKey
- - currency
- - feeCurrency
- TransferCeloBlockchainKMS:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- currency:
- type: string
- description: Currency of the transaction.
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- required:
- - to
- - feeCurrency
- - currency
- - amount
- - signatureId
- CeloEstimateGas:
- type: object
- properties:
- from:
- type: string
- maxLength: 42
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- minLength: 42
- description: Sender address.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- pattern: ^(0x|0h)?[0-9A-F]+$
- required:
- - to
- - amount
- - from
- CeloBlock:
- type: object
- properties:
- difficulty:
- description: Difficulty for this block.
- type: string
- example: "3296820833"
- extraData:
- description: The 'extra data' field of this block.
- type: string
- example: 0x
- gasLimit:
- description: The maximum gas allowed in this block.
- type: number
- example: 8000000
- gasUsed:
- description: The total used gas by all transactions in this block.
- type: number
- example: 7985124
- hash:
- description: Hash of the block. 'null' when its pending block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- logsBloom:
- description: >-
- The bloom filter for the logs of the block. 'null' when its pending
- block.
- type: string
- example: >-
- 0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000
- miner:
- description: >-
- The address of the beneficiary to whom the mining rewards were
- given.
- type: string
- example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
- mixHash:
- description: ""
- type: string
- example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
- nonce:
- description: Hash of the generated proof-of-work. 'null' when its pending block.
- type: string
- example: "0xfa1692f52a7ac672"
- number:
- description: The block number. 'null' when its pending block.
- type: number
- example: 6470657
- parentHash:
- description: Hash of the parent block.
- type: string
- example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
- receiptsRoot:
- description: ""
- type: string
- example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
- sha3Uncles:
- description: SHA3 of the uncles data in the block.
- type: string
- example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
- size:
- description: The size of this block in bytes.
- type: number
- example: 15296
- stateRoot:
- description: The root of the final state trie of the block.
- type: string
- example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
- timestamp:
- description: The unix timestamp for when the block was collated.
- type: number
- example: 1569600592
- totalDifficulty:
- description: Total difficulty of the chain until this block.
- type: string
- example: "23329673338013873"
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/CeloTx"
- transactionsRoot:
- description: The root of the transaction trie of the block.
- type: string
- example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
- CeloTx:
- type: object
- properties:
- blockHash:
- description: Hash of the block where this transaction was in.
- type: string
- example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
- status:
- type: boolean
- example: true
- description: >-
- TRUE if the transaction was successful, FALSE, if the EVM reverted
- the transaction.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- from:
- type: string
- description: Address of the sender.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- gas:
- type: number
- description: Gas provided by the sender.
- example: 21000
- gasPrice:
- type: string
- description: Gas price provided by the sender in wei.
- example: "1000000000"
- transactionHash:
- type: string
- description: Hash of the transaction.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- input:
- type: string
- description: The data sent along with the transaction.
- example: 0x
- nonce:
- type: number
- description: The number of transactions made by the sender prior to this one.
- example: 26836405
- to:
- type: string
- description: >-
- Address of the receiver. 'null' when its a contract creation
- transaction.
- example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
- transactionIndex:
- type: number
- description: Integer of the transactions index position in the block.
- example: 3
- value:
- type: string
- description: Value transferred in wei.
- example: "1000000000000000000"
- gasUsed:
- type: number
- description: The amount of gas used by this specific transaction alone.
- example: 21000
- cumulativeGasUsed:
- type: number
- description: >-
- The total amount of gas used when this transaction was executed in
- the block.
- example: 314159
- contractAddress:
- type: string
- description: >-
- The contract address created, if the transaction was a contract
- creation, otherwise null.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- logs:
- type: array
- description: Log events, that happened in this transaction.
- items:
- type: object
- properties:
- address:
- type: string
- description: From which this event originated from.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- topics:
- type: array
- description: >-
- An array with max 4 32 Byte topics, topic 1-3 contains indexed
- parameters of the log.
- items:
- type: string
- example: >-
- 0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234
- data:
- type: string
- description: The data containing non-indexed log parameter.
- logIndex:
- type: number
- description: Integer of the event index position in the block.
- transactionIndex:
- type: number
- description: >-
- Integer of the transaction’s index position, the event was
- created in.
- transactionHash:
- type: string
- description: Hash of the transaction this event was created in.
- example: >-
- 0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7
- DeployErc721Celo:
- type: object
- properties:
- name:
- description: Name of the ERC721 token
- example: My ERC721
- maxLength: 100
- minLength: 1
- type: string
- symbol:
- description: Symbol of the ERC721 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- fromPrivateKey:
- description: >-
- Private key of Celo account address, from which gas for deployment
- of ERC721 will be paid. Private key, or signature Id must be
- present.
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - name
- - symbol
- - feeCurrency
- - fromPrivateKey
- DeployErc721CeloKMS:
- type: object
- properties:
- name:
- description: Name of the ERC721 token
- example: My ERC721
- maxLength: 100
- minLength: 1
- type: string
- symbol:
- description: Symbol of the ERC721 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - name
- - symbol
- - feeCurrency
- - signatureId
- DeployErc20Celo:
- type: object
- properties:
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Celo blockchain, where all created ERC20 tokens will be
- transferred.
- maxLength: 42
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- fromPrivateKey:
- description: >-
- Private key of Celo account address, from which the fee for the
- deployment of ERC20 will be paid. Private key, or signature Id must
- be present.
- type: string
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- maxLength: 66
- minLength: 66
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - name
- - symbol
- - address
- - supply
- - fromPrivateKey
- - digits
- - feeCurrency
- DeployErc20KMSCelo:
- type: object
- properties:
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Celo blockchain, where all created ERC20 tokens will be
- transferred.
- maxLength: 42
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - name
- - symbol
- - address
- - supply
- - signatureId
- - digits
- - feeCurrency
- CallCeloSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- - feeCurrency
- CallCeloReadSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- required:
- - contractAddress
- - params
- - methodABI
- - methodName
- CallCeloSmartContractMethodKMS:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - signatureId
- - methodName
- - feeCurrency
- TransferErc20Celo:
- type: object
- properties:
- to:
- maxLength: 50
- minLength: 1
- description: Blockchain address to send ERC20 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: Amount to be sent.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- digits:
- description: Number of decimal points that ERC20 token has.
- example: 18
- maximum: 30
- minimum: 1
- type: number
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - contractAddress
- - digits
- - feeCurrency
- - fromPrivateKey
- - amount
- TransferErc20CeloKMS:
- type: object
- properties:
- to:
- maxLength: 50
- minLength: 1
- description: Blockchain address to send ERC20 token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: Amount to be sent.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- digits:
- description: Number of decimal points that ERC20 token has.
- example: 18
- maximum: 30
- minimum: 1
- type: number
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - contractAddress
- - signatureId
- - digits
- - amount
- - feeCurrency
- Error403CeloGasCalculation:
- properties:
- errorCode:
- description: celo.transaction.gas
- example: celo.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403CeloTxBody:
- properties:
- errorCode:
- description: celo.transaction.body
- example: celo.transaction.body
- type: string
- message:
- description: Either currency, or tokenAddress must be defined.
- example: Either currency, or tokenAddress must be defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- EgldBlock:
- type: object
- properties:
- nonce:
- description: The block height.
- type: number
- example: 5440076
- round:
- description: The round number.
- type: number
- example: 186582
- hash:
- description: Hash of the block.
- type: string
- example: bd2de3618929b696807f6ef8a619f93d29d639aec9277f9c6f8569a8487141b1
- prevBlockHash:
- description: Hash of the previous block.
- type: string
- example: 2a11aad21e933be58200839ff875f0ca7e955b8c483a0e117cb92409e5d2a5da
- epoch:
- description: >-
- An epoch is a sequence of consecutive rounds during which the
- configuration of the network does not change (currently aprox. 24
- hrs in length).
- type: number
- example: 18
- numTxs:
- description: Number of transactions in current block.
- type: number
- example: 8
- shardBlocks:
- description: Array of shard blocks
- type: array
- items:
- $ref: "#/components/schemas/EgldShardBlock"
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/EgldTx"
- EgldShardBlock:
- type: object
- properties:
- hash:
- description: The block hash.
- type: string
- example: a6f2ac15a6b1bafdde9afff2297cef49c4c523c516f8ee12fed54be070e9512b
- nonce:
- description: The block height.
- type: number
- example: 5440070
- shard:
- description: The shard number.
- type: number
- example: 1
- EgldTx:
- type: object
- properties:
- type:
- type: string
- description: Type of transaction.
- example: null
- nonce:
- type: number
- description: Nonce of the transaction.
- example: 2
- round:
- type: number
- description: The round number.
- example: 186580
- epoch:
- type: number
- description: >-
- An epoch is a sequence of consecutive rounds during which the
- configuration of the network does not change (currently aprox. 24
- hrs in length).
- example: 12
- value:
- type: string
- description: Transferred value.
- example: "1000000000000000000"
- receiver:
- type: string
- description: Address of the receiver.
- example: erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7
- sender:
- type: string
- description: Address of the sender.
- example: erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq1
- gasPrice:
- type: number
- description: Gas price provided by the sender
- example: 1000000000
- gasLimit:
- type: number
- description: Gas provided by the sender
- example: 70000
- data:
- type: string
- description: Data field in transaction.
- example: Zm9yIHRlc3Rz
- signature:
- type: string
- description: Signature of the transaction.
- example: >-
- c6ab10b401f14b122caf9d2ef80d532b986aa82b589dac77d77929da27ae2382c6ab10b401f14b122caf9d2ef80d532b986aa82b589dac77d77929da27ae238
- sourceShard:
- type: number
- description: Source shard.
- example: 2
- destinationShard:
- type: number
- description: Destination shard.
- example: 1
- blockNonce:
- type: number
- description: Nonce of block which contains current transaction.
- example: 186535
- blockHash:
- type: string
- description: Hash of block which contains current transaction.
- example: bd2de3618929b696807f6ef8a619f93d29d639aec9277f9c6f8569a8487141b1
- miniblockHash:
- type: string
- description: Miniblock hash.
- example: 7cb0a10cf9e9ec9ff719ffe99349db3feac3ec217b6de62f6cf7756647194bbf
- timestamp:
- type: number
- description: The unix timestamp for when the block was collated.
- example: 1569600592
- status:
- type: string
- description: Status of the transaction.
- example: Success
- hyperblockNonce:
- type: number
- description: Nonce of the hyperblockwhere this transaction was in.
- example: 123321
- hyperblockHash:
- type: string
- description: Hash of the hyperblock where this transaction was in.
- example: 715224f1f7d8330e3837500d1f82431954e30db6149f3ee4644d0950576d8dfe
- Error403EgldBroadcast:
- properties:
- errorCode:
- description: egld.broadcast.failed
- example: egld.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EgldTxHash:
- properties:
- errorCode:
- description: egld.transaction.hash
- example: egld.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403EgldTxSign:
- properties:
- errorCode:
- description: egld.transaction.sign
- example: egld.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- TransferEgldBlockchain:
- type: object
- properties:
- from:
- description: Account address of the sender
- example: erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7
- maxLength: 62
- minLength: 62
- type: string
- to:
- description: Account address of the receiver or smart contract
- example: erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq6
- maxLength: 62
- minLength: 62
- type: string
- amount:
- type: string
- description: Value to be sent.
- example: "0"
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- properties:
- gasLimit:
- type: string
- description: >-
- Gas limit for transaction. If transfer to a smart contract, then
- 500000 + an appropriate amount for the method call
- example: "500000"
- pattern: ^[+]?\d+$
- gasPrice:
- type: string
- description: Gas price.
- example: "1000000000"
- pattern: ^[+]?\d+$
- data:
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- type: string
- example: 4d79206e6f746520746f2074686520726563697069656e74
- fromPrivateKey:
- type: string
- maxLength: 64
- minLength: 64
- example: 0cd8e6217b4a218807b858ffb508483cdcdadbb7a21196727f764a510a692760
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- required:
- - fromPrivateKey
- - from
- - to
- - amount
- TransferEgldBlockchainKMS:
- type: object
- properties:
- from:
- description: Account address of the sender
- example: erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq7
- maxLength: 62
- minLength: 62
- type: string
- to:
- description: Account address of the receiver or smart contract
- example: erd17k95m339aqzxzyvjjjfa3lka0yyeqgcsda50tw5z9g73ycfe2caq9e6jq6
- maxLength: 62
- minLength: 62
- type: string
- amount:
- type: string
- description: Value to be sent.
- example: "0"
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction.
- example: "500000"
- pattern: ^[+]?\d+$
- gasPrice:
- type: string
- description: Gas price.
- example: "1000000000"
- pattern: ^[+]?\d+$
- data:
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- type: string
- example: 4d79206e6f746520746f2074686520726563697069656e74
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- required:
- - signatureId
- - from
- - to
- - amount
- TransferTronBlockchain:
- type: object
- properties:
- fromPrivateKey:
- type: string
- minLength: 64
- maxLength: 64
- description: Private key of the address, from which the TRX will be sent.
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- to:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- amount:
- description: Amount to be sent in TRX.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- required:
- - fromPrivateKey
- - to
- - amount
- TransferTronBlockchainKMS:
- type: object
- properties:
- from:
- type: string
- minLength: 34
- maxLength: 34
- description: Sender address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- signatureId:
- type: string
- minimum: 36
- maximum: 36
- format: uuid
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- to:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- amount:
- description: Amount to be sent in TRX.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- required:
- - from
- - signatureId
- - to
- - amount
- TransferTronTrc10Blockchain:
- type: object
- properties:
- fromPrivateKey:
- type: string
- minLength: 64
- maxLength: 64
- description: Private key of the address, from which the TRX will be sent.
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- to:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- tokenId:
- type: string
- minLength: 1
- maxLength: 100
- description: ID of the token to transfer.
- example: "1000538"
- amount:
- description: Amount to be sent in TRX.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- required:
- - fromPrivateKey
- - tokenId
- - to
- - amount
- TransferTronTrc10BlockchainKMS:
- type: object
- properties:
- from:
- type: string
- minLength: 34
- maxLength: 34
- description: Sender address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- signatureId:
- type: string
- minimum: 36
- maximum: 36
- format: uuid
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- to:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- tokenId:
- type: string
- minLength: 1
- maxLength: 100
- description: ID of the token to transfer.
- example: "1000538"
- amount:
- description: Amount to be sent in TRX.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- required:
- - from
- - signatureId
- - tokenId
- - to
- - amount
- TransferTronTrc20Blockchain:
- type: object
- properties:
- fromPrivateKey:
- type: string
- minLength: 64
- maxLength: 64
- description: Private key of the address, from which the TRX will be sent.
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- to:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- tokenAddress:
- type: string
- minLength: 34
- maxLength: 34
- description: Address of the TRC20 token to transfer.
- example: TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- amount:
- description: Amount to be sent in TRX.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- required:
- - fromPrivateKey
- - tokenAddress
- - to
- - amount
- - feeLimit
- TransferTronTrc20BlockchainKMS:
- type: object
- properties:
- from:
- type: string
- minLength: 34
- maxLength: 34
- description: Sender address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- signatureId:
- type: string
- minimum: 36
- maximum: 36
- format: uuid
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- to:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- tokenAddress:
- type: string
- minLength: 34
- maxLength: 34
- description: Address of the TRC20 token to transfer.
- example: TVAEYCmc15awaDRAjUZ1kvcHwQQaoPw2CW
- feeLimit:
- type: number
- minimum: 0
- description: Fee in TRX to be paid.
- example: 0.01
- amount:
- description: Amount to be sent in TRX.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- required:
- - from
- - signatureId
- - tokenAddress
- - to
- - amount
- - feeLimit
- CreateTronTrc20Blockchain:
- type: object
- properties:
- fromPrivateKey:
- type: string
- minLength: 64
- maxLength: 64
- description: Private key of the address, from which the TRX will be sent.
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- recipient:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of created TRC20 tokens.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- name:
- type: string
- minLength: 1
- maxLength: 100
- description: Name of the token.
- example: My token
- symbol:
- type: string
- minLength: 1
- maxLength: 100
- description: Symbol of the token.
- example: SYM
- totalSupply:
- type: number
- minimum: 0
- description: Total supply of the tokens.
- example: 100000
- decimals:
- type: number
- minimum: 0
- maximum: 30
- description: Number of decimal places of the token.
- example: 10
- required:
- - fromPrivateKey
- - name
- - recipient
- - symbol
- - totalSupply
- - decimals
- CreateTronTrc20BlockchainKMS:
- type: object
- properties:
- from:
- type: string
- minLength: 34
- maxLength: 34
- description: Sender address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- signatureId:
- type: string
- minimum: 36
- maximum: 36
- format: uuid
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- recipient:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of created TRC20 tokens.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- name:
- type: string
- minLength: 1
- maxLength: 100
- description: Name of the token.
- example: My token
- symbol:
- type: string
- minLength: 1
- maxLength: 100
- description: Symbol of the token.
- example: SYM
- totalSupply:
- type: number
- minimum: 0
- description: Total supply of the tokens.
- example: 100000
- decimals:
- type: number
- minimum: 0
- maximum: 30
- description: Number of decimal places of the token.
- example: 10
- required:
- - from
- - signatureId
- - name
- - recipient
- - symbol
- - totalSupply
- - decimals
- CreateTronTrc10Blockchain:
- type: object
- properties:
- fromPrivateKey:
- type: string
- minLength: 64
- maxLength: 64
- description: Private key of the address, from which the TRX will be sent.
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- recipient:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of created TRC 10 tokens.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- name:
- type: string
- minLength: 1
- maxLength: 100
- description: Name of the token.
- example: My token
- abbreviation:
- type: string
- minLength: 1
- maxLength: 100
- description: Abbreviation of the token.
- example: SYM
- description:
- type: string
- minLength: 1
- maxLength: 100
- description: Description of the token.
- example: My short description
- url:
- type: string
- minLength: 1
- maxLength: 100
- description: URL of the token.
- example: https://mytoken.com
- totalSupply:
- type: number
- minimum: 0
- description: Total supply of the tokens.
- example: 100000
- decimals:
- type: number
- minimum: 0
- maximum: 5
- description: Number of decimal places of the token.
- example: 10
- required:
- - fromPrivateKey
- - recipient
- - name
- - abbreviation
- - description
- - url
- - totalSupply
- - decimals
- CreateTronTrc10BlockchainKMS:
- type: object
- properties:
- from:
- type: string
- minLength: 34
- maxLength: 34
- description: Sender address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- signatureId:
- type: string
- minimum: 36
- maximum: 36
- format: uuid
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- recipient:
- type: string
- minLength: 34
- maxLength: 34
- description: Recipient address of created TRC 10 tokens.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- name:
- type: string
- minLength: 1
- maxLength: 100
- description: Name of the token.
- example: My token
- abbreviation:
- type: string
- minLength: 1
- maxLength: 100
- description: Abbreviation of the token.
- example: SYM
- description:
- type: string
- minLength: 1
- maxLength: 100
- description: Description of the token.
- example: My short description
- url:
- type: string
- minLength: 1
- maxLength: 100
- description: URL of the token.
- example: https://mytoken.com
- totalSupply:
- type: number
- minimum: 0
- description: Total supply of the tokens.
- example: 100000
- decimals:
- type: number
- minimum: 0
- maximum: 5
- description: Number of decimal places of the token.
- example: 10
- required:
- - from
- - signatureId
- - recipient
- - name
- - abbreviation
- - description
- - url
- - totalSupply
- - decimals
- TronTrc10Detail:
- type: object
- properties:
- ownerAddress:
- type: string
- minLength: 34
- maxLength: 34
- description: The address of the TRC-10 token's owner in the hexadecimal format
- example: 41d2803f9c22aa429d71554c9427e97ffedcec17c7
- name:
- type: string
- minLength: 1
- maxLength: 100
- description: The name of the TRC-10 token
- example: My token
- abbr:
- type: string
- minLength: 1
- maxLength: 100
- description: The abbreviated name of the TRC-10 token
- example: SYM
- description:
- type: string
- minLength: 1
- maxLength: 100
- description: The description of the TRC-10 token
- example: My short description
- url:
- type: string
- minLength: 1
- maxLength: 100
- description: The URL of the TRC-10 token
- example: https://mytoken.com
- totalSupply:
- type: number
- minimum: 0
- description: The total supply of tokens in the TRC-10 token
- example: 100000
- precision:
- type: number
- minimum: 0
- maximum: 5
- description: The number of decimal places
- example: 10
- id:
- type: number
- description: The ID of the TRC-10 token
- example: 1000540
- FreezeTron:
- type: object
- properties:
- fromPrivateKey:
- type: string
- minLength: 64
- maxLength: 64
- description: Private key of the address, from which the TRX will be sent.
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- resource:
- type: string
- description: Resource to obtain, BANDWIDTH or ENERGY.
- example: ENERGY
- enum:
- - BANDWIDTH
- - ENERGY
- amount:
- description: Amount to be frozen in TRX.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- required:
- - fromPrivateKey
- - resource
- - amount
- FreezeTronKMS:
- type: object
- properties:
- from:
- type: string
- minLength: 34
- maxLength: 34
- description: Sender address of TRON account in Base58 format.
- example: TYMwiDu22V6XG3yk6W9cTVBz48okKLRczh
- signatureId:
- type: string
- minimum: 36
- maximum: 36
- format: uuid
- example: 1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- resource:
- type: string
- description: Resource to obtain, BANDWIDTH or ENERGY.
- example: ENERGY
- enum:
- - BANDWIDTH
- - ENERGY
- amount:
- description: Amount to be frozen in TRX.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- required:
- - from
- - signatureId
- - resource
- - amount
- Error403Tron:
- properties:
- errorCode:
- description: tron.failed
- example: tron.failed
- type: string
- message:
- description: Unable to communicate to blockchain. ${error}
- example: Unable to communicate to blockchain. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- TronWallet:
- type: object
- required:
- - mnemonic
- - xpub
- properties:
- mnemonic:
- description: Generated mnemonic for wallet.
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- type: string
- xpub:
- description: >-
- Generated Extended public key for wallet with derivation path
- according to BIP44. This key can be used to generate addresses.
- example: >-
- 0244b3f40c6e570ae0032f6d7be87737a6c4e5314a4a1a82e22d0460a0d0cd794936c61f0c80dc74ace4cd04690d4eeb1aa6555883be006e1748306faa7ed3a26a
- type: string
- TronBlock:
- type: object
- properties:
- hash:
- type: string
- description: Block hash
- example: 000000000195a8cfe2ea4ca60ce921b30e95980a96c6bb1da4a35aa03da9c5a8
- blockNumber:
- type: number
- description: Block number.
- example: 26585295
- timestamp:
- type: number
- description: Time of the block in UTC millis.
- example: 1610134209000
- parentHash:
- type: string
- description: Hash of the parent block.
- example: 000000000195a8ce6003aa8b6443c52734b80aefdcd079bf40e7f165b046370e
- witnessAddress:
- type: string
- description: Witness address.
- example: 4118e2e1c6cdf4b74b7c1eb84682e503213a174955
- witnessSignature:
- type: string
- description: Witness signature.
- example: >-
- e20cb7a1f01d279ebe9c20baa0d747bea160042639ba0be63460cbb21ae63f072520e7766cb7aa1bd4e74bebbdea64be431ecf52c2aa2123ca0b1d7495bd581d00
- transactions:
- type: array
- description: Transactions that occurs in this block.
- items:
- $ref: "#/components/schemas/TronTx"
- TronBroadcast:
- type: object
- required:
- - txData
- properties:
- txData:
- type: string
- description: Raw signed transaction to be published to network.
- minLength: 1
- maxLength: 50000
- example: >-
- {"raw_data":
- "{\"contract\":[{\"parameter\":{\"value\":{\"amount\":1000,\"owner_address\":\"41608f8da72479edc7dd921e4c30bb7e7cddbe722e\",\"to_address\":\"41e9d79cc47518930bc322d9bf7cddd260a0260a8d\"},\"type_url\":\"type.googleapis.com/protocol.TransferContract\"},\"type\":\"TransferContract\"}],\"ref_block_bytes\":\"5e4b\",\"ref_block_hash\":\"47c9dc89341b300d\",\"expiration\":1591089627000,\"timestamp\":1591089567635}","raw_data_hex":
- "0a025e4b220847c9dc89341b300d40f8fed3a2a72e5a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a1541608f8da72479edc7dd921e4c30bb7e7cddbe722e121541e9d79cc47518930bc322d9bf7cddd260a0260a8d18e8077093afd0a2a72e"}
- TronTx:
- type: object
- required:
- - txID
- - signature
- - blockNumber
- - ret
- - rawData
- properties:
- ret:
- type: array
- description: Result of the smart contract invocation.
- items:
- properties:
- contractRet:
- type: string
- description: Returns the value of the smart contract invocation.
- example: SUCCESS
- required:
- - contractRet
- signature:
- type: array
- description: List of signatures of the transaction.
- items:
- type: string
- example: >-
- 91fa5d81f9578970d21fdcde4ebb849674d437b62774f34e8d9e4cb50960c0031362cbcb649553b1f5f9daf19495ae46e517d4401172b5e53bb06bfe6896e2e300
- blockNumber:
- type: number
- description: The block in which the transaction was included.
- example: 11223344
- txID:
- type: string
- description: Transaction ID.
- example: 24dd2f121a24516f22df78adf1ccc32119e3edb7760297f76a925b879f2baa98
- netUsage:
- type: number
- description: Usage of the network.
- example: 0
- rawData:
- type: object
- description: Raw data of the transaction.
- required:
- - expiration
- - timestamp
- - contract
- properties:
- contract:
- type: array
- description: Smart contract invocations details.
- items:
- type: object
- properties:
- parameter:
- type: object
- properties:
- value:
- type: object
- properties:
- data:
- type: string
- format: hex
- description: The amount transferred within the transaction.
- example: "0x000002e917e68b4e"
- amount:
- type: number
- description: The amount transferred within the transaction.
- example: 1000000
- owner_address:
- type: string
- example: 418632237fd33f62c549ee044dd3da779aba947dcc
- description: Address of the sender.
- to_address:
- type: string
- description: Address of the recipient.
- example: 41a614f803b6fd780986a42c78ec9c7f77e6ded13c
- ownerAddressBase58:
- type: string
- example: TNCmcTdyrYKMtmE1KU2itzeCX76jGm5Not
- description: Address of the sender in Base58 encoding.
- toAddressBase58:
- type: string
- example: TRwS7apsNdRGzMBfhB2hVC4RhqfubUYZ8P
- description: Address of the recipient in Base58 encoding.
- type_url:
- type: string
- example: type.googleapis.com/protocol.TriggerSmartContract
- description: Type of the smart contract event.
- type:
- example: TriggerSmartContract
- type: string
- description: Type of the Smart contract.
- ref_block_bytes:
- type: number
- description: The height of the transaction reference block.
- example: 4946
- ref_block_hash:
- type: number
- description: The hash of the transaction reference block.
- example: 6d0c1a0af5a52f17
- expiration:
- description: Expiration of the transaction.
- type: number
- example: 1610067216000
- timestamp:
- description: Time of the transaction.
- type: number
- example: 1609980816000
- TronInternalTx:
- type: object
- required:
- - internal_tx_id
- - tx_id
- - to_address
- - from_address
- properties:
- tx_id:
- type: string
- description: Transaction ID.
- example: 24dd2f121a24516f22df78adf1ccc32119e3edb7760297f76a925b879f2baa98
- internal_tx_id:
- type: string
- description: Internal TX ID.
- example: e1543ab5ac85e8fbf2397f30f19dc5b7a32abd508a57ff0c13642c9963d9f312
- to_address:
- type: string
- description: Recipient address.
- example: 41a614f803b6fd780986a42c78ec9c7f77e6ded13c
- from_address:
- type: string
- description: Sender address.
- example: 41a2726afbecbd8e936000ed684cef5e2f5cf43008
- TronTx20:
- type: object
- required:
- - txID
- - to
- - tokenInfo
- - type
- - value
- - from
- properties:
- txID:
- type: string
- description: Transaction ID.
- example: 24dd2f121a24516f22df78adf1ccc32119e3edb7760297f76a925b879f2baa98
- tokenInfo:
- type: object
- required:
- - symbol
- - decimals
- - address
- - name
- properties:
- symbol:
- type: string
- example: USDT
- address:
- type: string
- example: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
- decimals:
- type: number
- example: 6
- name:
- type: string
- example: Tether USD
- from:
- type: string
- example: TPn72oEg7WPaffgNBf62vGx8G1s4chx2fp
- to:
- type: string
- example: TJyhbP1bQfo8tLPxEVjaka9gh2qkN7MvD3
- type:
- type: string
- example: Transfer
- value:
- type: string
- example: "1800"
- TronAccount:
- type: object
- required:
- - address
- - freeNetUsage
- - balance
- - bandwidth
- - trc10
- - trc20
- - createTime
- properties:
- address:
- type: string
- description: Account address
- example: TGDqQAP5bduoPKVgdbk7fGyW4DwEt3RRn8
- balance:
- type: number
- description: Balance of the TRX, in SUN. SUN is 1/1000000 TRX.
- example: 2342342
- trc10:
- type: array
- items:
- type: object
- description: Balance of the TRC10 assets.
- properties:
- key:
- type: string
- description: Name of the TRC10 asset.
- example: TEST_TRC_10
- value:
- type: number
- description: Balance of the TRC10 asset.
- example: 123
- required:
- - key
- - value
- trc20:
- type: array
- items:
- type: object
- description: >-
- Balance of the TRC20 assets. It is structured as key value array,
- where key is the address of the TRC20 and value is the balance.
- example:
- TRkuKAxmWZ4G74MvZnFpoosQZsfvtNpmwH: "30958"
- TVKXY8DJ9aVTcg3wwVrRRs2FbTUwi4UZWR: "70000"
- createTime:
- type: number
- description: Date of creation of the account in UTC millis.
- example: 1602848895000
- assetIssuedId:
- type: string
- description: ID of the issued TRC10 token, if any.
- example: "1003475"
- assetIssuedName:
- type: number
- description: Balance of the issued TRC10 token, if any.
- example: 100
- freeNetUsage:
- type: number
- description: Free usage of the network.
- example: 1000
- freeNetLimit:
- type: number
- description: Free usage limit of the network.
- example: 1500
- netUsage:
- type: number
- description: Extra usage of the network.
- example: 5000
- netLimit:
- type: number
- description: Extra usage limit of the network.
- example: 5000
- bandwidth:
- type: number
- description: >-
- Remaining usage of the network, equal to freeNetLimit - freeNetUsed
- + netLimit - netUsed.
- example: 1500
- BscBalance:
- type: object
- properties:
- balance:
- type: string
- description: Balance in BNB
- example: "10.52"
- GeneratedAddressBsc:
- type: object
- properties:
- address:
- type: string
- description: BSC address
- example: "0xa7673161CbfE0116A4De9E341f8465940c2211d4"
- BscBlock:
- type: object
- properties:
- difficulty:
- description: Difficulty for this block.
- type: string
- example: "3296820833"
- extraData:
- description: The 'extra data' field of this block.
- type: string
- example: 0x
- gasLimit:
- description: The maximum gas allowed in this block.
- type: number
- example: 8000000
- gasUsed:
- description: The total used gas by all transactions in this block.
- type: number
- example: 7985124
- hash:
- description: Hash of the block. 'null' when its pending block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- logsBloom:
- description: >-
- The bloom filter for the logs of the block. 'null' when its pending
- block.
- type: string
- example: >-
- 0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000
- miner:
- description: >-
- The address of the beneficiary to whom the mining rewards were
- given.
- type: string
- example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
- mixHash:
- description: ""
- type: string
- example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
- nonce:
- description: Hash of the generated proof-of-work. 'null' when its pending block.
- type: string
- example: "0xfa1692f52a7ac672"
- number:
- description: The block number. 'null' when its pending block.
- type: number
- example: 6470657
- parentHash:
- description: Hash of the parent block.
- type: string
- example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
- receiptsRoot:
- description: ""
- type: string
- example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
- sha3Uncles:
- description: SHA3 of the uncles data in the block.
- type: string
- example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
- size:
- description: The size of this block in bytes.
- type: number
- example: 15296
- stateRoot:
- description: The root of the final state trie of the block.
- type: string
- example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
- timestamp:
- description: The unix timestamp for when the block was collated.
- type: number
- example: 1569600592
- totalDifficulty:
- description: Total difficulty of the chain until this block.
- type: string
- example: "23329673338013873"
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/BscTx"
- transactionsRoot:
- description: The root of the transaction trie of the block.
- type: string
- example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
- BscTx:
- type: object
- properties:
- blockHash:
- description: Hash of the block where this transaction was in.
- type: string
- example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
- status:
- type: boolean
- example: true
- description: >-
- TRUE if the transaction was successful, FALSE, if the EVM reverted
- the transaction.
- blockNumber:
- type:
- - number
- - "null"
- description: >-
- The number of the block that the transaction is included in; if not
- returned, the transaction has not been included in a block yet.
- example: 6470854
- from:
- type: string
- description: Address of the sender.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- gas:
- type: number
- description: Gas provided by the sender.
- example: 21000
- gasPrice:
- type: string
- description: Gas price provided by the sender in wei.
- example: "1000000000"
- transactionHash:
- type: string
- description: Hash of the transaction.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- input:
- type: string
- description: The data sent along with the transaction.
- example: 0x
- nonce:
- type: number
- description: The number of transactions made by the sender prior to this one.
- example: 26836405
- to:
- type: string
- description: >-
- Address of the receiver. 'null' when its a contract creation
- transaction.
- example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
- transactionIndex:
- type:
- - number
- - "null"
- description: >-
- The integer of the transactions index position in the block; if not
- returned, the transaction has not been included in a block yet.
- example: 3
- value:
- type: string
- description: Value transferred in wei.
- example: "1000000000000000000"
- gasUsed:
- type:
- - number
- - "null"
- description: >-
- The amount of gas used by this specific transaction alone; if not
- returned, the transaction has not been included in a block yet.
- example: 21000
- cumulativeGasUsed:
- type:
- - number
- - "null"
- description: >-
- The total amount of gas used when this transaction was executed in
- the block; if not returned, the transaction has not been included in
- a block yet.
- example: 314159
- contractAddress:
- type: string
- description: >-
- The contract address created, if the transaction was a contract
- creation, otherwise null.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- logs:
- type: array
- description: Log events, that happened in this transaction.
- items:
- $ref: "#/components/schemas/BscTxLog"
- BscTxLog:
- type: object
- properties:
- address:
- type: string
- description: From which this event originated from.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- topics:
- type: array
- description: >-
- An array with max 4 32 Byte topics, topic 1-3 contains indexed
- parameters of the log.
- items:
- type: string
- example: "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
- data:
- type: string
- description: The data containing non-indexed log parameter.
- logIndex:
- type: number
- description: Integer of the event index position in the block.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- blockHash:
- description: Hash of the block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- transactionIndex:
- type: number
- description: >-
- Integer of the transaction’s index position, the event was created
- in.
- transactionHash:
- type: string
- description: Hash of the transaction this event was created in.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- Error403BscBroadcast:
- properties:
- errorCode:
- description: bsc.broadcast.failed
- example: bsc.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscBep20NotFound:
- properties:
- errorCode:
- description: erc20.token.notFound
- example: erc20.token.notFound
- type: string
- message:
- description: No such BEP20 currency ${name}.
- example: No such BEP20 currency ${name}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscBep20Set:
- properties:
- errorCode:
- description: erc20.address.set
- example: erc20.address.set
- type: string
- message:
- description: BEP20 address was already set.
- example: BEP20 address was already set.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscMnemonicPrivateKey:
- properties:
- errorCode:
- description: private.mnemonic.missing
- example: private.mnemonic.missing
- type: string
- message:
- description: Either mnemonic and index or private key must be present.
- example: Either mnemonic and index or private key must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscBep20Unsupported:
- properties:
- errorCode:
- description: bsc.bep20.unsupported
- example: bsc.bep20.unsupported
- type: string
- message:
- description: Unsupported ETH BEP20 blockchain.
- example: Unsupported ETH BEP20 blockchain.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscTxHash:
- properties:
- errorCode:
- description: bsc.transaction.hash
- example: bsc.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscTxSign:
- properties:
- errorCode:
- description: bsc.transaction.sign
- example: bsc.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscErc20TxSign:
- properties:
- errorCode:
- description: bsc.bep20.sign
- example: bsc.bep20.sign
- type: string
- message:
- description: Unable to sign transaction for contract creation. ${error}
- example: Unable to sign transaction for contract creation. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscGasCalculation:
- properties:
- errorCode:
- description: bsc.transaction.gas
- example: bsc.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscTxBody:
- properties:
- errorCode:
- description: bsc.transaction.body
- example: bsc.transaction.body
- type: string
- message:
- description: Either currency, or tokenAddress must be defined.
- example: Either currency, or tokenAddress must be defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscScBody:
- properties:
- errorCode:
- description: bsc.sc.invalid
- example: bsc.sc.invalid
- type: string
- message:
- description: Invalid parameters for smart contract invocation.
- example: Invalid parameters for smart contract invocation.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403BscGasPrice:
- properties:
- errorCode:
- description: gas.price.failed
- example: gas.price.failed
- type: string
- message:
- description: Unable to obtain current GAS price.
- example: Unable to obtain current GAS price.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- CallBscSmartContractMethodCaller:
- type: object
- properties:
- caller:
- maxLength: 42
- minLength: 42
- description: >-
- The address of the account, which will be sender and fee payer of
- this transaction
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0xC9c8ba8C7e2EAF43e84330Db08915A8106d7bD74"
- type: string
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- - caller
- CallBscSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to BSC transaction. If not present, last known nonce
- will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- CallBscSmartContractReadMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- required:
- - contractAddress
- - params
- - methodABI
- - methodName
- CallBscSmartContractMethodKMS:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to BSC transaction. If not present, last known nonce
- will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - signatureId
- - methodName
- TransferBscBlockchain:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- (Only for BSC transactions) Additional data that can be passed to a
- blockchain transaction as a data property; must be in the
- hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to BSC transaction. If not present, last known nonce
- will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- description: >-
- Currency to transfer from BSC Blockchain Account. BEP20 tokens like
- BETH, BBTC, BADA, WBNB, BDOT, BXRP, BLTC, BBCH, CAKE are available
- only for mainnet use.
- enum:
- - BSC
- - BETH
- - BBTC
- - RMD
- - USDC_BSC
- - B2U_BSC
- - BADA
- - WBNB
- - GMC_BSC
- - BDOT
- - BXRP
- - BLTC
- - BBCH
- - HAG
- - CAKE
- - BUSD_BSC
- example: BSC
- type: string
- fee:
- $ref: "#/components/schemas/CustomFee"
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- required:
- - to
- - amount
- - currency
- - fromPrivateKey
- BscEstimateGas:
- type: object
- properties:
- from:
- type: string
- maxLength: 42
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- minLength: 42
- description: Sender address.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- amount:
- description: Amount to be sent in BSC.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- pattern: ^(0x|0h)?[0-9A-F]+$
- required:
- - to
- - amount
- - from
- TransferBscBlockchainKMS:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- (Only for BSC transactions) Additional data that can be passed to a
- blockchain transaction as a data property; must be in the
- hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to BSC transaction. If not present, last known nonce
- will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- description: >-
- Currency to transfer from BSC Blockchain Account. BEP20 tokens like
- BETH, BBTC, BADA, WBNB, BDOT, BXRP, BLTC, BBCH, CAKE are available
- only for mainnet use.
- enum:
- - BETH
- - BBTC
- - BADA
- - WBNB
- - BDOT
- - BXRP
- - BLTC
- - BBCH
- - BSC
- example: BSC
- type: string
- fee:
- $ref: "#/components/schemas/CustomFee"
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- required:
- - to
- - amount
- - currency
- - signatureId
- KcsBlock:
- type: object
- properties:
- difficulty:
- description: Difficulty for this block.
- type: string
- example: "3296820833"
- extraData:
- description: The 'extra data' field of this block.
- type: string
- example: 0x
- gasLimit:
- description: The maximum gas allowed in this block.
- type: number
- example: 8000000
- gasUsed:
- description: The total used gas by all transactions in this block.
- type: number
- example: 7985124
- hash:
- description: Hash of the block. 'null' when its pending block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- logsBloom:
- description: >-
- The bloom filter for the logs of the block. 'null' when its pending
- block.
- type: string
- example: >-
- 0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000
- miner:
- description: >-
- The address of the beneficiary to whom the mining rewards were
- given.
- type: string
- example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
- mixHash:
- description: ""
- type: string
- example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
- nonce:
- description: Hash of the generated proof-of-work. 'null' when its pending block.
- type: string
- example: "0xfa1692f52a7ac672"
- number:
- description: The block number. 'null' when its pending block.
- type: number
- example: 6470657
- parentHash:
- description: Hash of the parent block.
- type: string
- example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
- receiptsRoot:
- description: ""
- type: string
- example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
- sha3Uncles:
- description: SHA3 of the uncles data in the block.
- type: string
- example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
- size:
- description: The size of this block in bytes.
- type: number
- example: 15296
- stateRoot:
- description: The root of the final state trie of the block.
- type: string
- example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
- timestamp:
- description: The unix timestamp for when the block was collated.
- type: number
- example: 1569600592
- totalDifficulty:
- description: Total difficulty of the chain until this block.
- type: string
- example: "23329673338013873"
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/KcsTx"
- transactionsRoot:
- description: The root of the transaction trie of the block.
- type: string
- example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
- KcsTx:
- type: object
- properties:
- blockHash:
- description: Hash of the block where this transaction was in.
- type: string
- example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
- status:
- type: boolean
- example: true
- description: >-
- TRUE if the transaction was successful, FALSE, if the EVM reverted
- the transaction.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- from:
- type: string
- description: Address of the sender.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- gas:
- type: number
- description: Gas provided by the sender.
- example: 21000
- gasPrice:
- type: string
- description: Gas price provided by the sender in wei.
- example: "1000000000"
- transactionHash:
- type: string
- description: Hash of the transaction.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- input:
- type: string
- description: The data sent along with the transaction.
- example: 0x
- nonce:
- type: number
- description: The number of transactions made by the sender prior to this one.
- example: 26836405
- to:
- type: string
- description: >-
- Address of the receiver. 'null' when its a contract creation
- transaction.
- example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
- transactionIndex:
- type: number
- description: Integer of the transactions index position in the block.
- example: 3
- value:
- type: string
- description: Value transferred in wei.
- example: "1000000000000000000"
- gasUsed:
- type: number
- description: The amount of gas used by this specific transaction alone.
- example: 21000
- cumulativeGasUsed:
- type: number
- description: >-
- The total amount of gas used when this transaction was executed in
- the block.
- example: 314159
- contractAddress:
- type: string
- description: >-
- The contract address created, if the transaction was a contract
- creation, otherwise null.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- logs:
- type: array
- description: Log events, that happened in this transaction.
- items:
- type: object
- properties:
- address:
- type: string
- description: From which this event originated from.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- topics:
- type: array
- description: >-
- An array with max 4 32 Byte topics, topic 1-3 contains indexed
- parameters of the log.
- items:
- type: string
- example: >-
- 0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234
- data:
- type: string
- description: The data containing non-indexed log parameter.
- logIndex:
- type: number
- description: Integer of the event index position in the block.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- blockHash:
- description: Hash of the block.
- type: string
- example: >-
- 0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc
- transactionIndex:
- type: number
- description: >-
- Integer of the transaction’s index position, the event was
- created in.
- transactionHash:
- type: string
- description: Hash of the transaction this event was created in.
- example: >-
- 0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7
- Error403KcsBroadcast:
- properties:
- errorCode:
- description: kcs.broadcast.failed
- example: kcs.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsBep20NotFound:
- properties:
- errorCode:
- description: erc20.token.notFound
- example: erc20.token.notFound
- type: string
- message:
- description: No such ERC20 currency ${name}.
- example: No such ERC20 currency ${name}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsBep20Set:
- properties:
- errorCode:
- description: erc20.address.set
- example: erc20.address.set
- type: string
- message:
- description: ERC20 address was already set.
- example: ERC20 address was already set.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsMnemonicPrivateKey:
- properties:
- errorCode:
- description: private.mnemonic.missing
- example: private.mnemonic.missing
- type: string
- message:
- description: Either mnemonic and index or private key must be present.
- example: Either mnemonic and index or private key must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsBep20Unsupported:
- properties:
- errorCode:
- description: kcs.bep20.unsupported
- example: kcs.bep20.unsupported
- type: string
- message:
- description: Unsupported ETH ERC20 blockchain.
- example: Unsupported ETH ERC20 blockchain.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsTxHash:
- properties:
- errorCode:
- description: kcs.transaction.hash
- example: kcs.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsTxSign:
- properties:
- errorCode:
- description: kcs.transaction.sign
- example: kcs.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsErc20TxSign:
- properties:
- errorCode:
- description: kcs.bep20.sign
- example: kcs.bep20.sign
- type: string
- message:
- description: Unable to sign transaction for contract creation. ${error}
- example: Unable to sign transaction for contract creation. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsGasCalculation:
- properties:
- errorCode:
- description: kcs.transaction.gas
- example: kcs.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsTxBody:
- properties:
- errorCode:
- description: kcs.transaction.body
- example: kcs.transaction.body
- type: string
- message:
- description: Either currency, or tokenAddress must be defined.
- example: Either currency, or tokenAddress must be defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsScBody:
- properties:
- errorCode:
- description: kcs.sc.invalid
- example: kcs.sc.invalid
- type: string
- message:
- description: Invalid parameters for smart contract invocation.
- example: Invalid parameters for smart contract invocation.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403KcsGasPrice:
- properties:
- errorCode:
- description: gas.price.failed
- example: gas.price.failed
- type: string
- message:
- description: Unable to obtain current GAS price.
- example: Unable to obtain current GAS price.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- CallKcsSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Kcs transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- CallKcsSmartContractReadMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- required:
- - contractAddress
- - params
- - methodABI
- - methodName
- CallKcsSmartContractMethodKMS:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Kcs transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - contractAddress
- - params
- - methodABI
- - signatureId
- - methodName
- TransferKcsBlockchain:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Kcs transaction. If not present, last known nonce
- will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- description: Currency to transfer from Kcs Blockchain Account.
- enum:
- - KCS
- example: KCS
- type: string
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- example: "40000"
- pattern: ^[+]?\d+$
- gasPrice:
- type: string
- description: Gas price in Gwei.
- example: "20"
- pattern: ^[+]?\d+$
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- required:
- - to
- - amount
- - currency
- - fromPrivateKey
- KcsEstimateGas:
- type: object
- properties:
- from:
- type: string
- maxLength: 42
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- minLength: 42
- description: Sender address.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- amount:
- description: Amount to be sent in KCS.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- pattern: ^(0x|0h)?[0-9A-F]+$
- required:
- - to
- - amount
- - from
- TransferKcsBlockchainKMS:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Kcs transaction. If not present, last known nonce
- will be used.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- currency:
- description: Currency to transfer from Kcs Blockchain Account.
- enum:
- - KCS
- example: KCS
- type: string
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- example: "40000"
- pattern: ^[+]?\d+$
- gasPrice:
- type: string
- description: Gas price in Gwei.
- example: "20"
- pattern: ^[+]?\d+$
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- required:
- - to
- - amount
- - currency
- - signatureId
- OneBlockCurrent:
- type: object
- properties:
- shardID:
- type: number
- description: Shard ID
- example: 0
- blockNumber:
- type: number
- description: Current block number in this shard
- example: 6491272
- OneBalance:
- type: object
- properties:
- balance:
- type: string
- description: Balance in ONE
- example: "10.52"
- GeneratedAddressOne:
- type: object
- properties:
- address:
- type: string
- description: ONE address
- example: one15annzcwtlcq3dfx7nc6plpr9jsxzyyw5xc8pjn
- OneBlock:
- type: object
- properties:
- difficulty:
- description: Difficulty for this block.
- type: string
- example: "3296820833"
- extraData:
- description: The 'extra data' field of this block.
- type: string
- example: 0x
- gasLimit:
- description: The maximum gas allowed in this block.
- type: number
- example: 8000000
- gasUsed:
- description: The total used gas by all transactions in this block.
- type: number
- example: 7985124
- hash:
- description: Hash of the block. 'null' when its pending block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- logsBloom:
- description: >-
- The bloom filter for the logs of the block. 'null' when its pending
- block.
- type: string
- example: >-
- 0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000
- miner:
- description: >-
- The address of the beneficiary to whom the mining rewards were
- given.
- type: string
- example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
- mixHash:
- description: ""
- type: string
- example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
- nonce:
- description: Hash of the generated proof-of-work. 'null' when its pending block.
- type: string
- example: "0xfa1692f52a7ac672"
- number:
- description: The block number. 'null' when its pending block.
- type: number
- example: 6470657
- parentHash:
- description: Hash of the parent block.
- type: string
- example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
- receiptsRoot:
- description: ""
- type: string
- example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
- sha3Uncles:
- description: SHA3 of the uncles data in the block.
- type: string
- example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
- size:
- description: The size of this block in bytes.
- type: number
- example: 15296
- stateRoot:
- description: The root of the final state trie of the block.
- type: string
- example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
- timestamp:
- description: The unix timestamp for when the block was collated.
- type: number
- example: 1569600592
- totalDifficulty:
- description: Total difficulty of the chain until this block.
- type: string
- example: "23329673338013873"
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/OneTx"
- transactionsRoot:
- description: The root of the transaction trie of the block.
- type: string
- example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
- OneTx:
- type: object
- properties:
- blockHash:
- description: Hash of the block where this transaction was in.
- type: string
- example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
- status:
- type: boolean
- example: true
- description: >-
- TRUE if the transaction was successful, FALSE, if the EVM reverted
- the transaction.
- blockNumber:
- type:
- - number
- - "null"
- description: >-
- The number of the block that the transaction is included in; if not
- returned, the transaction has not been included in a block yet.
- example: 6470854
- from:
- type: string
- description: Address of the sender.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- gas:
- type: number
- description: Gas provided by the sender.
- example: 21000
- gasPrice:
- type: string
- description: Gas price provided by the sender in wei.
- example: "1000000000"
- transactionHash:
- type: string
- description: Hash of the transaction.
- example: "0x4fb94db21613051e6241f456dcc7da5789faae6a434ecd59c7ac4162e591ce1d"
- ethHash:
- type: string
- description: Eth Hash representation of the transaction.
- example: "0xb2a66a105f05304afc7194063b36cae2a8f14edf1e06fc1e185cfea635cf09bb"
- input:
- type: string
- description: The data sent along with the transaction.
- example: 0x
- nonce:
- type: number
- description: The number of transactions made by the sender prior to this one.
- example: 26836405
- to:
- type: string
- description: >-
- Address of the receiver. 'null' when its a contract creation
- transaction.
- example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
- transactionIndex:
- type:
- - number
- - "null"
- description: >-
- The integer of the transactions index position in the block; if not
- returned, the transaction has not been included in a block yet.
- example: 3
- value:
- type: string
- description: Value transferred in wei.
- example: "1000000000000000000"
- gasUsed:
- type:
- - number
- - "null"
- description: >-
- The amount of gas used by this specific transaction alone; if not
- returned, the transaction has not been included in a block yet.
- example: 21000
- cumulativeGasUsed:
- type:
- - number
- - "null"
- description: >-
- The total amount of gas used when this transaction was executed in
- the block; if not returned, the transaction has not been included in
- a block yet.
- example: 314159
- contractAddress:
- type: string
- description: >-
- The contract address created, if the transaction was a contract
- creation, otherwise null.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- logs:
- type: array
- description: Log events, that happened in this transaction.
- items:
- $ref: "#/components/schemas/OneTxLog"
- OneTxLog:
- type: object
- properties:
- address:
- type: string
- description: From which this event originated from.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- topics:
- type: array
- description: >-
- An array with max 4 32 Byte topics, topic 1-3 contains indexed
- parameters of the log.
- items:
- type: string
- example: "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
- data:
- type: string
- description: The data containing non-indexed log parameter.
- logIndex:
- type: number
- description: Integer of the event index position in the block.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- blockHash:
- description: Hash of the block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- transactionIndex:
- type: number
- description: >-
- Integer of the transaction’s index position, the event was created
- in.
- transactionHash:
- type: string
- description: Hash of the transaction this event was created in.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- Error403OneBroadcast:
- properties:
- errorCode:
- description: bsc.broadcast.failed
- example: bsc.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneBep20NotFound:
- properties:
- errorCode:
- description: erc20.token.notFound
- example: erc20.token.notFound
- type: string
- message:
- description: No such HRM20 currency ${name}.
- example: No such HRM20 currency ${name}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneBep20Set:
- properties:
- errorCode:
- description: erc20.address.set
- example: erc20.address.set
- type: string
- message:
- description: HRM20 address was already set.
- example: HRM20 address was already set.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneMnemonicPrivateKey:
- properties:
- errorCode:
- description: private.mnemonic.missing
- example: private.mnemonic.missing
- type: string
- message:
- description: Either mnemonic and index or private key must be present.
- example: Either mnemonic and index or private key must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneBep20Unsupported:
- properties:
- errorCode:
- description: bsc.bep20.unsupported
- example: bsc.bep20.unsupported
- type: string
- message:
- description: Unsupported ETH HRM20 blockchain.
- example: Unsupported ETH HRM20 blockchain.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneTxHash:
- properties:
- errorCode:
- description: bsc.transaction.hash
- example: bsc.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneTxSign:
- properties:
- errorCode:
- description: bsc.transaction.sign
- example: bsc.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneErc20TxSign:
- properties:
- errorCode:
- description: bsc.bep20.sign
- example: bsc.bep20.sign
- type: string
- message:
- description: Unable to sign transaction for contract creation. ${error}
- example: Unable to sign transaction for contract creation. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneGasCalculation:
- properties:
- errorCode:
- description: bsc.transaction.gas
- example: bsc.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneTxBody:
- properties:
- errorCode:
- description: bsc.transaction.body
- example: bsc.transaction.body
- type: string
- message:
- description: Either currency, or tokenAddress must be defined.
- example: Either currency, or tokenAddress must be defined.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneScBody:
- properties:
- errorCode:
- description: bsc.sc.invalid
- example: bsc.sc.invalid
- type: string
- message:
- description: Invalid parameters for smart contract invocation.
- example: Invalid parameters for smart contract invocation.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403OneGasPrice:
- properties:
- errorCode:
- description: gas.price.failed
- example: gas.price.failed
- type: string
- message:
- description: Unable to obtain current GAS price.
- example: Unable to obtain current GAS price.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- CallOneSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to ONE transaction. If not present, last known nonce
- will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- CallOneReadSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked
- required:
- - contractAddress
- - params
- - methodABI
- - methodName
- CallOneSmartContractMethodKMS:
- type: object
- properties:
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to ONE transaction. If not present, last known nonce
- will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - contractAddress
- - params
- - methodABI
- - signatureId
- - methodName
- TransferOneBlockchain:
- type: object
- properties:
- amount:
- description: The amount to transfer
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- currency:
- type: string
- description: The currency of the amount to transfer
- example: ONE
- enum:
- - ONE
- to:
- description: The blockchain address to transfer the amount to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- fee:
- $ref: "#/components/schemas/CustomFee"
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - to
- - amount
- - currency
- - fromPrivateKey
- OneEstimateGas:
- type: object
- properties:
- from:
- type: string
- maxLength: 66
- example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
- minLength: 66
- description: Sender address.
- to:
- description: Blockchain address to send assets
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- amount:
- description: Amount to be sent in One.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- required:
- - to
- - amount
- - from
- TransferOneBlockchainKMS:
- type: object
- properties:
- amount:
- description: The amount to transfer
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- currency:
- type: string
- description: The currency of the amount to transfer
- example: ONE
- enum:
- - ONE
- to:
- description: The blockchain address to transfer the amount to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- maxLength: 42
- minLength: 42
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- index:
- type: number
- minimum: 0
- description: >-
- (Only if the signature ID is mnemonic-based) The index of the
- address from which the fee will be deducted that was generated from
- the mnemonic
- fee:
- $ref: "#/components/schemas/CustomFee"
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - to
- - amount
- - currency
- - signatureId
- XdcBlock:
- type: object
- properties:
- number:
- description: The block number. 'null' when its pending block.
- type: number
- example: 6470657
- hash:
- description: Hash of the block. 'null' when its pending block.
- type: string
- example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
- parentHash:
- description: Hash of the parent block.
- type: string
- example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
- nonce:
- description: Hash of the generated proof-of-work. 'null' when its pending block.
- type: string
- example: "0xfa1692f52a7ac672"
- sha3Uncles:
- description: SHA3 of the uncles data in the block.
- type: string
- example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
- logsBloom:
- description: >-
- The bloom filter for the logs of the block. 'null' when its pending
- block.
- type: string
- example: >-
- 0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000
- transactionsRoot:
- description: The root of the transaction trie of the block.
- type: string
- example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
- stateRoot:
- description: The root of the final state trie of the block.
- type: string
- example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
- receiptsRoot:
- description: The root of the transaction trie of the block.
- type: string
- example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
- miner:
- description: >-
- The address of the beneficiary to whom the mining rewards were
- given.
- type: string
- example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
- difficulty:
- description: Difficulty for this block.
- type: string
- example: "3296820833"
- totalDifficulty:
- description: Total difficulty of the chain until this block.
- type: string
- example: "23329673338013873"
- extraData:
- description: The 'extra data' field of this block.
- type: string
- example: 0x
- size:
- description: The size of this block in bytes.
- type: number
- example: 15296
- gasLimit:
- description: The maximum gas allowed in this block.
- type: number
- example: 8000000
- gasUsed:
- description: The total used gas by all transactions in this block.
- type: number
- example: 7985124
- timestamp:
- description: The unix timestamp for when the block was collated.
- type: number
- example: 1569600592
- transactions:
- description: Array of transactions.
- type: array
- items:
- $ref: "#/components/schemas/XdcTx"
- uncles:
- description: Array of uncle hashes.
- type: array
- items:
- type: string
- example:
- - "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
- XdcTx:
- type: object
- properties:
- hash:
- type: string
- description: Hash of the transaction.
- example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
- nonce:
- type: number
- description: The number of transactions made by the sender prior to this one.
- example: 26836405
- blockHash:
- description: Hash of the block where this transaction was in.
- type: string
- example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- transactionIndex:
- type: number
- description: Integer of the transactions index position in the block.
- example: 3
- from:
- type: string
- description: Address of the sender.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- to:
- type: string
- description: >-
- Address of the receiver. 'null' when its a contract creation
- transaction.
- example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
- value:
- type: string
- description: Value transferred in wei.
- example: "1000000000000000000"
- gas:
- type: number
- description: Gas provided by the sender.
- example: 21000
- gasPrice:
- type: string
- description: Gas price provided by the sender in wei.
- example: "1000000000"
- input:
- type: string
- description: The data sent along with the transaction.
- example: 0x
- status:
- type: boolean
- example: true
- description: >-
- TRUE if the transaction was successful, FALSE, if the EVM reverted
- the transaction.
- gasUsed:
- type: number
- description: The amount of gas used by this specific transaction alone.
- example: 21000
- cumulativeGasUsed:
- type: number
- description: >-
- The total amount of gas used when this transaction was executed in
- the block.
- example: 314159
- contractAddress:
- type: string
- description: >-
- The contract address created, if the transaction was a contract
- creation, otherwise null.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- logs:
- type: array
- description: Log events, that happened in this transaction.
- items:
- type: object
- properties:
- address:
- type: string
- description: From which this event originated from.
- example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
- topics:
- type: array
- description: >-
- An array with max 4 32 Byte topics, topic 1-3 contains indexed
- parameters of the log.
- items:
- type: string
- example: >-
- 0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234
- data:
- type: string
- description: The data containing non-indexed log parameter.
- logIndex:
- type: number
- description: Integer of the event index position in the block.
- blockNumber:
- type: number
- description: Block number where this transaction was in.
- example: 6470854
- blockHash:
- description: Hash of the block.
- type: string
- example: >-
- 0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc
- transactionIndex:
- type: number
- description: >-
- Integer of the transaction’s index position, the event was
- created in.
- transactionHash:
- type: string
- description: Hash of the transaction this event was created in.
- example: >-
- 0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7
- logsBloom:
- type: string
- format: DATA, 256 Bytes
- description: Bloom filter for light clients to quickly retrieve related logs.
- example: null
- root:
- type: string
- description: 32 bytes of post-transaction stateroot (pre Byzantium)
- example: null
- Error403XdcBroadcast:
- properties:
- errorCode:
- description: xdc.broadcast.failed
- example: xdc.broadcast.failed
- type: string
- message:
- description: Unable to broadcast transaction due to ${error}.
- example: Unable to broadcast transaction due to ${error}.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XdcErc20Set:
- properties:
- errorCode:
- description: erc20.address.set
- example: erc20.address.set
- type: string
- message:
- description: ERC20 address was already set.
- example: ERC20 address was already set.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XdcMnemonicPrivateKey:
- properties:
- errorCode:
- description: private.mnemonic.missing
- example: private.mnemonic.missing
- type: string
- message:
- description: Either mnemonic and index or private key must be present.
- example: Either mnemonic and index or private key must be present.
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XdcTxHash:
- properties:
- errorCode:
- description: xdc.transaction.hash
- example: xdc.transaction.hash
- type: string
- message:
- description: Unable to calculate transaction hash. ${error}
- example: Unable to calculate transaction hash. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XdcTxSign:
- properties:
- errorCode:
- description: xdc.transaction.sign
- example: xdc.transaction.sign
- type: string
- message:
- description: Unable to sign transaction. ${error}
- example: Unable to sign transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XdcErc20TxSign:
- properties:
- errorCode:
- description: xdc.erc20.sign
- example: xdc.erc20.sign
- type: string
- message:
- description: Unable to sign transaction for contract creation. ${error}
- example: Unable to sign transaction for contract creation. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- Error403XdcGasCalculation:
- properties:
- errorCode:
- description: xdc.transaction.gas
- example: xdc.transaction.gas
- type: string
- message:
- description: Unable to calculate gas limit for transaction. ${error}
- example: Unable to calculate gas limit for transaction. ${error}
- type: string
- statusCode:
- description: "403"
- example: 403
- type: number
- required:
- - errorCode
- - message
- - statusCode
- type: object
- CallXdcSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The address of the smart contract
- example: xdc687422eEA2cB73B5d3e242bA5456b782919AFc85
- type: string
- amount:
- description: Amount of the assets to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to XDC transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- CallXdcReadSmartContractMethod:
- type: object
- properties:
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The address of the smart contract
- example: xdc687422eEA2cB73B5d3e242bA5456b782919AFc85
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- example:
- inputs:
- - internalType: uint256
- name: amount
- type: uint256
- name: stake
- outputs: []
- stateMutability: nonpayable
- type: function
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- required:
- - contractAddress
- - params
- - methodABI
- - methodName
- CallXdcSmartContractMethodKMS:
- type: object
- properties:
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The address of the smart contract
- example: xdc687422eEA2cB73B5d3e242bA5456b782919AFc85
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to XDC transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - contractAddress
- - params
- - methodABI
- - signatureId
- - methodName
- TransferXdcBlockchain:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- currency:
- type: string
- description: >-
- Currency of the transfer. ERC20 tokens are available only for
- mainnet use.
- example: XDC
- enum:
- - XDC
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to XDC transaction. If not present, last known nonce
- will be used.
- to:
- description: Blockchain address to send assets
- example: xdc687422eEA2cB73B5d3e242bA5456b782919AFc85
- maxLength: 43
- minLength: 42
- type: string
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- example: "40000"
- pattern: ^[+]?\d+$
- gasPrice:
- type: string
- description: Gas price in Gwei.
- example: "20"
- pattern: ^[+]?\d+$
- amount:
- description: Amount to be sent.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- required:
- - to
- - currency
- - amount
- - fromPrivateKey
- XdcEstimateGas:
- type: object
- properties:
- from:
- type: string
- maxLength: 43
- example: xdcfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef
- minLength: 42
- description: Sender address.
- to:
- description: Blockchain address to send assets
- example: xdc687422eEA2cB73B5d3e242bA5456b782919AFc85
- maxLength: 43
- minLength: 42
- type: string
- amount:
- description: Amount to be sent in XDC.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- required:
- - to
- - amount
- - from
- TransferXdcBlockchainKMS:
- type: object
- properties:
- data:
- type: string
- maxLength: 50000
- description: >-
- Additional data that can be passed to a blockchain transaction as a
- data property; must be in the hexadecimal format
- example: 4d79206e6f746520746f2074686520726563697069656e74
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to XDC transaction. If not present, last known nonce
- will be used.
- currency:
- type: string
- description: >-
- Currency of the transfer. ERC20 tokens are available only for
- mainnet use.
- example: XDC
- enum:
- - XDC
- to:
- description: Blockchain address to send assets
- example: xdc687422eEA2cB73B5d3e242bA5456b782919AFc85
- maxLength: 43
- minLength: 42
- type: string
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- example: "40000"
- pattern: ^[+]?\d+$
- gasPrice:
- type: string
- description: Gas price in Gwei.
- example: "20"
- pattern: ^[+]?\d+$
- amount:
- description: Amount to be sent in XDC.
- example: "100000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- required:
- - to
- - amount
- - signatureId
- - currency
- TransferMultiTokenCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example: "100000"
- type: string
- maxLength: 256
- amount:
- description: Amount of token.
- example: "100000"
- type: string
- maxLength: 256
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - tokenId
- - fromPrivateKey
- - amount
- - feeCurrency
- MultiTx:
- type: object
- properties:
- blockNumber:
- type: number
- example: 6541235
- description: Block number
- txId:
- type: string
- example: "0x955c1037608c7aecb6d1a3f150ce7d0a80536bcabb0deb69d62f55292cc4c372"
- description: Transaction ID
- contractAddress:
- type: string
- example: "0x4f54fAD27F7F46C102Cd49b8E75C5593397cd9c3"
- description: Contract address
- tokenId:
- type: string
- example: "1"
- description: ID of the token
- amount:
- type: string
- example: "1"
- description: Amount of tokens transferred.
- from:
- type: string
- example: "0x780c3de0aba1b51f04cfe8a5d9d277d4ad032b8d"
- description: Sender
- operator:
- type: string
- example: "0x780c3de0aba1b51f04cfe8a5d9d277d4ad032b8d"
- description: Operator
- to:
- type: string
- example: "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea"
- description: recipient
- required:
- - blockNumber
- - txId
- - contractAddress
- - tokenId
- - from
- - to
- - amount
- - operator
- TransferMultiTokenBatchCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example:
- - "100000"
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- description: Amount of token to be transferred
- example:
- - "100000"
- type: array
- items:
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - tokenId
- - amounts
- - fromPrivateKey
- - feeCurrency
- DeployMultiTokenCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- uri:
- description: URI of the Multi Token contract
- example: example.com
- maxLength: 100
- minLength: 1
- type: string
- publicMint:
- description: True if the contract is publicMint type
- example: true
- type: boolean
- fromPrivateKey:
- description: >-
- Private key of account address, from which gas for deployment of
- ERC1155 will be paid. Private key, or signature Id must be present.
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - uri
- - feeCurrency
- - fromPrivateKey
- DeployMultiTokenCeloKMS:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- uri:
- description: URI of the Multi Token contract
- example: example.com
- maxLength: 100
- minLength: 1
- type: string
- publicMint:
- description: True if the contract is publicMint type
- example: true
- type: boolean
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - uri
- - feeCurrency
- - signatureId
- MintMultiTokenBatchKMSCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- to:
- type: array
- description: The blockchain address to send the Multi Tokens to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: The IDs of the Multi Tokens to be created.
- example:
- - - "100000"
- - "100001"
- items:
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- type: array
- description: The amounts of the Multi Tokens to be created.
- example:
- - - "100"
- - "100"
- items:
- type: array
- items:
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the Multi Token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - feeCurrency
- - tokenId
- - amounts
- - signatureId
- BurnMultiTokenCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- account:
- maxLength: 42
- minLength: 42
- description: Address of holder
- example: "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: string
- tokenId:
- description: ID of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- amount:
- description: amount of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - feeCurrency
- - fromPrivateKey
- - tokenId
- - amount
- - account
- BurnMultiTokenBatchCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- account:
- maxLength: 42
- minLength: 42
- description: Address of holder
- example: "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: string
- tokenId:
- description: The IDs of the Multi Tokens to be destroyed.
- example:
- - "100000"
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- description: The amounts of the Multi Tokens to be destroyed.
- example:
- - "100000"
- type: array
- items:
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the Multi Token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - feeCurrency
- - fromPrivateKey
- - tokenId
- - amounts
- - account
- BurnMultiTokenKMSCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- account:
- maxLength: 42
- minLength: 42
- description: Address of holder
- example: "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: string
- tokenId:
- description: ID of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- amount:
- description: amount of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - feeCurrency
- - contractAddress
- - tokenId
- - amount
- - signatureId
- - account
- AddMultiTokenMinterKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - MATIC
- - KCS
- - KLAY
- - CELO
- - ONE
- - BSC
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of MultiToken token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- minter:
- maxLength: 42
- minLength: 42
- description: Address of MultiToken minter
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Ethereum transaction. If not present, last known
- nonce will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas, only valid for CELO chain.
- enum:
- - CELO
- - CUSD
- - CEUR
- required:
- - chain
- - url
- - contractAddress
- - minter
- - signatureId
- AddMultiTokenMinter:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - MATIC
- - KCS
- - KLAY
- - CELO
- - ONE
- - BSC
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of MultiToken token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- minter:
- maxLength: 42
- minLength: 42
- description: Address of MultiToken minter
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Ethereum transaction. If not present, last known
- nonce will be used.
- fee:
- $ref: "#/components/schemas/CustomFee"
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas, only valid for CELO chain.
- enum:
- - CELO
- - CUSD
- - CEUR
- required:
- - minter
- - chain
- - url
- - contractAddress
- - fromPrivateKey
- BurnMultiTokenBatchKMSCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- account:
- maxLength: 42
- minLength: 42
- description: Address of holder
- example: "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: string
- tokenId:
- description: The IDs of the Multi Tokens to be destroyed.
- example:
- - "100000"
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- description: The amounts of the Multi Tokens to be destroyed.
- example:
- - "100000"
- type: array
- items:
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the Multi Token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - feeCurrency
- - contractAddress
- - tokenId
- - amounts
- - account
- - signatureId
- TransferMultiTokenKMSCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example: "100000"
- type: string
- maxLength: 256
- amount:
- description: amount of token.
- example: "100000"
- type: string
- maxLength: 256
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - feeCurrency
- - signatureId
- - tokenId
- - amount
- TransferMultiTokenBatchKMSCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example:
- - "100000"
- type: array
- items:
- type: string
- amounts:
- description: amounts of token.
- example:
- - "100000"
- type: array
- items:
- type: string
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - feeCurrency
- - signatureId
- - tokenId
- - amounts
- MintMultiTokenCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- tokenId:
- description: ID of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- amount:
- description: amount of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - tokenId
- - amount
- - feeCurrency
- - contractAddress
- - fromPrivateKey
- MintMultiTokenBatchCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- tokenId:
- type: array
- description: The IDs of the Multi Tokens to be created.
- example:
- - - "100000"
- - "100001"
- items:
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- type: array
- description: The amounts of the Multi Tokens to be created.
- example:
- - - "100"
- - "100"
- items:
- type: array
- items:
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- to:
- maxLength: 42
- minLength: 42
- description: The blockchain address to send the Multi Tokens to
- example:
- - "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: array
- items:
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the Multi Token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - tokenId
- - amounts
- - feeCurrency
- - contractAddress
- - fromPrivateKey
- MintMultiTokenKMSCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: Chain to work with.
- enum:
- - CELO
- tokenId:
- description: ID of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- amount:
- description: amount of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to Celo transaction. If not present, last known
- nonce will be used.
- feeCurrency:
- type: string
- description: Currency to pay for transaction gas
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - tokenId
- - amount
- - feeCurrency
- - contractAddress
- - signatureId
- TransferMultiToken:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example: "100000"
- type: string
- maxLength: 256
- amount:
- description: amount of token.
- example: "100000"
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - chain
- - contractAddress
- - tokenId
- - fromPrivateKey
- - amount
- TransferMultiTokenBatch:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example:
- - "100000"
- type: array
- items:
- type: string
- maxLength: 256
- amounts:
- description: amounts of token.
- example:
- - "100000"
- type: array
- maxLength: 256
- items:
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - chain
- - contractAddress
- - tokenId
- - amounts
- - fromPrivateKey
- DeployMultiToken:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- uri:
- description: URI of the Multi Token token
- example: example.com
- type: string
- fromPrivateKey:
- description: >-
- Private key of account address, from which gas for deployment of
- ERC1155 will be paid. Private key, or signature Id must be present.
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- publicMint:
- description: True if the contract is publicMint type
- example: true
- type: boolean
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - uri
- - chain
- - fromPrivateKey
- DeployMultiTokenKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- uri:
- description: URI of the Multi Token token
- example: example.com
- type: string
- publicMint:
- description: True if the contract is publicMint type
- example: true
- type: boolean
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - uri
- - chain
- - signatureId
- TransferMultiTokenKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example: "100000"
- type: string
- maxLength: 256
- amount:
- description: amount of token.
- example: "100000"
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - chain
- - contractAddress
- - signatureId
- - tokenId
- - amount
- TransferMultiTokenBatchKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of token.
- example:
- - "100000"
- type: array
- items:
- type: string
- maxLength: 256
- amounts:
- description: amounts of token.
- example:
- - "100000"
- type: array
- maxLength: 256
- items:
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- example: 1
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - chain
- - contractAddress
- - signatureId
- - tokenId
- - amounts
- MintMultiToken:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- tokenId:
- description: ID of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: amount of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - chain
- - url
- - contractAddress
- - fromPrivateKey
- - tokenId
- - amount
- MintMultiTokenKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- tokenId:
- description: ID of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send Multi Token token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: amount of token to be created.
- example: "100000"
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - chain
- - url
- - contractAddress
- - signatureId
- - tokenId
- - amount
- MintMultiTokenBatch:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- to:
- type: array
- description: The blockchain address to send the Multi Tokens to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: The IDs of the Multi Tokens to be created.
- example:
- - - "100000"
- - "100001"
- items:
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- type: array
- description: The amounts of the Multi Tokens to be created.
- example:
- - - "100"
- - "100"
- items:
- type: array
- items:
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the Multi Token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - chain
- - url
- - contractAddress
- - fromPrivateKey
- - tokenId
- - amounts
- MintMultiTokenBatchKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- to:
- type: array
- description: The blockchain address to send the Multi Tokens to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: The IDs of the Multi Tokens to be created.
- example:
- - - "100000"
- - "100001"
- items:
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- type: array
- description: The amounts of the Multi Tokens to be created.
- example:
- - - "100"
- - "100"
- items:
- type: array
- items:
- type: string
- maxLength: 32
- data:
- description: Data in bytes
- example: "0x1234"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the Multi Token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - to
- - chain
- - contractAddress
- - tokenId
- - url
- - signatureId
- - amounts
- BurnMultiToken:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- account:
- maxLength: 42
- minLength: 42
- description: Address of holder
- example: "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: string
- tokenId:
- description: ID of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 103
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- amount:
- description: amount of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - account
- - chain
- - contractAddress
- - fromPrivateKey
- - tokenId
- - amount
- BurnMultiTokenBatch:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- account:
- maxLength: 42
- minLength: 42
- description: Address of holder
- example: "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: string
- tokenId:
- description: The IDs of the Multi Tokens to be destroyed.
- example:
- - "1000"
- - "1001"
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- description: The amounts of the Multi Tokens to be destroyed.
- example:
- - "10"
- - "10"
- type: array
- items:
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the Multi Token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - account
- - amounts
- - chain
- - url
- - contractAddress
- - fromPrivateKey
- - tokenId
- BurnMultiTokenKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- account:
- maxLength: 42
- minLength: 42
- description: Address of holder
- example: "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: string
- tokenId:
- description: ID of token to be destroyed.
- example: "100000"
- type: string
- maxLength: 32
- amount:
- description: amount of token to be destroyed.
- example: "100"
- type: string
- maxLength: 32
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of Multi Token token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - account
- - chain
- - amount
- - contractAddress
- - tokenId
- - signatureId
- BurnMultiTokenBatchKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: Chain to work with.
- enum:
- - ETH
- - ONE
- - MATIC
- - KCS
- - KLAY
- - BSC
- account:
- maxLength: 42
- minLength: 42
- description: Address of holder
- example: "0x4b812a77b109A150C2Fc89eD133EaBC78bC9EC8f"
- type: string
- tokenId:
- description: The IDs of the Multi Tokens to be destroyed.
- example:
- - "100"
- - "101"
- type: array
- items:
- type: string
- maxLength: 32
- amounts:
- description: The amounts of the Multi Tokens to be destroyed.
- example:
- - "10"
- - "10"
- type: array
- items:
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the Multi Token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- Nonce to be set to transaction. If not present, last known nonce
- will be used.
- fee:
- description: >-
- Custom defined fee. If not present, it will be calculated
- automatically.
- type: object
- required:
- - gasLimit
- - gasPrice
- properties:
- gasLimit:
- type: string
- description: Gas limit for transaction in gas price.
- pattern: ^[+]?\d+$
- example: "40000"
- gasPrice:
- type: string
- description: Gas price in Gwei.
- pattern: ^[+]?\d+$
- example: "20"
- required:
- - account
- - chain
- - amounts
- - contractAddress
- - tokenId
- - signatureId
- Erc20BalanceForAddress:
- type: object
- properties:
- contractAddress:
- type: string
- description: >-
- The address of the smart contract that the fungible tokens were
- minted on
- amount:
- type: string
- description: The number of the fungible tokens
- example: "10"
- Erc20Balance:
- type: object
- properties:
- balance:
- type: string
- description: >-
- The number of fungible tokens in the smallest token unit (for
- example, if the token has 10 decimal places, the number is returned
- as 9*10^10)
- example: "10"
- ChainDeployErc20:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - XDC
- - ONE
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: >-
- Initial supply of ERC20 token. If totalCap is not defined, this will
- be the total cap.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Ethereum blockchain, where all created ERC20 tokens will
- be transferred.
- maxLength: 43
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- fromPrivateKey:
- description: >-
- Private key of Ethereum account address, from which the fee for the
- deployment of ERC20 will be paid. Private key, or signature Id must
- be present.
- type: string
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- maxLength: 66
- minLength: 66
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - name
- - symbol
- - address
- - supply
- - fromPrivateKey
- - digits
- ChainDeploySolanaSpl:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- supply:
- description: Initial supply of SPL token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 0
- type: number
- address:
- description: >-
- Address on Solana blockchain, where all created SPL tokens will be
- transferred.
- maxLength: 44
- minLength: 32
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- from:
- description: >-
- Address on Solana blockchain, from which the fee for the deployment
- of SPL will be paid.
- maxLength: 44
- minLength: 32
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- freezeAuthority:
- description: >-
- Address on Solana blockchain which which can freeze token accounts.
- Default to the 'from'
- maxLength: 44
- minLength: 32
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- fromPrivateKey:
- description: >-
- Private key of Solana account address, from which the fee for the
- deployment of SPL will be paid. Private key, or signature Id must be
- present.
- type: string
- example: >-
- 3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad
- maxLength: 103
- minLength: 128
- feePayer:
- description: >-
- Address on the Solana blockchain, from which the fee will be paid
- for transaction. Defaults to from.
- maxLength: 44
- minLength: 32
- example: BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs
- type: string
- feePayerPrivateKey:
- type: string
- maxLength: 87
- example: >-
- YdQ1iy2NYs93dtkHdz3ijDuhRJj6uXYAUZmixirCrgCsTMj42BN1Q1buYcGZaMxw5buk9VU5ogQ6zuzn8DMsGaf
- minLength: 128
- description: Private key of the fee payer address.
- required:
- - chain
- - from
- - address
- - supply
- - fromPrivateKey
- - digits
- ChainDeploySolanaSplKMS:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- supply:
- description: Initial supply of SPL token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 0
- type: number
- address:
- description: >-
- Address on Solana blockchain, where all created SPL tokens will be
- transferred.
- maxLength: 44
- minLength: 32
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- from:
- description: >-
- Address on Solana blockchain, from which the fee for the deployment
- of SPL will be paid.
- maxLength: 44
- minLength: 32
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- freezeAuthority:
- description: >-
- Address on Solana blockchain which which can freeze token accounts.
- Default to the 'from'
- maxLength: 44
- minLength: 32
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- feePayer:
- description: Blockchain address to pay the fee for the transaction from
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- maxLength: 44
- minLength: 32
- type: string
- feePayerSignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key used for paying the gas costs in
- signing application. Defaults to the signatureId.
- required:
- - chain
- - from
- - address
- - supply
- - signatureId
- - digits
- FungibleTx:
- type: object
- properties:
- blockNumber:
- type: number
- example: 6541235
- description: Block number
- txId:
- type: string
- example: "0x955c1037608c7aecb6d1a3f150ce7d0a80536bcabb0deb69d62f55292cc4c372"
- description: Transaction ID
- contractAddress:
- type: string
- example: "0x4f54fAD27F7F46C102Cd49b8E75C5593397cd9c3"
- description: Contract address
- amount:
- type: string
- example: "1"
- description: Amount of tokens transferred, in smallest decimals
- from:
- type: string
- example: "0x780c3de0aba1b51f04cfe8a5d9d277d4ad032b8d"
- description: Sender
- to:
- type: string
- example: "0x8cb76aed9c5e336ef961265c6079c14e9cd3d2ea"
- description: recipient
- required:
- - txId
- - blockNumber
- - contractAddress
- - amount
- - from
- - to
- ChainDeployErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - XDC
- - ONE
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Ethereum blockchain, where all created ERC20 tokens will
- be transferred.
- maxLength: 43
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - name
- - symbol
- - address
- - supply
- - signatureId
- - digits
- ChainDeployKcsErc20:
- type: object
- properties:
- chain:
- type: string
- example: KCS
- description: The blockchain to work with
- enum:
- - KCS
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: >-
- Initial supply of ERC20 token. If totalCap is not defined, this will
- be the total cap.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Ethereum blockchain, where all created ERC20 tokens will
- be transferred.
- maxLength: 43
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- fromPrivateKey:
- description: >-
- Private key of Ethereum account address, from which the fee for the
- deployment of ERC20 will be paid. Private key, or signature Id must
- be present.
- type: string
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- maxLength: 66
- minLength: 66
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - name
- - symbol
- - address
- - supply
- - fromPrivateKey
- - digits
- ChainDeployKcsErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: KCS
- description: The blockchain to work with
- enum:
- - KCS
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Ethereum blockchain, where all created ERC20 tokens will
- be transferred.
- maxLength: 43
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - name
- - symbol
- - address
- - supply
- - signatureId
- - digits
- ChainDeployAlgoErc20:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: The blockchain to work with
- enum:
- - ALGO
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 8
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 32
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- supply:
- description: >-
- Initial supply of ERC20 token. If totalCap is not defined, this will
- be the total cap.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 1
- maximum: 15
- minimum: 0
- type: number
- url:
- description: The URL pointing to the metadata
- example: https://my_token_data.com
- type: string
- maxLength: 256
- fromPrivateKey:
- description: >-
- Private key of Ethereum account address, from which the fee for the
- deployment of ERC20 will be paid. Private key, or signature Id must
- be present.
- type: string
- example: >-
- GDNQECUM2JDPTA4KXNSXHQBAYL56FDZ73NXCQ2OLB32PN2G5BLNO5GY3QD2BQOYVBPYPMMETQUGTJUQ7W3V2K4NRJFHAVVWVZVBG5G2
- maxLength: 103
- minLength: 103
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- required:
- - chain
- - name
- - symbol
- - supply
- - fromPrivateKey
- - digits
- - fee
- ChainDeployAlgoErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: The blockchain to work with
- enum:
- - ALGO
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 8
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 32
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- supply:
- description: >-
- Initial supply of ERC20 token. If totalCap is not defined, this will
- be the total cap.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 15
- minimum: 0
- type: number
- from:
- maxLength: 58
- minLength: 58
- description: Blockchain address to create token from
- example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
- type: string
- url:
- description: The URL pointing to the metadata
- example: https://my_token_data.com
- type: string
- maxLength: 256
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- fee:
- description: The transaction fee in ALGO
- type: string
- example: "0.001"
- required:
- - chain
- - name
- - symbol
- - supply
- - signatureId
- - digits
- - from
- ChainDeployCeloErc20:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Ethereum blockchain, where all created ERC20 tokens will
- be transferred.
- maxLength: 42
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- fromPrivateKey:
- description: >-
- Private key of Ethereum account address, from which the fee for the
- deployment of ERC20 will be paid. Private key, or signature Id must
- be present.
- type: string
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- maxLength: 66
- minLength: 66
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - name
- - symbol
- - address
- - supply
- - fromPrivateKey
- - digits
- - feeCurrency
- ChainDeployCeloErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- symbol:
- description: Symbol of the ERC20 token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- name:
- description: Name of the ERC20 token
- example: MyERC20
- maxLength: 100
- minLength: 1
- pattern: ^[a-zA-Z0-9_]+$
- type: string
- totalCap:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- supply:
- description: Max supply of ERC20 token.
- maxLength: 38
- example: "10000000"
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- type: string
- digits:
- description: Number of decimal points
- example: 18
- maximum: 30
- minimum: 1
- type: number
- address:
- description: >-
- Address on Ethereum blockchain, where all created ERC20 tokens will
- be transferred.
- maxLength: 42
- minLength: 42
- example: "0xa0Ca9FF38Bad06eBe64f0fDfF279cAE35129F5C6"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - name
- - symbol
- - address
- - supply
- - signatureId
- - digits
- - feeCurrency
- ChainMintErc20:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - XDC
- - ONE
- amount:
- description: Amount to be minted and transferred to the recipient.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- to:
- maxLength: 43
- minLength: 42
- description: Blockchain address to send ERC-20 tokens to.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC-20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - to
- - amount
- - contractAddress
- - fromPrivateKey
- ChainMintKcsErc20:
- type: object
- properties:
- chain:
- type: string
- example: KCS
- description: The blockchain to work with
- enum:
- - KCS
- amount:
- description: Amount to be minted and transferred to the recipient.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- to:
- maxLength: 43
- minLength: 42
- description: Blockchain address to send ERC-20 tokens to.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC-20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - to
- - amount
- - contractAddress
- - fromPrivateKey
- ChainMintErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - XDC
- - ONE
- amount:
- description: Amount to be minted and transferred to the recipient.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- to:
- maxLength: 43
- minLength: 42
- description: Blockchain address to send ERC-20 tokens to.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC-20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - to
- - amount
- - contractAddress
- - signatureId
- ChainMintKcsErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: KCS
- description: The blockchain to work with
- enum:
- - KCS
- amount:
- description: Amount to be minted and transferred to the recipient.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- to:
- maxLength: 43
- minLength: 42
- description: Blockchain address to send ERC-20 tokens to.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC-20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - to
- - amount
- - contractAddress
- - signatureId
- ChainMintCeloErc20:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- amount:
- description: Amount to be minted and transferred to the recipient.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send ERC-20 tokens to.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC-20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - amount
- - feeCurrency
- - contractAddress
- - fromPrivateKey
- ChainMintCeloErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- amount:
- description: Amount to be minted and transferred to the recipient.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send ERC-20 tokens to.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC-20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - amount
- - feeCurrency
- - contractAddress
- - signatureId
- ApproveErc20:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - ONE
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- spender:
- maxLength: 43
- minLength: 42
- description: >-
- The blockchain address to be allowed to transfer or burn the
- fungible tokens
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the tokens allowed to be transferred or burnt
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the smart contract's owner; the fee will be
- deducted from the owner's address
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - spender
- - amount
- - contractAddress
- - fromPrivateKey
- ApproveErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - ONE
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- spender:
- maxLength: 43
- minLength: 42
- description: >-
- The blockchain address to be allowed to transfer or burn the
- fungible tokens
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the tokens allowed to be transferred or burnt
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the smart contract's owner;
- the fee will be deducted from the owner's address
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - spender
- - amount
- - contractAddress
- - signatureId
- ApproveCeloErc20:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- spender:
- maxLength: 42
- minLength: 42
- description: >-
- The blockchain address to be allowed to transfer or burn the
- fungible tokens
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the tokens allowed to be transferred or burnt
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the smart contract's owner; the fee will be
- deducted from the owner's address
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - spender
- - amount
- - feeCurrency
- - contractAddress
- - fromPrivateKey
- ApproveCeloErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The address of the smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- spender:
- maxLength: 42
- minLength: 42
- description: >-
- The blockchain address to be allowed to transfer or burn the
- fungible tokens
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the tokens allowed to be transferred or burnt
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the smart contract's owner;
- the fee will be deducted from the owner's address
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - spender
- - amount
- - feeCurrency
- - contractAddress
- - signatureId
- ChainBurnErc20:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - XDC
- - ONE
- amount:
- description: Amount of tokens to be destroyed.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - contractAddress
- - fromPrivateKey
- - amount
- ChainBurnErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - XDC
- - ONE
- amount:
- description: Amount of tokens to be destroyed.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - contractAddress
- - signatureId
- - amount
- ChainBurnKcsErc20:
- type: object
- properties:
- chain:
- type: string
- example: KCS
- description: The blockchain to work with
- enum:
- - KCS
- amount:
- description: Amount of tokens to be destroyed.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - contractAddress
- - fromPrivateKey
- - amount
- ChainBurnKcsErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: KCS
- description: The blockchain to work with
- enum:
- - KCS
- amount:
- description: Amount of tokens to be destroyed.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- required:
- - chain
- - contractAddress
- - signatureId
- - amount
- ChainBurnCeloErc20:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- amount:
- description: Amount of tokens to be destroyed.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- required:
- - chain
- - contractAddress
- - feeCurrency
- - fromPrivateKey
- - amount
- ChainBurnCeloErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- amount:
- description: Amount of tokens to be destroyed.
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- fee:
- $ref: "#/components/schemas/CustomFee"
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- required:
- - chain
- - contractAddress
- - feeCurrency
- - signatureId
- - amount
- ChainTransferAlgoErc20:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: The blockchain to work with
- enum:
- - ALGO
- to:
- maxLength: 58
- minLength: 42
- description: The blockchain address to send the fungible tokens to
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- type: string
- contractAddress:
- maxLength: 43
- minLength: 1
- description: The asset ID (the ID of the fungible tokens)
- example: "1"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: The number of decimal places that the fungible tokens have
- example: 18
- maximum: 30
- minimum: 1
- type: number
- fromPrivateKey:
- type: string
- maxLength: 103
- example: >-
- 72TCV5BRQPBMSAFPYO3CPWVDBYWNGAYNMTW5QHENOMQF7I6QLNMJWCJZ7A3V5YKD7QD6ZZPEHG2PV2ZVVEDDO6BCRGXWIL3DIUMSUCI
- minLength: 103
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- required:
- - chain
- - to
- - contractAddress
- - amount
- - digits
- - fromPrivateKey
- ChainTransferAlgoErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: The blockchain to work with
- enum:
- - ALGO
- to:
- maxLength: 58
- minLength: 42
- description: The blockchain address to send the fungible tokens to
- example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
- type: string
- from:
- maxLength: 58
- minLength: 58
- description: The blockchain address to send the fungible tokens from
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- type: string
- contractAddress:
- maxLength: 43
- minLength: 1
- description: The asset ID (the ID of the fungible tokens)
- example: "1"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: The number of decimal places that the fungible tokens have
- example: 18
- maximum: 30
- minimum: 1
- type: number
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- required:
- - chain
- - currency
- - to
- - contractAddress
- - signatureId
- - amount
- - from
- ChainBurnAlgoErc20:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: Chain to work with.
- enum:
- - ALGO
- contractAddress:
- maxLength: 43
- minLength: 1
- description: assetIndex - asset index uniquely specifying the asset
- example: "1"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 103
- example: >-
- 72TCV5BRQPBMSAFPYO3CPWVDBYWNGAYNMTW5QHENOMQF7I6QLNMJWCJZ7A3V5YKD7QD6ZZPEHG2PV2ZVVEDDO6BCRGXWIL3DIUMSUCI
- minLength: 103
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- required:
- - chain
- - contractAddress
- - fromPrivateKey
- ChainBurnAlgoErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: Chain to work with.
- enum:
- - ALGO
- from:
- maxLength: 58
- minLength: 58
- description: Blockchain address to send ERC20 token from
- example: NTAESFCB3WOD7SAOL42KSPVARLB3JFA3MNX3AESWHYVT2RMYDVZI6YLG4Y
- type: string
- contractAddress:
- maxLength: 43
- minLength: 1
- description: assetIndex - asset index uniquely specifying the asset
- example: "1"
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- required:
- - chain
- - contractAddress
- - signatureId
- - from
- ChainTransferEthErc20:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - XDC
- - ONE
- to:
- maxLength: 50
- minLength: 1
- description: The blockchain address to send the fungible tokens to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The blockchain address of the fungible token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: >-
- The number of decimal places that the fungible tokens have; to find
- out how many decimal places are used in the fungible tokens, check
- out the smart contract
- example: 18
- maximum: 30
- minimum: 1
- type: number
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - currency
- - to
- - contractAddress
- - digits
- - fromPrivateKey
- - amount
- ChainTransferSolanaSpl:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- from:
- description: The blockchain address to send the fungible tokens from
- maxLength: 44
- minLength: 32
- example: BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs
- type: string
- to:
- description: The blockchain address to send the fungible tokens to
- maxLength: 44
- minLength: 32
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the fungible tokens
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: The number of decimal places that the fungible tokens have
- example: 18
- maximum: 30
- minimum: 0
- type: number
- fromPrivateKey:
- type: string
- maxLength: 87
- example: >-
- YdQ1iy2NYs93dtkHdz3ijDuhRJj6uXYAUZmixirCrgCsTMj42BN1Q1buYcGZaMxw5buk9VU5ogQ6zuzn8DMsGaf
- minLength: 128
- description: >-
- The private key of the blockchain address that you are sending the
- fungible tokens from (the address that you specified in the
- from
parameter); the transaction fee will be deducted
- from this address
- feePayer:
- description: >-
- The blockchain address from which the fee will be deducted; if not
- set, defaults to the address that you specified in the
- from
parameter
- maxLength: 44
- minLength: 32
- example: BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs
- type: string
- feePayerPrivateKey:
- type: string
- maxLength: 87
- example: >-
- YdQ1iy2NYs93dtkHdz3ijDuhRJj6uXYAUZmixirCrgCsTMj42BN1Q1buYcGZaMxw5buk9VU5ogQ6zuzn8DMsGaf
- minLength: 128
- description: >-
- The private key of the blockchain address that you specified in the
- feePayer
parameter; if not set, defaults to the private
- key that you specified in the fromPrivateKey
parameter
- required:
- - chain
- - currency
- - to
- - contractAddress
- - digits
- - fromPrivateKey
- - from
- - amount
- ChainTransferSolanaSplKMS:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- from:
- description: The blockchain address to send the fungible tokens from
- maxLength: 44
- minLength: 32
- example: BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs
- type: string
- to:
- description: The blockchain address to send the fungible tokens to
- maxLength: 44
- minLength: 32
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the fungible tokens
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: The number of decimal places that the fungible tokens have
- example: 18
- maximum: 30
- minimum: 0
- type: number
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- you are sending the fungible tokens from (the address that you
- specified in the from
parameter); the transaction fee
- will be deducted from this address
- feePayer:
- description: >-
- The blockchain address from which the fee will be deducted; if not
- set, defaults to the address that you specified in the
- from
parameter
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- maxLength: 44
- minLength: 32
- type: string
- feePayerSignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- you specified in the feePayer
parameter; if not set,
- defaults to the signature ID that you specified in the
- signatureId
parameter
- required:
- - chain
- - currency
- - to
- - contractAddress
- - digits
- - signatureId
- - from
- - amount
- ChainTransferEthErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - MATIC
- - KLAY
- - XDC
- - ONE
- to:
- maxLength: 50
- minLength: 1
- description: The blockchain address to send the fungible tokens to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The blockchain address of the fungible token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: >-
- The number of decimal places that the fungible tokens have; to find
- out how many decimal places are used in the fungible tokens, check
- out the smart contract
- example: 18
- maximum: 30
- minimum: 1
- type: number
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - currency
- - to
- - contractAddress
- - digits
- - signatureId
- - amount
- ChainTransferKcsEthErc20:
- type: object
- properties:
- chain:
- type: string
- example: KCS
- description: The blockchain to work with
- enum:
- - KCS
- to:
- maxLength: 50
- minLength: 1
- description: The blockchain address to send the fungible tokens to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The blockchain address of the fungible token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: The number of decimal places that the fungible tokens have
- example: 18
- maximum: 30
- minimum: 1
- type: number
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - currency
- - to
- - contractAddress
- - digits
- - fromPrivateKey
- - amount
- ChainTransferKcsEthErc20KMS:
- type: object
- properties:
- chain:
- type: string
- example: KCS
- description: The blockchain to work with
- enum:
- - KCS
- to:
- maxLength: 50
- minLength: 1
- description: The blockchain address to send the fungible tokens to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 43
- minLength: 42
- description: The blockchain address of the fungible token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: The number of decimal places that the fungible tokens have
- example: 18
- maximum: 30
- minimum: 1
- type: number
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - currency
- - to
- - contractAddress
- - digits
- - signatureId
- - amount
- ChainTransferBscBep20:
- type: object
- properties:
- chain:
- type: string
- example: BSC
- description: The blockchain to work with
- enum:
- - BSC
- to:
- maxLength: 50
- minLength: 1
- description: The blockchain address to send the fungible tokens to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the fungible tokens
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: >-
- The number of decimal places that the fungible tokens have; to find
- out how many decimal places are used in the fungible tokens, check
- out the smart contract
- example: 18
- maximum: 30
- minimum: 1
- type: number
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - digits
- - fromPrivateKey
- - amount
- ChainTransferBscBep20KMS:
- type: object
- properties:
- chain:
- type: string
- example: BSC
- description: The blockchain to work with
- enum:
- - BSC
- to:
- maxLength: 50
- minLength: 1
- description: The blockchain address to send the fungible tokens to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the fungible tokens
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: >-
- The number of decimal places that the fungible tokens have; to find
- out how many decimal places are used in the fungible tokens, check
- out the smart contract
- example: 18
- maximum: 30
- minimum: 1
- type: number
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - digits
- - signatureId
- - amount
- ChainTransferCeloErc20Token:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- to:
- maxLength: 50
- minLength: 1
- description: The blockchain address to send the fungible tokens to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the fungible token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: >-
- The number of decimal places that the fungible tokens have; to find
- out how many decimal places are used in the fungible tokens, check
- out the smart contract
- example: 18
- maximum: 30
- minimum: 1
- type: number
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - digits
- - feeCurrency
- - fromPrivateKey
- - amount
- ChainTransferCeloErc20TokenKMS:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- to:
- maxLength: 50
- minLength: 1
- description: The blockchain address to send the fungible tokens to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the fungible token smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- amount:
- description: The amount of the fungible tokens to be sent
- example: "100000"
- type: string
- pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
- digits:
- description: >-
- The number of decimal places that the fungible tokens have; to find
- out how many decimal places are used in the fungible tokens, check
- out the smart contract
- example: 18
- maximum: 30
- minimum: 1
- type: number
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address from
- which the fee will be deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - digits
- - feeCurrency
- - signatureId
- - amount
- ChainCallSmartContractMethod:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - BSC
- - XDC
- contractAddress:
- maxLength: 43
- minLength: 42
- description: Address of ERC20 token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- methodName:
- minLength: 1
- maxLength: 500
- description: Name of the method to invoke on smart contract.
- type: string
- example: transfer
- methodABI:
- type: object
- description: ABI of the method to invoke.
- params:
- type: array
- example:
- - "0x632"
- items:
- type: string
- description: Parameters of the method to be invoked.
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - params
- - methodABI
- - fromPrivateKey
- - methodName
- NftMetadataErc721:
- type: object
- properties:
- data:
- type: string
- description: Metadata associated with token.
- example: https://my_token_data.com
- NftMetadataErc721OnchainSolana:
- type: object
- properties:
- onchainData:
- type: object
- description: (Solana) Metadata associated with token.
- properties:
- name:
- type: string
- example: My token
- symbol:
- type: string
- example: symbol
- uri:
- type: string
- example: http://google.com
- NftMetadataErc721OnchainFlow:
- type: array
- description: (Flow) Token ids
- items:
- type: string
- example: "3654"
- NftMetadataErc721OnchainAlgo:
- type: object
- properties:
- onchainData:
- type: string
- description: (ALGO) Metadata associated with token.
- example: https://my_token_data.com
- NftRoyaltyErc721:
- type: object
- properties:
- addresses:
- type: array
- description: >-
- The blockchain addresses where the royalty cashback will be sent
- every time the NFT is transferred
- items:
- type: string
- example: "0x94Ce79B9F001E25BBEbE7C01998A78F7B27D1326"
- values:
- type: array
- description: >
- The amounts of the royalties that will be paid to the authors of the
- NFT every time the NFT is transferred; the royalties are paid as a
- percentage of the NFT price (on Solana) or in a native blockchain
- currency (on the other supported blockchains)
- items:
- type: string
- example: "0.2"
- NftTokenByAddressErc721:
- type: object
- required:
- - contractAddress
- - balances
- - metadata
- properties:
- contractAddress:
- type: string
- example: "43821281"
- description: >-
- On Algorand, this is the asset ID (the ID of the NFT); on the other
- blockchains, this is the address of the NFT smart contract.
- balances:
- type: array
- description: >-
- On Algorand, this is either an array of "1" to indicate that the
- NFTs with the specified IDs exist, or an array with the number of
- NFT fractions if the NFTs are fractional; on the other blockchains, this is an
- array of the IDs of the NFTs.
- items:
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- blockNumber:
- type: array
- description: >-
- (EVM-based blockchains only) An array of the numbers of the blocks
- in which the NFT was received by the address
- items:
- type: number
- example: 13816552
- metadata:
- type: array
- items:
- $ref: "#/components/schemas/NftTokenByAddressErc721TokenMetadata"
- supply:
- type: number
- example: 10
- description: >-
- (Algorand only) The number of fractions in the NFT if the NFT is fractional
- decimals:
- type: number
- example: 1
- description: >-
- (Algorand only) The number of decimal places in an NFT fraction if
- the NFT is fractional
- NftTokenByAddressErc721TokenMetadata:
- type: object
- properties:
- tokenId:
- description: (EVM-based blockchains only) The ID of the NFT owned by this address
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- url:
- description: >-
- The URL pointing to the NFT metadata; the URL may not be present,
- and if it is not returned, you can get it by calling the NFT
- Contract.tokenURI() method
- example: ipfs://QmXFpaS3S7CkLZvihLFA9JbawKdqhjg8dJeDkPntmkD2Pc
- type: string
- metadata:
- $ref: "#/components/schemas/NftTokenByAddressErc721Metadata"
- NftTokenByAddressErc721Metadata:
- type: object
- description: >-
- The metadata scheme obtained from the metadata URL; the scheme may not
- be present, and if it is not returned, you can get it using the NFT metadata API
- example:
- name: Example NFT name
- description: Example NFT description
- image: ipfs://QmP4R7ACZ7JRQ6sLdmnPHqjWEXxzdnPvhAV2f6RnQ8uxJ6
- NftTokenByCollectionErc721:
- type: object
- required:
- - tokenId
- properties:
- tokenId:
- description: ID of the token.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- metadata:
- $ref: "#/components/schemas/NftTokenByCollectionErc721TokenMetadata"
- NftTokenByCollectionErc721TokenMetadata:
- type: object
- required:
- - tokenID
- properties:
- tokenId:
- description: TokenID of the NFT token owned by this address.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- url:
- description: >-
- Metadata URL of the TokenID. This data don't have to be present,
- safest way (if not present) is to obtain them from the NFT
- Contract.tokenURI() method call.
- example: ipfs://QmXFpaS3S7CkLZvihLFA9JbawKdqhjg8dJeDkPntmkD2Pc
- type: string
- metadata:
- type: object
- description: >-
- Metadata scheme obtained from the url. This data don't have to be
- present, safest way (if not present) is to obtain them from the NFT
- Contract.tokenURI() method call.
- example:
- name: Example NFT name
- description: Example NFT description
- image: ipfs://QmP4R7ACZ7JRQ6sLdmnPHqjWEXxzdnPvhAV2f6RnQ8uxJ6
- TransferNftCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send NFT token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of the token.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - tokenId
- - fromPrivateKey
- - feeCurrency
- TransferNftTezos:
- type: object
- properties:
- chain:
- type: string
- example: TEZOS
- description: The blockchain to work with
- enum:
- - TEZOS
- from:
- maxLength: 36
- minLength: 36
- description: Blockchain address that owns the NFT token
- example: tz1LszyhzQS6JgySBSNkM55szM18inGwEgPa
- type: string
- to:
- maxLength: 36
- minLength: 36
- description: Blockchain address to send NFT token to
- example: tz1LszyhzQS6JgySBSNkM55szM18inGwEgPa
- type: string
- contractAddress:
- maxLength: 36
- minLength: 36
- description: The blockchain address of the NFT smart contract
- example: KT1PemxAAhNkjvt49gBtFHn4JEm49Z3HA8TX
- type: string
- tokenId:
- description: The ID of the NFT
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- edskRvJQqeNih91dkoRkTG1PWxV5AruYbtrkp5DKibL2iMkPGWBbdYp8jpsY3N3skCNrwf9socTv9Sstonkckc4jTb
- minLength: 64
- description: >-
- The private key of the blockchain address that owns the token or has
- rights to transfer the token. This address will pay the fee for the
- transaction,
- required:
- - chain
- - from
- - to
- - tokenId
- - contractAddress
- - fromPrivateKey
- TransferNftTron:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- to:
- maxLength: 34
- minLength: 34
- description: Blockchain address to send NFT token to
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- tokenId:
- description: ID of the token.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of NFT token
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- description: The maximum amount to be paid as the transaction fee (in TRX)
- example: 600
- required:
- - chain
- - to
- - contractAddress
- - tokenId
- - fromPrivateKey
- - feeLimit
- FlowMintedMultipleResult:
- type: object
- properties:
- txId:
- type: string
- description: Transaction ID
- example: d67787399d205139f4d6f42c2aa4fffdf6f247411fae3706e874fbba0ce04b1b
- tokenId:
- type: array
- items:
- description: ID of the minted token.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- FlowMintedResult:
- type: object
- properties:
- txId:
- type: string
- description: Transaction ID
- example: d67787399d205139f4d6f42c2aa4fffdf6f247411fae3706e874fbba0ce04b1b
- tokenId:
- description: ID of the token.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- SolanaMintedResult:
- type: object
- properties:
- txId:
- type: string
- description: The ID of the transaction
- example: >-
- 4kiRkAWjjr5t3rBKmYQ5d2e3xjgnRRttB5GtUz2F4sz5wwC7NnV74qCZ1KN1b37qsnjkKknsJPGXdcPhzHpkiMAs
- nftAddress:
- type: string
- description: The blockchain address of the minted NFT
- example: 4afZBmAneN2j6gDHH8zdrNWkCqfMC3XPH2cpFKtYMSVe
- nftAccountAddress:
- type: string
- description: >-
- The blockchain address that received the minted NFT; this address
- was created under the recipient's account address (the one in the
- to
parameter of the request body), is owned by the
- recipient's address, and has the same private key
- example: A8BSHPJcB5ZGCT6yo6pz2RYqnypTSpzTAFSBhtTQmsEE
- AlgorandMintedResult:
- type: object
- properties:
- txId:
- type: string
- description: The ID of the transaction
- example: HQ32RQPJ7EAASLHPG5TTQEGETOEMN7BPND2TQMUMZWLIZBJWJ23A
- assetIndex:
- type: number
- description: The ID of the minted NFT
- example: 88885810
- confirmed:
- type: boolean
- description: >-
- If set to "true", the transaction was included in the block within
- five rounds; otherwise, returned set to "false". "false" does not
- mean that the transaction was not included in the block; the Tatum
- API just does not wait for that much time to return the response.
- example: true
- MintMultipleNftCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "123"
- items:
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- url:
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- type: array
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - url
- - fromPrivateKey
- - feeCurrency
- - tokenId
- MintMultipleNftTron:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- items:
- maxLength: 34
- minLength: 34
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "123"
- items:
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- url:
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- type: array
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of NFT token
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- description: The maximum amount to be paid as the transaction fee (in TRX)
- example: 600
- required:
- - chain
- - to
- - contractAddress
- - url
- - fromPrivateKey
- - feeLimit
- - tokenId
- DeployNftCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- name:
- description: Name of the NFT token
- example: My ERC721
- maxLength: 100
- minLength: 1
- type: string
- publicMint:
- description: True if the contract is publicMint type. False by default.
- example: true
- type: boolean
- symbol:
- description: Symbol of the NFT token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- fromPrivateKey:
- description: >-
- Private key of account address, from which gas for deployment of
- ERC721 will be paid. Private key, or signature Id must be present.
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - name
- - symbol
- - feeCurrency
- - fromPrivateKey
- DeployNftTezos:
- type: object
- properties:
- chain:
- type: string
- example: TEZOS
- description: The blockchain to work with
- enum:
- - TEZOS
- ownerAddress:
- description: >-
- Public address that will be admin of the contract. Must be a valid
- address of the Tezos blockchain.
- example: tz1cCRCbBwnazV6howgD84a6fuhikKTnsWHZ
- type: string
- metadata:
- description: >-
- Object of key-value pairs representing metadata of the contract.
- Keys must be strings, values can be strings, numbers, or booleans.
- example:
- name: My NFT
- type: object
- fromPrivateKey:
- description: >-
- Private key of account address, from which fee and storage costs for
- deployment of Tzip12 contract will be paid.
- type: string
- example: >-
- edskRvJQqeNih91dkoRkTG1PWxV5AruYbtrkp5DKibL2iMkPGWBbdYp8jpsY3N3skCNrwf9socTv9Sstonkckc
- required:
- - chain
- - ownerAddress
- - metadata
- - fromPrivateKey
- DeployNftTron:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- name:
- description: Name of the NFT token
- example: My ERC721
- maxLength: 100
- minLength: 1
- type: string
- symbol:
- description: Symbol of the NFT token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- fromPrivateKey:
- description: >-
- Private key of account address, from which gas for deployment of
- ERC721 will be paid. Private key, or signature Id must be present.
- type: string
- maxLength: 64
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- minLength: 64
- feeLimit:
- type: number
- description: >-
- The maximum amount to be paid as the transaction fee (in TRX);
- deployment of a smart contract on TRON costs around 580 TRX
- example: 600
- required:
- - chain
- - name
- - symbol
- - feeLimit
- - fromPrivateKey
- DeployNftCeloKMS:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- name:
- description: Name of the NFT token
- example: My ERC721
- maxLength: 100
- minLength: 1
- type: string
- symbol:
- description: Symbol of the NFT token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- publicMint:
- description: True if the contract is publicMint type. False by default.
- example: true
- type: boolean
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - name
- - symbol
- - feeCurrency
- - signatureId
- DeployNftTronKMS:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- from:
- maxLength: 34
- minLength: 34
- description: Blockchain address to perform transaction from
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- name:
- description: Name of the NFT token
- example: My ERC721
- maxLength: 100
- minLength: 1
- type: string
- symbol:
- description: Symbol of the NFT token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- feeLimit:
- type: number
- description: >-
- The maximum amount to be paid as the transaction fee (in TRX);
- deployment of a smart contract on TRON costs around 580 TRX
- example: 600
- required:
- - chain
- - name
- - from
- - symbol
- - feeLimit
- - signatureId
- MintMultipleNftKMSCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "123"
- items:
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- url:
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- type: array
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- minimum: 0
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - to
- - contractAddress
- - feeCurrency
- - tokenId
- - url
- - signatureId
- MintMultipleNftKMSTron:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- items:
- maxLength: 34
- minLength: 34
- type: string
- from:
- maxLength: 34
- minLength: 34
- description: Blockchain address to perform transaction from
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "123"
- items:
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- url:
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- type: array
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of NFT token
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- feeLimit:
- type: number
- description: The maximum amount to be paid as the transaction fee (in TRX)
- example: 600
- required:
- - chain
- - to
- - from
- - contractAddress
- - feeLimit
- - tokenId
- - url
- - signatureId
- BurnNftCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- tokenId:
- description: ID of token to be destroyed.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - contractAddress
- - feeCurrency
- - fromPrivateKey
- - tokenId
- BurnNftTezos:
- type: object
- properties:
- chain:
- type: string
- example: TEZOS
- description: The blockchain to work with
- enum:
- - TEZOS
- tokenId:
- description: ID of token to be destroyed.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: Address of NFT token
- example: KT1KVGCm3WTQndN8WLvdYWAaCJheWj7oudY7
- type: string
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- edskRvJQqeNih91dkoRkTG1PWxV5AruYbtrkp5DKibL2iMkPGWBbdYp8jpsY3N3skCNrwf9socTv9Sstonkckc4
- minLength: 66
- description: Private key of sender address.
- ownerAddress:
- maxLength: 36
- minLength: 36
- description: >-
- Public address of the owner. Owner is admin and minter of the token.
- Must be a valid address of the Tezos blockchain.
- example: tz1cCRCbBwnazV6howgD84a6fuhikKTnsWHZ
- type: string
- required:
- - chain
- - tokenId
- - contractAddress
- - fromPrivateKey
- - ownerAddress
- BurnNftAlgo:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: The blockchain to work with
- enum:
- - ALGO
- contractAddress:
- maxLength: 42
- minLength: 42
- description: >-
- The ID of the NFT to burn; this is the ID from the
- assetIndex
parameter returned in the response body of
- the minting call
- example: "116363571"
- type: string
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- fromPrivateKey:
- type: string
- maxLength: 103
- example: >-
- 46OPDKNDLB35M3QMRRZEAW2HDTDT2LFHRUCHDE5FJZAJOV7GDPCC6AYZ6KCUULTHA4QL6YPHN2PNEXHPJMUZGHYJXQK6SUL2HQ2MLXQ
- minLength: 103
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- required:
- - chain
- - contractAddress
- - fromPrivateKey
- BurnNftAlgoKMS:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: The blockchain to work with
- enum:
- - ALGO
- contractAddress:
- maxLength: 265
- description: >-
- The ID of the NFT to burn; this is the ID from the
- assetIndex
parameter returned in the response body of
- the minting call
- example: "116363571"
- type: string
- from:
- maxLength: 58
- minLength: 58
- description: Blockchain address to burn NFT token from
- example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
- type: string
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- required:
- - chain
- - contractAddress
- - signatureId
- - from
- BurnNftTron:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- tokenId:
- description: ID of token to be destroyed.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of NFT token
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- fromPrivateKey:
- type: string
- maxLength: 64
- example: 842E09EB40D8175979EFB0071B28163E11AED0F14BDD84090A4CEFB936EF5701
- minLength: 64
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- feeLimit:
- type: number
- description: The maximum amount to be paid as the transaction fee (in TRX)
- example: 600
- required:
- - chain
- - contractAddress
- - feeLimit
- - fromPrivateKey
- - tokenId
- BurnNftSolana:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- from:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address to send the NFT from; this is the address
- that you used in the to
parameter in the request body
- of the minting call; from
- this address, the transaction fee will be paid
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT; this is the address from the
- nftAddress
parameter returned in the response body of
- the minting call
- example: 3tzudv5KaoqmieWiBUqzWokKEtTvx1wQMapVKeH7CHaq
- type: string
- collection:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the NFT collection
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- 3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad
- minLength: 128
- description: >-
- The private key of the blockchain address that you are sending the
- NFT from (the address that you specified in the from
- parameter)
- feePayer:
- description: >-
- Address on the Solana blockchain, from which the fee will be paid
- for transaction. Defaults to from.
- maxLength: 44
- minLength: 32
- example: BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs
- type: string
- feePayerPrivateKey:
- type: string
- maxLength: 87
- example: >-
- YdQ1iy2NYs93dtkHdz3ijDuhRJj6uXYAUZmixirCrgCsTMj42BN1Q1buYcGZaMxw5buk9VU5ogQ6zuzn8DMsGaf
- minLength: 128
- description: Private key of the fee payer address.
- required:
- - from
- - chain
- - contractAddress
- - fromPrivateKey
- BurnNftSolanaKMS:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- from:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address to send the NFT from; this is the address
- that you used in the to
parameter in the request body
- of the minting call; from
- this address, the transaction fee will be paid
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT; this is the address from the
- nftAddress
parameter returned in the response body of
- the minting call
- example: 3tzudv5KaoqmieWiBUqzWokKEtTvx1wQMapVKeH7CHaq
- type: string
- collection:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the NFT collection
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- feePayer:
- description: Blockchain address to pay the fee for the transaction from
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- maxLength: 44
- minLength: 32
- type: string
- feePayerSignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key used for paying the gas costs in
- signing application. Defaults to the signatureId.
- required:
- - from
- - chain
- - contractAddress
- - signatureId
- BurnNftKMSCelo:
- type: object
- properties:
- chain:
- type: string
- example: CELO
- description: The blockchain to work with
- enum:
- - CELO
- tokenId:
- description: ID of token to be destroyed.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- feeCurrency:
- type: string
- description: The currency in which the transaction fee will be paid
- enum:
- - CELO
- - CUSD
- - CEUR
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - chain
- - feeCurrency
- - contractAddress
- - tokenId
- - signatureId
- BurnNftKMSTron:
- type: object
- properties:
- chain:
- type: string
- example: TRON
- description: The blockchain to work with
- enum:
- - TRON
- from:
- maxLength: 34
- minLength: 34
- description: Blockchain address to perform transaction from
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- tokenId:
- description: ID of token to be destroyed.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 34
- minLength: 34
- description: Address of NFT token
- example: TCrmdJmvDUPy8qSTgoVStF51yWm6VUh5yQ
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- feeLimit:
- type: number
- description: The maximum amount to be paid as the transaction fee (in TRX)
- example: 600
- required:
- - chain
- - feeLimit
- - contractAddress
- - tokenId
- - signatureId
- - from
- BurnNftFlowPK:
- type: object
- properties:
- chain:
- type: string
- example: FLOW
- description: The blockchain to work with
- enum:
- - FLOW
- tokenId:
- description: ID of token to be destroyed.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: Address of NFT token
- example: 17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f
- type: string
- account:
- type: string
- maxLength: 18
- example: "0xc1b45bc27b9c61c3"
- minLength: 18
- description: Blockchain address of the sender account.
- privateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, mnemonic and index or
- signature Id must be present.
- required:
- - chain
- - contractAddress
- - account
- - privateKey
- - tokenId
- BurnNftFlowMnemonic:
- type: object
- properties:
- chain:
- type: string
- example: FLOW
- description: The blockchain to work with
- enum:
- - FLOW
- tokenId:
- description: ID of token to be destroyed.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: Address of NFT token
- example: 17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f
- type: string
- account:
- type: string
- maxLength: 18
- example: "0xc1b45bc27b9c61c3"
- minLength: 18
- description: Blockchain address of the sender account.
- mnemonic:
- type: string
- maxLength: 500
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- minLength: 1
- description: Mnemonic to generate private key of sender address.
- index:
- description: Derivation index of sender address.
- example: 0
- type: integer
- maximum: 2147483647
- required:
- - chain
- - contractAddress
- - account
- - mnemonic
- - index
- - tokenId
- BurnNftFlowKMS:
- type: object
- properties:
- chain:
- type: string
- example: FLOW
- description: The blockchain to work with
- enum:
- - FLOW
- tokenId:
- description: ID of token to be destroyed.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: Address of NFT token
- example: 17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f
- type: string
- account:
- type: string
- maxLength: 18
- example: "0xc1b45bc27b9c61c3"
- minLength: 18
- description: Blockchain address of the sender account.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- description: Derivation index of sender address.
- example: 0
- type: integer
- maximum: 2147483647
- required:
- - chain
- - contractAddress
- - account
- - signatureId
- - tokenId
- MintMultipleNftFlowPK:
- type: object
- properties:
- chain:
- type: string
- example: FLOW
- description: The blockchain to work with
- enum:
- - FLOW
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - "0xc1b45bc27b9c61c3"
- items:
- maxLength: 18
- minLength: 18
- type: string
- url:
- type: array
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: Address of NFT token
- example: 17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f
- type: string
- account:
- type: string
- maxLength: 18
- example: "0xc1b45bc27b9c61c3"
- minLength: 18
- description: Blockchain address of the sender account.
- privateKey:
- type: string
- maxLength: 64
- example: 05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2
- minLength: 64
- description: >-
- Private key of sender address. Private key, mnemonic and index or
- signature Id must be present.
- required:
- - chain
- - contractAddress
- - account
- - privateKey
- - to
- - url
- MintMultipleNftFlowMnemonic:
- type: object
- properties:
- chain:
- type: string
- example: FLOW
- description: The blockchain to work with
- enum:
- - FLOW
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - "0xc1b45bc27b9c61c3"
- items:
- maxLength: 18
- minLength: 18
- type: string
- url:
- type: array
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: Address of NFT token
- example: 17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f
- type: string
- account:
- type: string
- maxLength: 18
- example: "0xc1b45bc27b9c61c3"
- minLength: 18
- description: Blockchain address of the sender account.
- mnemonic:
- type: string
- maxLength: 500
- example: >-
- urge pulp usage sister evidence arrest palm math please chief egg
- abuse
- minLength: 1
- description: Mnemonic to generate private key of sender address.
- index:
- description: Derivation index of sender address.
- example: 0
- type: integer
- maximum: 2147483647
- required:
- - chain
- - contractAddress
- - account
- - mnemonic
- - index
- - to
- - url
- MintMultipleNftFlowKMS:
- type: object
- properties:
- chain:
- type: string
- example: FLOW
- description: The blockchain to work with
- enum:
- - FLOW
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - "0xc1b45bc27b9c61c3"
- items:
- maxLength: 18
- minLength: 18
- type: string
- url:
- type: array
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: Address of NFT token
- example: 17a50dad-bcb1-4f3d-ae2c-ea2bfb04419f
- type: string
- account:
- type: string
- maxLength: 18
- example: "0xc1b45bc27b9c61c3"
- minLength: 18
- description: Blockchain address of the sender account.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- index:
- description: Derivation index of sender address.
- example: 0
- type: integer
- maximum: 2147483647
- required:
- - chain
- - contractAddress
- - account
- - signatureId
- - to
- - url
- MintNftFlowPK:
- description: >-
- The MintNftFlowPK
schema lets you mint NFTs natively on
- Flow and sign the transaction with your private key.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
The MintNftFlowMnemonic
schema lets you mint NFTs
- natively on Flow and sign the transaction with your wallet
- mnemonic.
For more information, see "Minting NFTs natively on a
- blockchain" in Mint an
- NFT.
The MintNftFlowKMS
schema lets you mint NFTs natively on
- Flow and sign the transaction with your signature ID.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
The MintNftCelo
schema lets you mint NFTs natively on
- Celo and sign the transaction with your private key.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
The MintNftTron
schema lets you mint NFTs natively on
- TRON and sign the transaction with your private key.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
The MintNftKMSCelo
schema lets you mint NFTs natively on
- Celo and sign the transaction with your signature ID.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
The MintNftKMSTron
schema lets you mint NFTs natively on
- TRON and sign the transaction with your signature ID.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
to
parameter in the request body
- of the minting call; from
- this address, the transaction fee will be paid
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- to:
- maxLength: 44
- minLength: 32
- description: The blockchain address to send the NFT to
- example: 9pSkqSG71Sb25ia9WBFhoeBYjp8dhUf7fRux9xrDq89b
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT; this is the address from the
- nftAddress
parameter returned in the response body of
- the minting call
- example: 3tzudv5KaoqmieWiBUqzWokKEtTvx1wQMapVKeH7CHaq
- type: string
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- 3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad
- minLength: 128
- description: >-
- The private key of the blockchain address that you are sending the
- NFT from (the address that you specified in the from
- parameter)
- feePayer:
- description: >-
- Address on the Solana blockchain, from which the fee will be paid
- for transaction. Defaults to from.
- maxLength: 44
- minLength: 32
- example: BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs
- type: string
- feePayerPrivateKey:
- type: string
- maxLength: 87
- example: >-
- YdQ1iy2NYs93dtkHdz3ijDuhRJj6uXYAUZmixirCrgCsTMj42BN1Q1buYcGZaMxw5buk9VU5ogQ6zuzn8DMsGaf
- minLength: 128
- description: Private key of the fee payer address.
- required:
- - to
- - from
- - chain
- - contractAddress
- - fromPrivateKey
- TransferNftAlgoKMS:
- type: object
- properties:
- chain:
- type: string
- example: ALGO
- description: The blockchain to work with
- enum:
- - ALGO
- from:
- maxLength: 58
- minLength: 58
- description: The blockchain address to transfer the NFT from
- example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
- type: string
- to:
- maxLength: 58
- minLength: 58
- description: The blockchain address to transfer the NFT to
- example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
- type: string
- contractAddress:
- description: The asset ID (the ID of the NFT)
- example: "100000"
- type: string
- maxLength: 256
- fee:
- description: The transaction fee in Algos
- type: string
- example: "0.001"
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the sender's blockchain
- address
- amount:
- description: >-
- (For fractional NFTs only) The number of NFT
- fractions to transfer; if not set, defaults to 1, which means that
- one fraction of the NFT will be transferred
- example: 1
- default: 1
- type: number
- minimum: 0
- required:
- - to
- - chain
- - contractAddress
- - from
- - signatureId
- TransferNftSolanaKMS:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- from:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address to send the NFT from; this is the address
- that you used in the to
parameter in the request body
- of the minting call; from
- this address, the transaction fee will be paid
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- to:
- maxLength: 44
- minLength: 32
- description: The blockchain address to send the NFT to
- example: 9pSkqSG71Sb25ia9WBFhoeBYjp8dhUf7fRux9xrDq89b
- type: string
- contractAddress:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT; this is the address from the
- nftAddress
parameter returned in the response body of
- the minting call
- example: 3tzudv5KaoqmieWiBUqzWokKEtTvx1wQMapVKeH7CHaq
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- The KMS identifier of the private key of the blockchain address that
- you are sending the NFT from (the address that you specified in the
- from
parameter)
- feePayer:
- description: Blockchain address to pay the fee for the transaction from
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- maxLength: 44
- minLength: 32
- type: string
- feePayerSignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key used for paying the gas costs in
- signing application. Defaults to the signatureId.
- required:
- - to
- - from
- - chain
- - contractAddress
- - signatureId
- DeployNft:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - MATIC
- - KCS
- - ONE
- - KLAY
- - BSC
- - ZEN
- name:
- description: Name of the NFT token
- example: My ERC721
- maxLength: 100
- minLength: 1
- type: string
- symbol:
- description: Symbol of the NFT token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- fromPrivateKey:
- description: >-
- Private key of account address, from which gas for deployment of
- ERC721 will be paid. Private key, or signature Id must be present.
- type: string
- maxLength: 103
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- publicMint:
- description: True if the contract is publicMint type. False by default.
- example: true
- type: boolean
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - name
- - chain
- - symbol
- - fromPrivateKey
- DeployNftKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - MATIC
- - KCS
- - ONE
- - KLAY
- - BSC
- name:
- description: Name of the NFT token
- example: My ERC721
- maxLength: 100
- minLength: 1
- type: string
- publicMint:
- description: True if the contract is publicMint type. False by default.
- example: true
- type: boolean
- symbol:
- description: Symbol of the NFT token
- example: ERC_SYMBOL
- maxLength: 30
- minLength: 1
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - name
- - chain
- - symbol
- - signatureId
- TransferNftKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - MATIC
- - KCS
- - ONE
- - KLAY
- - BSC
- to:
- maxLength: 42
- minLength: 42
- description: Blockchain address to send NFT token to
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- tokenId:
- description: ID of the token.
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- example: 1
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - chain
- - contractAddress
- - signatureId
- - tokenId
- MintNft:
- description: >-
- The MintNft
schema lets you mint NFTs natively on BNB
- Smart Chain, Ethereum, Harmony, Klaytn, KuCoin Community Chain, Polygon
- and Horizen Eon and sign the transaction with your private key.
For
- more information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
The MintNftMinter
schema lets you mint NFTs on BNB Smart
- Chain, Celo, Ethereum, Harmony, Klaytn, Polygon and Horizen Eon using
- the NTF minter, a special blockchain address provided by Tatum
- that will cover the minting fees.
For more information, see "Use
- your own smart contract to mint NFTs" in Mint an NFT.
The MintNftExpress
schema lets you mint NFTs on BNB
- Smart Chain, Celo, Ethereum, Harmony, Klaytn, and Polygon using NTF
- Express with the pre-built smart contract provided by Tatum.
For
- more information, see "Use the pre-built smart contract provided by
- Tatum to mint NFTs" in Mint an
- NFT.
The MintNftExpressAlgorand
schema lets you mint NFTs on
- Algorand using NTF Express with the pre-built smart contract
- provided by Tatum.
For more information, see "Use the pre-built
- smart contract provided by Tatum to mint NFTs" in Mint an NFT.
total
parameter); for
- example, if total
is set to 10,
- decimals
must be set to 1.The MintNftAlgorand
schema lets you mint NFTs natively
- on Algorand and sign the transaction with your private key.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
total
parameter); for
- example, if total
is set to 10,
- decimals
must be set to 1.The MintNftAlgorandKMS
schema lets you mint NFTs
- natively on Algorand and sign the transaction with your signature
- ID.
For more information, see "Minting NFTs natively on a
- blockchain" in Mint an
- NFT.
total
parameter); for
- example, if total
is set to 10,
- decimals
must be set to 1.The MintNftExpressTezos
schema lets you mint NFTs on
- Tezos using NTF Express. You don't need to provide the private
- key and Tatum will cover the minting fees. The price of the mint
- operation will be deducted from your credits. In order to use the mint
- you need to first deploy the smartcontract using NFT Express
The MintNftTezos
schema lets you mint NFTs on
- Tezos.
For more information, see "Minting NFTs natively on a
- blockchain" in Mint an NFT.
- type: object
- properties:
- chain:
- type: string
- example: TEZOS
- description: The blockchain to work with
- enum:
- - TEZOS
- url:
- description: The URL pointing to the NFT metadata
- example: https://my_token_data.com
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 36
- minLength: 36
- description: The blockchain address of the smart contract to build the NFT on
- example: KT1PemxAAhNkjvt49gBtFHn4JEm49Z3HA8TX
- type: string
- ownerAddress:
- maxLength: 36
- minLength: 36
- description: The blockchain address to send the NFT to
- example: tz1f1nboqWEhZJHwZnxnokQ9QoTiT21qMZxG
- type: string
- tokenId:
- description: The ID of the NFT
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- edskRvJQqeNih91dkoRkTG1PWxV5AruYbtrkp5DKibL2iMkPGWBbdYp8jpsY3N3skCNrwf9socTv9Sstonkckc4jTb
- minLength: 64
- description: >-
- The private key of the blockchain address that will pay the fee for
- the transaction
- required:
- - tokenId
- - chain
- - url
- - ownerAddress
- - contractAddress
- - fromPrivateKey
- MintNftKMS:
- description: >-
-
The MintNftKMS
schema lets you mint NFTs natively on BNB
- Smart Chain, Ethereum, Harmony, Klaytn, KuCoin Community Chain, and
- Polygon and sign the transaction with your signature ID.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
The MintNftSolana
schema lets you mint NFTs natively on
- Solana and sign the transaction with your private key.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
collection
parameter in the metadata
- section of the request body. To know more about Solana collections
- and verification, refer to the Solana user documentation.
- metadata:
- $ref: "#/components/schemas/SolanaNftMetadata"
- required:
- - to
- - chain
- - fromPrivateKey
- - from
- - metadata
- VerifySolanaNFT:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- nftAddress:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the NFT to verify
- example: CHw1Fy5YdbaaosLXrrxhuc3X3fpssMqDQm9XwJh9LPGe
- type: string
- collectionAddress:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT collection where the NFT should be
- verified in. The collection must be a sized collection that was
- introduced in Version 1.3 of the Metaplex Token Metadata
- program.
- example: CHw1Fy5YdbaaosLXrrxhuc3X3fpssMqDQm9XwJh9LPGe
- type: string
- from:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the collection verifier on behalf of whom
- the transaction will be originated. The transaction fee will be paid
- from this address.
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- fromPrivateKey:
- type: string
- maxLength: 128
- example: >-
- 3abc79a31093e4cfa4a724e94a44906cbbc3a32e2f75f985a28616676a5dbaf1de8d82a7e1d0561bb0e1b729c7a9b9b1708cf2803ad0ca928a332587ace391ad
- minLength: 64
- description: The private key of the collection verifier's address
- feePayer:
- description: >-
- Address on the Solana blockchain, from which the fee will be paid
- for transaction. Defaults to from.
- maxLength: 44
- minLength: 32
- example: BL4Xgn1jkuU4Yr3SQ4HG8cD5SBrsSk7BihKzkb5zTUfs
- type: string
- feePayerPrivateKey:
- type: string
- maxLength: 87
- example: >-
- YdQ1iy2NYs93dtkHdz3ijDuhRJj6uXYAUZmixirCrgCsTMj42BN1Q1buYcGZaMxw5buk9VU5ogQ6zuzn8DMsGaf
- minLength: 128
- description: Private key of the fee payer address.
- required:
- - collectionAddress
- - chain
- - fromPrivateKey
- - from
- - nftAddress
- VerifySolanaNFTKMS:
- type: object
- properties:
- chain:
- type: string
- example: SOL
- description: The blockchain to work with
- enum:
- - SOL
- nftAddress:
- maxLength: 44
- minLength: 32
- description: The blockchain address of the NFT to verify
- example: CHw1Fy5YdbaaosLXrrxhuc3X3fpssMqDQm9XwJh9LPGe
- type: string
- collectionAddress:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT collection where the NFT should be
- verified in. The collection must be a sized collection that was
- introduced in Version 1.3 of the Metaplex Token Metadata
- program.
- example: CHw1Fy5YdbaaosLXrrxhuc3X3fpssMqDQm9XwJh9LPGe
- type: string
- from:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the collection verifier on behalf of whom
- the transaction will be originated. The transaction fee will be paid
- from this address.
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- feePayer:
- description: Blockchain address to pay the fee for the transaction from
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- maxLength: 44
- minLength: 32
- type: string
- feePayerSignatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key used for paying the gas costs in
- signing application. Defaults to the signatureId.
- required:
- - collectionAddress
- - chain
- - signatureId
- - from
- - nftAddress
- MintNftExpressSolana:
- description: >-
- The MintNftExpressSolana
schema lets you mint NFTs on
- Solana using NTF Express with the pre-built smart contract
- provided by Tatum.
For more information, see "Use the pre-built
- smart contract provided by Tatum to mint NFTs" in Mint an NFT.
The MintNftSolanaKMS
schema lets you mint NFTs natively
- on Solana and sign the transaction with your signature ID.
For more
- information, see "Minting NFTs natively on a blockchain" in Mint an NFT.
100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.creators
- parameter.sellerFeeBasisPoints
to 0
and do not set
- creators
.
- example: 0
- uri:
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example: https://my_token_data.com
- type: string
- maxLength: 200
- collection:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT collection where the NFT will be
- minted in. Specify the private key of the collection verifier in the
- collectionVerifierPrivateKey
parameter of the request
- body to get the NFT verified in the collection after the NFT has
- been minted. To know more about Solana collections and verification,
- refer to the Solana user documentation.
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- mutable:
- type: boolean
- default: true
- description: >-
- Specifies whether the NFT metadata is mutable ("true") or immutable
- ("false"); if not set, defaults to "true"
- creators:
- type: array
- description: >-
- The blockchain addresses where the royalties will be sent every time
- the minted NFT is transferred
- items:
- $ref: "#/components/schemas/SolanaNftMetadataCreator"
- SolanaNftMetadataKMS:
- type: object
- required:
- - name
- - symbol
- - uri
- - sellerFeeBasisPoints
- properties:
- name:
- type: string
- description: The name of the NFT
- example: My NFT
- maxLength: 32
- symbol:
- type: string
- description: The symbol or abbreviated name of the NFT
- example: NFT_SYMBOL
- maxLength: 10
- sellerFeeBasisPoints:
- type: number
- description: >-
- The royalty that will be paid to the authors of the minted NFT every
- time the NFT is transferred100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.creators
- parameter.sellerFeeBasisPoints
to 0
and do not set
- creators
.
- example: 0
- uri:
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example: https://my_token_data.com
- type: string
- maxLength: 200
- collection:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT collection where the NFT will be
- minted in. The minted NFT will get verified in the collection on
- behalf of the blockchain address specified in the from
- parameter. To know more about Solana collections and verification,
- refer to the Solana user documentation and NFT verification API.
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- mutable:
- type: boolean
- default: true
- description: >-
- Specifies whether the NFT metadata is mutable ("true") or immutable
- ("false"); if not set, defaults to "true"
- creators:
- type: array
- description: >-
- The blockchain addresses where the royalties will be sent every time
- the minted NFT is transferred
- items:
- $ref: "#/components/schemas/SolanaNftMetadataCreator"
- SolanaNftExpressMetadata:
- type: object
- required:
- - name
- - symbol
- - uri
- - sellerFeeBasisPoints
- properties:
- name:
- type: string
- description: The name of the NFT
- example: My NFT
- maxLength: 32
- symbol:
- type: string
- description: The symbol or abbreviated name of the NFT
- example: NFT_SYMBOL
- maxLength: 10
- sellerFeeBasisPoints:
- type: number
- description: >-
- The royalty that will be paid to the authors of the minted NFT every
- time the NFT is transferred100
; to set 10%, set this parameter to
- 1000
; to set 50%, set this parameter to
- 5000
, and so on.creators
- parameter.sellerFeeBasisPoints
to 0
and do not set
- creators
.
- example: 0
- uri:
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example: https://my_token_data.com
- type: string
- maxLength: 200
- collection:
- maxLength: 44
- minLength: 32
- description: >-
- The blockchain address of the NFT collection where the NFT will be
- minted in. By default, the NFT is minted as not verified (is not
- considered a part of the collection). To verify the NFT in the
- collection, use the NFT verification API. To know more about Solana
- collections and verification, refer to the Solana user documentation.
- example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
- type: string
- mutable:
- type: boolean
- default: true
- description: >-
- Specifies whether the NFT metadata is mutable ("true") or immutable
- ("false"); if not set, defaults to "true"
- creators:
- type: array
- description: >-
- The blockchain addresses where the royalties will be sent every time
- the minted NFT is transferred
- items:
- $ref: "#/components/schemas/SolanaNftMetadataCreator"
- MintMultipleNft:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - MATIC
- - KCS
- - ONE
- - KLAY
- - BSC
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "123"
- items:
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- url:
- type: array
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 66
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- Private key of sender address. Private key, or signature Id must be
- present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- erc20:
- type: string
- maxLength: 42
- minLength: 42
- description: The blockchain address of the custom fungible token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - chain
- - url
- - contractAddress
- - fromPrivateKey
- - tokenId
- MintMultipleNftMinter:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - MATIC
- - CELO
- - KCS
- - ONE
- - KLAY
- - BSC
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "123"
- items:
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- minter:
- maxLength: 42
- minLength: 43
- description: >-
- Address of NFT minter, which will be used to mint the tokens. From
- this address, transaction fees will be deducted.
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- url:
- type: array
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- feeCurrency:
- type: string
- description: (Celo only) The currency in which the transaction fee will be paid
- enum:
- - CELO
- required:
- - to
- - chain
- - url
- - contractAddress
- - minter
- - tokenId
- MintMultipleNftKMS:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - MATIC
- - KCS
- - ONE
- - KLAY
- - BSC
- to:
- type: array
- description: Blockchain address to send NFT token to.
- example:
- - "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- items:
- maxLength: 42
- minLength: 42
- type: string
- tokenId:
- type: array
- description: ID of token to be created.
- example:
- - "123"
- items:
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- url:
- type: array
- description: >-
- The URL pointing to the NFT metadata; for more information, see EIP-721
- example:
- - https://my_token_data.com
- items:
- type: string
- maxLength: 256
- contractAddress:
- maxLength: 42
- minLength: 42
- description: Address of NFT token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- index:
- type: number
- minimum: 0
- description: >-
- If signatureId is mnemonic-based, this is the index to the specific
- address from that mnemonic.
- signatureId:
- type: string
- format: uuid
- example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
- description: >-
- Identifier of the private key associated in signing application.
- Private key, or signature Id must be present.
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- erc20:
- type: string
- maxLength: 42
- minLength: 42
- description: The blockchain address of the custom fungible token
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - chain
- - contractAddress
- - tokenId
- - url
- - signatureId
- BurnNft:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - ETH
- - MATIC
- - KCS
- - ONE
- - KLAY
- - BSC
- - ZEN
- tokenId:
- description: The ID of the NFT to burn
- type: string
- maxLength: 78
- example: "123"
- format: uint256
- contractAddress:
- maxLength: 42
- minLength: 1
- description: The blockchain address of the NFT to burn
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- fromPrivateKey:
- type: string
- maxLength: 103
- example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
- minLength: 66
- description: >-
- The private key of the blockchain address from which the fee will be
- deducted
- nonce:
- type: number
- minimum: 0
- description: >-
- The nonce to be set to the transaction; if not present, the last
- known nonce will be used
- fee:
- $ref: "#/components/schemas/CustomFee"
- required:
- - to
- - chain
- - url
- - contractAddress
- - fromPrivateKey
- - tokenId
- AddNftMinter:
- type: object
- properties:
- chain:
- type: string
- example: ETH
- description: The blockchain to work with
- enum:
- - BSC
- - CELO
- - ETH
- - KLAY
- - KCS
- - MATIC
- - ONE
- - ZEN
- contractAddress:
- maxLength: 42
- minLength: 42
- description: The blockchain address of the NFT smart contract
- example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
- type: string
- minter:
- maxLength: 42
- minLength: 42
- description: >-
- The blockchain address to add to the smart contract as an NFT
- minter1
to indicate that the NFT
- with the specified ID exists
- items:
- type: string
- example: "1"
- metadata:
- type: array
- items:
- type: object
- properties:
- url:
- description: The URL pointing to the NFT metadata; may not be present
- example: ipfs://QmXFpaS3S7CkLZvihLFA9JbawKdqhjg8dJeDkPntmkD2Pc
- type: string
- BalanceItem:
- oneOf:
- - $ref: "#/components/schemas/NativeTokenBalance"
- - $ref: "#/components/schemas/NftBalance"
- - $ref: "#/components/schemas/FungibleTokenBalance"
- NativeTokenBalance:
- type: object
- properties:
- chain:
- $ref: "#/components/schemas/Chain"
- type:
- $ref: "#/components/schemas/TokenType"
- example: native
- address:
- type: string
- balance:
- type: string
- required:
- - chain
- - type
- - address
- - balance
- NftBalance:
- type: object
- properties:
- chain:
- $ref: "#/components/schemas/Chain"
- type:
- $ref: "#/components/schemas/TokenType"
- example: nft
- address:
- type: string
- balance:
- type: string
- tokenAddress:
- type: string
- tokenId:
- type: string
- metadataURI:
- type: string
- lastUpdatedBlockNumber:
- type: integer
- metadata:
- type: object
- required:
- - chain
- - type
- - address
- - balance
- - tokenAddress
- - lastUpdatedBlockNumber
- FungibleTokenBalance:
- type: object
- properties:
- chain:
- $ref: "#/components/schemas/Chain"
- type:
- $ref: "#/components/schemas/TokenType"
- example: fungible
- address:
- type: string
- balance:
- type: string
- tokenAddress:
- type: string
- lastUpdatedBlockNumber:
- type: integer
- required:
- - chain
- - type
- - address
- - balance
- - tokenAddress
- - lastUpdatedBlockNumber
- TokenType:
- type: string
- enum:
- - native
- - fungible
- - nft
- - multitoken
- description: Enum representing the type of token.
- example: nft
- BlockItem:
- type: object
- properties:
- blockNumber:
- type: integer
- description: The block number in the blockchain.
- example: 10
- blockTimestamp:
- type: integer
- format: int64
- description: >-
- The timestamp when the block was created, in milliseconds since Unix
- epoch.
- example: 1598671520000
- hash:
- type: string
- description: The hash of the block.
- example: "0xec1a2d906f34e1981b2b1a15dbe5e10cf640e8b4b27dc056ebb65c0409b5a9af"
- eventIngestedSize:
- type: integer
- description: The number of ingested events in the block.
- example: 0
- nftIngestedSize:
- type: integer
- description: The number of ingested NFTs in the block.
- example: 0
- txHashes:
- type: array
- items:
- type: string
- description: The array of transaction hashes included in the block.
- example:
- - "0x19eaae1f7bdd28605f4175d7e87c9de68431bf76e85a262e268252a84bfc3984"
- Event:
- type: object
- properties:
- chain:
- $ref: "#/components/schemas/Chain"
- address:
- type: string
- description: The address associated with the event.
- blockNumber:
- type: integer
- description: The block number where the event was recorded.
- timestamp:
- type: integer
- description: The timestamp of the event in UNIX format.
- decoded:
- oneOf:
- - $ref: "#/components/schemas/FungibleTransfer"
- - $ref: "#/components/schemas/StablecoinTransfer"
- - $ref: "#/components/schemas/NftTransfer"
- - $ref: "#/components/schemas/MultitokenTransferSingle"
- - $ref: "#/components/schemas/MultitokenTransferBatch"
- - $ref: "#/components/schemas/UniswapTradeV2"
- - $ref: "#/components/schemas/UniswapTradeV3"
- description: The decoded event data based on the given models.
- raw:
- $ref: "#/components/schemas/RawData"
- txHash:
- type: string
- description: The transaction hash related to the event.
- txIndex:
- type: integer
- description: The transaction index within the block.
- logIndex:
- type: integer
- description: The log index within the transaction.
- DecodedDataCommon:
- type: object
- description: Common properties for decoded data events.
- properties:
- label:
- type: string
- description: The label of the event.
- example: Transfer
- type:
- type: string
- description: The type of the event.
- example: FungibleTransfer
- subtype:
- type: string
- description: The subtype of the event.
- example: ERC20
- from:
- type: string
- description: The sender address of the event.
- example: "0x742d35cc6634c0532925a3b844bc454e4438f44e"
- to:
- type: string
- description: The receiver address of the event.
- example: "0xb7d49e5aa39ff1e5d1b33286c3a8e5515b6a4e1a"
- FungibleTransfer:
- allOf:
- - $ref: "#/components/schemas/DecodedDataCommon"
- - type: object
- properties:
- decimals:
- type: integer
- description: The number of decimal places for the transferred token.
- example: 18
- value:
- type: string
- description: The value of the transferred token.
- example: "1000"
- StablecoinTransfer:
- allOf:
- - $ref: "#/components/schemas/FungibleTransfer"
- - type: object
- properties:
- stablecoin:
- type: string
- description: The address of the stablecoin being transferred.
- example: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
- NftTransfer:
- allOf:
- - $ref: "#/components/schemas/DecodedDataCommon"
- - type: object
- properties:
- tokenId:
- type: string
- description: The unique identifier of the NFT being transferred.
- example: "101"
- MultitokenTransfer:
- allOf:
- - $ref: "#/components/schemas/DecodedDataCommon"
- - type: object
- properties:
- operator:
- type: string
- description: The address of the operator initiating the transfer.
- example: "0x742d35cc6634c0532925a3b844bc454e4438f44e"
- MultitokenTransferSingle:
- allOf:
- - $ref: "#/components/schemas/MultitokenTransfer"
- - type: object
- properties:
- multitokenId:
- type: string
- description: >-
- The unique identifier of the single multitoken being
- transferred.
- example: "1"
- multitokenValue:
- type: string
- description: The value of the single multitoken being transferred.
- example: "100"
- MultitokenTransferBatch:
- allOf:
- - $ref: "#/components/schemas/MultitokenTransfer"
- - type: object
- properties:
- multitokenIds:
- type: array
- items:
- type: string
- description: The unique identifiers of the multitokens being transferred.
- example:
- - "1"
- - "2"
- - "3"
- multitokenValues:
- type: array
- items:
- type: string
- description: The values of the multitokens being transferred.
- example:
- - "100"
- - "200"
- - "300"
- UniswapTrade:
- allOf:
- - $ref: "#/components/schemas/DecodedDataCommon"
- - type: object
- properties:
- token0:
- type: string
- description: The address of the first token involved in the trade.
- example: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
- token1:
- type: string
- description: The address of the second token involved in the trade.
- example: "0x6b175474e89094c44da98b954eedeac495271d0f"
- partiallyRaw:
- type: boolean
- description: Indicates whether the trade data is partially raw or not.
- example: false
- UniswapTradeV2:
- allOf:
- - $ref: "#/components/schemas/UniswapTrade"
- - type: object
- properties:
- amount0In:
- type: string
- description: The input amount of the first token in the trade.
- example: "0.5"
- amount1In:
- type: string
- description: The input amount of the second token in the trade.
- example: "0.0"
- amount0Out:
- type: string
- description: The output amount of the first token in the trade.
- example: "0.0"
- amount1Out:
- type: string
- description: The output amount of the second token in the trade.
- example: "1.0"
- UniswapTradeV3:
- allOf:
- - $ref: "#/components/schemas/UniswapTrade"
- - type: object
- properties:
- amount0:
- type: string
- description: The net amount of the first token involved in the trade.
- example: "0.5"
- amount1:
- type: string
- description: The net amount of the second token involved in the trade.
- example: "1.0"
- sqrtPriceX96:
- type: string
- description: The square root price of the trading pair scaled by 2^96.
- example: "79228162514264337593543950336"
- liquidity:
- type: string
- description: The liquidity of the trading pair at the time of the trade.
- example: "1000"
- tick:
- type: integer
- description: The tick index of the Uniswap V3 pool at the time of the trade.
- example: 1000
- RawData:
- type: object
- description: Raw data associated with the event, including topics and data.
- required:
- - topic_0
- properties:
- topic_0:
- type: string
- description: The first topic of the event, if present.
- example: "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef"
- topic_1:
- type: string
- description: The second topic of the event, if present.
- example: "0x000000000000000000000000742d35cc6634c0532925a3b844bc454e4438f44e"
- topic_2:
- type: string
- description: The third topic of the event, if present.
- example: "0x000000000000000000000000b7d49e5aa39ff1e5d1b33286c3a8e5515b6a4e1a"
- topic_3:
- type: string
- description: The fourth topic of the event, if present.
- example: ""
- data:
- type: string
- description: The data associated with the event, if present.
- example: "0x0000000000000000000000000000000000000000000000000de0b6b3a7640000"
- TxData:
- type: object
- properties:
- chain:
- $ref: "#/components/schemas/ChainEnum"
- hash:
- type: string
- description: The transaction hash.
- example: "0x549447710026cef714da21fb29cbfae1f689bd3246f2fa0a5081149c4aeb3bb3"
- address:
- type: string
- description: The address involved in the transaction.
- example: "0xdef1c0ded9bec7f1a1670819833240f027b25eff"
- counterAddress:
- type: string
- description: The counter address involved in the transaction (optional).
- example: "0x0d4a11d5eeaac28ec3f61d100daf4d40471f1852"
- tokenAddress:
- type: string
- description: The token address involved in the transaction (optional).
- example: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
- tokenId:
- type: string
- description: The ID of the token involved in the transaction (optional).
- example: 33
- blockNumber:
- type: number
- description: The block number in which the transaction occurred.
- example: 16819465
- transactionIndex:
- type: number
- description: The transaction index within the block.
- example: 84
- transactionType:
- $ref: "#/components/schemas/TxType"
- transactionSubtype:
- $ref: "#/components/schemas/TxSubtype"
- amount:
- type: string
- description: The amount transferred in the transaction.
- example: 0.9909237063720822
- timestamp:
- type: number
- description: The timestamp when the transaction occurred.
- example: 1678715303000
- TxType:
- type: string
- description: The type of the transaction.
- enum:
- - fungible
- - nft
- - multitoken
- - native
- TxSubtype:
- type: string
- description: The subtype of the transaction.
- enum:
- - incoming
- - outgoing
- - zero-transfer
- FungibleInfo:
- type: object
- properties:
- symbol:
- type: string
- description: The symbol of the fungible token.
- example: USDC
- name:
- type: string
- description: The full name of the fungible token.
- example: USD Coin
- supply:
- type: string
- description: The total supply of the fungible token.
- example: "1000000000"
- decimals:
- type: number
- description: The number of decimal places for the fungible token.
- example: 6
- tokenType:
- type: string
- description: The type of the token (e.g., ERC20, BEP20).
- example: ERC20
- cap:
- type: string
- description: The maximum supply cap of the fungible token.
- example: "2000000000"
- FungibleInfoTezos:
- type: object
- properties:
- symbol:
- type: string
- description: The symbol of the fungible token.
- example: USDC
- name:
- type: string
- description: The full name of the fungible token.
- example: USD Coin
- description:
- type: string
- description: The describtion of the fungible token.
- example: USD Coin
- supply:
- type: string
- description: The total supply of the fungible token.
- example: "1000000000"
- decimals:
- type: number
- description: The number of decimal places for the fungible token.
- example: 6
- tokenType:
- type: string
- description: The type of the token (e.g., fungible, nft).
- example: fungible
- NftInfo:
- type: object
- properties:
- symbol:
- type: string
- description: The symbol of the NFT collection.
- example: ART
- name:
- type: string
- description: The full name of the NFT collection.
- example: Art Collection
- supply:
- type: string
- description: The total supply of the NFT collection.
- example: "5000"
- tokenType:
- type: string
- description: The type of the token (e.g., ERC721, ERC1155).
- example: ERC721
- NftInfoTezos:
- type: object
- properties:
- name:
- type: string
- description: The full name of the NFT collection.
- example: Art Collection
- description:
- type: string
- description: The total supply of the NFT collection.
- example: "5000"
- tokenType:
- type: string
- description: The type of the token (e.g., ERC721, ERC1155).
- example: ERC721
- contractMetadata:
- type: object
- description: Additional information about the contract
- MultitokenInfo:
- type: object
- properties:
- symbol:
- type: string
- description: The symbol of the multitoken collection.
- example: GAME
- name:
- type: string
- description: The full name of the multitoken collection.
- example: Game Assets
- tokenType:
- type: string
- description: The type of the token (e.g., ERC1155).
- example: ERC1155
- NftTokenInfo:
- type: object
- properties:
- symbol:
- type: string
- description: The symbol of the NFT token.
- example: ART
- name:
- type: string
- description: The name of the NFT token.
- example: Mona Lisa
- metadata:
- type: object
- description: The metadata associated with the NFT token.
- example:
- artist: Leonardo da Vinci
- year: 1503
- metadataURI:
- type: string
- description: The URI of the metadata associated with the NFT token.
- example: https://example.com/metadata/123
- tokenType:
- type: string
- description: The type of the token (e.g., ERC721, ERC1155).
- example: ERC721
- Token:
- type: object
- properties:
- chain:
- $ref: "#/components/schemas/Chain"
- tokenId:
- $ref: "#/components/schemas/TokenId"
- tokenAddress:
- $ref: "#/components/schemas/TokenAddress"
- tokenType:
- $ref: "#/components/schemas/TokenType"
- metadataURI:
- $ref: "#/components/schemas/NftMetadataURI"
- metadata:
- $ref: "#/components/schemas/NftMetadata"
- TokenTezos:
- type: object
- properties:
- chain:
- $ref: "#/components/schemas/Chain"
- tokenId:
- $ref: "#/components/schemas/TokenId"
- tokenAddress:
- $ref: "#/components/schemas/TokenAddress"
- tokenType:
- $ref: "#/components/schemas/TokenType"
- creator:
- type: string
- description: Address of the token creator.
- example: tz1hkNPg5jQ66pJpZH2boiF5AnbAcd1dt5KS
- name:
- type: string
- description: Name of the token.
- example: My token 1
- Chain:
- type: string
- description: Name of the chain.
- example: ethereum
- ChainEnum:
- type: string
- example: ethereum
- enum:
- - ethereum
- - ethereum-sepolia
- - celo
- - celo-testnet
- - bsc
- - bsc-testnet
- - polygon
- - polygon-mumbai
- - eon
- - chiliz
- ChainEnumExtended:
- type: string
- example: ethereum
- enum:
- - ethereum
- - ethereum-sepolia
- - celo
- - celo-testnet
- - bsc
- - bsc-testnet
- - polygon
- - polygon-mumbai
- - tezos
- - eon
- - chiliz
- ChainUtxoEnum:
- type: string
- example: bitcoin
- enum:
- - bitcoin
- - bitcoin-testnet
- - litecoin
- - litecoin-testnet
- - doge
- - doge-testnet
- - cardano
- - cardano-preprod
- TokenId:
- type: string
- description: ID of the token.
- maxLength: 78
- example: "3"
- format: uint256
- TokenIds:
- type: string
- description: IDs of the token.
- maxLength: 78
- example: 3,4
- format: uint256
- TokenAddress:
- type: string
- description: Contract address of the token.
- example: "0x524cab2ec69124574082676e6f654a18df49a048"
- ExcludeMetadata:
- type: boolean
- example: false
- NftMetadataURI:
- type: string
- description: >
- Metadata URL of the token. This data doesn't have to be present.
-
- The safest way to obtain them in that case is from the NFT
- Contract.tokenURI() method call.
- example: ipfs://QmTDcCdt3yb6mZitzWBmQr65AW6Wska295Dg9nbEYpSUDR/3
- NftMetadata:
- type: object
- description: >
- Metadata scheme obtained from the url. This data don't have to be
- present.
-
- The safest way to obtain them in that case is from the NFT
- Contract.tokenURI() method call.
- example:
- image: ipfs://QmamEqaaVttv9AvfgM4Wa7d9Ettonep1NBQSDCtM7THUSX
- attributes:
- - trait_type: Background
- value: Club Exterior
- - trait_type: Fur
- value: Radioactive
- - trait_type: Back
- value: Beer Kegs
- - trait_type: Mouth
- value: Goofball
- - trait_type: Eyes
- value: Closed
- BlockNumber:
- type: number
- example: 16499510
- minimum: 0
- BlockNumberTo:
- type: number
- example: 16779230
- minimum: 0
- PageSize:
- type: number
- example: 10
- minimum: 1
- maximum: 50
- Cursor:
- type: string
- description: >
- Cursor pagination, used to get next page or previous page of results.
- The size of result is defined by the `pageSize` parameter.
-
- The cursor is a base64 encoded string, user can get the value from a
- response in the `nextPage` or `prevPage` field.
-
- If the nextPage or prevPage fields are not present in the response body,
- pagination is usually available with the `offset` and `pageSize`
- parameters.
- example: MzYxNTQ3MHwyNDV8cHJldg==
- Offset:
- type: number
- example: 0
- securitySchemes:
- X-API-Key:
- type: apiKey
- name: x-api-key
- in: header
- description: >
- The **API key** represents your [pricing plan](https://tatum.io/pricing)
- and defines how many API calls
-
- you can make per second and what the total number of API calls per month
- is available for you.
-
-
- One API key must be used by only one person.
-
-
- Choose one of the following authentication methods:
-
-
- * **Provide the API key in each API call.**
-
- To obtain the API key, [create a Tatum account](https://dashboard.tatum.io/sign-up). Once you are logged in,
- you are automatically assigned the Free plan.
-
- With the Free plan:
- * You get two API keys, one tied to the testnet of a blockchain and the other to the mainnet.
- * You can make up to five API calls per second.
- * The number of API calls per month is not limited.
-
- When making an API call, provide the appropriate API key (testnet or mainnet) as either an HTTP header
- or a path parameter of the API call.
-
- If you ever need your API keys, you can find them in [your Tatum account](https://dashboard.tatum.io/).
-
- For more information about the Free plan and paid plans, refer to [this article](https://docs.tatum.io/payments/plans-and-pricing).
-
- * **Get an auto-generated API key attached to API calls.**
-
- Make an API call without any API key provided. The API key will be generated and tied to your IP address.
- This API key is stored within the Tatum platform and is automatically attached to all your API calls.
-
- With the auto-generated API key:
- * You can make up to five API calls per second.
- * You get 10,000,000 credits to spend on API calls within a month.
-
- The number of credits is reset on the first day of a month. The unused credits from the current month are not
- rolled over to the next month.
-
- These limits are applied to both the testnet and mainnet.
-
- By default, API calls with the auto-generated API key are executed against the mainnet.
- To make an API call to the testnet, add the `type` query parameter set to `testnet` to the endpoint URL,
- for example:
-
- `https://api.tatum.io/v3/ledger/account?type=testnet`
diff --git a/components/schemas/AddMultiTokenMinter.yml b/components/schemas/AddMultiTokenMinter.yml
index ae8c4ff..ad877e4 100644
--- a/components/schemas/AddMultiTokenMinter.yml
+++ b/components/schemas/AddMultiTokenMinter.yml
@@ -12,6 +12,9 @@ properties:
- CELO
- ONE
- BSC
+ - FLR
+ - CRO
+ - BASE
contractAddress:
maxLength: 42
minLength: 42
diff --git a/components/schemas/AddNftMinter.yml b/components/schemas/AddNftMinter.yml
index ec62bfb..669d804 100644
--- a/components/schemas/AddNftMinter.yml
+++ b/components/schemas/AddNftMinter.yml
@@ -13,6 +13,9 @@ properties:
- MATIC
- ONE
- ZEN
+ - FLR
+ - CRO
+ - BASE
contractAddress:
maxLength: 42
minLength: 42
diff --git a/components/schemas/ApproveErc20.yml b/components/schemas/ApproveErc20.yml
index c4b477e..d611ac1 100644
--- a/components/schemas/ApproveErc20.yml
+++ b/components/schemas/ApproveErc20.yml
@@ -10,6 +10,9 @@ properties:
- MATIC
- KLAY
- ONE
+ - FLR
+ - CRO
+ - BASE
contractAddress:
maxLength: 43
minLength: 42
diff --git a/components/schemas/BalanceItem.yml b/components/schemas/BalanceItem.yml
index 77bf020..72ca28e 100644
--- a/components/schemas/BalanceItem.yml
+++ b/components/schemas/BalanceItem.yml
@@ -1,4 +1,4 @@
oneOf:
- - $ref: "../migrated.yml#/components/schemas/NativeTokenBalance"
- - $ref: "../migrated.yml#/components/schemas/NftBalance"
- - $ref: "../migrated.yml#/components/schemas/FungibleTokenBalance"
+ - $ref: "../migrated_v1.yml#/components/schemas/NativeTokenBalance"
+ - $ref: "../migrated_v1.yml#/components/schemas/NftBalance"
+ - $ref: "../migrated_v1.yml#/components/schemas/FungibleTokenBalance"
diff --git a/components/schemas/BaseBalance.yml b/components/schemas/BaseBalance.yml
new file mode 100644
index 0000000..c9c9d54
--- /dev/null
+++ b/components/schemas/BaseBalance.yml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ balance:
+ type: string
+ description: Balance in BASE
+ example: "10.52"
diff --git a/components/schemas/BaseBlock.yml b/components/schemas/BaseBlock.yml
new file mode 100644
index 0000000..3a4d5d8
--- /dev/null
+++ b/components/schemas/BaseBlock.yml
@@ -0,0 +1,81 @@
+type: object
+properties:
+ difficulty:
+ description: Difficulty for this block.
+ type: string
+ example: "3296820833"
+ extraData:
+ description: The 'extra data' field of this block.
+ type: string
+ example: 0x
+ gasLimit:
+ description: The maximum gas allowed in this block.
+ type: number
+ example: 8000000
+ gasUsed:
+ description: The total used gas by all transactions in this block.
+ type: number
+ example: 7985124
+ hash:
+ description: Hash of the block. 'null' when its pending block.
+ type: string
+ example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
+ logsBloom:
+ description:
+ The bloom filter for the logs of the block. 'null' when its pending
+ block.
+ type: string
+ example: "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
+ miner:
+ description: The address of the beneficiary to whom the mining rewards were given.
+ type: string
+ example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
+ mixHash:
+ description: ""
+ type: string
+ example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
+ nonce:
+ description: Hash of the generated proof-of-work. 'null' when its pending block.
+ type: string
+ example: "0xfa1692f52a7ac672"
+ number:
+ description: The block number. 'null' when its pending block.
+ type: number
+ example: 6470657
+ parentHash:
+ description: Hash of the parent block.
+ type: string
+ example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
+ receiptsRoot:
+ description: ""
+ type: string
+ example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
+ sha3Uncles:
+ description: SHA3 of the uncles data in the block.
+ type: string
+ example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
+ size:
+ description: The size of this block in bytes.
+ type: number
+ example: 15296
+ stateRoot:
+ description: The root of the final state trie of the block.
+ type: string
+ example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
+ timestamp:
+ description: The unix timestamp for when the block was collated.
+ type: number
+ example: 1569600592
+ totalDifficulty:
+ description: Total difficulty of the chain until this block.
+ type: string
+ example: "23329673338013873"
+ transactions:
+ description: Array of transactions.
+ type: array
+ items:
+ $ref: "../migrated.yml#/components/schemas/BaseTx"
+ transactionsRoot:
+ description: The root of the transaction trie of the block.
+ type: string
+ example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
diff --git a/components/schemas/BaseEstimateGas.yml b/components/schemas/BaseEstimateGas.yml
new file mode 100644
index 0000000..8a1dd14
--- /dev/null
+++ b/components/schemas/BaseEstimateGas.yml
@@ -0,0 +1,31 @@
+type: object
+properties:
+ from:
+ type: string
+ maxLength: 42
+ example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
+ minLength: 42
+ description: Sender address.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ amount:
+ description: Amount to be sent in Base.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ pattern: ^(0x|0h)?[0-9A-F]+$
+required:
+ - to
+ - amount
+ - from
diff --git a/components/schemas/BaseTx.yml b/components/schemas/BaseTx.yml
new file mode 100644
index 0000000..77d8401
--- /dev/null
+++ b/components/schemas/BaseTx.yml
@@ -0,0 +1,109 @@
+type: object
+properties:
+ blockHash:
+ description: Hash of the block where this transaction was in.
+ type: string
+ example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
+ status:
+ type: boolean
+ example: true
+ description:
+ TRUE if the transaction was successful, FALSE, if the EVM reverted
+ the transaction.
+ blockNumber:
+ type: number
+ description: Block number where this transaction was in.
+ example: 6470854
+ from:
+ type: string
+ description: Address of the sender.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ gas:
+ type: number
+ description: Gas provided by the sender.
+ example: 21000
+ gasPrice:
+ type: string
+ description: Gas price provided by the sender in wei.
+ example: "1000000000"
+ transactionHash:
+ type: string
+ description: Hash of the transaction.
+ example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
+ input:
+ type: string
+ description: The data sent along with the transaction.
+ example: 0x
+ nonce:
+ type: number
+ description: The number of transactions made by the sender prior to this one.
+ example: 26836405
+ to:
+ type: string
+ description: Address of the receiver. 'null' when its a contract creation transaction.
+ example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
+ transactionIndex:
+ type: number
+ description: Integer of the transactions index position in the block.
+ example: 3
+ value:
+ type: string
+ description: Value transferred in wei.
+ example: "1000000000000000000"
+ gasUsed:
+ type: number
+ description: The amount of gas used by this specific transaction alone.
+ example: 21000
+ cumulativeGasUsed:
+ type: number
+ description:
+ The total amount of gas used when this transaction was executed in
+ the block.
+ example: 314159
+ contractAddress:
+ type: string
+ description:
+ The contract address created, if the transaction was a contract creation,
+ otherwise null.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ logs:
+ type: array
+ description: Log events, that happened in this transaction.
+ items:
+ type: object
+ properties:
+ address:
+ type: string
+ description: From which this event originated from.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ topics:
+ type: array
+ description:
+ An array with max 4 32 Byte topics, topic 1-3 contains indexed
+ parameters of the log.
+ items:
+ type: string
+ example: "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
+ data:
+ type: string
+ description: The data containing non-indexed log parameter.
+ logIndex:
+ type: number
+ description: Integer of the event index position in the block.
+ blockNumber:
+ type: number
+ description: Block number where this transaction was in.
+ example: 6470854
+ blockHash:
+ description: Hash of the block.
+ type: string
+ example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
+ transactionIndex:
+ type: number
+ description:
+ "Integer of the transaction\u2019s index position, the event\
+ \ was created in."
+ transactionHash:
+ type: string
+ description: Hash of the transaction this event was created in.
+ example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
diff --git a/components/schemas/BtcGetTxByAddressBatch.yml b/components/schemas/BtcGetTxByAddressBatch.yml
new file mode 100644
index 0000000..a313af1
--- /dev/null
+++ b/components/schemas/BtcGetTxByAddressBatch.yml
@@ -0,0 +1,23 @@
+type: object
+properties:
+ txType:
+ description:
+ Type of the transaction to fetch - either incoming, or outgoing.
+ If none is present - all transactions are fetched.
+ type: string
+ example: incoming
+ enum:
+ - incoming
+ - outgoing
+ addresses:
+ description: Addresses
+ type: array
+ items:
+ type: string
+ maxItems: 50
+ minItems: 1
+ example:
+ - bc1qdj8dxppx6gyukpemsqx06a39877rt8kcc08uqs
+ - bc1qjwqv9qqnen2gmkqm57p2tl5pqqsyh0xnr7wnk2
+required:
+ - addresses
diff --git a/components/schemas/BurnMultiToken.yml b/components/schemas/BurnMultiToken.yml
index 0595de4..c27e7c7 100644
--- a/components/schemas/BurnMultiToken.yml
+++ b/components/schemas/BurnMultiToken.yml
@@ -11,6 +11,9 @@ properties:
- KCS
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
account:
maxLength: 42
minLength: 42
diff --git a/components/schemas/BurnMultiTokenBatch.yml b/components/schemas/BurnMultiTokenBatch.yml
index 24b5039..f19d46b 100644
--- a/components/schemas/BurnMultiTokenBatch.yml
+++ b/components/schemas/BurnMultiTokenBatch.yml
@@ -11,6 +11,9 @@ properties:
- KCS
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
account:
maxLength: 42
minLength: 42
diff --git a/components/schemas/BurnNft.yml b/components/schemas/BurnNft.yml
index 191e5e8..b035ef1 100644
--- a/components/schemas/BurnNft.yml
+++ b/components/schemas/BurnNft.yml
@@ -12,6 +12,9 @@ properties:
- KLAY
- BSC
- ZEN
+ - FLR
+ - CRO
+ - BASE
tokenId:
description: The ID of the NFT to burn
type: string
diff --git a/components/schemas/CallBaseSmartContractMethod.yml b/components/schemas/CallBaseSmartContractMethod.yml
new file mode 100644
index 0000000..063e5dc
--- /dev/null
+++ b/components/schemas/CallBaseSmartContractMethod.yml
@@ -0,0 +1,75 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ amount:
+ description: Amount of the assets to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+ fromPrivateKey:
+ type: string
+ maxLength: 66
+ example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
+ minLength: 66
+ description:
+ Private key of sender address. Private key, or signature Id must
+ be present.
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Base transaction. If not present, last known nonce
+ will be used.
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ pattern: ^[+]?\d+$
+ example: "40000"
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ pattern: ^[+]?\d+$
+ example: "20"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - fromPrivateKey
+ - methodName
diff --git a/components/schemas/CallBaseSmartContractMethodCaller.yml b/components/schemas/CallBaseSmartContractMethodCaller.yml
new file mode 100644
index 0000000..28cc330
--- /dev/null
+++ b/components/schemas/CallBaseSmartContractMethodCaller.yml
@@ -0,0 +1,55 @@
+type: object
+properties:
+ caller:
+ maxLength: 42
+ minLength: 42
+ description:
+ The address of the account, which will be sender and fee payer of
+ this transaction
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0xC9c8ba8C7e2EAF43e84330Db08915A8106d7bD74"
+ type: string
+ amount:
+ description: Amount of the assets to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+ fee:
+ $ref: "../migrated.yml#/components/schemas/CustomFee"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - fromPrivateKey
+ - methodName
+ - caller
diff --git a/components/schemas/CallBaseSmartContractMethodKMS.yml b/components/schemas/CallBaseSmartContractMethodKMS.yml
new file mode 100644
index 0000000..994549c
--- /dev/null
+++ b/components/schemas/CallBaseSmartContractMethodKMS.yml
@@ -0,0 +1,66 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked.
+ index:
+ type: number
+ minimum: 0
+ description:
+ If signatureId is mnemonic-based, this is the index to the specific
+ address from that mnemonic.
+ signatureId:
+ type: string
+ format: uuid
+ example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
+ description:
+ Identifier of the private key associated in signing application.
+ Private key, or signature Id must be present.
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Base transaction. If not present, last known nonce
+ will be used.
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ pattern: ^[+]?\d+$
+ example: "40000"
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ pattern: ^[+]?\d+$
+ example: "20"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - signatureId
+ - methodName
diff --git a/components/schemas/CallBaseSmartContractReadMethod.yml b/components/schemas/CallBaseSmartContractReadMethod.yml
new file mode 100644
index 0000000..7aefd5b
--- /dev/null
+++ b/components/schemas/CallBaseSmartContractReadMethod.yml
@@ -0,0 +1,38 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - methodName
diff --git a/components/schemas/CallCronosSmartContractMethod.yml b/components/schemas/CallCronosSmartContractMethod.yml
new file mode 100644
index 0000000..a65abd2
--- /dev/null
+++ b/components/schemas/CallCronosSmartContractMethod.yml
@@ -0,0 +1,75 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ amount:
+ description: Amount of the assets to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+ fromPrivateKey:
+ type: string
+ maxLength: 66
+ example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
+ minLength: 66
+ description:
+ Private key of sender address. Private key, or signature Id must
+ be present.
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Cronos transaction. If not present, last known
+ nonce will be used.
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ pattern: ^[+]?\d+$
+ example: "40000"
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ pattern: ^[+]?\d+$
+ example: "20"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - fromPrivateKey
+ - methodName
diff --git a/components/schemas/CallCronosSmartContractMethodCaller.yml b/components/schemas/CallCronosSmartContractMethodCaller.yml
new file mode 100644
index 0000000..28cc330
--- /dev/null
+++ b/components/schemas/CallCronosSmartContractMethodCaller.yml
@@ -0,0 +1,55 @@
+type: object
+properties:
+ caller:
+ maxLength: 42
+ minLength: 42
+ description:
+ The address of the account, which will be sender and fee payer of
+ this transaction
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0xC9c8ba8C7e2EAF43e84330Db08915A8106d7bD74"
+ type: string
+ amount:
+ description: Amount of the assets to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+ fee:
+ $ref: "../migrated.yml#/components/schemas/CustomFee"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - fromPrivateKey
+ - methodName
+ - caller
diff --git a/components/schemas/CallCronosSmartContractMethodKMS.yml b/components/schemas/CallCronosSmartContractMethodKMS.yml
new file mode 100644
index 0000000..255670a
--- /dev/null
+++ b/components/schemas/CallCronosSmartContractMethodKMS.yml
@@ -0,0 +1,66 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked.
+ index:
+ type: number
+ minimum: 0
+ description:
+ If signatureId is mnemonic-based, this is the index to the specific
+ address from that mnemonic.
+ signatureId:
+ type: string
+ format: uuid
+ example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
+ description:
+ Identifier of the private key associated in signing application.
+ Private key, or signature Id must be present.
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Cronos transaction. If not present, last known
+ nonce will be used.
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ pattern: ^[+]?\d+$
+ example: "40000"
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ pattern: ^[+]?\d+$
+ example: "20"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - signatureId
+ - methodName
diff --git a/components/schemas/CallCronosSmartContractReadMethod.yml b/components/schemas/CallCronosSmartContractReadMethod.yml
new file mode 100644
index 0000000..7aefd5b
--- /dev/null
+++ b/components/schemas/CallCronosSmartContractReadMethod.yml
@@ -0,0 +1,38 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - methodName
diff --git a/components/schemas/CallFlareSmartContractMethod.yml b/components/schemas/CallFlareSmartContractMethod.yml
new file mode 100644
index 0000000..78e7c62
--- /dev/null
+++ b/components/schemas/CallFlareSmartContractMethod.yml
@@ -0,0 +1,75 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ amount:
+ description: Amount of the assets to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+ fromPrivateKey:
+ type: string
+ maxLength: 66
+ example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
+ minLength: 66
+ description:
+ Private key of sender address. Private key, or signature Id must
+ be present.
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Flare transaction. If not present, last known
+ nonce will be used.
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ pattern: ^[+]?\d+$
+ example: "40000"
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ pattern: ^[+]?\d+$
+ example: "20"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - fromPrivateKey
+ - methodName
diff --git a/components/schemas/CallFlareSmartContractMethodCaller.yml b/components/schemas/CallFlareSmartContractMethodCaller.yml
new file mode 100644
index 0000000..28cc330
--- /dev/null
+++ b/components/schemas/CallFlareSmartContractMethodCaller.yml
@@ -0,0 +1,55 @@
+type: object
+properties:
+ caller:
+ maxLength: 42
+ minLength: 42
+ description:
+ The address of the account, which will be sender and fee payer of
+ this transaction
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0xC9c8ba8C7e2EAF43e84330Db08915A8106d7bD74"
+ type: string
+ amount:
+ description: Amount of the assets to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+ fee:
+ $ref: "../migrated.yml#/components/schemas/CustomFee"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - fromPrivateKey
+ - methodName
+ - caller
diff --git a/components/schemas/CallFlareSmartContractMethodKMS.yml b/components/schemas/CallFlareSmartContractMethodKMS.yml
new file mode 100644
index 0000000..8e32250
--- /dev/null
+++ b/components/schemas/CallFlareSmartContractMethodKMS.yml
@@ -0,0 +1,66 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked.
+ index:
+ type: number
+ minimum: 0
+ description:
+ If signatureId is mnemonic-based, this is the index to the specific
+ address from that mnemonic.
+ signatureId:
+ type: string
+ format: uuid
+ example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
+ description:
+ Identifier of the private key associated in signing application.
+ Private key, or signature Id must be present.
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Flare transaction. If not present, last known
+ nonce will be used.
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ pattern: ^[+]?\d+$
+ example: "40000"
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ pattern: ^[+]?\d+$
+ example: "20"
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - signatureId
+ - methodName
diff --git a/components/schemas/CallFlareSmartContractReadMethod.yml b/components/schemas/CallFlareSmartContractReadMethod.yml
new file mode 100644
index 0000000..7aefd5b
--- /dev/null
+++ b/components/schemas/CallFlareSmartContractReadMethod.yml
@@ -0,0 +1,38 @@
+type: object
+properties:
+ contractAddress:
+ maxLength: 42
+ minLength: 42
+ description: The address of the smart contract
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ type: string
+ methodName:
+ minLength: 1
+ maxLength: 500
+ description: Name of the method to invoke on smart contract.
+ type: string
+ example: transfer
+ methodABI:
+ type: object
+ example:
+ inputs:
+ - internalType: uint256
+ name: amount
+ type: uint256
+ name: stake
+ outputs: []
+ stateMutability: nonpayable
+ type: function
+ description: ABI of the method to invoke.
+ params:
+ type: array
+ example:
+ - "0x632"
+ items:
+ type: string
+ description: Parameters of the method to be invoked
+required:
+ - contractAddress
+ - params
+ - methodABI
+ - methodName
diff --git a/components/schemas/ChainBurnErc20.yml b/components/schemas/ChainBurnErc20.yml
index c9e9d68..b9b4a77 100644
--- a/components/schemas/ChainBurnErc20.yml
+++ b/components/schemas/ChainBurnErc20.yml
@@ -11,6 +11,9 @@ properties:
- KLAY
- XDC
- ONE
+ - FLR
+ - CRO
+ - BASE
amount:
description: Amount of tokens to be destroyed.
example: "100000"
diff --git a/components/schemas/ChainDeployErc20.yml b/components/schemas/ChainDeployErc20.yml
index 28d3c51..9760849 100644
--- a/components/schemas/ChainDeployErc20.yml
+++ b/components/schemas/ChainDeployErc20.yml
@@ -11,6 +11,9 @@ properties:
- KLAY
- XDC
- ONE
+ - FLR
+ - CRO
+ - BASE
symbol:
description: Symbol of the ERC20 token
example: ERC_SYMBOL
diff --git a/components/schemas/ChainMintErc20.yml b/components/schemas/ChainMintErc20.yml
index 6f7feca..fe30aa7 100644
--- a/components/schemas/ChainMintErc20.yml
+++ b/components/schemas/ChainMintErc20.yml
@@ -11,6 +11,9 @@ properties:
- KLAY
- XDC
- ONE
+ - FLR
+ - CRO
+ - BASE
amount:
description: Amount to be minted and transferred to the recipient.
example: "100000"
diff --git a/components/schemas/ChainTransferEthErc20.yml b/components/schemas/ChainTransferEthErc20.yml
index b75c659..e65084f 100644
--- a/components/schemas/ChainTransferEthErc20.yml
+++ b/components/schemas/ChainTransferEthErc20.yml
@@ -11,6 +11,9 @@ properties:
- KLAY
- XDC
- ONE
+ - FLR
+ - CRO
+ - BASE
to:
maxLength: 50
minLength: 1
diff --git a/components/schemas/ChainUtxoEnum.yml b/components/schemas/ChainUtxoEnum.yml
index 3366a08..36dd9b3 100644
--- a/components/schemas/ChainUtxoEnum.yml
+++ b/components/schemas/ChainUtxoEnum.yml
@@ -1,11 +1,16 @@
+description: The blockchain to work with.
type: string
example: bitcoin
enum:
- bitcoin
+ - bitcoin-mainnet
- bitcoin-testnet
- litecoin
+ - litecoin-mainnet
- litecoin-testnet
- doge
+ - doge-mainnet
- doge-testnet
- cardano
+ - cardano-mainnet
- cardano-preprod
diff --git a/components/schemas/CreateContractAddressLogEventSubscription.yml b/components/schemas/CreateContractAddressLogEventSubscription.yml
index 19b34a9..1f42f9f 100644
--- a/components/schemas/CreateContractAddressLogEventSubscription.yml
+++ b/components/schemas/CreateContractAddressLogEventSubscription.yml
@@ -12,10 +12,11 @@ properties:
description: Additional attributes based on the subscription type.
required:
- chain
- - address
+ - contractAddress
+ - event
- url
properties:
- address:
+ contractAddress:
description: Blockchain address to watch.
example: FykfMwA9WNShzPJbbb9DNXsfgDgS3XZzWiFgrVXfWoPJ
maxLength: 128
diff --git a/components/schemas/CreateSubscriptionContractLogEvent.yml b/components/schemas/CreateSubscriptionContractLogEvent.yml
index 8927871..deee963 100644
--- a/components/schemas/CreateSubscriptionContractLogEvent.yml
+++ b/components/schemas/CreateSubscriptionContractLogEvent.yml
@@ -35,6 +35,9 @@ properties:
- CELO
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
url:
type: string
description:
diff --git a/components/schemas/CreateSubscriptionMultiTokenTransferEvent.yml b/components/schemas/CreateSubscriptionMultiTokenTransferEvent.yml
index 1dbd166..4fe2825 100644
--- a/components/schemas/CreateSubscriptionMultiTokenTransferEvent.yml
+++ b/components/schemas/CreateSubscriptionMultiTokenTransferEvent.yml
@@ -26,6 +26,9 @@ properties:
- CELO
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
url:
type: string
description:
diff --git a/components/schemas/CreateSubscriptionNftTransferEvent.yml b/components/schemas/CreateSubscriptionNftTransferEvent.yml
index b3c8705..6176b3f 100644
--- a/components/schemas/CreateSubscriptionNftTransferEvent.yml
+++ b/components/schemas/CreateSubscriptionNftTransferEvent.yml
@@ -26,6 +26,9 @@ properties:
- CELO
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
url:
type: string
description:
diff --git a/components/schemas/CreateSubscriptionNotification.yml b/components/schemas/CreateSubscriptionNotification.yml
index 233a27a..021499a 100644
--- a/components/schemas/CreateSubscriptionNotification.yml
+++ b/components/schemas/CreateSubscriptionNotification.yml
@@ -6,9 +6,22 @@ properties:
type:
type: string
description: Type of the subscription.
- example: ADDRESS_TRANSACTION
+ example: ADDRESS_EVENT
enum:
- - ADDRESS_TRANSACTION
+ - ADDRESS_EVENT
+ - INCOMING_NATIVE_TX
+ - OUTGOING_NATIVE_TX
+ - OUTGOING_FAILED_TX
+ - PAID_FEE
+ - INCOMING_INTERNAL_TX
+ - OUTGOING_INTERNAL_TX
+ - INCOMING_FUNGIBLE_TX
+ - OUTGOING_FUNGIBLE_TX
+ - INCOMING_NFT_TX
+ - OUTGOING_NFT_TX
+ - INCOMING_MULTITOKEN_TX
+ - OUTGOING_MULTITOKEN_TX
+ - CONTRACT_ADDRESS_LOG_EVENT
attr:
type: object
description: Additional attributes based on the subscription type.
@@ -39,6 +52,7 @@ properties:
- DOGE
- TRON
- BSC
+ - TEZOS
url:
type: string
description:
diff --git a/components/schemas/CreateSubscriptionTxInTheBlock.yml b/components/schemas/CreateSubscriptionTxInTheBlock.yml
index 5813cf2..7371b84 100644
--- a/components/schemas/CreateSubscriptionTxInTheBlock.yml
+++ b/components/schemas/CreateSubscriptionTxInTheBlock.yml
@@ -6,14 +6,15 @@ properties:
type:
type: string
description: Type of the subscription.
- example: TRANSACTION_IN_THE_BLOCK
+ example: FAILED_TX_PER_BLOCK
enum:
- - TRANSACTION_IN_THE_BLOCK
+ - FAILED_TX_PER_BLOCK
attr:
type: object
description: Additional attributes based on the subscription type.
required:
- url
+ - chain
properties:
url:
type: string
@@ -22,3 +23,20 @@ properties:
outgoing ledger transaction is included in the block.
example: https://dashboard.tatum.io/webhook-handler
maxLength: 500
+ chain:
+ description: Blockchain of the address.
+ example: SOL
+ type: string
+ enum:
+ - SOL
+ - ETH
+ - MATIC
+ - CELO
+ - KLAY
+ - BTC
+ - LTC
+ - BCH
+ - DOGE
+ - TRON
+ - BSC
+ - TEZOS
diff --git a/components/schemas/CronosBalance.yml b/components/schemas/CronosBalance.yml
new file mode 100644
index 0000000..cfb6455
--- /dev/null
+++ b/components/schemas/CronosBalance.yml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ balance:
+ type: string
+ description: Balance in CRO
+ example: "10.52"
diff --git a/components/schemas/CronosBlock.yml b/components/schemas/CronosBlock.yml
new file mode 100644
index 0000000..f54813a
--- /dev/null
+++ b/components/schemas/CronosBlock.yml
@@ -0,0 +1,81 @@
+type: object
+properties:
+ difficulty:
+ description: Difficulty for this block.
+ type: string
+ example: "3296820833"
+ extraData:
+ description: The 'extra data' field of this block.
+ type: string
+ example: 0x
+ gasLimit:
+ description: The maximum gas allowed in this block.
+ type: number
+ example: 8000000
+ gasUsed:
+ description: The total used gas by all transactions in this block.
+ type: number
+ example: 7985124
+ hash:
+ description: Hash of the block. 'null' when its pending block.
+ type: string
+ example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
+ logsBloom:
+ description:
+ The bloom filter for the logs of the block. 'null' when its pending
+ block.
+ type: string
+ example: "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
+ miner:
+ description: The address of the beneficiary to whom the mining rewards were given.
+ type: string
+ example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
+ mixHash:
+ description: ""
+ type: string
+ example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
+ nonce:
+ description: Hash of the generated proof-of-work. 'null' when its pending block.
+ type: string
+ example: "0xfa1692f52a7ac672"
+ number:
+ description: The block number. 'null' when its pending block.
+ type: number
+ example: 6470657
+ parentHash:
+ description: Hash of the parent block.
+ type: string
+ example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
+ receiptsRoot:
+ description: ""
+ type: string
+ example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
+ sha3Uncles:
+ description: SHA3 of the uncles data in the block.
+ type: string
+ example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
+ size:
+ description: The size of this block in bytes.
+ type: number
+ example: 15296
+ stateRoot:
+ description: The root of the final state trie of the block.
+ type: string
+ example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
+ timestamp:
+ description: The unix timestamp for when the block was collated.
+ type: number
+ example: 1569600592
+ totalDifficulty:
+ description: Total difficulty of the chain until this block.
+ type: string
+ example: "23329673338013873"
+ transactions:
+ description: Array of transactions.
+ type: array
+ items:
+ $ref: "../migrated.yml#/components/schemas/CronosTx"
+ transactionsRoot:
+ description: The root of the transaction trie of the block.
+ type: string
+ example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
diff --git a/components/schemas/CronosEstimateGas.yml b/components/schemas/CronosEstimateGas.yml
new file mode 100644
index 0000000..d1577fd
--- /dev/null
+++ b/components/schemas/CronosEstimateGas.yml
@@ -0,0 +1,31 @@
+type: object
+properties:
+ from:
+ type: string
+ maxLength: 42
+ example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
+ minLength: 42
+ description: Sender address.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ amount:
+ description: Amount to be sent in Cronos.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ pattern: ^(0x|0h)?[0-9A-F]+$
+required:
+ - to
+ - amount
+ - from
diff --git a/components/schemas/CronosTx.yml b/components/schemas/CronosTx.yml
new file mode 100644
index 0000000..77d8401
--- /dev/null
+++ b/components/schemas/CronosTx.yml
@@ -0,0 +1,109 @@
+type: object
+properties:
+ blockHash:
+ description: Hash of the block where this transaction was in.
+ type: string
+ example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
+ status:
+ type: boolean
+ example: true
+ description:
+ TRUE if the transaction was successful, FALSE, if the EVM reverted
+ the transaction.
+ blockNumber:
+ type: number
+ description: Block number where this transaction was in.
+ example: 6470854
+ from:
+ type: string
+ description: Address of the sender.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ gas:
+ type: number
+ description: Gas provided by the sender.
+ example: 21000
+ gasPrice:
+ type: string
+ description: Gas price provided by the sender in wei.
+ example: "1000000000"
+ transactionHash:
+ type: string
+ description: Hash of the transaction.
+ example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
+ input:
+ type: string
+ description: The data sent along with the transaction.
+ example: 0x
+ nonce:
+ type: number
+ description: The number of transactions made by the sender prior to this one.
+ example: 26836405
+ to:
+ type: string
+ description: Address of the receiver. 'null' when its a contract creation transaction.
+ example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
+ transactionIndex:
+ type: number
+ description: Integer of the transactions index position in the block.
+ example: 3
+ value:
+ type: string
+ description: Value transferred in wei.
+ example: "1000000000000000000"
+ gasUsed:
+ type: number
+ description: The amount of gas used by this specific transaction alone.
+ example: 21000
+ cumulativeGasUsed:
+ type: number
+ description:
+ The total amount of gas used when this transaction was executed in
+ the block.
+ example: 314159
+ contractAddress:
+ type: string
+ description:
+ The contract address created, if the transaction was a contract creation,
+ otherwise null.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ logs:
+ type: array
+ description: Log events, that happened in this transaction.
+ items:
+ type: object
+ properties:
+ address:
+ type: string
+ description: From which this event originated from.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ topics:
+ type: array
+ description:
+ An array with max 4 32 Byte topics, topic 1-3 contains indexed
+ parameters of the log.
+ items:
+ type: string
+ example: "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
+ data:
+ type: string
+ description: The data containing non-indexed log parameter.
+ logIndex:
+ type: number
+ description: Integer of the event index position in the block.
+ blockNumber:
+ type: number
+ description: Block number where this transaction was in.
+ example: 6470854
+ blockHash:
+ description: Hash of the block.
+ type: string
+ example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
+ transactionIndex:
+ type: number
+ description:
+ "Integer of the transaction\u2019s index position, the event\
+ \ was created in."
+ transactionHash:
+ type: string
+ description: Hash of the transaction this event was created in.
+ example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
diff --git a/components/schemas/DeployMultiToken.yml b/components/schemas/DeployMultiToken.yml
index 531c936..bf9a310 100644
--- a/components/schemas/DeployMultiToken.yml
+++ b/components/schemas/DeployMultiToken.yml
@@ -11,6 +11,9 @@ properties:
- KCS
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
uri:
description: URI of the Multi Token token
example: example.com
diff --git a/components/schemas/DeployNft.yml b/components/schemas/DeployNft.yml
index 5731451..831e623 100644
--- a/components/schemas/DeployNft.yml
+++ b/components/schemas/DeployNft.yml
@@ -12,6 +12,9 @@ properties:
- KLAY
- BSC
- ZEN
+ - FLR
+ - CRO
+ - BASE
name:
description: Name of the NFT token
example: My ERC721
diff --git a/components/schemas/Error403BaseBep20NotFound.yml b/components/schemas/Error403BaseBep20NotFound.yml
new file mode 100644
index 0000000..2b3b8b6
--- /dev/null
+++ b/components/schemas/Error403BaseBep20NotFound.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: erc20.token.notFound
+ example: erc20.token.notFound
+ type: string
+ message:
+ description: No such ERC20 currency ${name}.
+ example: No such ERC20 currency ${name}.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseBep20Set.yml b/components/schemas/Error403BaseBep20Set.yml
new file mode 100644
index 0000000..941d974
--- /dev/null
+++ b/components/schemas/Error403BaseBep20Set.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: erc20.address.set
+ example: erc20.address.set
+ type: string
+ message:
+ description: ERC20 address was already set.
+ example: ERC20 address was already set.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseBep20Unsupported.yml b/components/schemas/Error403BaseBep20Unsupported.yml
new file mode 100644
index 0000000..92690a5
--- /dev/null
+++ b/components/schemas/Error403BaseBep20Unsupported.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: base.bep20.unsupported
+ example: base.bep20.unsupported
+ type: string
+ message:
+ description: Unsupported BASE ERC20 blockchain.
+ example: Unsupported BASE ERC20 blockchain.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseBroadcast.yml b/components/schemas/Error403BaseBroadcast.yml
new file mode 100644
index 0000000..e591eaf
--- /dev/null
+++ b/components/schemas/Error403BaseBroadcast.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: base.broadcast.failed
+ example: base.broadcast.failed
+ type: string
+ message:
+ description: Unable to broadcast transaction due to ${error}.
+ example: Unable to broadcast transaction due to ${error}.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseErc20TxSign.yml b/components/schemas/Error403BaseErc20TxSign.yml
new file mode 100644
index 0000000..062e539
--- /dev/null
+++ b/components/schemas/Error403BaseErc20TxSign.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: base.bep20.sign
+ example: base.bep20.sign
+ type: string
+ message:
+ description: Unable to sign transaction for contract creation. ${error}
+ example: Unable to sign transaction for contract creation. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseGasCalculation.yml b/components/schemas/Error403BaseGasCalculation.yml
new file mode 100644
index 0000000..f9264f0
--- /dev/null
+++ b/components/schemas/Error403BaseGasCalculation.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: base.transaction.gas
+ example: base.transaction.gas
+ type: string
+ message:
+ description: Unable to calculate gas limit for transaction. ${error}
+ example: Unable to calculate gas limit for transaction. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseGasPrice.yml b/components/schemas/Error403BaseGasPrice.yml
new file mode 100644
index 0000000..df25954
--- /dev/null
+++ b/components/schemas/Error403BaseGasPrice.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: gas.price.failed
+ example: gas.price.failed
+ type: string
+ message:
+ description: Unable to obtain current GAS price.
+ example: Unable to obtain current GAS price.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseMnemonicPrivateKey.yml b/components/schemas/Error403BaseMnemonicPrivateKey.yml
new file mode 100644
index 0000000..77020a9
--- /dev/null
+++ b/components/schemas/Error403BaseMnemonicPrivateKey.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: private.mnemonic.missing
+ example: private.mnemonic.missing
+ type: string
+ message:
+ description: Either mnemonic and index or private key must be present.
+ example: Either mnemonic and index or private key must be present.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseScBody.yml b/components/schemas/Error403BaseScBody.yml
new file mode 100644
index 0000000..097487e
--- /dev/null
+++ b/components/schemas/Error403BaseScBody.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: base.sc.invalid
+ example: base.sc.invalid
+ type: string
+ message:
+ description: Invalid parameters for smart contract invocation.
+ example: Invalid parameters for smart contract invocation.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseTxBody.yml b/components/schemas/Error403BaseTxBody.yml
new file mode 100644
index 0000000..a56ff9b
--- /dev/null
+++ b/components/schemas/Error403BaseTxBody.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: base.transaction.body
+ example: base.transaction.body
+ type: string
+ message:
+ description: Either currency, or tokenAddress must be defined.
+ example: Either currency, or tokenAddress must be defined.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseTxHash.yml b/components/schemas/Error403BaseTxHash.yml
new file mode 100644
index 0000000..617b85c
--- /dev/null
+++ b/components/schemas/Error403BaseTxHash.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: base.transaction.hash
+ example: base.transaction.hash
+ type: string
+ message:
+ description: Unable to calculate transaction hash. ${error}
+ example: Unable to calculate transaction hash. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403BaseTxSign.yml b/components/schemas/Error403BaseTxSign.yml
new file mode 100644
index 0000000..dd58c17
--- /dev/null
+++ b/components/schemas/Error403BaseTxSign.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: base.transaction.sign
+ example: base.transaction.sign
+ type: string
+ message:
+ description: Unable to sign transaction. ${error}
+ example: Unable to sign transaction. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosBep20NotFound.yml b/components/schemas/Error403CronosBep20NotFound.yml
new file mode 100644
index 0000000..2b3b8b6
--- /dev/null
+++ b/components/schemas/Error403CronosBep20NotFound.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: erc20.token.notFound
+ example: erc20.token.notFound
+ type: string
+ message:
+ description: No such ERC20 currency ${name}.
+ example: No such ERC20 currency ${name}.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosBep20Set.yml b/components/schemas/Error403CronosBep20Set.yml
new file mode 100644
index 0000000..941d974
--- /dev/null
+++ b/components/schemas/Error403CronosBep20Set.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: erc20.address.set
+ example: erc20.address.set
+ type: string
+ message:
+ description: ERC20 address was already set.
+ example: ERC20 address was already set.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosBep20Unsupported.yml b/components/schemas/Error403CronosBep20Unsupported.yml
new file mode 100644
index 0000000..a2da8a9
--- /dev/null
+++ b/components/schemas/Error403CronosBep20Unsupported.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: cronos.bep20.unsupported
+ example: cronos.bep20.unsupported
+ type: string
+ message:
+ description: Unsupported CRO ERC20 blockchain.
+ example: Unsupported CRO ERC20 blockchain.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosBroadcast.yml b/components/schemas/Error403CronosBroadcast.yml
new file mode 100644
index 0000000..dc93696
--- /dev/null
+++ b/components/schemas/Error403CronosBroadcast.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: cronos.broadcast.failed
+ example: cronos.broadcast.failed
+ type: string
+ message:
+ description: Unable to broadcast transaction due to ${error}.
+ example: Unable to broadcast transaction due to ${error}.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosErc20TxSign.yml b/components/schemas/Error403CronosErc20TxSign.yml
new file mode 100644
index 0000000..f40354d
--- /dev/null
+++ b/components/schemas/Error403CronosErc20TxSign.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: cronos.bep20.sign
+ example: cronos.bep20.sign
+ type: string
+ message:
+ description: Unable to sign transaction for contract creation. ${error}
+ example: Unable to sign transaction for contract creation. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosGasCalculation.yml b/components/schemas/Error403CronosGasCalculation.yml
new file mode 100644
index 0000000..9eabd96
--- /dev/null
+++ b/components/schemas/Error403CronosGasCalculation.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: cronos.transaction.gas
+ example: cronos.transaction.gas
+ type: string
+ message:
+ description: Unable to calculate gas limit for transaction. ${error}
+ example: Unable to calculate gas limit for transaction. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosGasPrice.yml b/components/schemas/Error403CronosGasPrice.yml
new file mode 100644
index 0000000..df25954
--- /dev/null
+++ b/components/schemas/Error403CronosGasPrice.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: gas.price.failed
+ example: gas.price.failed
+ type: string
+ message:
+ description: Unable to obtain current GAS price.
+ example: Unable to obtain current GAS price.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosMnemonicPrivateKey.yml b/components/schemas/Error403CronosMnemonicPrivateKey.yml
new file mode 100644
index 0000000..77020a9
--- /dev/null
+++ b/components/schemas/Error403CronosMnemonicPrivateKey.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: private.mnemonic.missing
+ example: private.mnemonic.missing
+ type: string
+ message:
+ description: Either mnemonic and index or private key must be present.
+ example: Either mnemonic and index or private key must be present.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosScBody.yml b/components/schemas/Error403CronosScBody.yml
new file mode 100644
index 0000000..9798aa6
--- /dev/null
+++ b/components/schemas/Error403CronosScBody.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: cronos.sc.invalid
+ example: cronos.sc.invalid
+ type: string
+ message:
+ description: Invalid parameters for smart contract invocation.
+ example: Invalid parameters for smart contract invocation.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosTxBody.yml b/components/schemas/Error403CronosTxBody.yml
new file mode 100644
index 0000000..6150b4f
--- /dev/null
+++ b/components/schemas/Error403CronosTxBody.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: cronos.transaction.body
+ example: cronos.transaction.body
+ type: string
+ message:
+ description: Either currency, or tokenAddress must be defined.
+ example: Either currency, or tokenAddress must be defined.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosTxHash.yml b/components/schemas/Error403CronosTxHash.yml
new file mode 100644
index 0000000..ca945cc
--- /dev/null
+++ b/components/schemas/Error403CronosTxHash.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: cronos.transaction.hash
+ example: cronos.transaction.hash
+ type: string
+ message:
+ description: Unable to calculate transaction hash. ${error}
+ example: Unable to calculate transaction hash. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403CronosTxSign.yml b/components/schemas/Error403CronosTxSign.yml
new file mode 100644
index 0000000..3febf4d
--- /dev/null
+++ b/components/schemas/Error403CronosTxSign.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: cronos.transaction.sign
+ example: cronos.transaction.sign
+ type: string
+ message:
+ description: Unable to sign transaction. ${error}
+ example: Unable to sign transaction. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareBep20NotFound.yml b/components/schemas/Error403FlareBep20NotFound.yml
new file mode 100644
index 0000000..2b3b8b6
--- /dev/null
+++ b/components/schemas/Error403FlareBep20NotFound.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: erc20.token.notFound
+ example: erc20.token.notFound
+ type: string
+ message:
+ description: No such ERC20 currency ${name}.
+ example: No such ERC20 currency ${name}.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareBep20Set.yml b/components/schemas/Error403FlareBep20Set.yml
new file mode 100644
index 0000000..941d974
--- /dev/null
+++ b/components/schemas/Error403FlareBep20Set.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: erc20.address.set
+ example: erc20.address.set
+ type: string
+ message:
+ description: ERC20 address was already set.
+ example: ERC20 address was already set.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareBep20Unsupported.yml b/components/schemas/Error403FlareBep20Unsupported.yml
new file mode 100644
index 0000000..cabde19
--- /dev/null
+++ b/components/schemas/Error403FlareBep20Unsupported.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: flare.bep20.unsupported
+ example: flare.bep20.unsupported
+ type: string
+ message:
+ description: Unsupported FLR ERC20 blockchain.
+ example: Unsupported FLR ERC20 blockchain.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareBroadcast.yml b/components/schemas/Error403FlareBroadcast.yml
new file mode 100644
index 0000000..212b2cc
--- /dev/null
+++ b/components/schemas/Error403FlareBroadcast.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: flare.broadcast.failed
+ example: flare.broadcast.failed
+ type: string
+ message:
+ description: Unable to broadcast transaction due to ${error}.
+ example: Unable to broadcast transaction due to ${error}.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareErc20TxSign.yml b/components/schemas/Error403FlareErc20TxSign.yml
new file mode 100644
index 0000000..23d6195
--- /dev/null
+++ b/components/schemas/Error403FlareErc20TxSign.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: flare.bep20.sign
+ example: flare.bep20.sign
+ type: string
+ message:
+ description: Unable to sign transaction for contract creation. ${error}
+ example: Unable to sign transaction for contract creation. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareGasCalculation.yml b/components/schemas/Error403FlareGasCalculation.yml
new file mode 100644
index 0000000..fb8576d
--- /dev/null
+++ b/components/schemas/Error403FlareGasCalculation.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: flare.transaction.gas
+ example: flare.transaction.gas
+ type: string
+ message:
+ description: Unable to calculate gas limit for transaction. ${error}
+ example: Unable to calculate gas limit for transaction. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareGasPrice.yml b/components/schemas/Error403FlareGasPrice.yml
new file mode 100644
index 0000000..df25954
--- /dev/null
+++ b/components/schemas/Error403FlareGasPrice.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: gas.price.failed
+ example: gas.price.failed
+ type: string
+ message:
+ description: Unable to obtain current GAS price.
+ example: Unable to obtain current GAS price.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareMnemonicPrivateKey.yml b/components/schemas/Error403FlareMnemonicPrivateKey.yml
new file mode 100644
index 0000000..77020a9
--- /dev/null
+++ b/components/schemas/Error403FlareMnemonicPrivateKey.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: private.mnemonic.missing
+ example: private.mnemonic.missing
+ type: string
+ message:
+ description: Either mnemonic and index or private key must be present.
+ example: Either mnemonic and index or private key must be present.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareScBody.yml b/components/schemas/Error403FlareScBody.yml
new file mode 100644
index 0000000..ab1e40a
--- /dev/null
+++ b/components/schemas/Error403FlareScBody.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: flare.sc.invalid
+ example: flare.sc.invalid
+ type: string
+ message:
+ description: Invalid parameters for smart contract invocation.
+ example: Invalid parameters for smart contract invocation.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareTxBody.yml b/components/schemas/Error403FlareTxBody.yml
new file mode 100644
index 0000000..c5d018c
--- /dev/null
+++ b/components/schemas/Error403FlareTxBody.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: flare.transaction.body
+ example: flare.transaction.body
+ type: string
+ message:
+ description: Either currency, or tokenAddress must be defined.
+ example: Either currency, or tokenAddress must be defined.
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareTxHash.yml b/components/schemas/Error403FlareTxHash.yml
new file mode 100644
index 0000000..c2f7543
--- /dev/null
+++ b/components/schemas/Error403FlareTxHash.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: flare.transaction.hash
+ example: flare.transaction.hash
+ type: string
+ message:
+ description: Unable to calculate transaction hash. ${error}
+ example: Unable to calculate transaction hash. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/Error403FlareTxSign.yml b/components/schemas/Error403FlareTxSign.yml
new file mode 100644
index 0000000..e66a4c8
--- /dev/null
+++ b/components/schemas/Error403FlareTxSign.yml
@@ -0,0 +1,18 @@
+properties:
+ errorCode:
+ description: flare.transaction.sign
+ example: flare.transaction.sign
+ type: string
+ message:
+ description: Unable to sign transaction. ${error}
+ example: Unable to sign transaction. ${error}
+ type: string
+ statusCode:
+ description: "403"
+ example: 403
+ type: number
+required:
+ - errorCode
+ - message
+ - statusCode
+type: object
diff --git a/components/schemas/EthTestnetType.yml b/components/schemas/EthTestnetType.yml
new file mode 100644
index 0000000..7e3f0e6
--- /dev/null
+++ b/components/schemas/EthTestnetType.yml
@@ -0,0 +1,5 @@
+type: string
+default: ethereum-sepolia
+enum:
+ - ethereum-sepolia
+ - ethereum-holesky
diff --git a/components/schemas/Event.yml b/components/schemas/Event.yml
index cea77ce..2c7cb6b 100644
--- a/components/schemas/Event.yml
+++ b/components/schemas/Event.yml
@@ -1,7 +1,7 @@
type: object
properties:
chain:
- $ref: "../migrated.yml#/components/schemas/Chain"
+ $ref: "../migrated_v1.yml#/components/schemas/Chain"
address:
type: string
description: The address associated with the event.
@@ -13,16 +13,16 @@ properties:
description: The timestamp of the event in UNIX format.
decoded:
oneOf:
- - $ref: "../migrated.yml#/components/schemas/FungibleTransfer"
- - $ref: "../migrated.yml#/components/schemas/StablecoinTransfer"
- - $ref: "../migrated.yml#/components/schemas/NftTransfer"
- - $ref: "../migrated.yml#/components/schemas/MultitokenTransferSingle"
- - $ref: "../migrated.yml#/components/schemas/MultitokenTransferBatch"
- - $ref: "../migrated.yml#/components/schemas/UniswapTradeV2"
- - $ref: "../migrated.yml#/components/schemas/UniswapTradeV3"
+ - $ref: "../migrated_v1.yml#/components/schemas/FungibleTransfer"
+ - $ref: "../migrated_v1.yml#/components/schemas/StablecoinTransfer"
+ - $ref: "../migrated_v1.yml#/components/schemas/NftTransfer"
+ - $ref: "../migrated_v1.yml#/components/schemas/MultitokenTransferSingle"
+ - $ref: "../migrated_v1.yml#/components/schemas/MultitokenTransferBatch"
+ - $ref: "../migrated_v1.yml#/components/schemas/UniswapTradeV2"
+ - $ref: "../migrated_v1.yml#/components/schemas/UniswapTradeV3"
description: The decoded event data based on the given models.
raw:
- $ref: "../migrated.yml#/components/schemas/RawData"
+ $ref: "../migrated_v1.yml#/components/schemas/RawData"
txHash:
type: string
description: The transaction hash related to the event.
diff --git a/components/schemas/ExchangeRate.yml b/components/schemas/ExchangeRate.yml
index 0e00f02..0893524 100644
--- a/components/schemas/ExchangeRate.yml
+++ b/components/schemas/ExchangeRate.yml
@@ -3,7 +3,7 @@ properties:
id:
description: FIAT or crypto asset.
example: BTC
- $ref: "../migrated.yml#/components/schemas/FiatOrCryptoCurrency"
+ $ref: "../migrated_v1.yml#/components/schemas/FiatOrCryptoCurrency"
value:
description: FIAT value of the asset in given base pair.
example: "1235.56"
@@ -12,7 +12,7 @@ properties:
description: Base pair.
example: EUR
default: EUR
- $ref: "../migrated.yml#/components/schemas/FiatOrCryptoCurrency"
+ $ref: "../migrated_v1.yml#/components/schemas/FiatOrCryptoCurrency"
timestamp:
description: Date of validity of rate in UTC.
example: 1572031674384
diff --git a/components/schemas/FiatOrCryptoCurrency.yml b/components/schemas/FiatOrCryptoCurrency.yml
index 86e105e..5166846 100644
--- a/components/schemas/FiatOrCryptoCurrency.yml
+++ b/components/schemas/FiatOrCryptoCurrency.yml
@@ -21,7 +21,6 @@ enum:
- BHD
- BIF
- BMD
- - BNB
- BND
- BOB
- BRL
@@ -108,7 +107,6 @@ enum:
- LVL
- LYD
- MAD
- - MATIC
- MDL
- MGA
- MKD
@@ -176,8 +174,6 @@ enum:
- UNI
- USD
- USDC
- - USDC_MATIC
- - USDC_MATIC_NATIVE
- USDT
- USDT_TRON
- USDT_MATIC
diff --git a/components/schemas/FlareBalance.yml b/components/schemas/FlareBalance.yml
new file mode 100644
index 0000000..86d5ebb
--- /dev/null
+++ b/components/schemas/FlareBalance.yml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ balance:
+ type: string
+ description: Balance in FLR
+ example: "10.52"
diff --git a/components/schemas/FlareBlock.yml b/components/schemas/FlareBlock.yml
new file mode 100644
index 0000000..0c587e8
--- /dev/null
+++ b/components/schemas/FlareBlock.yml
@@ -0,0 +1,81 @@
+type: object
+properties:
+ difficulty:
+ description: Difficulty for this block.
+ type: string
+ example: "3296820833"
+ extraData:
+ description: The 'extra data' field of this block.
+ type: string
+ example: 0x
+ gasLimit:
+ description: The maximum gas allowed in this block.
+ type: number
+ example: 8000000
+ gasUsed:
+ description: The total used gas by all transactions in this block.
+ type: number
+ example: 7985124
+ hash:
+ description: Hash of the block. 'null' when its pending block.
+ type: string
+ example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
+ logsBloom:
+ description:
+ The bloom filter for the logs of the block. 'null' when its pending
+ block.
+ type: string
+ example: "0x042080004210492080800001610060ad9600005bc81502020800000043e302020381a404000100409102040240300641108004000400007000008000c049558055a800000a0001800748900806502004200400108205005418c0218802281a0408060000533210462021050470810a010140102809011814018281115020090201068401847000a04010000c00084062000485640d00020220181150020008589105a41c0880001112034100010882545410240011402a3480050104004c310204000002009490d0012022a040c20c20011020401020140250805100410060008280200008181a220114102800001648640828200c00a94c1003a2060e001000"
+ miner:
+ description: The address of the beneficiary to whom the mining rewards were given.
+ type: string
+ example: "0xD8869d9E3d497323561Fbca2319a9FC3F6f10c4B"
+ mixHash:
+ description: ""
+ type: string
+ example: "0x7a44a1f56f12ae825fdc04550d7c3af2344daab987691771c06235f25fafcaa6"
+ nonce:
+ description: Hash of the generated proof-of-work. 'null' when its pending block.
+ type: string
+ example: "0xfa1692f52a7ac672"
+ number:
+ description: The block number. 'null' when its pending block.
+ type: number
+ example: 6470657
+ parentHash:
+ description: Hash of the parent block.
+ type: string
+ example: "0xd34aab8a455027086ac54034e68608c84d984401a883b7b5d91f9ae0bbefda15"
+ receiptsRoot:
+ description: ""
+ type: string
+ example: "0x4a496b6b7f2a1c5850bf9eebbea7193807be0067b1c06f17b9dde4eef7b2f960"
+ sha3Uncles:
+ description: SHA3 of the uncles data in the block.
+ type: string
+ example: "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"
+ size:
+ description: The size of this block in bytes.
+ type: number
+ example: 15296
+ stateRoot:
+ description: The root of the final state trie of the block.
+ type: string
+ example: "0x32757c92f10c6c5a106c6fb4b9ca3ff301e413a59ca3d0513b4bf98c72efddba"
+ timestamp:
+ description: The unix timestamp for when the block was collated.
+ type: number
+ example: 1569600592
+ totalDifficulty:
+ description: Total difficulty of the chain until this block.
+ type: string
+ example: "23329673338013873"
+ transactions:
+ description: Array of transactions.
+ type: array
+ items:
+ $ref: "../migrated.yml#/components/schemas/FlareTx"
+ transactionsRoot:
+ description: The root of the transaction trie of the block.
+ type: string
+ example: "0x5990081ef8515d561b50255af03c5d505f7725ddef27405dc67d23bfd0f47704"
diff --git a/components/schemas/FlareEstimateGas.yml b/components/schemas/FlareEstimateGas.yml
new file mode 100644
index 0000000..8c3e3cf
--- /dev/null
+++ b/components/schemas/FlareEstimateGas.yml
@@ -0,0 +1,31 @@
+type: object
+properties:
+ from:
+ type: string
+ maxLength: 42
+ example: "0xfb99f8ae9b70a0c8cd96ae665bbaf85a7e01a2ef"
+ minLength: 42
+ description: Sender address.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ amount:
+ description: Amount to be sent in Flare.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ pattern: ^(0x|0h)?[0-9A-F]+$
+required:
+ - to
+ - amount
+ - from
diff --git a/components/schemas/FlareTestnetType.yml b/components/schemas/FlareTestnetType.yml
new file mode 100644
index 0000000..f5f5bc3
--- /dev/null
+++ b/components/schemas/FlareTestnetType.yml
@@ -0,0 +1,6 @@
+type: string
+default: flare-coston
+enum:
+ - flare-coston
+ - flare-coston2
+ - flare-songbird
diff --git a/components/schemas/FlareTx.yml b/components/schemas/FlareTx.yml
new file mode 100644
index 0000000..77d8401
--- /dev/null
+++ b/components/schemas/FlareTx.yml
@@ -0,0 +1,109 @@
+type: object
+properties:
+ blockHash:
+ description: Hash of the block where this transaction was in.
+ type: string
+ example: "0xcf2c40f475e78c7c19778e1ae999a0e371c9319b38182ea15dc94536f13f9137"
+ status:
+ type: boolean
+ example: true
+ description:
+ TRUE if the transaction was successful, FALSE, if the EVM reverted
+ the transaction.
+ blockNumber:
+ type: number
+ description: Block number where this transaction was in.
+ example: 6470854
+ from:
+ type: string
+ description: Address of the sender.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ gas:
+ type: number
+ description: Gas provided by the sender.
+ example: 21000
+ gasPrice:
+ type: string
+ description: Gas price provided by the sender in wei.
+ example: "1000000000"
+ transactionHash:
+ type: string
+ description: Hash of the transaction.
+ example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
+ input:
+ type: string
+ description: The data sent along with the transaction.
+ example: 0x
+ nonce:
+ type: number
+ description: The number of transactions made by the sender prior to this one.
+ example: 26836405
+ to:
+ type: string
+ description: Address of the receiver. 'null' when its a contract creation transaction.
+ example: "0xbC546fa1716Ed886967cf73f40e8F2F5e623a92d"
+ transactionIndex:
+ type: number
+ description: Integer of the transactions index position in the block.
+ example: 3
+ value:
+ type: string
+ description: Value transferred in wei.
+ example: "1000000000000000000"
+ gasUsed:
+ type: number
+ description: The amount of gas used by this specific transaction alone.
+ example: 21000
+ cumulativeGasUsed:
+ type: number
+ description:
+ The total amount of gas used when this transaction was executed in
+ the block.
+ example: 314159
+ contractAddress:
+ type: string
+ description:
+ The contract address created, if the transaction was a contract creation,
+ otherwise null.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ logs:
+ type: array
+ description: Log events, that happened in this transaction.
+ items:
+ type: object
+ properties:
+ address:
+ type: string
+ description: From which this event originated from.
+ example: "0x81b7E08F65Bdf5648606c89998A9CC8164397647"
+ topics:
+ type: array
+ description:
+ An array with max 4 32 Byte topics, topic 1-3 contains indexed
+ parameters of the log.
+ items:
+ type: string
+ example: "0x033456732123ffff2342342dd12342434324234234fd234fd23fd4f23d4234"
+ data:
+ type: string
+ description: The data containing non-indexed log parameter.
+ logIndex:
+ type: number
+ description: Integer of the event index position in the block.
+ blockNumber:
+ type: number
+ description: Block number where this transaction was in.
+ example: 6470854
+ blockHash:
+ description: Hash of the block.
+ type: string
+ example: "0x5d40698ee1b1ec589035f2a39c6162287e9056868cc79d66cfb248ba9f66c3fc"
+ transactionIndex:
+ type: number
+ description:
+ "Integer of the transaction\u2019s index position, the event\
+ \ was created in."
+ transactionHash:
+ type: string
+ description: Hash of the transaction this event was created in.
+ example: "0xe6e7340394958674cdf8606936d292f565e4ecc476aaa8b258ec8a141f7c75d7"
diff --git a/components/schemas/FungibleTokenBalance.yml b/components/schemas/FungibleTokenBalance.yml
index 557c425..45564d7 100644
--- a/components/schemas/FungibleTokenBalance.yml
+++ b/components/schemas/FungibleTokenBalance.yml
@@ -1,9 +1,9 @@
type: object
properties:
chain:
- $ref: "../migrated.yml#/components/schemas/Chain"
+ $ref: "../migrated_v1.yml#/components/schemas/Chain"
type:
- $ref: "../migrated.yml#/components/schemas/TokenType"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenType"
example: fungible
address:
type: string
diff --git a/components/schemas/FungibleTransfer.yml b/components/schemas/FungibleTransfer.yml
index 0a8ece2..cd3eaab 100644
--- a/components/schemas/FungibleTransfer.yml
+++ b/components/schemas/FungibleTransfer.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/DecodedDataCommon"
+ - $ref: "../migrated_v1.yml#/components/schemas/DecodedDataCommon"
- type: object
properties:
decimals:
diff --git a/components/schemas/GeneratedAddressBase.yml b/components/schemas/GeneratedAddressBase.yml
new file mode 100644
index 0000000..f12b36b
--- /dev/null
+++ b/components/schemas/GeneratedAddressBase.yml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ address:
+ type: string
+ description: Base address
+ example: "0xa7673161CbfE0116A4De9E341f8465940c2211d4"
diff --git a/components/schemas/GeneratedAddressCronos.yml b/components/schemas/GeneratedAddressCronos.yml
new file mode 100644
index 0000000..4ae8d83
--- /dev/null
+++ b/components/schemas/GeneratedAddressCronos.yml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ address:
+ type: string
+ description: Cronos address
+ example: "0xa7673161CbfE0116A4De9E341f8465940c2211d4"
diff --git a/components/schemas/GeneratedAddressFlare.yml b/components/schemas/GeneratedAddressFlare.yml
new file mode 100644
index 0000000..07018fe
--- /dev/null
+++ b/components/schemas/GeneratedAddressFlare.yml
@@ -0,0 +1,6 @@
+type: object
+properties:
+ address:
+ type: string
+ description: Flare address
+ example: "0xa7673161CbfE0116A4De9E341f8465940c2211d4"
diff --git a/components/schemas/MintMultiToken.yml b/components/schemas/MintMultiToken.yml
index e7f2fac..e0ccfab 100644
--- a/components/schemas/MintMultiToken.yml
+++ b/components/schemas/MintMultiToken.yml
@@ -11,6 +11,9 @@ properties:
- KCS
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
tokenId:
description: ID of token to be created.
example: "100000"
diff --git a/components/schemas/MintMultiTokenBatch.yml b/components/schemas/MintMultiTokenBatch.yml
index 4df5bc4..b7523ae 100644
--- a/components/schemas/MintMultiTokenBatch.yml
+++ b/components/schemas/MintMultiTokenBatch.yml
@@ -11,6 +11,9 @@ properties:
- KCS
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
to:
type: array
description: The blockchain address to send the Multi Tokens to.
diff --git a/components/schemas/MintMultipleNft.yml b/components/schemas/MintMultipleNft.yml
index 17f38a2..37ba188 100644
--- a/components/schemas/MintMultipleNft.yml
+++ b/components/schemas/MintMultipleNft.yml
@@ -11,6 +11,9 @@ properties:
- ONE
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
to:
type: array
description: Blockchain address to send NFT token to.
diff --git a/components/schemas/MintNft.yml b/components/schemas/MintNft.yml
index 76727f9..99d5806 100644
--- a/components/schemas/MintNft.yml
+++ b/components/schemas/MintNft.yml
@@ -18,6 +18,9 @@ properties:
- MATIC
- ONE
- ZEN
+ - FLR
+ - CRO
+ - BASE
to:
maxLength: 42
minLength: 42
diff --git a/components/schemas/MultitokenTransfer.yml b/components/schemas/MultitokenTransfer.yml
index f04d916..b26f96e 100644
--- a/components/schemas/MultitokenTransfer.yml
+++ b/components/schemas/MultitokenTransfer.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/DecodedDataCommon"
+ - $ref: "../migrated_v1.yml#/components/schemas/DecodedDataCommon"
- type: object
properties:
operator:
diff --git a/components/schemas/MultitokenTransferBatch.yml b/components/schemas/MultitokenTransferBatch.yml
index 0210937..1f17889 100644
--- a/components/schemas/MultitokenTransferBatch.yml
+++ b/components/schemas/MultitokenTransferBatch.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/MultitokenTransfer"
+ - $ref: "../migrated_v1.yml#/components/schemas/MultitokenTransfer"
- type: object
properties:
multitokenIds:
diff --git a/components/schemas/MultitokenTransferSingle.yml b/components/schemas/MultitokenTransferSingle.yml
index c9a7af1..070e4fc 100644
--- a/components/schemas/MultitokenTransferSingle.yml
+++ b/components/schemas/MultitokenTransferSingle.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/MultitokenTransfer"
+ - $ref: "../migrated_v1.yml#/components/schemas/MultitokenTransfer"
- type: object
properties:
multitokenId:
diff --git a/components/schemas/NativeTokenBalance.yml b/components/schemas/NativeTokenBalance.yml
index 28651ff..6a7a226 100644
--- a/components/schemas/NativeTokenBalance.yml
+++ b/components/schemas/NativeTokenBalance.yml
@@ -1,9 +1,9 @@
type: object
properties:
chain:
- $ref: "../migrated.yml#/components/schemas/Chain"
+ $ref: "../migrated_v1.yml#/components/schemas/Chain"
type:
- $ref: "../migrated.yml#/components/schemas/TokenType"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenType"
example: native
address:
type: string
diff --git a/components/schemas/NftBalance.yml b/components/schemas/NftBalance.yml
index 4759385..b490770 100644
--- a/components/schemas/NftBalance.yml
+++ b/components/schemas/NftBalance.yml
@@ -1,9 +1,9 @@
type: object
properties:
chain:
- $ref: "../migrated.yml#/components/schemas/Chain"
+ $ref: "../migrated_v1.yml#/components/schemas/Chain"
type:
- $ref: "../migrated.yml#/components/schemas/TokenType"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenType"
example: nft
address:
type: string
diff --git a/components/schemas/NftTransfer.yml b/components/schemas/NftTransfer.yml
index 38fefcb..fab2f5f 100644
--- a/components/schemas/NftTransfer.yml
+++ b/components/schemas/NftTransfer.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/DecodedDataCommon"
+ - $ref: "../migrated_v1.yml#/components/schemas/DecodedDataCommon"
- type: object
properties:
tokenId:
diff --git a/components/schemas/NodeRpcPostChains.yml b/components/schemas/NodeRpcPostChains.yml
index 393b91f..7fd1c11 100644
--- a/components/schemas/NodeRpcPostChains.yml
+++ b/components/schemas/NodeRpcPostChains.yml
@@ -3,7 +3,6 @@ example: ethereum-sepolia
enum:
- ethereum-sepolia
- ethereum-mainnet
- - ethereum-goerli
- ethereum-holesky
- polygon-mumbai
- polygon-mainnet
@@ -95,3 +94,8 @@ enum:
- zilliqa-mainnet
- zilliqa-testnet
- ethereum-classic-mainnet
+ - ethereum-classic-testnet
+ - base-mainnet
+ - base-sepolia
+ - chiliz-mainnet
+ - chiliz-testnet
diff --git a/components/schemas/PendingTransaction.yml b/components/schemas/PendingTransaction.yml
index 3f0ada5..cae1497 100644
--- a/components/schemas/PendingTransaction.yml
+++ b/components/schemas/PendingTransaction.yml
@@ -28,6 +28,7 @@ properties:
- EGLD
- KLAY
- SOL
+ - ADA
hashes:
type: array
description:
diff --git a/components/schemas/RateQuery.yml b/components/schemas/RateQuery.yml
index 9cc5a9d..e6ec7b1 100644
--- a/components/schemas/RateQuery.yml
+++ b/components/schemas/RateQuery.yml
@@ -7,11 +7,11 @@ properties:
basePair:
description: Base pair.
example: EUR
- $ref: "../migrated.yml#/components/schemas/FiatCurrency"
+ $ref: "../migrated_v1.yml#/components/schemas/FiatCurrency"
currency:
description: FIAT or crypto asset.
example: BTC
- $ref: "../migrated.yml#/components/schemas/FiatOrCryptoCurrency"
+ $ref: "../migrated_v1.yml#/components/schemas/FiatOrCryptoCurrency"
required:
- batchId
- basePair
diff --git a/components/schemas/StablecoinTransfer.yml b/components/schemas/StablecoinTransfer.yml
index 1e08aeb..102004e 100644
--- a/components/schemas/StablecoinTransfer.yml
+++ b/components/schemas/StablecoinTransfer.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/FungibleTransfer"
+ - $ref: "../migrated_v1.yml#/components/schemas/FungibleTransfer"
- type: object
properties:
stablecoin:
diff --git a/components/schemas/Subscription.yml b/components/schemas/Subscription.yml
index 6f35be4..020ac71 100644
--- a/components/schemas/Subscription.yml
+++ b/components/schemas/Subscription.yml
@@ -6,19 +6,22 @@ properties:
type:
type: string
description: Type of the subscription.
- example: ACCOUNT_BALANCE_LIMIT
+ example: ADDRESS_EVENT
enum:
- - ADDRESS_TRANSACTION
- - CONTRACT_LOG_EVENT
- - ACCOUNT_INCOMING_BLOCKCHAIN_TRANSACTION
- - ACCOUNT_PENDING_BLOCKCHAIN_TRANSACTION
- - CUSTOMER_TRADE_MATCH
- - CUSTOMER_PARTIAL_TRADE_MATCH
- - TRANSACTION_IN_THE_BLOCK
- - KMS_FAILED_TX
- - KMS_COMPLETED_TX
- - ACCOUNT_BALANCE_LIMIT
- - TRANSACTION_HISTORY_REPORT
+ - ADDRESS_EVENT
+ - FAILED_TX_PER_BLOCK
+ - INCOMING_NATIVE_TX
+ - OUTGOING_NATIVE_TX
+ - OUTGOING_FAILED_TX
+ - PAID_FEE
+ - INCOMING_INTERNAL_TX
+ - OUTGOING_INTERNAL_TX
+ - INCOMING_FUNGIBLE_TX
+ - OUTGOING_FUNGIBLE_TX
+ - INCOMING_NFT_TX
+ - OUTGOING_NFT_TX
+ - INCOMING_MULTITOKEN_TX
+ - OUTGOING_MULTITOKEN_TX
id:
type: string
description: ID of the subscription
diff --git a/components/schemas/TestnetType.yml b/components/schemas/TestnetType.yml
new file mode 100644
index 0000000..fa05902
--- /dev/null
+++ b/components/schemas/TestnetType.yml
@@ -0,0 +1,11 @@
+type: string
+description:
+ Specifies the testnet type. The default is ethereum-sepolia for Ethereum
+ (ETH) currency and flare-coston for Flare (FLR) currency. Valid testnet types depend
+ on the specified currency.
+enum:
+ - ethereum-sepolia
+ - ethereum-holesky
+ - flare-coston
+ - flare-coston2
+ - flare-songbird
diff --git a/components/schemas/Token.yml b/components/schemas/Token.yml
index 36b86c6..7f22f73 100644
--- a/components/schemas/Token.yml
+++ b/components/schemas/Token.yml
@@ -1,14 +1,14 @@
type: object
properties:
chain:
- $ref: "../migrated.yml#/components/schemas/Chain"
+ $ref: "../migrated_v1.yml#/components/schemas/Chain"
tokenId:
- $ref: "../migrated.yml#/components/schemas/TokenId"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenId"
tokenAddress:
- $ref: "../migrated.yml#/components/schemas/TokenAddress"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenAddress"
tokenType:
- $ref: "../migrated.yml#/components/schemas/TokenType"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenType"
metadataURI:
- $ref: "../migrated.yml#/components/schemas/NftMetadataURI"
+ $ref: "../migrated_v1.yml#/components/schemas/NftMetadataURI"
metadata:
- $ref: "../migrated.yml#/components/schemas/NftMetadata"
+ $ref: "../migrated_v1.yml#/components/schemas/NftMetadata"
diff --git a/components/schemas/TokenTezos.yml b/components/schemas/TokenTezos.yml
index 0ccb87b..8af56d9 100644
--- a/components/schemas/TokenTezos.yml
+++ b/components/schemas/TokenTezos.yml
@@ -1,13 +1,13 @@
type: object
properties:
chain:
- $ref: "../migrated.yml#/components/schemas/Chain"
+ $ref: "../migrated_v1.yml#/components/schemas/Chain"
tokenId:
- $ref: "../migrated.yml#/components/schemas/TokenId"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenId"
tokenAddress:
- $ref: "../migrated.yml#/components/schemas/TokenAddress"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenAddress"
tokenType:
- $ref: "../migrated.yml#/components/schemas/TokenType"
+ $ref: "../migrated_v1.yml#/components/schemas/TokenType"
creator:
type: string
description: Address of the token creator.
diff --git a/components/schemas/TransferAlgoKMS.yml b/components/schemas/TransferAlgoKMS.yml
index 023ddb2..6f4abb7 100644
--- a/components/schemas/TransferAlgoKMS.yml
+++ b/components/schemas/TransferAlgoKMS.yml
@@ -36,6 +36,10 @@ properties:
description:
If signatureId is mnemonic-based, this is the index to the specific
address from that mnemonic.
+ from:
+ description: The blockchain address of the sender
+ type: string
+ example: TMETT6BXL3QUH7AH5TS6IONU7LVTLKIGG54CFCNPMQXWGRIZFIESZBYWP4
compliant:
description:
Compliance check; if the withdrawal is not compliant, it will not
@@ -61,3 +65,4 @@ required:
- address
- amount
- signatureId
+ - from
diff --git a/components/schemas/TransferBaseBlockchain.yml b/components/schemas/TransferBaseBlockchain.yml
new file mode 100644
index 0000000..3325d03
--- /dev/null
+++ b/components/schemas/TransferBaseBlockchain.yml
@@ -0,0 +1,62 @@
+type: object
+properties:
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Base transaction. If not present, last known nonce
+ will be used.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ currency:
+ description: Currency to transfer from Base Blockchain Account.
+ enum:
+ - BASE
+ example: BASE
+ type: string
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ example: "40000"
+ pattern: ^[+]?\d+$
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ example: "20"
+ pattern: ^[+]?\d+$
+ amount:
+ description: Amount to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ fromPrivateKey:
+ type: string
+ maxLength: 66
+ example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
+ minLength: 66
+ description:
+ Private key of sender address. Private key, or signature Id must
+ be present.
+required:
+ - to
+ - amount
+ - currency
+ - fromPrivateKey
diff --git a/components/schemas/TransferBaseBlockchainKMS.yml b/components/schemas/TransferBaseBlockchainKMS.yml
new file mode 100644
index 0000000..bebed25
--- /dev/null
+++ b/components/schemas/TransferBaseBlockchainKMS.yml
@@ -0,0 +1,67 @@
+type: object
+properties:
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Base transaction. If not present, last known nonce
+ will be used.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ currency:
+ description: Currency to transfer from Base Blockchain Account.
+ enum:
+ - BASE
+ example: BASE
+ type: string
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ example: "40000"
+ pattern: ^[+]?\d+$
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ example: "20"
+ pattern: ^[+]?\d+$
+ amount:
+ description: Amount to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ index:
+ type: number
+ minimum: 0
+ description:
+ If signatureId is mnemonic-based, this is the index to the specific
+ address from that mnemonic.
+ signatureId:
+ type: string
+ format: uuid
+ example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
+ description:
+ Identifier of the private key associated in signing application.
+ Private key, or signature Id must be present.
+required:
+ - to
+ - amount
+ - currency
+ - signatureId
diff --git a/components/schemas/TransferCronosBlockchain.yml b/components/schemas/TransferCronosBlockchain.yml
new file mode 100644
index 0000000..a5c2f0b
--- /dev/null
+++ b/components/schemas/TransferCronosBlockchain.yml
@@ -0,0 +1,62 @@
+type: object
+properties:
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Cronos transaction. If not present, last known
+ nonce will be used.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ currency:
+ description: Currency to transfer from Cronos Blockchain Account.
+ enum:
+ - CRO
+ example: CRO
+ type: string
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ example: "40000"
+ pattern: ^[+]?\d+$
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ example: "20"
+ pattern: ^[+]?\d+$
+ amount:
+ description: Amount to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ fromPrivateKey:
+ type: string
+ maxLength: 66
+ example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
+ minLength: 66
+ description:
+ Private key of sender address. Private key, or signature Id must
+ be present.
+required:
+ - to
+ - amount
+ - currency
+ - fromPrivateKey
diff --git a/components/schemas/TransferCronosBlockchainKMS.yml b/components/schemas/TransferCronosBlockchainKMS.yml
new file mode 100644
index 0000000..19c7d3e
--- /dev/null
+++ b/components/schemas/TransferCronosBlockchainKMS.yml
@@ -0,0 +1,67 @@
+type: object
+properties:
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Cronos transaction. If not present, last known
+ nonce will be used.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ currency:
+ description: Currency to transfer from Cronos Blockchain Account.
+ enum:
+ - CRO
+ example: CRO
+ type: string
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ example: "40000"
+ pattern: ^[+]?\d+$
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ example: "20"
+ pattern: ^[+]?\d+$
+ amount:
+ description: Amount to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ index:
+ type: number
+ minimum: 0
+ description:
+ If signatureId is mnemonic-based, this is the index to the specific
+ address from that mnemonic.
+ signatureId:
+ type: string
+ format: uuid
+ example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
+ description:
+ Identifier of the private key associated in signing application.
+ Private key, or signature Id must be present.
+required:
+ - to
+ - amount
+ - currency
+ - signatureId
diff --git a/components/schemas/TransferFlareBlockchain.yml b/components/schemas/TransferFlareBlockchain.yml
new file mode 100644
index 0000000..881fc9e
--- /dev/null
+++ b/components/schemas/TransferFlareBlockchain.yml
@@ -0,0 +1,62 @@
+type: object
+properties:
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Flare transaction. If not present, last known
+ nonce will be used.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ currency:
+ description: Currency to transfer from Flare Blockchain Account.
+ enum:
+ - FLR
+ example: FLR
+ type: string
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ example: "40000"
+ pattern: ^[+]?\d+$
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ example: "20"
+ pattern: ^[+]?\d+$
+ amount:
+ description: Amount to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ fromPrivateKey:
+ type: string
+ maxLength: 66
+ example: "0x05e150c73f1920ec14caa1e0b6aa09940899678051a78542840c2668ce5080c2"
+ minLength: 66
+ description:
+ Private key of sender address. Private key, or signature Id must
+ be present.
+required:
+ - to
+ - amount
+ - currency
+ - fromPrivateKey
diff --git a/components/schemas/TransferFlareBlockchainKMS.yml b/components/schemas/TransferFlareBlockchainKMS.yml
new file mode 100644
index 0000000..b155333
--- /dev/null
+++ b/components/schemas/TransferFlareBlockchainKMS.yml
@@ -0,0 +1,67 @@
+type: object
+properties:
+ data:
+ type: string
+ maxLength: 50000
+ description:
+ Additional data that can be passed to a blockchain transaction as
+ a data property; must be in the hexadecimal format
+ example: 4d79206e6f746520746f2074686520726563697069656e74
+ nonce:
+ type: number
+ minimum: 0
+ description:
+ Nonce to be set to Flare transaction. If not present, last known
+ nonce will be used.
+ to:
+ description: Blockchain address to send assets
+ example: "0x687422eEA2cB73B5d3e242bA5456b782919AFc85"
+ maxLength: 42
+ minLength: 42
+ type: string
+ currency:
+ description: Currency to transfer from Flare Blockchain Account.
+ enum:
+ - FLR
+ example: FLR
+ type: string
+ fee:
+ description: Custom defined fee. If not present, it will be calculated automatically.
+ type: object
+ required:
+ - gasLimit
+ - gasPrice
+ properties:
+ gasLimit:
+ type: string
+ description: Gas limit for transaction in gas price.
+ example: "40000"
+ pattern: ^[+]?\d+$
+ gasPrice:
+ type: string
+ description: Gas price in Gwei.
+ example: "20"
+ pattern: ^[+]?\d+$
+ amount:
+ description: Amount to be sent.
+ example: "100000"
+ pattern: ^[+]?((\d+(\.\d*)?)|(\.\d+))$
+ type: string
+ index:
+ type: number
+ minimum: 0
+ description:
+ If signatureId is mnemonic-based, this is the index to the specific
+ address from that mnemonic.
+ signatureId:
+ type: string
+ format: uuid
+ example: 26d3883e-4e17-48b3-a0ee-09a3e484ac83
+ description:
+ Identifier of the private key associated in signing application.
+ Private key, or signature Id must be present.
+required:
+ - to
+ - amount
+ - currency
+ - signatureId
diff --git a/components/schemas/TransferMultiToken.yml b/components/schemas/TransferMultiToken.yml
index e08b0e1..1c1b8eb 100644
--- a/components/schemas/TransferMultiToken.yml
+++ b/components/schemas/TransferMultiToken.yml
@@ -11,6 +11,9 @@ properties:
- KCS
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
to:
maxLength: 42
minLength: 42
diff --git a/components/schemas/TransferMultiTokenBatch.yml b/components/schemas/TransferMultiTokenBatch.yml
index 04ed0c3..fcce549 100644
--- a/components/schemas/TransferMultiTokenBatch.yml
+++ b/components/schemas/TransferMultiTokenBatch.yml
@@ -11,6 +11,9 @@ properties:
- KCS
- KLAY
- BSC
+ - FLR
+ - CRO
+ - BASE
to:
maxLength: 42
minLength: 42
diff --git a/components/schemas/TransferNft.yml b/components/schemas/TransferNft.yml
index 0be2981..199335b 100644
--- a/components/schemas/TransferNft.yml
+++ b/components/schemas/TransferNft.yml
@@ -12,6 +12,9 @@ properties:
- KLAY
- BSC
- ZEN
+ - FLR
+ - CRO
+ - BASE
to:
maxLength: 58
minLength: 42
diff --git a/components/schemas/TxData.yml b/components/schemas/TxData.yml
index 0f2b364..bc1f6a8 100644
--- a/components/schemas/TxData.yml
+++ b/components/schemas/TxData.yml
@@ -1,7 +1,7 @@
type: object
properties:
chain:
- $ref: "../migrated.yml#/components/schemas/ChainEnum"
+ $ref: "../migrated_v1.yml#/components/schemas/ChainEnum"
hash:
type: string
description: The transaction hash.
@@ -31,9 +31,9 @@ properties:
description: The transaction index within the block.
example: 84
transactionType:
- $ref: "../migrated.yml#/components/schemas/TxType"
+ $ref: "../migrated_v1.yml#/components/schemas/TxType"
transactionSubtype:
- $ref: "../migrated.yml#/components/schemas/TxSubtype"
+ $ref: "../migrated_v1.yml#/components/schemas/TxSubtype"
amount:
type: string
description: The amount transferred in the transaction.
diff --git a/components/schemas/UniswapTrade.yml b/components/schemas/UniswapTrade.yml
index c3e3448..cbe41a5 100644
--- a/components/schemas/UniswapTrade.yml
+++ b/components/schemas/UniswapTrade.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/DecodedDataCommon"
+ - $ref: "../migrated_v1.yml#/components/schemas/DecodedDataCommon"
- type: object
properties:
token0:
diff --git a/components/schemas/UniswapTradeV2.yml b/components/schemas/UniswapTradeV2.yml
index e789b4d..99beeec 100644
--- a/components/schemas/UniswapTradeV2.yml
+++ b/components/schemas/UniswapTradeV2.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/UniswapTrade"
+ - $ref: "../migrated_v1.yml#/components/schemas/UniswapTrade"
- type: object
properties:
amount0In:
diff --git a/components/schemas/UniswapTradeV3.yml b/components/schemas/UniswapTradeV3.yml
index 226be4d..a29d7f5 100644
--- a/components/schemas/UniswapTradeV3.yml
+++ b/components/schemas/UniswapTradeV3.yml
@@ -1,5 +1,5 @@
allOf:
- - $ref: "../migrated.yml#/components/schemas/UniswapTrade"
+ - $ref: "../migrated_v1.yml#/components/schemas/UniswapTrade"
- type: object
properties:
amount0:
diff --git a/components/schemas/WebHook.yml b/components/schemas/WebHook.yml
index 5a01335..8299806 100644
--- a/components/schemas/WebHook.yml
+++ b/components/schemas/WebHook.yml
@@ -11,17 +11,22 @@ properties:
type:
type: string
description: Type of the subscription.
- example: ACCOUNT_BALANCE_LIMIT
+ example: ADDRESS_EVENT
enum:
- - INCOMING_BLOCKCHAIN_HOOK
- - ADDRESS_TRANSACTION
- - CONTRACT_LOG_EVENT
- - TRADE_MATCH
- - TRADE_PARTIAL_FILL
- - PENDING_BLOCKCHAIN_HOOK
- - TRANSACTION_IN_THE_BLOCK
- - KMS_FAILED_TX
- - KMS_COMPLETED_TX
+ - ADDRESS_EVENT
+ - FAILED_TX_PER_BLOCK
+ - INCOMING_NATIVE_TX
+ - OUTGOING_NATIVE_TX
+ - OUTGOING_FAILED_TX
+ - PAID_FEE
+ - INCOMING_INTERNAL_TX
+ - OUTGOING_INTERNAL_TX
+ - INCOMING_FUNGIBLE_TX
+ - OUTGOING_FUNGIBLE_TX
+ - INCOMING_NFT_TX
+ - OUTGOING_NFT_TX
+ - INCOMING_MULTITOKEN_TX
+ - OUTGOING_MULTITOKEN_TX
id:
type: string
description: ID of the WebHook