types

package
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 5, 2026 License: Apache-2.0, MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	WrappedToken = iota
	SovereignToken
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address string

Address represents an Ethereum address @Description A 20-byte Ethereum address @example "0xabcdef1234567890abcdef1234567890abcdef12"

type BigIntString 

type BigIntString string

BigIntString is a wrapper type for big.Int for Swagger compatibility @Description Big integer represented as a decimal string

func (BigIntString) ToBigInt 

func (b BigIntString) ToBigInt() *big.Int

ToBigInt converts the BigIntString to a big.Int

type BridgeResponse 

type BridgeResponse struct {
	// Block number where the bridge event was recorded
	BlockNum uint64 `json:"block_num" example:"1234"`

	// Position of the bridge event within the block
	BlockPos uint64 `json:"block_pos" example:"1"`

	// Address that initiated the transaction on bridge contract. It can be intermediary contract or EOA
	FromAddress Address `json:"from_address" example:"0xabc1234567890abcdef1234567890abcdef1234"`

	// Hash of the transaction that included the bridge event
	TxHash Hash `json:"tx_hash" example:"0xdef4567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"`

	// Global index of the bridge event (consisted of mainnet flag, rollup id and deposit count)
	GlobalIndex *big.Int `json:"global_index" example:"4294967296" swaggertype:"string"`

	// Timestamp of the block containing the bridge event
	BlockTimestamp uint64 `json:"block_timestamp" example:"1684500000"`

	// Type of leaf (bridge event type) used in the tree structure
	LeafType uint8 `json:"leaf_type" example:"1"`

	// ID of the network where the bridge transaction originated
	OriginNetwork uint32 `json:"origin_network" example:"10"`

	// Address of the token sender on the origin network
	OriginAddress Address `json:"origin_address" example:"0xabc1234567890abcdef1234567890abcdef1234"`

	// ID of the network where the bridge transaction is destined
	DestinationNetwork uint32 `json:"destination_network" example:"42161"`

	// Address of the token receiver on the destination network
	DestinationAddress Address `json:"destination_address" example:"0xdef4567890abcdef1234567890abcdef12345678"`

	// Amount of tokens being bridged
	Amount BigIntString `json:"amount" example:"1000000000000000000"`

	// Optional metadata attached to the bridge event
	Metadata string `json:"metadata" example:"0xdeadbeef"`

	// Count of total deposits processed so far for the given token/address
	DepositCount uint32 `json:"deposit_count" example:"10"`

	// Unique hash representing the bridge event, often used as an identifier
	BridgeHash Hash `json:"bridge_hash" example:"0xabc1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcd"`

	// Address of the transaction sender who initiated the bridge transaction
	TxnSender Address `json:"txn_sender" example:"0xabc1234567890abcdef1234567890abcdef12345"`

	// Address of the contract that was the recipient of the transaction. This may differ from the bridge contract address.
	ToAddress Address `json:"to_address" example:"0xF9D64d54D32EE2BDceAAbFA60C4C438E224427d0"`
}

BridgeResponse represents a bridge event response @Description Detailed information about a bridge event

type BridgesResult 

type BridgesResult struct {
	// List of bridge events
	Bridges []*BridgeResponse `json:"bridges"`

	// Total number of bridge events
	Count int `json:"count" example:"42"`
}

BridgesResult contains the bridges and the total count of bridges @Description Paginated response of bridge events

type ClaimProof 

type ClaimProof struct {
	// Merkle proof for the local exit root
	ProofLocalExitRoot Proof `json:"proof_local_exit_root" example:"[0x1, 0x2, 0x3...]"`

	// Merkle proof for the rollup exit root
	ProofRollupExitRoot Proof `json:"proof_rollup_exit_root" example:"[0x4, 0x5, 0x6...]"`

	// L1 info tree leaf data associated with the claim
	L1InfoTreeLeaf L1InfoTreeLeafResponse `json:"l1_info_tree_leaf"`
}

ClaimProof represents the Merkle proofs (local and rollup exit roots) and the L1 info tree leaf required to verify a claim in the bridge.

@Description Claim proof structure for verifying claims in the bridge

type ClaimResponse 

type ClaimResponse struct {
	// Block number where the claim was processed
	BlockNum uint64 `json:"block_num" example:"1234"`

	// Timestamp of the block containing the claim
	BlockTimestamp uint64 `json:"block_timestamp" example:"1684500000"`

	// Transaction hash associated with the claim
	TxHash Hash `json:"tx_hash" example:"0xdef4567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"`

	// Global index of the claim
	GlobalIndex BigIntString `json:"global_index" example:"1000000000000000000"`

	// Address initiating the claim on the origin network
	OriginAddress Address `json:"origin_address" example:"0xabc1234567890abcdef1234567890abcdef1234"`

	// Origin network ID where the claim was initiated
	OriginNetwork uint32 `json:"origin_network" example:"10"`

	// Address receiving the claim on the destination network
	DestinationAddress Address `json:"destination_address" example:"0xdef4567890abcdef1234567890abcdef12345678"`

	// Destination network ID where the claim was processed
	DestinationNetwork uint32 `json:"destination_network" example:"42161"`

	// Amount claimed
	Amount BigIntString `json:"amount" example:"1000000000000000000"`

	// Address from which the claim originated
	FromAddress Address `json:"from_address" example:"0xabc1234567890abcdef1234567890abcdef1234"`

	// Mainnet exit root associated with the claim
	MainnetExitRoot Hash `json:"mainnet_exit_root" example:"0x27ae5ba08d7291c96c8cbddcc148bf48a6d68c7974b94356f53754ef6171d757"` //nolint:lll

	// Rollup exit root associated with the claim
	RollupExitRoot Hash `json:"rollup_exit_root" example:"0x27ae5ba08d7291c96c8cbddcc148bf48a6d68c7974b94356f53754ef6171d757"` //nolint:lll

	// Global exit root associated with the claim
	GlobalExitRoot Hash `json:"global_exit_root" example:"0x27ae5ba08d7291c96c8cbddcc148bf48a6d68c7974b94356f53754ef6171d757"` //nolint:lll

	// Proof local exit root associated with the claim (optional)
	ProofLocalExitRoot *Proof `json:"proof_local_exit_root,omitempty" example:"[0x1, 0x2, 0x3...]"`

	// Proof rollup exit root associated with the claim (optional)
	ProofRollupExitRoot *Proof `json:"proof_rollup_exit_root,omitempty" example:"[0x4, 0x5, 0x6...]"`

	// Metadata associated with the claim
	Metadata string `json:"metadata" example:"0xdeadbeef"`
}

ClaimResponse represents a claim event response @Description Detailed information about a claim event

type ClaimsResult 

type ClaimsResult struct {
	// List of claims matching the query
	Claims []*ClaimResponse `json:"claims"`

	// Total number of matching claims
	Count int `json:"count" example:"42"`
}

ClaimsResult contains the list of claim records and the total count @Description Paginated response containing claim events and total count

type ErrorResponse 

type ErrorResponse struct {
	Error string `json:"error" example:"Error message"`
}

ErrorResponse defines a generic error structure. @Description Generic error response structure

type Hash 

type Hash string

Hash represents an Ethereum hash @Description A 32-byte Ethereum hash @example "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"

type HealthCheckResponse 

type HealthCheckResponse struct {
	Status  string    `json:"status"`
	Time    time.Time `json:"time"`
	Version string    `json:"version"`
}

HealthCheckResponse represents the JSON returned by HealthCheckHandler. @Description Contains basic health‐check information for the bridge service including service status, current time, and version. @example {"status":"ok","time":"2025-06-05T07:30:00Z","version":"v0.4.0-beta9-tmp-bridge-6-g4d9b717"}

type L1InfoTreeLeafResponse 

type L1InfoTreeLeafResponse struct {
	// Block number where the leaf was recorded
	BlockNumber uint64 `json:"block_num" example:"123456"`

	// Position of the leaf in the block (used for ordering)
	BlockPosition uint64 `json:"block_pos" example:"5"`

	// Index of this leaf in the L1 info tree
	L1InfoTreeIndex uint32 `json:"l1_info_tree_index" example:"42"`

	// Hash of the previous block in the tree
	PreviousBlockHash Hash `json:"previous_block_hash" example:"0xabc1...bcd"`

	// Timestamp of the block in seconds since the Unix epoch
	Timestamp uint64 `json:"timestamp" example:"1684500000"`

	// Mainnet exit root at this leaf
	MainnetExitRoot Hash `json:"mainnet_exit_root" example:"0xdefc...789"`

	// Rollup exit root at this leaf
	RollupExitRoot Hash `json:"rollup_exit_root" example:"0x7890...123"`

	// Global exit root computed from mainnet and rollup roots
	// @example "0x4567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef123"
	GlobalExitRoot Hash `json:"global_exit_root"`

	// Unique hash identifying this leaf node
	Hash Hash `json:"hash" example:"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"`
}

L1InfoTreeLeafResponse represents a leaf node in the L1 info tree used for bridge state verification.

This includes references to the block and exit roots relevant to L1 and rollup state.

type LegacyTokenMigrationResponse 

type LegacyTokenMigrationResponse struct {
	// Block number where the migration occurred
	BlockNum uint64 `json:"block_num" example:"1234"`

	// Position of the transaction in the block
	BlockPos uint64 `json:"block_pos" example:"1"`

	// Timestamp of the block
	BlockTimestamp uint64 `json:"block_timestamp" example:"1684500000"`

	// Transaction hash of the migration event
	TxHash Hash `json:"tx_hash" example:"0xabc123..."`

	// Address of the sender initiating the migration
	Sender Address `json:"sender" example:"0xabc123..."`

	// Legacy token address being migrated
	LegacyTokenAddress Address `json:"legacy_token_address" example:"0xdef456..."`

	// New updated token address after migration
	UpdatedTokenAddress Address `json:"updated_token_address" example:"0xfeed789..."`

	// Amount of tokens migrated
	Amount BigIntString `json:"amount" example:"1000000000000000000"`
}

LegacyTokenMigrationResponse represents a MigrateLegacyToken event emitted by the sovereign chain bridge contract @Description Details of a legacy token migration event

type LegacyTokenMigrationsResult 

type LegacyTokenMigrationsResult struct {
	// List of legacy token migration events
	TokenMigrations []*LegacyTokenMigrationResponse `json:"legacy_token_migrations"`

	// Total number of legacy token migration events
	Count int `json:"count" example:"12"`
}

LegacyTokenMigrationsResult contains the legacy token migrations and the total count of such migrations @Description Paginated response of legacy token migrations

type NetworkSyncInfo 

type NetworkSyncInfo struct {
	ContractDepositCount     uint32 `json:"contract_deposit_count" example:"676797" description:"Bridge deposits in contract"`     //nolint:lll
	SynchronizedDepositCount uint32 `json:"synchronized_deposit_count" example:"676797" description:"Bridge deposits in database"` //nolint:lll
	IsSynced                 bool   `json:"is_synced" example:"true" description:"True if counts match (sync up-to-date)"`
	IsActive                 bool   `json:"is_active" example:"true" description:"True if bridge syncer is running"`
	LastProcessedBlock       uint64 `json:"last_processed_block,omitempty" example:"12345678" description:"Last block processed"` //nolint:lll
	NetworkBlock             uint64 `json:"network_block,omitempty" example:"12350000" description:"Current latest block"`
}

NetworkSyncInfo represents the bridge synchronization status of a single network (L1 or L2) @Description Network-specific bridge sync status with deposit counts and block information @example {"contract_deposit_count":100,"synchronized_deposit_count":100,"is_synced":true,"is_active":true, "last_processed_block":1234,"network_block":2555}

type Proof 

type Proof [tree.DefaultHeight]Hash

Proof represents a Merkle proof for a tree of a given height @Description Merkle proof structure for a tree of a given height

func ConvertToProofResponse 

func ConvertToProofResponse(proof tree.Proof) Proof

ConvertToProofResponse converts a Merkle proof to a ProofResponse @Description Converts a Merkle proof to a ProofResponse

type RemoveGEREventResponse added in v0.8.0 

type RemoveGEREventResponse struct {
	// Global Exit Root hash that was removed
	GlobalExitRoot Hash `json:"global_exit_root" example:"0x27ae5ba08d7291c96c8cbddcc148bf48a6d68c7974b94356f53754ef6171d757"` //nolint:lll

	// Block number where the GER was removed
	BlockNum uint64 `json:"block_num" example:"1234"`

	// Position of the event within the block
	BlockPos uint64 `json:"block_pos" example:"0"`

	// Timestamp when the remove event was recorded in database
	CreatedAt uint64 `json:"created_at" example:"1684500000"`
}

RemoveGEREventResponse represents a remove GER event response @Description Information about a GER removal event

type RemoveGEREventsResult added in v0.8.0 

type RemoveGEREventsResult struct {
	// List of remove GER events
	RemoveGEREvents []*RemoveGEREventResponse `json:"remove_ger_events"`

	// Total number of remove GER events
	Count int `json:"count" example:"10"`
}

RemoveGEREventsResult contains the remove GER events and the total count @Description Paginated response of remove GER events

type SyncStatus 

type SyncStatus struct {
	L1Info *NetworkSyncInfo `json:"l1_info" description:"L1 network bridge sync status"`
	L2Info *NetworkSyncInfo `json:"l2_info" description:"L2 network bridge sync status"`
}

SyncStatus represents the bridge synchronization status for both L1 and L2 networks @Description Bridge sync status comparing on-chain deposit counts with local database counts @example {"l1_info":{"contract_deposit_count":100,"synchronized_deposit_count":100, "is_synced":true,"is_active":true},"l2_info":{"contract_deposit_count":200, "synchronized_deposit_count":200,"is_synced":true,"is_active":true}}

type TokenMappingResponse 

type TokenMappingResponse struct {
	// Block number where the token mapping was recorded
	BlockNum uint64 `json:"block_num" example:"123456"`

	// Position of the mapping event within the block
	BlockPos uint64 `json:"block_pos" example:"2"`

	// Timestamp of the block containing the mapping event
	BlockTimestamp uint64 `json:"block_timestamp" example:"1684501234"`

	// Transaction hash associated with the mapping event
	TxHash Hash `json:"tx_hash" example:"0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd"`

	// ID of the origin network where the original token resides
	OriginNetwork uint32 `json:"origin_network" example:"1"`

	// Address of the token on the origin network
	OriginTokenAddress Address `json:"origin_token_address" example:"0x1234567890abcdef1234567890abcdef12345678"`

	// Address of the wrapped token on the destination network
	WrappedTokenAddress Address `json:"wrapped_token_address" example:"0xabcdef1234567890abcdef1234567890abcdef12"`

	// Optional metadata associated with the token mapping
	Metadata string `json:"metadata" example:"0xdeadbeef"`

	// Indicates whether the wrapped token is not mintable (true = not mintable)
	IsNotMintable bool `json:"is_not_mintable" example:"false"`

	// Type of the token mapping: 0 = WrappedToken, 1 = SovereignToken
	Type TokenMappingType `json:"token_type" example:"0"`
}

TokenMappingResponse represents a token mapping event @Description Detailed information about a token mapping between origin and wrapped networks

type TokenMappingType 

type TokenMappingType uint8

TokenMappingType defines the type of token mapping @Description Enum for token mapping types @Enum TokenMappingType

func (TokenMappingType) String 

func (l TokenMappingType) String() string

type TokenMappingsResult 

type TokenMappingsResult struct {
	// List of token mapping entries
	TokenMappings []*TokenMappingResponse `json:"token_mappings"`

	// Total number of token mapping records
	Count int `json:"count" example:"27"`
}

TokenMappingsResult contains the token mappings and the total count of token mappings @Description Paginated response of token mapping records

type UnsetClaimResponse added in v0.8.0 

type UnsetClaimResponse struct {
	// Block number where the unset claim was processed
	BlockNum uint64 `json:"block_num" example:"1234"`

	// Position of the unset claim event within the block
	BlockPos uint64 `json:"block_pos" example:"2"`

	// Transaction hash associated with the unset claim
	TxHash Hash `json:"tx_hash" example:"0xdef4567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"`

	// Global index of the claim that was unset
	GlobalIndex BigIntString `json:"global_index" example:"1000000000000000000"`

	// Hash chain value for unset global indexes
	UnsetGlobalIndexHashChain Hash `json:"unset_global_index_hash_chain" example:"0x1234567890abcdef"`

	// Timestamp when the unset claim was created
	CreatedAt uint64 `json:"created_at" example:"1684500000"`
}

UnsetClaimResponse represents an unset claim event response @Description Detailed information about an unset claim event (UpdatedUnsetGlobalIndexHashChain)

type UnsetClaimsResult added in v0.8.0 

type UnsetClaimsResult struct {
	// List of unset claim events
	UnsetClaims []*UnsetClaimResponse `json:"unset_claims"`

	// Total number of unset claim events
	Count int `json:"count" example:"15"`
}

UnsetClaimsResult contains the unset claims and the total count @Description Paginated response of unset claim events (L2 networks only)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.