@tatumio/api-client - npm Package Compare versions

Comparing version 2.0.1-alpha.233 to 2.0.1-alpha.234

package.json

 {
   "name": "@tatumio/api-client",
-  "version": "2.0.1-alpha.233",
+  "version": "2.0.1-alpha.234",
   "license": "MIT",
@@ -5,0 +5,0 @@ "main": "./src/index.js",

src/generated/models/KlaytnTx.d.ts

@@ -7,2 +7,10 @@ export declare type KlaytnTx = {
     /**
+     * Type of Klaytn Transaction
+     */
+    type?: string;
+    /**
+     * Type of Klaytn Transaction
+     */
+    typeInt?: number;
+    /**
      * TRUE if the transaction was successful, FALSE, if the EVM reverted the transaction.
@@ -9,0 +17,0 @@ */

src/generated/services/BlockchainNftService.d.ts

@@ -37,2 +37,3 @@ import type { AddNftMinter } from '../models/AddNftMinter';
 import type { MintNftCelo } from '../models/MintNftCelo';
+import type { MintNftExpress } from '../models/MintNftExpress';
 import type { MintNftFlowKMS } from '../models/MintNftFlowKMS';
@@ -44,2 +45,3 @@ import type { MintNftFlowMnemonic } from '../models/MintNftFlowMnemonic';
 import type { MintNftKMSTron } from '../models/MintNftKMSTron';
+import type { MintNftMinter } from '../models/MintNftMinter';
 import type { MintNftSolana } from '../models/MintNftSolana';
@@ -113,2 +115,3 @@ import type { MintNftSolanaKMS } from '../models/MintNftSolanaKMS';
      * <li><b>Celo</b></li>
+     * <li><b>Klaytn</b></li>
      * <li><b>Solana</b></li>
@@ -123,3 +126,3 @@ * <li><b>Harmony.ONE</b></li>
      * <br/>
-     * This operation works in two modes.
+     * This operation works in three modes.
      *
@@ -136,2 +139,5 @@ * First mode works just like other NFT endpoints. Every time the funds are transferred, the transaction must be signed with the corresponding private key.
      *
+     * Third mode enables you to mint on any custom NFT ERC-721 smart contract, on which specified minter address is approved as a minter. You don't specify private key or signatureId, only minter address, from which the NFT will be minted.
+     * You can use addresses specified in the bellow table to be used as a minter.
+     *
      * Performed request without fromPrivateKey or signatureId fields will be populated with following attributes:
@@ -209,2 +215,8 @@ *
              * <tr>
+             * <td>KLAY</td>
+             * <td>Testnet</td>
+             * <td>0x80d8bac9a6901698b3749fe336bbd1385c1f98f2</td>
+             * <td>0x45871ED5F15203C0ce791eFE5f4B5044833aE10e</td>
+             * </tr>
+             * <tr>
              * <td>MATIC</td>
@@ -216,3 +228,3 @@ * <td>Mainnet</td>
              * <tr>
-             * <td>KCS</td>
+             * <td>BSC</td>
              * <td>Mainnet</td>
@@ -223,3 +235,3 @@ * <td>0xcf9e127455d28e7362380aec1b92ddee8200b295</td>
              * <tr>
-             * <td>BSC</td>
+             * <td>ONE</td>
              * <td>Mainnet</td>
@@ -236,3 +248,3 @@ * <td>0xcf9e127455d28e7362380aec1b92ddee8200b295</td>
              * <tr>
-             * <td>ONE</td>
+             * <td>CELO</td>
              * <td>Mainnet</td>
@@ -243,3 +255,3 @@ * <td>0xcf9e127455d28e7362380aec1b92ddee8200b295</td>
              * <tr>
-             * <td>CELO</td>
+             * <td>KLAY</td>
              * <td>Mainnet</td>
@@ -249,3 +261,2 @@ * <td>0xcf9e127455d28e7362380aec1b92ddee8200b295</td>
              * </tr>
-             *
              * </table>
@@ -260,3 +271,3 @@ * To add ETH mainnet smart contract contact [e-mail].
              */
-    static nftMintErc721(requestBody: (MintNftCelo | MintNftKMSCelo | MintNftTron | MintNftKMSTron | MintNft | MintNftKMS | MintNftSolana | MintNftSolanaKMS | MintNftFlowPK | MintNftFlowMnemonic | MintNftFlowKMS), xTestnetType?: 'ethereum-ropsten' | 'ethereum-rinkeby'): CancelablePromise<(TransactionHashKMS | FlowMintedResult | SolanaMintedResult | SignatureId)>;
+    static nftMintErc721(requestBody: (MintNftExpress | MintNftMinter | MintNftCelo | MintNftKMSCelo | MintNftTron | MintNftKMSTron | MintNft | MintNftKMS | MintNftSolana | MintNftSolanaKMS | MintNftFlowPK | MintNftFlowMnemonic | MintNftFlowKMS), xTestnetType?: 'ethereum-ropsten' | 'ethereum-rinkeby'): CancelablePromise<(TransactionHashKMS | FlowMintedResult | SolanaMintedResult | SignatureId)>;
     /**
@@ -278,2 +289,3 @@ * Transfer NFT Token
      * <li><b>Algorand</b></li>
+     * <li><b>Klaytn</b></li>
      * <li><b>Solana</b></li>
@@ -495,2 +507,33 @@ * </ul>
     /**
+     * Get NFT tokens in collection
+     * <h4>1 credit per API call + 5 credits for each listed token.</h4><br/><p>Get all minted NFTs in the collection. Returns all NFTs this contract minted.</p>
+     *
+     * @param chain Blockchain to work with
+     * @param pageSize Max number of items per page is 50.
+     * @param address Collection address
+     * @param offset Offset to obtain next page of the data.
+     * @returns any OK
+     * @throws ApiError
+     */
+    static nftGetTokensByCollectionErc721(chain: 'CELO' | 'MATIC' | 'ETH', pageSize: number, address: string, offset?: number): CancelablePromise<Array<{
+        /**
+         * ID of the token.
+         */
+        tokenId: string;
+        metadata: Array<{
+            /**
+             * TokenID of the NFT token owned by this address.
+             */
+            tokenId?: string;
+            /**
+             * 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.
+             */
+            url?: string;
+            /**
+             * 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.
+             */
+            metadata?: any;
+        }>;
+    }>>;
+    /**
      * Get NFT Account balance
@@ -497,0 +540,0 @@ * <h4>1 credit per API call.</h4><br/><p>Get NFTs on Account. Returns tokenIDs of tokens Account holds. This method is valid only for tokens deplyed using Tatum API - it reads data from the smart contract.</p>

src/generated/services/BlockchainNftService.js

@@ -64,2 +64,3 @@ "use strict";
      * <li><b>Celo</b></li>
+     * <li><b>Klaytn</b></li>
      * <li><b>Solana</b></li>
@@ -74,3 +75,3 @@ * <li><b>Harmony.ONE</b></li>
      * <br/>
-     * This operation works in two modes.
+     * This operation works in three modes.
      *
@@ -87,2 +88,5 @@ * First mode works just like other NFT endpoints. Every time the funds are transferred, the transaction must be signed with the corresponding private key.
      *
+     * Third mode enables you to mint on any custom NFT ERC-721 smart contract, on which specified minter address is approved as a minter. You don't specify private key or signatureId, only minter address, from which the NFT will be minted.
+     * You can use addresses specified in the bellow table to be used as a minter.
+     *
      * Performed request without fromPrivateKey or signatureId fields will be populated with following attributes:
@@ -160,2 +164,8 @@ *
              * <tr>
+             * <td>KLAY</td>
+             * <td>Testnet</td>
+             * <td>0x80d8bac9a6901698b3749fe336bbd1385c1f98f2</td>
+             * <td>0x45871ED5F15203C0ce791eFE5f4B5044833aE10e</td>
+             * </tr>
+             * <tr>
              * <td>MATIC</td>
@@ -167,3 +177,3 @@ * <td>Mainnet</td>
              * <tr>
-             * <td>KCS</td>
+             * <td>BSC</td>
              * <td>Mainnet</td>
@@ -174,3 +184,3 @@ * <td>0xcf9e127455d28e7362380aec1b92ddee8200b295</td>
              * <tr>
-             * <td>BSC</td>
+             * <td>ONE</td>
              * <td>Mainnet</td>
@@ -187,3 +197,3 @@ * <td>0xcf9e127455d28e7362380aec1b92ddee8200b295</td>
              * <tr>
-             * <td>ONE</td>
+             * <td>CELO</td>
              * <td>Mainnet</td>
@@ -194,3 +204,3 @@ * <td>0xcf9e127455d28e7362380aec1b92ddee8200b295</td>
              * <tr>
-             * <td>CELO</td>
+             * <td>KLAY</td>
              * <td>Mainnet</td>
@@ -200,3 +210,2 @@ * <td>0xcf9e127455d28e7362380aec1b92ddee8200b295</td>
              * </tr>
-             *
              * </table>
@@ -244,2 +253,3 @@ * To add ETH mainnet smart contract contact [e-mail].
      * <li><b>Algorand</b></li>
+     * <li><b>Klaytn</b></li>
      * <li><b>Solana</b></li>
@@ -587,2 +597,29 @@ * </ul>
     /**
+     * Get NFT tokens in collection
+     * <h4>1 credit per API call + 5 credits for each listed token.</h4><br/><p>Get all minted NFTs in the collection. Returns all NFTs this contract minted.</p>
+     *
+     * @param chain Blockchain to work with
+     * @param pageSize Max number of items per page is 50.
+     * @param address Collection address
+     * @param offset Offset to obtain next page of the data.
+     * @returns any OK
+     * @throws ApiError
+     */
+    static nftGetTokensByCollectionErc721(chain, pageSize, address, offset) {
+        return (0, request_1.request)({
+            method: 'GET',
+            path: `/v3/nft/collection/${chain}/${address}`,
+            query: {
+                'pageSize': pageSize,
+                'offset': offset,
+            },
+            errors: {
+                400: `Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.`,
+                401: `Unauthorized. Not valid or inactive subscription key present in the HTTP Header.`,
+                403: `Forbidden. The request is authenticated, but it is not possible to 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.`,
+            },
+        });
+    }
+    /**
      * Get NFT Account balance
@@ -589,0 +626,0 @@ * <h4>1 credit per API call.</h4><br/><p>Get NFTs on Account. Returns tokenIDs of tokens Account holds. This method is valid only for tokens deplyed using Tatum API - it reads data from the smart contract.</p>

src/generated/services/BlockchainUtilsService.d.ts

@@ -16,2 +16,3 @@ import type { ApproveTransferCustodialWallet } from '../models/ApproveTransferCustodialWallet';
 import type { GenerateCustodialWalletBatchKMS } from '../models/GenerateCustodialWalletBatchKMS';
+import type { GenerateCustodialWalletBatchPayer } from '../models/GenerateCustodialWalletBatchPayer';
 import type { GenerateCustodialWalletBatchTron } from '../models/GenerateCustodialWalletBatchTron';
@@ -121,2 +122,3 @@ import type { GenerateCustodialWalletBatchTronKMS } from '../models/GenerateCustodialWalletBatchTronKMS';
      * This operation deploys a smart contract on the blockchain.<br/>
+     * For paid plans, it is possible to pay for the gas costs - you don't have to provide private key or signatureId. Blockchain fees will be covered by your credits.
      * Supported blockchains:
@@ -140,3 +142,3 @@ * <ul>
      */
-    static generateCustodialWalletBatch(requestBody: (GenerateCustodialWalletBatch | GenerateCustodialWalletBatchKMS | GenerateCustodialWalletBatchCelo | GenerateCustodialWalletBatchCeloKMS | GenerateCustodialWalletBatchTron | GenerateCustodialWalletBatchTronKMS), xTestnetType?: 'ethereum-ropsten' | 'ethereum-rinkeby'): CancelablePromise<(TransactionHashKMS | SignatureId)>;
+    static generateCustodialWalletBatch(requestBody: (GenerateCustodialWalletBatchPayer | GenerateCustodialWalletBatch | GenerateCustodialWalletBatchKMS | GenerateCustodialWalletBatchCelo | GenerateCustodialWalletBatchCeloKMS | GenerateCustodialWalletBatchTron | GenerateCustodialWalletBatchTronKMS), xTestnetType?: 'ethereum-ropsten' | 'ethereum-rinkeby'): CancelablePromise<(TransactionHashKMS | SignatureId)>;
     /**
@@ -143,0 +145,0 @@ * Get custodial addresses from transaction

src/generated/services/BlockchainUtilsService.js

@@ -119,2 +119,3 @@ "use strict";
      * This operation deploys a smart contract on the blockchain.<br/>
+     * For paid plans, it is possible to pay for the gas costs - you don't have to provide private key or signatureId. Blockchain fees will be covered by your credits.
      * Supported blockchains:
@@ -121,0 +122,0 @@ * <ul>

src/generated/services/LedgerSubscriptionService.d.ts

@@ -64,2 +64,9 @@ import type { Account } from '../models/Account';
      * <tr>
+     * <td>Klaytn</td>
+     * <td>Yes/Yes</td>
+     * <td>Klay, Internal transfers, ERC20, ERC721, ERC1155</td>
+     * <td>Free plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains</td>
+     * <td>25 credits / day / address</td>
+     * </tr>
+     * <tr>
      * <td>Bitcoin</td>
@@ -66,0 +73,0 @@ * <td>Yes/Yes</td>

src/generated/services/LedgerSubscriptionService.js

@@ -52,2 +52,9 @@ "use strict";
      * <tr>
+     * <td>Klaytn</td>
+     * <td>Yes/Yes</td>
+     * <td>Klay, Internal transfers, ERC20, ERC721, ERC1155</td>
+     * <td>Free plans - 10 addresses across all blockchains, Paid plans - unlimited addresses across all blockchains</td>
+     * <td>25 credits / day / address</td>
+     * </tr>
+     * <tr>
      * <td>Bitcoin</td>
@@ -54,0 +61,0 @@ * <td>Yes/Yes</td>

src/lib/api-client.d.ts

@@ -1,2 +0,2 @@
-import { BlockchainAdaService, BlockchainAlgorandAlgoService, BlockchainBinanceService, BlockchainBitcoinCashService, BlockchainBitcoinService, BlockchainBscService, BlockchainCeloService, BlockchainDogecoinService, BlockchainElrondNetworkEgldService, BlockchainEthereumService, BlockchainFabricService, BlockchainFlowService, BlockchainFungibleTokenService, BlockchainHarmonyOneService, BlockchainKcsKcsService, BlockchainLitecoinService, BlockchainMarketplaceService, BlockchainMultiTokenErc1155Service, BlockchainNeoService, BlockchainNftService, BlockchainPolygonMaticService, BlockchainQtumService, BlockchainQuorumService, BlockchainRecordService, BlockchainScryptaService, BlockchainSolanaService, BlockchainTronService, BlockchainUtilsService, BlockchainVeChainService, BlockchainXdcNetworkXinFinService, BlockchainXlmService, BlockchainXrpService, LedgerAccountService, LedgerCustomerService, LedgerOrderBookService, LedgerSubscriptionService, LedgerTransactionService, LedgerVirtualCurrencyService, OffChainAccountService, OffChainBlockchainService, OffChainWithdrawalService, SecurityAddressService, SecurityKeyManagementSystemService, StorageIpfsService, TatumServiceService } from '../generated';
+import { BlockchainAdaService, BlockchainAlgorandAlgoService, BlockchainBinanceService, BlockchainBitcoinCashService, BlockchainBitcoinService, BlockchainBscService, BlockchainCeloService, BlockchainDogecoinService, BlockchainElrondNetworkEgldService, BlockchainEthereumService, BlockchainFabricService, BlockchainFlowService, BlockchainFungibleTokenService, BlockchainHarmonyOneService, BlockchainKcsKcsService, BlockchainKlaytnService, BlockchainLitecoinService, BlockchainMarketplaceService, BlockchainMultiTokenErc1155Service, BlockchainNeoService, BlockchainNftService, BlockchainPolygonMaticService, BlockchainQtumService, BlockchainQuorumService, BlockchainRecordService, BlockchainScryptaService, BlockchainSolanaService, BlockchainTronService, BlockchainUtilsService, BlockchainVeChainService, BlockchainXdcNetworkXinFinService, BlockchainXlmService, BlockchainXrpService, LedgerAccountService, LedgerCustomerService, LedgerOrderBookService, LedgerSubscriptionService, LedgerTransactionService, LedgerVirtualCurrencyService, OffChainAccountService, OffChainBlockchainService, OffChainWithdrawalService, SecurityAddressService, SecurityKeyManagementSystemService, StorageIpfsService, TatumServiceService } from '../generated';
 export declare type TatumApiType = ReturnType<typeof TatumApi>;
@@ -30,2 +30,3 @@ export declare enum TatumUrl {
         kcs: typeof BlockchainKcsKcsService;
+        klaytn: typeof BlockchainKlaytnService;
         ltc: typeof BlockchainLitecoinService;
@@ -86,2 +87,3 @@ neo: typeof BlockchainNeoService;
         kcs: typeof BlockchainKcsKcsService;
+        klaytn: typeof BlockchainKlaytnService;
         ltc: typeof BlockchainLitecoinService;
@@ -88,0 +90,0 @@ neo: typeof BlockchainNeoService;

src/lib/api-client.js

@@ -42,2 +42,3 @@ "use strict";
         kcs: generated_1.BlockchainKcsKcsService,
+        klaytn: generated_1.BlockchainKlaytnService,
         ltc: generated_1.BlockchainLitecoinService,
@@ -44,0 +45,0 @@ neo: generated_1.BlockchainNeoService,

No alert changes

Improved metrics

Total package byte prevSize

2697394

increased by0.33%

Number of package files

2749

increased by0.33%

Lines of code

55323

increased by0.33%

No dependency changes