@tormentalabs/floyd-types


TypeScript type definitions for the Floyd Blockchain API.

Installation

``bash
npm install @tormentalabs/floyd-types
`

Usage

`typescript
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

$3


- Asset - Vehicle/bike NFT entity
- Wallet - Custodial wallet
- HistoryEvent - Asset history event
- Accessory - Asset component/accessory

$3

- CreateAssetRequest, UpdateAssetRequest
- TransferRequest, CustodialTransferRequest
- CreateWalletRequest
- PaginatedResponse, PaginationOptions

$3

- WebhookEvent, WebhookEventType, WebhookEventMap
- AssetCreatedEventData, AssetTransferredEventData
- AssetBlockchainConfirmedEventData
- WalletCreatedEventData

$3

- FloydClientConfig
- RetryConfig, TimeoutConfig, CacheConfig`

Related Packages

- @tormentalabs/floyd-sdk - Main API client
- @tormentalabs/floyd-webhooks - Webhook handling
- @tormentalabs/floyd-validators - Document validators

License

MIT