// ----------------------------------------------------------------------------- // Enum Typedefs // ----------------------------------------------------------------------------- /** * @typedef {"IE" | "UK"} Country */ // ----------------------------------------------------------------------------- // Model Typedefs // ----------------------------------------------------------------------------- /** * @typedef {Object} ActiveStakeAmount * @property {number} amount_in_lovelaces */ /** * @typedef {Object} AddressStakeAmount * @property {string} stake_address stake1... * @property {number} amount_in_lovelaces */ /** * @typedef {Object} Block * @property {number} number * @property {number} epoch_number * @property {number} slot_number * @property {number} epoch_slot_number * @property {number} size * @property {number} transaction_count * @property {string} time */ /** * @typedef {Object} CnftMetadataV001 * @property {string} policyId * @property {Object.} tokens * @property {CnftMetadataV001Asset} asset */ /** * @typedef {Object} CnftMetadataV001Asset * @property {string} [assetName] * @property {*} [attributes] * @property {string} ipfs * @property {string} [mimeType] */ /** * @typedef {Object} DayBlock * @property {Block} first * @property {Block} last */ /** * @typedef {Object} Delegation * @property {string} staking_address * @property {StakepoolDelegation[]} delegations */ /** * @typedef {Object} DelegatorsCount * @property {number} delegators_count_total */ /** * @typedef {Object} Epoch * @property {number} out_sum * @property {number} fees * @property {number} tx_count * @property {number} blk_count * @property {number} number * @property {string} start_time * @property {string} end_time */ /** * @typedef {Object} GenericError * @property {string} description */ /** * Response for the healthcheck's endpoint of the service * @typedef {Object} Healthcheck * @property {string} status */ /** * @typedef {Object} NativeAsset * @property {string} transaction_id * @property {string} policy_id * @property {string} token_name * @property {*} metadata * @property {number} block_number * @property {number} epoch_slot_number * @property {number} epoch_number * @property {number} [invalid_before] * @property {number} [invalid_hereafter] * @property {number} quantity */ /** * @typedef {Object} NativeAssetDetails * @property {string} policy_id * @property {string} asset_name * @property {*} metadata * @property {string} minted_at * @property {string} last_minted_at * @property {number} first_minting_tx_block * @property {number} last_minting_tx_block * @property {string} minting_tx_hash * @property {number} circulating_supply * @property {string} fingerprint */ /** * @typedef {Object} NativeAssetDetailsRequest * @property {string} policy_id * @property {string[]} [asset_names] */ /** * @typedef {Object} NativeAssetId * @property {string} policy_id * @property {string} asset_name * @property {number} block_number * @property {string} block_time * @property {string} fingerprint */ /** * @typedef {Object} NftDetails * @property {string} policy_id * @property {string} asset_name_raw * @property {string} [asset_name] * @property {*} metadata * @property {string} minted_at * @property {number} minted_at_block * @property {string} minting_tx_hash * @property {number} amount * @property {string} fingerprint */ /** * @typedef {Object} NftMetadata * @property {string} [name] * @property {string} [image] * @property {string} [mediaType] * @property {NftMetadataFile[]} [files] */ /** * @typedef {Object} NftMetadataFile * @property {string} [name] * @property {string} [src] * @property {string} [mediaType] */ /** * @typedef {Object} NftMetadataFilesAsObject * @property {string} [name] * @property {string} [image] * @property {string} [mediaType] * @property {NftMetadataFile} [files] */ /** * @typedef {Object} NftMetadataImgArray * @property {string} [name] * @property {string[]} [image] * @property {string} [mediaType] * @property {NftMetadataFile[]} [files] */ /** * @typedef {Object} NftMetadataNoFiles * @property {string} [name] * @property {string} [image] * @property {string} [mediaType] */ /** * @typedef {Object} PoolRetiring * @property {string} [ticker_name] * @property {string} pool_id * @property {number} certificate_index * @property {number} epoch_number * @property {number} block_number * @property {number} retiring_at_epoch * @property {string} tx_hash */ /** * @typedef {Object} PoolUpdate * @property {number} epoch_number * @property {number} block_number * @property {string} tx_hash * @property {string} [pool_ticker_name] * @property {string} pool_bech32_id * @property {number} certificate_index * @property {string} vrf_key_hash * @property {number} pledge * @property {string} reward_address * @property {number} active_epoch_number * @property {number} margin * @property {number} fixed_cost */ /** * @typedef {Object} Reward * @property {string} staking_address * @property {number} epoch * @property {number} amount * @property {string} pool_id */ /** * @typedef {Object} Sigma * @property {number} sigma * @property {number} epoch * @property {number} total_staked * @property {number} active_stake * @property {string} nonce * @property {number} d */ /** * @typedef {Object} Stakepool * @property {string} id the id of the pool * @property {string} pool_id_bech32 the id in bech32 format of the pool * @property {StakepoolMetadata} [metadata] * @property {number} cost operational costs per epoch in lovelaces * @property {number} margin operator margin, percentage (from 0 to 1) * @property {number} pledge pledge amount, in lovelaces * @property {number} active_stake active stake for current epoch in lovelaces * @property {number} saturation pool saturation as percentage (0 to 1) * @property {number} [retiring_at_epoch] if defined, is the epoch at which the pool will retire */ /** * @typedef {Object} StakepoolDelegation * @property {Stakepool} stakepool * @property {number} epoch */ /** * Stake Pool Offline Metadata * @typedef {Object} StakepoolMetadata * @property {string} name * @property {string} ticker * @property {string} homepage * @property {string} description * @property {string} [extended] */ /** * @typedef {Object} Transaction * @property {string} hash * @property {number} block * @property {string} timestamp */ /** * @typedef {Object} TransactionHistoryRequest * @property {string[]} addresses */ /** * @typedef {Object} WalletBalance * @property {number} balance */ // ----------------------------------------------------------------------------- // Union Typedefs // -----------------------------------------------------------------------------