@tormentalabs/floyd-types
v1.0.4
Published
TypeScript type definitions for the Floyd Blockchain API
Maintainers
Readme
@tormentalabs/floyd-types
TypeScript type definitions for the Floyd Blockchain API.
Installation
npm install @tormentalabs/floyd-typesUsage
import type {
Asset,
Wallet,
CreateAssetRequest,
WebhookEvent,
WebhookEventType
} from '@tormentalabs/floyd-types';
// Use types for your API interactions
const asset: Asset = {
id: 'uuid',
name: 'My Bike',
// ...
};Available Types
Entities
Asset- Vehicle/bike NFT entityWallet- Custodial walletHistoryEvent- Asset history eventAccessory- Asset component/accessory
Requests/Responses
CreateAssetRequest,UpdateAssetRequestTransferRequest,CustodialTransferRequestCreateWalletRequestPaginatedResponse<T>,PaginationOptions
Webhook Events
WebhookEvent,WebhookEventType,WebhookEventMapAssetCreatedEventData,AssetTransferredEventDataAssetBlockchainConfirmedEventDataWalletCreatedEventData
Configuration
FloydClientConfigRetryConfig,TimeoutConfig,CacheConfig
Related Packages
- @tormentalabs/floyd-sdk - Main API client
- @tormentalabs/floyd-webhooks - Webhook handling
- @tormentalabs/floyd-validators - Document validators
License
MIT
