1 credit per API call
*Tatum supports BIP44 HD wallets. It is very convenient and secure, since it can generate 2^31 addresses from 1 mnemonic phrase. Mnemonic phrase consists of 24 special words in defined order and can restore access to all generated addresses and private keys.
Each address is identified by 3 main values:
Tatum follows BIP44 specification and generates for Polygon wallet with derivation path m'/44'/966'/0'/0. More about BIP44 HD wallets can be found here - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki. * Generate BIP44 compatible Polygon wallet.
* * @param mnemonic Mnemonic to use for generation of extended public and private keys. * @returns Wallet OK * @throws ApiError */ public static polygonGenerateWallet( mnemonic?: string, ): CancelablePromise1 credit per API call
*Generate Polygon account deposit address from Extended public key. 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.
* * @param xpub Extended public key of wallet. * @param index Derivation index of desired address to be generated. * @returns any OK * @throws ApiError */ public static polygonGenerateAddress( xpub: string, index: number, ): CancelablePromise<{ /** * Polygon address */ address?: string; }> { return __request({ method: 'GET', path: `/v3/polygon/address/${xpub}/${index}`, errors: { 400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`, 401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`, 500: `Internal server error. There was an error on the server during the processing of the request.`, }, }); } /** * Generate Polygon private key *1 credit per API call
*Generate private key of address from mnemonic for given derivation path index. Private key is generated for the specific index - each mnemonic * can generate up to 2^31 private keys starting from index 0 until 2^31.
* * @param requestBody * @returns PrivKey OK * @throws ApiError */ public static polygonGenerateAddressPrivateKey( requestBody: PrivKeyRequest, ): CancelablePromise2 credits per API call
*This endpoint is deprecated. Use the HTTP-based JSON RPC driver instead.
Use this endpoint URL as a http-based web3 driver to connect directly to the Polygon node provided by Tatum. * To learn more about Polygon Web3, visit the Polygon developer's guide.
* * @param xApiKey Tatum X-API-Key used for authorization. * @param requestBody * @returns any OK * @throws ApiError */ public static polygonWeb3Driver( xApiKey: string, requestBody: any, ): CancelablePromise1 credit per API call
*Get Polygon current block number. This is the number of the latest block in the blockchain.
* * @returns number OK * @throws ApiError */ public static polygonGetCurrentBlock(): CancelablePromise1 credit per API call
*Get Polygon block by block hash or block number.
* * @param hash Block hash or block number * @returns EthBlock OK * @throws ApiError */ public static polygonGetBlock( hash: string, ): CancelablePromise1 credit per API call
*Get Polygon account balance in MATIC. This method does not prints any balance of the ERC20 or ERC721 tokens on the account.
* * @param address Account address you want to get balance of * @returns any OK * @throws ApiError */ public static polygonGetBalance( address: string, ): CancelablePromise<{ /** * Balance in MATIC */ balance?: string; }> { return __request({ method: 'GET', path: `/v3/polygon/account/balance/${address}`, errors: { 400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`, 401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`, 500: `Internal server error. There was an error on the server during the processing of the request.`, }, }); } /** * Get Polygon Transaction *2 credits per API call
*Get Polygon transaction by transaction hash.
* * @param hash Transaction hash * @returns PolygonTx OK * @throws ApiError */ public static polygonGetTransaction( hash: string, ): CancelablePromise1 credit per API call
*Get Polygon transactions by address. This includes incoming and outgoing transactions for the address.
* * @param address Account address you want to get balance of * @param pageSize Max number of items per page is 50. * @param offset Offset to obtain next page of the data. * @param from Transactions from this block onwords will be included. * @param to Transactions up to this block will be included. * @param sort Sorting of the data. ASC - oldest first, DESC - newest first. * @returns PolygonTx OK * @throws ApiError */ public static polygonGetTransactionByAddress( address: string, pageSize: number, offset?: number, from?: number, to?: number, sort: 'ASC' | 'DESC' = 'DESC', ): CancelablePromise1 credit per API call
*Get a number of outgoing Polygon 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.
* * @param address address * @returns number OK * @throws ApiError */ public static polygonGetTransactionCount( address: string, ): CancelablePromise2 credits per API call
*Send MATIC from account to account.
*
Signing a transaction
*When sending MATIC, 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.
* * @param requestBody * @returns any OK * @throws ApiError */ public static polygonBlockchainTransfer( requestBody: (TransferPolygonBlockchain | TransferPolygonBlockchainKMS), ): CancelablePromise<(TransactionHash | SignatureId)> { return __request({ method: 'POST', path: `/v3/polygon/transaction`, body: requestBody, mediaType: 'application/json', errors: { 400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`, 401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`, 403: `Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.`, 500: `Internal server error. There was an error on the server during the processing of the request.`, }, }); } /** * Invoke a method in a smart contract on Polygon *2 credits per API call
*Invoke a method in an existing smart contract on Polygon.
*You can call a read-only or write method.
*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.
* * @param requestBody * @returns any OK * @throws ApiError */ public static polygonBlockchainSmartContractInvocation( requestBody: (CallPolygonSmartContractReadMethod | CallPolygonSmartContractMethod | CallPolygonSmartContractMethodCaller | CallPolygonSmartContractMethodKMS), ): CancelablePromise<(TransactionHash | SignatureId | Data)> { return __request({ method: 'POST', path: `/v3/polygon/smartcontract`, body: requestBody, mediaType: 'application/json', errors: { 400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`, 401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`, 403: `Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.`, 500: `Internal server error. There was an error on the server during the processing of the request.`, }, }); } /** * Broadcast signed Polygon transaction *2 credits per API call
*Broadcast signed transaction to Polygon 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 blockchian.
* * @param requestBody * @returns TransactionHash OK * @throws ApiError */ public static polygonBroadcast( requestBody: BroadcastKMS, ): CancelablePromise