package kava.bep3.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the bep3 Msg service.

• rpc CreateAtomicSwap (MsgCreateAtomicSwap, MsgCreateAtomicSwapResponse)

  tx.proto:13

  CreateAtomicSwap defines a method for creating an atomic swap

  message MsgCreateAtomicSwap

  tx.proto:23

  MsgCreateAtomicSwap defines the Msg/CreateAtomicSwap request type.

  • string from = 1

  • string to = 2

  • string recipient_other_chain = 3

  • string sender_other_chain = 4

  • string random_number_hash = 5

  • int64 timestamp = 6

  • repeated cosmos.base.v1beta1.Coin amount = 7

  • uint64 height_span = 8

  message MsgCreateAtomicSwapResponse

  tx.proto:42

  MsgCreateAtomicSwapResponse defines the Msg/CreateAtomicSwap response type.

  (message has no fields)

• rpc ClaimAtomicSwap (MsgClaimAtomicSwap, MsgClaimAtomicSwapResponse)

  tx.proto:16

  ClaimAtomicSwap defines a method for claiming an atomic swap

  message MsgClaimAtomicSwap

  tx.proto:45

  MsgClaimAtomicSwap defines the Msg/ClaimAtomicSwap request type.

  • string from = 1

  • string swap_id = 2

  • string random_number = 3

  message MsgClaimAtomicSwapResponse

  tx.proto:56

  MsgClaimAtomicSwapResponse defines the Msg/ClaimAtomicSwap response type.

  (message has no fields)

• rpc RefundAtomicSwap (MsgRefundAtomicSwap, MsgRefundAtomicSwapResponse)

  tx.proto:19

  RefundAtomicSwap defines a method for refunding an atomic swap

  message MsgRefundAtomicSwap

  tx.proto:59

  MsgRefundAtomicSwap defines the Msg/RefundAtomicSwap request type.

  • string from = 1

  • string swap_id = 2

  message MsgRefundAtomicSwapResponse

  tx.proto:69

  MsgRefundAtomicSwapResponse defines the Msg/RefundAtomicSwap response type.

  (message has no fields)

Query defines the gRPC querier service for bep3 module

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:17

  Params queries module params

  message QueryParamsRequest

  query.proto:43

  QueryParamsRequest defines the request type for querying x/bep3 parameters.

  (message has no fields)

  message QueryParamsResponse

  query.proto:46

  QueryParamsResponse defines the response type for querying x/bep3 parameters.

  • optional Params params = 1

    params represents the parameters of the module

• rpc AssetSupply (QueryAssetSupplyRequest, QueryAssetSupplyResponse)

  query.proto:22

  AssetSupply queries info about an asset's supply

  message QueryAssetSupplyRequest

  query.proto:52

  QueryAssetSupplyRequest is the request type for the Query/AssetSupply RPC method.

  • string denom = 1

    denom filters the asset response for the specified denom

  message QueryAssetSupplyResponse

  query.proto:78

  QueryAssetSupplyResponse is the response type for the Query/AssetSupply RPC method.

  • optional AssetSupplyResponse asset_supply = 1

    asset_supply represents the supply of the asset

• rpc AssetSupplies (QueryAssetSuppliesRequest, QueryAssetSuppliesResponse)

  query.proto:27

  AssetSupplies queries a list of asset supplies

  message QueryAssetSuppliesRequest

  query.proto:84

  QueryAssetSuppliesRequest is the request type for the Query/AssetSupplies RPC method.

  (message has no fields)

  message QueryAssetSuppliesResponse

  query.proto:90

  QueryAssetSuppliesResponse is the response type for the Query/AssetSupplies RPC method.

  • repeated AssetSupplyResponse asset_supplies = 1

    asset_supplies represents the supplies of returned assets

• rpc AtomicSwap (QueryAtomicSwapRequest, QueryAtomicSwapResponse)

  query.proto:32

  AtomicSwap queries info about an atomic swap

  message QueryAtomicSwapRequest

  query.proto:96

  QueryAtomicSwapRequest is the request type for the Query/AtomicSwap RPC method.

  • string swap_id = 1

    swap_id represents the id of the swap to query

  message QueryAtomicSwapResponse

  query.proto:105

  QueryAtomicSwapResponse is the response type for the Query/AtomicSwap RPC method.

  • optional AtomicSwapResponse atomic_swap = 2

• rpc AtomicSwaps (QueryAtomicSwapsRequest, QueryAtomicSwapsResponse)

  query.proto:37

  AtomicSwaps queries a list of atomic swaps

  message QueryAtomicSwapsRequest

  query.proto:143

  QueryAtomicSwapsRequest is the request type for the Query/AtomicSwaps RPC method.

  • string involve = 1

    involve filters by address

  • uint64 expiration = 2

    expiration filters by expiration block height

  • SwapStatus status = 3

    status filters by swap status

  • SwapDirection direction = 4

    direction fitlers by swap direction

  • optional cosmos.base.query.v1beta1.PageRequest pagination = 5

  message QueryAtomicSwapsResponse

  query.proto:160

  QueryAtomicSwapsResponse is the response type for the Query/AtomicSwaps RPC method.

  • repeated AtomicSwapResponse atomic_swaps = 1

    atomic_swap represents the returned atomic swaps for the request

  • optional cosmos.base.query.v1beta1.PageResponse pagination = 3

AssetParam defines parameters for each bep3 asset.

Used in: Params

• string denom = 1

  denom represents the denominatin for this asset

• int64 coin_id = 2

  coin_id represents the registered coin type to use (https://github.com/satoshilabs/slips/blob/master/slip-0044.md)

• optional SupplyLimit supply_limit = 3

  supply_limit defines the maximum supply allowed for the asset - a total or time based rate limit

• bool active = 4

  active specifies if the asset is live or paused

• bytes deputy_address = 5

  deputy_address the kava address of the deputy

• string fixed_fee = 6

  fixed_fee defines the fee for incoming swaps

• string min_swap_amount = 7

  min_swap_amount defines the minimum amount able to be swapped in a single message

• string max_swap_amount = 8

  max_swap_amount defines the maximum amount able to be swapped in a single message

• uint64 min_block_lock = 9

  min_block_lock defined the minimum blocks to lock

• uint64 max_block_lock = 10

  min_block_lock defined the maximum blocks to lock

AssetSupply defines information about an asset's supply.

Used in: GenesisState

• optional cosmos.base.v1beta1.Coin incoming_supply = 1

  incoming_supply represents the incoming supply of an asset

• optional cosmos.base.v1beta1.Coin outgoing_supply = 2

  outgoing_supply represents the outgoing supply of an asset

• optional cosmos.base.v1beta1.Coin current_supply = 3

  current_supply represents the current on-chain supply of an asset

• optional cosmos.base.v1beta1.Coin time_limited_current_supply = 4

  time_limited_current_supply represents the time limited current supply of an asset

• optional google.protobuf.Duration time_elapsed = 5

  time_elapsed represents the time elapsed

AssetSupplyResponse defines information about an asset's supply.

Used in: QueryAssetSuppliesResponse, QueryAssetSupplyResponse

• optional cosmos.base.v1beta1.Coin incoming_supply = 1

  incoming_supply represents the incoming supply of an asset

• optional cosmos.base.v1beta1.Coin outgoing_supply = 2

  outgoing_supply represents the outgoing supply of an asset

• optional cosmos.base.v1beta1.Coin current_supply = 3

  current_supply represents the current on-chain supply of an asset

• optional cosmos.base.v1beta1.Coin time_limited_current_supply = 4

  time_limited_current_supply represents the time limited current supply of an asset

• optional google.protobuf.Duration time_elapsed = 5

  time_elapsed represents the time elapsed

AtomicSwap defines an atomic swap between chains for the pricefeed module.

Used in: GenesisState

• repeated cosmos.base.v1beta1.Coin amount = 1

  amount represents the amount being swapped

• bytes random_number_hash = 2

  random_number_hash represents the hash of the random number

• uint64 expire_height = 3

  expire_height represents the height when the swap expires

• int64 timestamp = 4

  timestamp represents the timestamp of the swap

• bytes sender = 5

  sender is the kava chain sender of the swap

• bytes recipient = 6

  recipient is the kava chain recipient of the swap

• string sender_other_chain = 7

  sender_other_chain is the sender on the other chain

• string recipient_other_chain = 8

  recipient_other_chain is the recipient on the other chain

• int64 closed_block = 9

  closed_block is the block when the swap is closed

• SwapStatus status = 10

  status represents the current status of the swap

• bool cross_chain = 11

  cross_chain identifies whether the atomic swap is cross chain

• SwapDirection direction = 12

  direction identifies if the swap is incoming or outgoing

AtomicSwapResponse represents the returned atomic swap properties

Used in: QueryAtomicSwapResponse, QueryAtomicSwapsResponse

• string id = 1

  id represents the id of the atomic swap

• repeated cosmos.base.v1beta1.Coin amount = 2

  amount represents the amount being swapped

• string random_number_hash = 3

  random_number_hash represents the hash of the random number

• uint64 expire_height = 4

  expire_height represents the height when the swap expires

• int64 timestamp = 5

  timestamp represents the timestamp of the swap

• string sender = 6

  sender is the kava chain sender of the swap

• string recipient = 7

  recipient is the kava chain recipient of the swap

• string sender_other_chain = 8

  sender_other_chain is the sender on the other chain

• string recipient_other_chain = 9

  recipient_other_chain is the recipient on the other chain

• int64 closed_block = 10

  closed_block is the block when the swap is closed

• SwapStatus status = 11

  status represents the current status of the swap

• bool cross_chain = 12

  cross_chain identifies whether the atomic swap is cross chain

• SwapDirection direction = 13

  direction identifies if the swap is incoming or outgoing

GenesisState defines the pricefeed module's genesis state.

• optional Params params = 1

  params defines all the parameters of the module.

• repeated AtomicSwap atomic_swaps = 2

  atomic_swaps represents the state of stored atomic swaps

• repeated AssetSupply supplies = 3

  supplies represents the supply information of each atomic swap

• optional google.protobuf.Timestamp previous_block_time = 4

  previous_block_time represents the time of the previous block

Params defines the parameters for the bep3 module.

Used in: GenesisState, QueryParamsResponse

• repeated AssetParam asset_params = 1

  asset_params define the parameters for each bep3 asset

SupplyLimit define the absolute and time-based limits for an assets's supply.

Used in: AssetParam

• string limit = 1

  limit defines the total supply allowed

• bool time_limited = 2

  time_limited enables or disables time based supply limiting

• optional google.protobuf.Duration time_period = 3

  time_period specifies the duration that time_based_limit is evalulated

• string time_based_limit = 4

  time_based_limit defines the maximum supply that can be swapped within time_period

SwapDirection is the direction of an AtomicSwap

Used in: AtomicSwap, AtomicSwapResponse, QueryAtomicSwapsRequest

• SWAP_DIRECTION_UNSPECIFIED = 0

  SWAP_DIRECTION_UNSPECIFIED represents unspecified or invalid swap direcation

• SWAP_DIRECTION_INCOMING = 1

  SWAP_DIRECTION_INCOMING represents is incoming swap (to the kava chain)

• SWAP_DIRECTION_OUTGOING = 2

  SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the kava chain)

SwapStatus is the status of an AtomicSwap

Used in: AtomicSwap, AtomicSwapResponse, QueryAtomicSwapsRequest

• SWAP_STATUS_UNSPECIFIED = 0

  SWAP_STATUS_UNSPECIFIED represents an unspecified status

• SWAP_STATUS_OPEN = 1

  SWAP_STATUS_OPEN represents an open swap

• SWAP_STATUS_COMPLETED = 2

  SWAP_STATUS_COMPLETED represents a completed swap

• SWAP_STATUS_EXPIRED = 3

  SWAP_STATUS_EXPIRED represents an expired swap