fireblocks-sdk - npm Package Compare versions

Comparing version 5.27.2 to 5.28.0

dist/package.json

 {
     "name": "fireblocks-sdk",
-    "version": "5.27.2",
+    "version": "5.28.0",
     "main": "dist/src/fireblocks-sdk.js",
@@ -5,0 +5,0 @@ "types": "dist/src/fireblocks-sdk.d.ts",

dist/src/fireblocks-sdk.d.ts

 import { ApiClient } from "./api-client";
 import { IAuthProvider } from "./iauth-provider";
-import { AllocateFundsRequest, AssetResponse, AssetTypeResponse, CancelTransactionResponse, ConvertExchangeAssetResponse, CreateTransactionResponse, DeallocateFundsRequest, DepositAddressResponse, EstimateFeeResponse, EstimateTransactionFeeResponse, ExchangeResponse, ExternalWalletAsset, FiatAccountResponse, GasStationInfo, GenerateAddressResponse, InternalWalletAsset, MaxSpendableAmountResponse, MaxBip44IndexUsedResponse, PaginatedAddressesResponse, OptionalPaginatedAddressesRequestFilters, NetworkConnectionResponse, OffExchangeEntityResponse, OperationSuccessResponse, PagedVaultAccountsRequestFilters, PagedVaultAccountsResponse, PublicKeyInfoArgs, PublicKeyInfoForVaultAccountArgs, RequestOptions, ResendWebhooksResponse, TransactionArguments, TransactionFilter, TransactionPageFilter, TransactionPageResponse, TransactionResponse, User, ValidateAddressResponse, VaultAccountResponse, VaultAssetResponse, VaultBalancesFilter, WalletContainerResponse, SetFeePayerConfiguration, FeePayerConfiguration, CreateWeb3ConnectionResponse, Session, NetworkConnectionRoutingPolicy, NetworkIdRoutingPolicy, NetworkIdResponse, TimePeriod, AuditsResponse, NFTOwnershipFilter, NFTOwnedAssetsFilter, Token, TokenWithBalance, Web3PagedResponse, CreateWalletConnectPayload, Web3ConnectionType, GetWeb3ConnectionsPayload, PublicKeyResponse, AllocateFundsResponse, AddCollateralTransactionRequest, RemoveCollateralTransactionRequest, GetSettlementTransactionsResponse, SettlementRequest, SettlementResponse, GetNFTsFilter, SettleOffExchangeAccountResponse, PublicKeyInformation, DropTransactionResponse, GetAssetWalletsFilters, GetAssetWalletsResponse, NFTOwnershipStatus, NFTOwnershipStatusUpdatedPayload, NFTOwnedCollectionsFilter, CollectionOwnership, TravelRuleOptions, ValidateTravelRuleVaspInfo, ValidateTravelRuleResult, ValidateCreateTravelRuleTransaction, ValidateFullTravelRuleResult, TravelRuleVasp, TravelRuleVaspFilter, TravelRuleEncryptionOptions, SmartTransfersTicketResponse, SmartTransfersTicketCreatePayload, SmartTransfersTicketsResponse, SmartTransfersTicketsFilters, SmartTransfersTicketTermPayload, SmartTransfersTicketTermFundPayload, ScreeningPolicyConfiguration, SmartTransfersTicketTermResponse, ConsoleUser, ApiUser, TRole, UsersGroup, SmartTransfersUserGroupsResponse, LeanContractTemplateDto, ContractTemplateDto, BatchTask, BatchJob, JobCreatedResponse, ContractUploadRequest, ContractDeployResponse, ContractDeployRequest, ExchangeAccountsPageFilter, PagedExchangeResponse, TAP, WriteCallFunctionDto, ReadCallFunctionDto, WriteCallFunctionResponseDto, ContractAbiResponseDto, DeployedContractResponseDto, LeanDeployedContractResponseDto, ParameterWithValueList, ScreeningTenantConfiguration, ScreeningType, ScreeningConfigurationsResponse, ScreeningPolicyRuleResponse, ScreeningProviderConfigurationResponse, AuditLogsResponse, TokenLink, IssueTokenRequest, TokenLinksCount, GetTokenLinksFilter, GetContractTemplatesFilter, SupportedContractTemplateType, AbiFunction, SupportedBlockchainsResponse, GetContractsFilter, TokenOwnershipSpamUpdatePayload, ScreeningSupportedAssetResponse, ScreeningSupportedProviders, RegisterAssetResponse, UnspentInputsResponse, ContractAddressResponseDto } from "./types";
+import { AllocateFundsRequest, AssetResponse, AssetTypeResponse, CancelTransactionResponse, ConvertExchangeAssetResponse, CreateTransactionResponse, DeallocateFundsRequest, DepositAddressResponse, EstimateFeeResponse, EstimateTransactionFeeResponse, ExchangeResponse, ExternalWalletAsset, FiatAccountResponse, GasStationInfo, GenerateAddressResponse, InternalWalletAsset, MaxSpendableAmountResponse, MaxBip44IndexUsedResponse, PaginatedAddressesResponse, OptionalPaginatedAddressesRequestFilters, NetworkConnectionResponse, OffExchangeEntityResponse, OperationSuccessResponse, PagedVaultAccountsRequestFilters, PagedVaultAccountsResponse, PublicKeyInfoArgs, PublicKeyInfoForVaultAccountArgs, RequestOptions, ResendWebhooksResponse, TransactionArguments, TransactionFilter, TransactionPageFilter, TransactionPageResponse, TransactionResponse, User, ValidateAddressResponse, VaultAccountResponse, VaultAssetResponse, VaultBalancesFilter, WalletContainerResponse, SetFeePayerConfiguration, FeePayerConfiguration, CreateWeb3ConnectionResponse, Session, NetworkConnectionRoutingPolicy, NetworkIdRoutingPolicy, NetworkIdResponse, TimePeriod, AuditsResponse, NFTOwnershipFilter, NFTOwnedAssetsFilter, Token, TokenWithBalance, Web3PagedResponse, CreateWalletConnectPayload, Web3ConnectionType, GetWeb3ConnectionsPayload, PublicKeyResponse, AllocateFundsResponse, AddCollateralTransactionRequest, RemoveCollateralTransactionRequest, GetSettlementTransactionsResponse, SettlementRequest, SettlementResponse, GetNFTsFilter, SettleOffExchangeAccountResponse, PublicKeyInformation, DropTransactionResponse, GetAssetWalletsFilters, GetAssetWalletsResponse, NFTOwnershipStatus, NFTOwnershipStatusUpdatedPayload, NFTOwnedCollectionsFilter, CollectionOwnership, TravelRuleOptions, ValidateTravelRuleVaspInfo, ValidateTravelRuleResult, ValidateCreateTravelRuleTransaction, ValidateFullTravelRuleResult, TravelRuleVasp, TravelRuleVaspFilter, TravelRuleEncryptionOptions, SmartTransfersTicketResponse, SmartTransfersTicketCreatePayload, SmartTransfersTicketsResponse, SmartTransfersTicketsFilters, SmartTransfersTicketTermPayload, SmartTransfersTicketTermFundPayload, ScreeningPolicyConfiguration, SmartTransfersTicketTermResponse, ConsoleUser, ApiUser, TRole, UsersGroup, SmartTransfersUserGroupsResponse, LeanContractTemplateDto, ContractTemplateDto, BatchTask, BatchJob, JobCreatedResponse, ContractUploadRequest, ContractDeployResponse, ContractDeployRequest, ExchangeAccountsPageFilter, PagedExchangeResponse, TAP, WriteCallFunctionDto, ReadCallFunctionDto, WriteCallFunctionResponseDto, ContractAbiResponseDto, DeployedContractResponseDto, LeanDeployedContractResponseDto, ParameterWithValueList, ScreeningTenantConfiguration, ScreeningType, ScreeningConfigurationsResponse, ScreeningPolicyRuleResponse, ScreeningProviderConfigurationResponse, AuditLogsResponse, TokenLink, IssueTokenRequest, TokenLinksCount, GetTokenLinksFilter, GetContractTemplatesFilter, SupportedContractTemplateType, AbiFunction, SupportedBlockchainsResponse, GetContractsFilter, TokenOwnershipSpamUpdatePayload, ScreeningSupportedAssetResponse, ScreeningSupportedProviders, RegisterAssetResponse, UnspentInputsResponse, ContractAddressResponseDto, CollectionLink, CreateCollectionRequest, CollectionTokenResponseDto, MintCollectionTokenRequest, BurnCollectionTokenRequest } from "./types";
 import { AxiosProxyConfig, AxiosResponse, InternalAxiosRequestConfig } from "axios";
@@ -1084,4 +1084,4 @@ import { NcwSdk } from "./ncw-sdk";
      *
-     * @param {Object} payload - The payload for retrieving linked tokens
-     * @param {TokenLinkStatus} payload.status - The status of linked tokens (COMPLETED / PENDING)
+     * @param {Object} payload
+     * @param {TokenLinkStatus} payload.status - The status of linked tokens (COMPLETED / PENDING). Default is COMPLETED
      * @param {number} payload.pageSize - The number of results to return on the next page
@@ -1118,3 +1118,3 @@ * @param {string} payload.pageCursor - The cursor for the next page
      */
-    unlinkToken(id: string): Promise<TokenLink>;
+    unlinkToken(id: string): Promise<void>;
     /**
@@ -1131,2 +1131,49 @@ * Retrieves all pending linked tokens in a paginated format
     /**
+     * Creates a new collection and links it
+     *
+     * @param {CreateCollectionRequest} payload - The payload containing information for collection creation
+     *
+     * @returns {CollectionLink} Response with created collection link ID
+     */
+    createNewCollection(payload: CreateCollectionRequest): Promise<CollectionLink>;
+    /**
+     * Retrieves all linked collections in a paginated format.
+     *
+     * @param {Object} payload
+     * @param {TokenLinkStatus} payload.status - The status of linked collections (COMPLETED / PENDING). Default is COMPLETED
+     * @param {number} payload.pageSize - The number of results to return on the next page
+     * @param {string} payload.pageCursor - The cursor for the next page
+     *
+     * @returns {CollectionLink[]} A paginated array of linked collections
+     */
+    getLinkedCollections({ status, pageSize, pageCursor }?: GetTokenLinksFilter): Promise<Web3PagedResponse<CollectionLink>>;
+    /**
+     * Get a linked collection
+     *
+     * @returns CollectionLink
+     */
+    getLinkedCollection(id: string): Promise<CollectionLink>;
+    /**
+     * Unlink a collection
+     */
+    unlinkCollection(id: string): Promise<void>;
+    /**
+     * Mint collection NFT
+     *
+     * @returns WriteCallFunctionResponseDto
+     */
+    mintNFT(collectionId: string, payload: MintCollectionTokenRequest): Promise<WriteCallFunctionResponseDto>;
+    /**
+     * Burn collection NFT
+     *
+     * @returns WriteCallFunctionResponseDto
+     */
+    burnNFT(collectionId: string, payload: BurnCollectionTokenRequest): Promise<WriteCallFunctionResponseDto>;
+    /**
+     * Get collection token details
+     *
+     * @returns CollectionTokenResponseDto
+     */
+    getLinkedCollectionTokenDetails(collectionId: string, tokenId: string): Promise<CollectionTokenResponseDto>;
+    /**
      * Validate VASP details for travel rule compliance
@@ -1133,0 +1180,0 @@ * @param travelRuleMessageVaspInfo

dist/src/types.d.ts

@@ -1635,2 +1635,18 @@ import { AxiosResponseHeaders } from "axios";
 }
+export interface LinkedContractMetadataDto {
+    id: string;
+    blockchainId: string;
+    baseAssetId: string;
+    contractAddress: string;
+    contractTemplateId: string;
+    vaultAccountId?: string;
+}
+export interface LinkedCollectionMetadataDto {
+    fbCollectionId: string;
+    name?: string;
+    symbol?: string;
+    standard?: string;
+    blockchainDescriptor: string;
+    contractAddress?: string;
+}
 export declare enum TokenLinkStatus {
@@ -1645,5 +1661,21 @@ PENDING = "PENDING",
     status: TokenLinkStatus;
-    tokenMetadata?: LinkedTokenMetadata;
+    tokenMetadata?: LinkedTokenMetadata | LinkedCollectionMetadataDto | LinkedContractMetadataDto;
     displayName?: string;
 }
+export declare enum CollectionType {
+    NON_FUNGIBLE_TOKEN = "NON_FUNGIBLE_TOKEN",
+    SEMI_FUNGIBLE_TOKEN = "SEMI_FUNGIBLE_TOKEN"
+}
+export interface CollectionLink {
+    id: string;
+    type: CollectionType;
+    status: TokenLinkStatus;
+    displayName?: string;
+    collectionMetadata?: LinkedCollectionMetadataDto;
+}
+export interface CollectionTokenResponseDto {
+    tokenId: string;
+    metadataURI: string;
+    totalSupply: string;
+}
 export interface GetTokenLinksFilter {
@@ -1691,2 +1723,38 @@ status?: TokenLinkStatus;
 }
+export interface CreateCollectionRequest {
+    baseAssetId: string;
+    vaultAccountId: string;
+    type: CollectionType;
+    name: string;
+    symbol: string;
+    adminAddress: string;
+    displayName?: string;
+}
+export interface TokenMetadataAttributesDto {
+    traitType: string;
+    value: string;
+    displayType?: string;
+}
+export interface TokenMetadataDto {
+    name: string;
+    description: string;
+    image?: string;
+    animationUrl?: string;
+    externalUrl?: string;
+    attributes?: TokenMetadataAttributesDto[];
+}
+export interface MintCollectionTokenRequest {
+    to: string;
+    tokenId: string;
+    vaultAccountId: string;
+    amount?: string;
+    metadataURI?: string;
+    metadata?: TokenMetadataDto;
+}
+export interface BurnCollectionTokenRequest {
+    to: string;
+    tokenId: string;
+    vaultAccountId: string;
+    amount?: string;
+}
 export interface IssueTokenRequest {
@@ -1693,0 +1761,0 @@ assetId?: string;

dist/src/types.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TAP = exports.NCW = exports.SmartTransferTicketTermStatus = exports.SmartTransfersTicketStatus = exports.SmartTransfersTicketDirection = exports.BatchTask = exports.BatchJob = exports.BatchStatus = exports.TokenLinkStatus = exports.NFTSpamTokenOwnership = exports.InputFieldMetadataTypes = exports.ContractInitializationPhase = exports.ContractTemplateType = exports.NFTOwnershipWalletType = exports.NFTOwnershipStatus = exports.OrderValues = exports.GetOwnedAssetsSortValues = exports.GetOwnedCollectionsSortValues = exports.GetOwnedNFTsSortValues = exports.GetNFTsSortValues = exports.TimePeriod = exports.ExchangeReply = exports.SettleResponseCode = exports.TransferTicketTermStatus = exports.TransferTicketStatus = exports.Web3ConnectionMethod = exports.Web3ConnectionType = exports.TransactionOperation = exports.VirtualType = exports.PeerType = exports.TransactionStatus = exports.TransactionOrder = exports.NetworkDestType = exports.NetworkScheme = exports.FeeLevel = exports.Web3ConnectionFeeLevel = exports.ScreeningSupportedProviders = exports.ScreeningVerdict = exports.ScreeningTransactionStatus = exports.TransactionDirection = exports.PolicyApprovalStatus = exports.ScreeningAction = exports.TravelRuleAddressTypeCode = exports.SigningAlgorithm = exports.VaultAssetActivationStatus = exports.AssetScope = exports.AssetClass = exports.VirtualAffiliation = void 0;
+exports.TAP = exports.NCW = exports.SmartTransferTicketTermStatus = exports.SmartTransfersTicketStatus = exports.SmartTransfersTicketDirection = exports.BatchTask = exports.BatchJob = exports.BatchStatus = exports.CollectionType = exports.TokenLinkStatus = exports.NFTSpamTokenOwnership = exports.InputFieldMetadataTypes = exports.ContractInitializationPhase = exports.ContractTemplateType = exports.NFTOwnershipWalletType = exports.NFTOwnershipStatus = exports.OrderValues = exports.GetOwnedAssetsSortValues = exports.GetOwnedCollectionsSortValues = exports.GetOwnedNFTsSortValues = exports.GetNFTsSortValues = exports.TimePeriod = exports.ExchangeReply = exports.SettleResponseCode = exports.TransferTicketTermStatus = exports.TransferTicketStatus = exports.Web3ConnectionMethod = exports.Web3ConnectionType = exports.TransactionOperation = exports.VirtualType = exports.PeerType = exports.TransactionStatus = exports.TransactionOrder = exports.NetworkDestType = exports.NetworkScheme = exports.FeeLevel = exports.Web3ConnectionFeeLevel = exports.ScreeningSupportedProviders = exports.ScreeningVerdict = exports.ScreeningTransactionStatus = exports.TransactionDirection = exports.PolicyApprovalStatus = exports.ScreeningAction = exports.TravelRuleAddressTypeCode = exports.SigningAlgorithm = exports.VaultAssetActivationStatus = exports.AssetScope = exports.AssetClass = exports.VirtualAffiliation = void 0;
 var VirtualAffiliation;
@@ -282,2 +282,7 @@ (function (VirtualAffiliation) {
 })(TokenLinkStatus || (exports.TokenLinkStatus = TokenLinkStatus = {}));
+var CollectionType;
+(function (CollectionType) {
+    CollectionType["NON_FUNGIBLE_TOKEN"] = "NON_FUNGIBLE_TOKEN";
+    CollectionType["SEMI_FUNGIBLE_TOKEN"] = "SEMI_FUNGIBLE_TOKEN";
+})(CollectionType || (exports.CollectionType = CollectionType = {}));
 var BatchStatus;
@@ -284,0 +289,0 @@ (function (BatchStatus) {

package.json

 {
   "name": "fireblocks-sdk",
-  "version": "5.27.2",
+  "version": "5.28.0",
   "main": "dist/src/fireblocks-sdk.js",
@@ -5,0 +5,0 @@ "types": "dist/src/fireblocks-sdk.d.ts",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

351953

increased by2.33%

Lines of code

7579

increased by2.71%

No dependency changes