models

type AccountListResponse struct {
	Accounts []string `json:"accounts" swagger:"required"`
}

type AccountNFTsResponse struct {
	NFTIDs []string `json:"nftIds" swagger:"required"`
}

type AccountNonceResponse struct {
	Nonce uint64 `json:"nonce" swagger:"required"`
}

type AccountsResponse struct {
	AccountIDs []string `json:"accountIds" swagger:"required"`
}

type AddUserRequest struct {
	Username    string   `json:"username" swagger:"required"`
	Password    string   `json:"password" swagger:"required"`
	Permissions []string `json:"permissions" swagger:"required"`
}

type AliasOutputMetricItem MetricItem[*Output]

type Allowance struct {
	FungibleTokens *FungibleTokens `json:"fungibleTokens" swagger:"required"`
	NFTs           []string        `json:"nfts" swagger:"required"`
}

type AssetsResponse struct {
	BaseTokens   uint64         `json:"baseTokens" swagger:"required"`
	NativeTokens []*NativeToken `json:"nativeTokens" swagger:"required"`
}

type BlockInfoResponse struct {
	AnchorTransactionID         string    `json:"anchorTransactionId" swagger:"required"`
	BlockIndex                  uint32    `json:"blockIndex" swagger:"required"`
	GasBurned                   uint64    `json:"gasBurned" swagger:"required"`
	GasFeeCharged               uint64    `json:"gasFeeCharged" swagger:"required"`
	L1CommitmentHash            string    `json:"l1CommitmentHash" swagger:"required"`
	NumOffLedgerRequests        uint16    `json:"numOffLedgerRequests" swagger:"required"`
	NumSuccessfulRequests       uint16    `json:"numSuccessfulRequests" swagger:"required"`
	PreviousL1CommitmentHash    string    `json:"previousL1CommitmentHash" swagger:"required"`
	Timestamp                   time.Time `json:"timestamp" swagger:"required"`
	TotalBaseTokensInL2Accounts uint64    `json:"totalBaseTokensInL2Accounts" swagger:"required"`
	TotalRequests               uint16    `json:"totalRequests" swagger:"required"`
	TotalStorageDeposit         uint64    `json:"totalStorageDeposit" swagger:"required"`
	TransactionSubEssenceHash   string    `json:"transactionSubEssenceHash" swagger:"required"`
}

type BlockReceiptError struct {
	Hash         string `json:"hash" swagger:"required"`
	ErrorMessage string `json:"errorMessage" swagger:"required"`
}

type BlockReceiptsResponse struct {
	Receipts []*RequestReceiptResponse `json:"receipts" swagger:"required"`
}

type ChainInfoResponse struct {
	IsActive        bool         `json:"isActive" swagger:"desc(Whether or not the chain is active.) required"`
	ChainID         string       `json:"chainID" swagger:"desc(ChainID (Bech32-encoded).) required"`
	EVMChainID      uint16       `json:"evmChainId" swagger:"desc(The EVM chain ID) required"`
	ChainOwnerID    string       `json:"chainOwnerId" swagger:"desc(The chain owner address (Bech32-encoded).) required"`
	Description     string       `json:"description" swagger:"desc(The description of the chain.) required"`
	GasFeePolicy    gasFeePolicy `json:"gasFeePolicy"`
	MaxBlobSize     uint32       `json:"maxBlobSize" swagger:"desc(The maximum contract blob size.) required"`
	MaxEventSize    uint16       `json:"maxEventSize" swagger:"desc(The maximum event size.) required"`                      // TODO: Clarify
	MaxEventsPerReq uint16       `json:"maxEventsPerReq" swagger:"desc(The maximum amount of events per request.) required"` // TODO: Clarify
}

type ChainMetrics struct {
	InAliasOutput                   AliasOutputMetricItem         `json:"inAliasOutput" swagger:"required"`
	InOnLedgerRequest               OnLedgerRequestMetricItem     `json:"inOnLedgerRequest" swagger:"required"`
	InOutput                        InOutputMetricItem            `json:"inOutput" swagger:"required"`
	InStateOutput                   InStateOutputMetricItem       `json:"inStateOutput" swagger:"required"`
	InTxInclusionState              TxInclusionStateMsgMetricItem `json:"inTxInclusionState" swagger:"required"`
	OutPublishGovernanceTransaction TransactionMetricItem         `json:"outPublishGovernanceTransaction" swagger:"required"`
	OutPullLatestOutput             InterfaceMetricItem           `json:"outPullLatestOutput" swagger:"required"`
	OutPullOutputByID               UTXOInputMetricItem           `json:"outPullOutputByID" swagger:"required"`
	OutPullTxInclusionState         TransactionIDMetricItem       `json:"outPullTxInclusionState" swagger:"required"`
}

type CommitteeInfoResponse struct {
	AccessNodes    []CommitteeNode `json:"accessNodes" swagger:"desc(A list of all access nodes and their peering info.),required"`
	Active         bool            `json:"active" swagger:"desc(Whether or not the chain is active.),required"`
	CandidateNodes []CommitteeNode `json:"candidateNodes" swagger:"desc(A list of all candidate nodes and their peering info.),required"`
	ChainID        string          `json:"chainId" swagger:"desc(ChainID (Bech32-encoded).),required"`
	CommitteeNodes []CommitteeNode `json:"committeeNodes" swagger:"desc(A list of all committee nodes and their peering info.),required"`
	StateAddress   string          `json:"stateAddress" swagger:"desc(State address, if we are part of it.),required"`
}

type CommitteeNode struct {
	AccessAPI string                    `json:"accessAPI" swagger:"required"`
	Node      PeeringNodeStatusResponse `json:"node" swagger:"required"`
}

type ConsensusPipeMetrics struct {
	EventStateTransitionMsgPipeSize int `json:"eventStateTransitionMsgPipeSize" swagger:"required"`
	EventPeerLogIndexMsgPipeSize    int `json:"eventPeerLogIndexMsgPipeSize" swagger:"required"`
	EventACSMsgPipeSize             int `json:"eventACSMsgPipeSize" swagger:"required"`
	EventVMResultMsgPipeSize        int `json:"eventVMResultMsgPipeSize" swagger:"required"`
	EventTimerMsgPipeSize           int `json:"eventTimerMsgPipeSize" swagger:"required"`
}

type ConsensusWorkflowMetrics struct {
	FlagStateReceived        bool `json:"flagStateReceived" swagger:"desc(Shows if state output is received in current consensus iteration),required"`
	FlagBatchProposalSent    bool `json:"flagBatchProposalSent" swagger:"desc(Shows if batch proposal is sent out in current consensus iteration),required"`
	FlagConsensusBatchKnown  bool `` /* 135-byte string literal not displayed */
	FlagVMStarted            bool `json:"flagVMStarted" swagger:"desc(Shows if virtual machine is started in current consensus iteration),required"`
	FlagVMResultSigned       bool `` /* 131-byte string literal not displayed */
	FlagTransactionFinalized bool `` /* 132-byte string literal not displayed */
	FlagTransactionPosted    bool `json:"flagTransactionPosted" swagger:"desc(Shows if transaction is posted to L1 in current consensus iteration),required"`
	FlagTransactionSeen      bool `` /* 136-byte string literal not displayed */
	FlagInProgress           bool `` /* 129-byte string literal not displayed */

	TimeBatchProposalSent    time.Time `` /* 128-byte string literal not displayed */
	TimeConsensusBatchKnown  time.Time `` /* 149-byte string literal not displayed */
	TimeVMStarted            time.Time `json:"timeVMStarted" swagger:"desc(Shows when virtual machine was last started in current consensus iteration),required"`
	TimeVMResultSigned       time.Time `` /* 146-byte string literal not displayed */
	TimeTransactionFinalized time.Time `` /* 184-byte string literal not displayed */
	TimeTransactionPosted    time.Time `` /* 129-byte string literal not displayed */
	TimeTransactionSeen      time.Time `` /* 151-byte string literal not displayed */
	TimeCompleted            time.Time `json:"timeCompleted" swagger:"desc(Shows when algorithm was last completed in current consensus iteration),required"`

	CurrentStateIndex uint32 `json:"currentStateIndex" swagger:"desc(Shows current state index of the consensus)"`
}

type ContractCallViewRequest struct {
	ChainID       string        `json:"chainId" swagger:"desc(The chain id),required"`
	ContractName  string        `json:"contractName" swagger:"desc(The contract name),required"`
	ContractHName string        `json:"contractHName" swagger:"desc(The contract name as HName (Hex)),required"`
	FunctionName  string        `json:"functionName" swagger:"desc(The function name),required"`
	FunctionHName string        `json:"functionHName" swagger:"desc(The function name as HName (Hex)),required"`
	Arguments     dict.JSONDict `json:"arguments" swagger:"desc(Encoded arguments to be passed to the function),required"`
}

type ContractInfoResponse struct {
	Description string            `json:"description" swagger:"desc(The description of the contract.),required"`
	HName       string            `json:"hName" swagger:"desc(The id (HName as Hex)) of the contract.),required"`
	Name        string            `json:"name" swagger:"desc(The name of the contract.),required"`
	ProgramHash hashing.HashValue `json:"programHash" swagger:"desc(The hash of the contract.),required"`
}

type ControlAddressesResponse struct {
	GoverningAddress string `json:"governingAddress" swagger:"required"`
	SinceBlockIndex  uint32 `json:"sinceBlockIndex" swagger:"required"`
	StateAddress     string `json:"stateAddress" swagger:"required"`
}

type DKSharesInfo struct {
	Address         string   `json:"address" swagger:"desc(New generated shared address.),required"`
	PeerIdentities  []string `json:"peerIdentities" swagger:"desc(Identities of the nodes sharing the key. (Hex)),required"`
	PeerIndex       *uint16  `json:"peerIndex" swagger:"desc(Index of the node returning the share, if it is a member of the sharing group.),required"`
	PublicKey       string   `json:"publicKey" swagger:"desc(Used public key. (Hex)),required"`
	PublicKeyShares []string `json:"publicKeyShares" swagger:"desc(Public key shares for all the peers. (Hex)),required"`
	Threshold       uint16   `json:"threshold" swagger:"required"`
}

type DKSharesPostRequest struct {
	PeerIdentities []string `json:"peerIdentities" swagger:"desc(Optional, Hex encoded public keys of the peers generating the DKS. (Hex)),required"`
	Threshold      uint16   `json:"threshold" swagger:"desc(Should be =< len(PeerPublicIdentities)),required"`
	TimeoutMS      uint32   `json:"timeoutMS" swagger:"desc(Timeout in milliseconds.),required"`
}

type EventsResponse struct {
	Events []string `json:"events" swagger:"required"`
}

type FoundryOutputResponse struct {
	FoundryID string         `json:"foundryId" swagger:"required"`
	Assets    AssetsResponse `json:"assets" swagger:"required"`
}

type FungibleTokens struct {
	BaseTokens   uint64         `json:"baseTokens" swagger:"required"`
	NativeTokens []*NativeToken `json:"nativeTokens" swagger:"required"`
}

type InOutput struct {
	OutputID string  `json:"outputId" swagger:"desc(The output ID),required"`
	Output   *Output `json:"output" swagger:"desc(The parsed output),required"`
}

type InOutputMetricItem MetricItem[*InOutput]

type InStateOutput struct {
	OutputID string  `json:"outputId" swagger:"desc(The output ID),required"`
	Output   *Output `json:"output" swagger:"desc(The parsed output),required"`
}

type InStateOutputMetricItem MetricItem[*InStateOutput]

type InfoResponse struct {
	Version   string    `json:"version" swagger:"desc(The version of the node),required"`
	PublicKey string    `json:"publicKey" swagger:"desc(The public key of the node (Hex)),required"`
	NetID     string    `json:"netID" swagger:"desc(The net id of the node),required"`
	L1Params  *L1Params `json:"l1Params" swagger:"desc(The L1 parameters),required"`
}

type InterfaceMetricItem MetricItem[interface{}]

type L1Params struct {
	MaxPayloadSize int                   `json:"maxPayloadSize" swagger:"desc(The max payload size),required"`
	Protocol       *ProtocolParameters   `json:"protocol" swagger:"desc(The protocol parameters),required"`
	BaseToken      *parameters.BaseToken `json:"baseToken" swagger:"desc(The base token parameters),required"`
}

type MetricItem[T interface{}] struct {
	Messages    uint32    `json:"messages" swagger:"required"`
	Timestamp   time.Time `json:"timestamp" swagger:"required"`
	LastMessage T         `json:"lastMessage" swagger:"required"`
}

type NFTDataResponse struct {
	ID       string `json:"id" swagger:"required"`
	Issuer   string `json:"issuer" swagger:"required"`
	Metadata string `json:"metadata" swagger:"required"`
	Owner    string `json:"owner" swagger:"required"`
}

type NativeToken struct {
	ID     string `json:"id" swagger:"required"`
	Amount string `json:"amount" swagger:"required"`
}

type NativeTokenIDRegistryResponse struct {
	NativeTokenRegistryIDs []string `json:"nativeTokenRegistryIds" swagger:"required"`
}

type NodeOwnerCertificateRequest struct {
	PublicKey    string `json:"publicKey" swagger:"desc(The public key of the node (Hex)),required"`
	OwnerAddress string `json:"ownerAddress" swagger:"desc(Node owner address. (Bech32)),required"`
}

type NodeOwnerCertificateResponse struct {
	Certificate string `json:"certificate" swagger:"desc(Certificate stating the ownership. (Hex)),required"`
}

type OffLedgerRequest struct {
	ChainID string `json:"chainId" swagger:"desc(The chain id),required"`
	Request string `json:"request" swagger:"desc(Offledger Request (Hex)),required"`
}

type OnLedgerRequest struct {
	ID       string  `json:"id" swagger:"desc(The request ID),required"`
	OutputID string  `json:"outputId" swagger:"desc(The output ID),required"`
	Output   *Output `json:"output" swagger:"desc(The parsed output),required"`
	Raw      string  `json:"raw" swagger:"desc(The raw data of the request (Hex)),required"`
}

type OnLedgerRequestMetricItem MetricItem[*OnLedgerRequest]

type Output struct {
	OutputType iotago.OutputType `json:"outputType" swagger:"desc(The output type),required"`
	Raw        string            `json:"raw" swagger:"desc(The raw data of the output (Hex)),required"`
}

type OutputID struct {
	OutputID string `json:"outputId" swagger:"desc(The output ID),required"`
}

type PeeringNodeIdentityResponse struct {
	PublicKey string `json:"publicKey" swagger:"desc(The peers public key encoded in Hex),required"`
	NetID     string `json:"netId" swagger:"desc(The NetID of the peer),required"`
	IsTrusted bool   `json:"isTrusted" swagger:"Desc(Whether or not the peer is trusted),required"`
}

type PeeringNodePublicKeyRequest struct {
	PublicKey string `json:"publicKey" swagger:"desc(The peers public key encoded in Hex),required"`
}

type PeeringNodeStatusResponse struct {
	IsAlive   bool   `json:"isAlive" swagger:"desc(Whether or not the peer is activated),required"`
	NetID     string `json:"netId" swagger:"desc(The NetID of the peer),required"`
	NumUsers  int    `json:"numUsers" swagger:"desc(The amount of users attached to the peer),required"`
	PublicKey string `json:"publicKey" swagger:"desc(The peers public key encoded in Hex),required"`
	IsTrusted bool   `json:"isTrusted" swagger:"Desc(Whether or not the peer is trusted),required"`
}

type PeeringTrustRequest struct {
	PublicKey string `json:"publicKey" swagger:"desc(The peers public key encoded in Hex),required"`
	NetID     string `json:"netId" swagger:"desc(The NetID of the peer),required"`
}

type ProtocolParameters struct {
	// The version of the protocol running.
	Version byte `json:"version" swagger:"desc(The protocol version),required"`
	// The human friendly name of the network.
	NetworkName string `json:"networkName" swagger:"desc(The network name),required"`
	// The HRP prefix used for Bech32 addresses in the network.
	Bech32HRP iotago.NetworkPrefix `json:"bech32Hrp" swagger:"desc(The human readable network prefix),required"`
	// The minimum pow score of the network.
	MinPoWScore uint32 `json:"minPowScore" swagger:"desc(The minimal PoW score),required"`
	// The below max depth parameter of the network.
	BelowMaxDepth uint8 `json:"belowMaxDepth" swagger:"desc(The networks max depth),required"`
	// The rent structure used by given node/network.
	RentStructure RentStructure `json:"rentStructure" swagger:"desc(The rent structure of the protocol),required"`
	// TokenSupply defines the current token supply on the network.
	TokenSupply string `json:"tokenSupply" swagger:"desc(The token supply),required"`
}

type ReceiptError struct {
	ContractID    isc.Hname     `json:"contractId" swagger:"required"`
	ErrorID       uint16        `json:"errorId" swagger:"required"`
	ErrorCode     string        `json:"errorCode" swagger:"required"`
	Message       string        `json:"message" swagger:"required"`
	MessageFormat string        `json:"messageFormat" swagger:"required"`
	Parameters    []interface{} `json:"parameters" swagger:"required"`
}

type ReceiptResponse struct {
	Request       string           `json:"request" swagger:"required"`
	Error         *ReceiptError    `json:"error"`
	GasBudget     uint64           `json:"gasBudget" swagger:"required"`
	GasBurned     uint64           `json:"gasBurned" swagger:"required"`
	GasFeeCharged uint64           `json:"gasFeeCharged" swagger:"required"`
	BlockIndex    uint32           `json:"blockIndex" swagger:"required"`
	RequestIndex  uint16           `json:"requestIndex" swagger:"required"`
	GasBurnLog    []gas.BurnRecord `json:"gasBurnLog" swagger:"required"`
}

type RentStructure struct {
	// Defines the rent of a single virtual byte denoted in IOTA tokens.
	VByteCost uint32 `json:"vByteCost" swagger:"desc(The virtual byte cost),required"`
	// Defines the factor to be used for data only fields.
	VBFactorData iotago.VByteCostFactor `json:"vByteFactorData" swagger:"desc(The virtual byte factor for data fields),required"`
	// defines the factor to be used for key/lookup generating fields.
	VBFactorKey iotago.VByteCostFactor `json:"vByteFactorKey" swagger:"desc(The virtual byte factor for key/lookup generating fields),required"`
}

type RequestDetail struct {
	Allowance      *Allowance       `json:"allowance" swagger:"required"`
	CallTarget     isc.CallTarget   `json:"callTarget" swagger:"required"`
	FungibleTokens *FungibleTokens  `json:"fungibleTokens" swagger:"required"`
	GasGudget      uint64           `json:"gasGudget" swagger:"required"`
	IsEVM          bool             `json:"isEVM" swagger:"required"`
	IsOffLedger    bool             `json:"isOffLedger" swagger:"required"`
	NFT            *NFTDataResponse `json:"nft" swagger:"required"`
	Params         dict.JSONDict    `json:"params" swagger:"required"`
	RequestID      string           `json:"requestId" swagger:"required"`
	SenderAccount  string           `json:"senderAccount" swagger:"required"`
	TargetAddress  string           `json:"targetAddress" swagger:"required"`
}

type RequestIDResponse struct {
	RequestID string `json:"requestId" swagger:"desc(The request ID of the given transaction ID.)"`
}

type RequestIDsResponse struct {
	RequestIDs []string `json:"requestIds" swagger:"required"`
}

type RequestProcessedResponse struct {
	ChainID     string `json:"chainId" swagger:"required"`
	RequestID   string `json:"requestId" swagger:"required"`
	IsProcessed bool   `json:"isProcessed" swagger:"required"`
}

type RequestReceiptResponse struct {
	BlockIndex    uint32             `json:"blockIndex" swagger:"required"`
	Error         *BlockReceiptError `json:"error" swagger:"required"`
	GasBudget     uint64             `json:"gasBudget" swagger:"required"`
	GasBurnLog    *gas.BurnLog       `json:"gasBurnLog" swagger:"required"`
	GasBurned     uint64             `json:"gasBurned" swagger:"required"`
	GasFeeCharged uint64             `json:"gasFeeCharged" swagger:"required"`
	Request       *RequestDetail     `json:"request" swagger:"required"`
	RequestIndex  uint16             `json:"requestIndex" swagger:"required"`
}

type StateTransaction struct {
	StateIndex    uint32 `json:"stateIndex" swagger:"desc(The state index),required"`
	TransactionID string `json:"txId" swagger:"desc(The transaction ID),required"`
}

type Transaction struct {
	TransactionID string `json:"txId" swagger:"desc(The transaction ID),required"`
}

type TransactionIDMetricItem MetricItem[*Transaction]

type TransactionMetricItem MetricItem[*Transaction]

type TxInclusionStateMsg struct {
	TransactionID string `json:"txId" swagger:"desc(The transaction ID),required"`
	State         string `json:"state" swagger:"desc(The inclusion state),required"`
}

type TxInclusionStateMsgMetricItem MetricItem[*TxInclusionStateMsg]

type UTXOInputMetricItem MetricItem[*OutputID]

type UpdateUserPasswordRequest struct {
	Password string `json:"password" swagger:"required"`
}

type UpdateUserPermissionsRequest struct {
	Permissions []string `json:"permissions" swagger:"required"`
}

type User struct {
	Username    string   `json:"username" swagger:"required"`
	Permissions []string `json:"permissions" swagger:"required"`
}