go-cyber/docs/proto/proto-docs.md

π 0.0%

Protobuf Documentation

Table of Contents

cyber/bandwidth/v1beta1/types.proto

cyber/bandwidth/v1beta1/genesis.proto

cyber/bandwidth/v1beta1/query.proto

cyber/bandwidth/v1beta1/tx.proto

cyber/clock/v1/clock.proto

cyber/clock/v1/genesis.proto

cyber/clock/v1/query.proto

cyber/clock/v1/tx.proto

cyber/dmn/v1beta1/types.proto

cyber/dmn/v1beta1/genesis.proto

cyber/dmn/v1beta1/query.proto

cyber/dmn/v1beta1/tx.proto

cyber/graph/v1beta1/query.proto

cyber/graph/v1beta1/types.proto

cyber/graph/v1beta1/tx.proto

cyber/grid/v1beta1/types.proto

cyber/grid/v1beta1/genesis.proto

cyber/grid/v1beta1/query.proto

cyber/grid/v1beta1/tx.proto

cyber/liquidity/v1beta1/tx.proto

cyber/liquidity/v1beta1/liquidity.proto

cyber/liquidity/v1beta1/genesis.proto

cyber/liquidity/v1beta1/query.proto

cyber/rank/v1beta1/types.proto

cyber/rank/v1beta1/genesis.proto

cyber/rank/v1beta1/pagination.proto

cyber/rank/v1beta1/query.proto

cyber/rank/v1beta1/tx.proto

cyber/resources/v1beta1/types.proto

cyber/resources/v1beta1/genesis.proto

cyber/resources/v1beta1/query.proto

cyber/resources/v1beta1/tx.proto

osmosis/tokenfactory/v1beta1/authority_metadata.proto

osmosis/tokenfactory/v1beta1/params.proto

osmosis/tokenfactory/v1beta1/genesis.proto

osmosis/tokenfactory/v1beta1/query.proto

osmosis/tokenfactory/v1beta1/tx.proto

Scalar Value Types

Top

cyber/bandwidth/v1beta1/types.proto

NeuronBandwidth

Field Type Label Description
neuron string
remained_value uint64
last_updated_block uint64
max_value uint64

Params

Field Type Label Description
recovery_period uint64
adjust_price_period uint64
base_price string
base_load string
max_block_bandwidth uint64

Price

Field Type Label Description
price string

Top

cyber/bandwidth/v1beta1/genesis.proto

GenesisState

Field Type Label Description
params Params

Top

cyber/bandwidth/v1beta1/query.proto

QueryLoadRequest

QueryLoadResponse

Field Type Label Description
load string

QueryNeuronBandwidthRequest

Field Type Label Description
neuron string

QueryNeuronBandwidthResponse

Field Type Label Description
neuron_bandwidth NeuronBandwidth

QueryParamsRequest

QueryParamsResponse

Field Type Label Description
params Params

QueryPriceRequest

QueryPriceResponse

Field Type Label Description
price string

QueryTotalBandwidthRequest

QueryTotalBandwidthResponse

Field Type Label Description
total_bandwidth uint64

Query

Method Name Request Type Response Type Description HTTP Verb Endpoint
Load QueryLoadRequest QueryLoadResponse GET /cyber/bandwidth/v1beta1/bandwidth/load
Price QueryPriceRequest QueryPriceResponse GET /cyber/bandwidth/v1beta1/bandwidth/price
TotalBandwidth QueryTotalBandwidthRequest QueryTotalBandwidthResponse GET /cyber/bandwidth/v1beta1/bandwidth/total
NeuronBandwidth QueryNeuronBandwidthRequest QueryNeuronBandwidthResponse GET /cyber/bandwidth/v1beta1/bandwidth/neuron/{neuron}
Params QueryParamsRequest QueryParamsResponse GET /cyber/bandwidth/v1beta1/bandwidth/params

Top

cyber/bandwidth/v1beta1/tx.proto

MsgUpdateParams

Field Type Label Description
authority string
params Params

MsgUpdateParamsResponse

Msg

Method Name Request Type Response Type Description HTTP Verb Endpoint
UpdateParams MsgUpdateParams MsgUpdateParamsResponse

Top

cyber/clock/v1/clock.proto

ClockContract

This object is used to store the contract address and the jail status of the contract.

Field Type Label Description
contract_address string The address of the contract.
is_jailed bool The jail status of the contract.

Top

cyber/clock/v1/genesis.proto

GenesisState

GenesisState - initial state of module

Field Type Label Description
params Params Params of this module

Params

Params defines the set of module parameters.

Field Type Label Description
contract_gas_limit uint64 contract_gas_limit defines the maximum amount of gas that can be used by a contract.

Top

cyber/clock/v1/query.proto

QueryClockContract

QueryClockContract is the request type to get a single contract.

Field Type Label Description
contract_address string contract_address is the address of the contract to query.

QueryClockContractResponse

QueryClockContractResponse is the response type for the Query/ClockContract RPC method.

Field Type Label Description
clock_contract ClockContract contract is the clock contract.

QueryClockContracts

QueryClockContracts is the request type to get all contracts.

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryClockContractsResponse

QueryClockContractsResponse is the response type for the Query/ClockContracts RPC method.

Field Type Label Description
clock_contracts ClockContract repeated clock_contracts are the clock contracts.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryParamsRequest

QueryParams is the request type to get all module params.

QueryParamsResponse

QueryClockContractsResponse is the response type for the Query/ClockContracts RPC method.

Field Type Label Description
params Params

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
ClockContracts QueryClockContracts QueryClockContractsResponse ClockContracts GET /cyber/clock/v1/contracts
ClockContract QueryClockContract QueryClockContractResponse ClockContract GET /cyber/clock/v1/contracts/{contract_address}
Params QueryParamsRequest QueryParamsResponse Params GET /cyber/clock/v1/params

Top

cyber/clock/v1/tx.proto

MsgRegisterClockContract

MsgRegisterClockContract is the Msg/RegisterClockContract request type.

Field Type Label Description
sender_address string The address of the sender.
contract_address string The address of the contract to register.

MsgRegisterClockContractResponse

MsgRegisterClockContractResponse defines the response structure for executing a MsgRegisterClockContract message.

MsgUnjailClockContract

MsgUnjailClockContract is the Msg/UnjailClockContract request type.

Field Type Label Description
sender_address string The address of the sender.
contract_address string The address of the contract to unjail.

MsgUnjailClockContractResponse

MsgUnjailClockContractResponse defines the response structure for executing a MsgUnjailClockContract message.

MsgUnregisterClockContract

MsgUnregisterClockContract is the Msg/UnregisterClockContract request type.

Field Type Label Description
sender_address string The address of the sender.
contract_address string The address of the contract to unregister.

MsgUnregisterClockContractResponse

MsgUnregisterClockContractResponse defines the response structure for executing a MsgUnregisterClockContract message.

MsgUpdateParams

MsgUpdateParams is the Msg/UpdateParams request type.

Since: cosmos-sdk 0.47

Field Type Label Description
authority string authority is the address of the governance account.
params Params params defines the x/clock parameters to update.

NOTE: All parameters must be supplied. |

MsgUpdateParamsResponse

MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.

Since: cosmos-sdk 0.47

Msg

Msg defines the Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
RegisterClockContract MsgRegisterClockContract MsgRegisterClockContractResponse RegisterClockContract defines the endpoint for registering a new clock contract. POST /cyber/clock/v1/tx/register
UnregisterClockContract MsgUnregisterClockContract MsgUnregisterClockContractResponse UnregisterClockContract defines the endpoint for unregistering a clock contract. POST /cyber/clock/v1/tx/unregister
UnjailClockContract MsgUnjailClockContract MsgUnjailClockContractResponse UnjailClockContract defines the endpoint for unjailing a clock contract. POST /cyber/clock/v1/tx/unjail
UpdateParams MsgUpdateParams MsgUpdateParamsResponse UpdateParams defines a governance operation for updating the x/clock module parameters. The authority is hard-coded to the x/gov module account.

Since: cosmos-sdk 0.47 | |

Top

cyber/dmn/v1beta1/types.proto

Load

Field Type Label Description
input string
gas_price cosmos.base.v1beta1.Coin

Params

Field Type Label Description
max_slots uint32
max_gas uint32
fee_ttl uint32

Thought

Field Type Label Description
program string
trigger Trigger
load Load
name string
particle string

ThoughtStats

Field Type Label Description
program string
name string
calls uint64
fees uint64
gas uint64
last_block uint64

Trigger

Field Type Label Description
period uint64
block uint64

Top

cyber/dmn/v1beta1/genesis.proto

GenesisState

Field Type Label Description
params Params

Top

cyber/dmn/v1beta1/query.proto

QueryParamsRequest

QueryParamsResponse

Field Type Label Description
params Params

QueryThoughtParamsRequest

Field Type Label Description
program string
name string

QueryThoughtResponse

Field Type Label Description
thought Thought

QueryThoughtStatsResponse

Field Type Label Description
thought_stats ThoughtStats

QueryThoughtsFeesRequest

QueryThoughtsFeesResponse

Field Type Label Description
fees cosmos.base.v1beta1.Coin repeated

QueryThoughtsRequest

QueryThoughtsResponse

Field Type Label Description
thoughts Thought repeated

QueryThoughtsStatsRequest

QueryThoughtsStatsResponse

Field Type Label Description
thoughts_stats ThoughtStats repeated

Query

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse GET /cyber/dmn/v1beta1/dmn/params
Thought QueryThoughtParamsRequest QueryThoughtResponse GET /cyber/dmn/v1beta1/dmn/thought
ThoughtStats QueryThoughtParamsRequest QueryThoughtStatsResponse GET /cyber/dmn/v1beta1/dmn/thought_stats
Thoughts QueryThoughtsRequest QueryThoughtsResponse GET /cyber/dmn/v1beta1/dmn/thoughts
ThoughtsStats QueryThoughtsStatsRequest QueryThoughtsStatsResponse GET /cyber/dmn/v1beta1/dmn/thoughts_stats
ThoughtsFees QueryThoughtsFeesRequest QueryThoughtsFeesResponse GET /cyber/dmn/v1beta1/dmn/thoughts_fees

Top

cyber/dmn/v1beta1/tx.proto

MsgChangeThoughtBlock

Field Type Label Description
program string
name string
block uint64

MsgChangeThoughtBlockResponse

MsgChangeThoughtGasPrice

Field Type Label Description
program string
name string
gas_price cosmos.base.v1beta1.Coin

MsgChangeThoughtGasPriceResponse

MsgChangeThoughtInput

Field Type Label Description
program string
name string
input string

MsgChangeThoughtInputResponse

MsgChangeThoughtName

Field Type Label Description
program string
name string
new_name string

MsgChangeThoughtNameResponse

MsgChangeThoughtParticle

Field Type Label Description
program string
name string
particle string

MsgChangeThoughtParticleResponse

MsgChangeThoughtPeriod

Field Type Label Description
program string
name string
period uint64

MsgChangeThoughtPeriodResponse

MsgCreateThought

Field Type Label Description
program string
trigger Trigger
load Load
name string
particle string

MsgCreateThoughtResponse

MsgForgetThought

Field Type Label Description
program string
name string

MsgForgetThoughtResponse

MsgUpdateParams

Field Type Label Description
authority string
params Params

MsgUpdateParamsResponse

Msg

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateThought MsgCreateThought MsgCreateThoughtResponse
ForgetThought MsgForgetThought MsgForgetThoughtResponse
ChangeThoughtParticle MsgChangeThoughtParticle MsgChangeThoughtParticleResponse
ChangeThoughtName MsgChangeThoughtName MsgChangeThoughtNameResponse
ChangeThoughtInput MsgChangeThoughtInput MsgChangeThoughtInputResponse
ChangeThoughtGasPrice MsgChangeThoughtGasPrice MsgChangeThoughtGasPriceResponse
ChangeThoughtPeriod MsgChangeThoughtPeriod MsgChangeThoughtPeriodResponse
ChangeThoughtBlock MsgChangeThoughtBlock MsgChangeThoughtBlockResponse
UpdateParams MsgUpdateParams MsgUpdateParamsResponse

Top

cyber/graph/v1beta1/query.proto

QueryBurnStatsRequest

QueryBurnStatsResponse

Field Type Label Description
millivolt uint64
milliampere uint64

QueryGraphStatsRequest

QueryGraphStatsResponse

Field Type Label Description
cyberlinks uint64
particles uint64

Query

Method Name Request Type Response Type Description HTTP Verb Endpoint
GraphStats QueryGraphStatsRequest QueryGraphStatsResponse GET /cyber/graph/v1beta1/graph_stats
BurnStats QueryBurnStatsRequest QueryBurnStatsResponse GET /cyber/graph/v1beta1/burn_stats

Top

cyber/graph/v1beta1/types.proto

Link

Field Type Label Description
from string
to string

Top

cyber/graph/v1beta1/tx.proto

MsgCyberlink

Field Type Label Description
neuron string
links Link repeated

MsgCyberlinkResponse

Msg

Method Name Request Type Response Type Description HTTP Verb Endpoint
Cyberlink MsgCyberlink MsgCyberlinkResponse

Top

cyber/grid/v1beta1/types.proto

Params

Field Type Label Description
max_routes uint32

Route

Field Type Label Description
source string
destination string
name string
value cosmos.base.v1beta1.Coin repeated

Value

Field Type Label Description
value cosmos.base.v1beta1.Coin repeated

Top

cyber/grid/v1beta1/genesis.proto

GenesisState

Field Type Label Description
params Params
routes Route repeated

Top

cyber/grid/v1beta1/query.proto

QueryDestinationRequest

Field Type Label Description
destination string

QueryParamsRequest

QueryParamsResponse

Field Type Label Description
params Params

QueryRouteRequest

Field Type Label Description
source string
destination string

QueryRouteResponse

Field Type Label Description
route Route

QueryRoutedEnergyResponse

Field Type Label Description
value cosmos.base.v1beta1.Coin repeated

QueryRoutesRequest

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest

QueryRoutesResponse

Field Type Label Description
routes Route repeated
pagination cosmos.base.query.v1beta1.PageResponse

QuerySourceRequest

Field Type Label Description
source string

Query

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse GET /cyber/grid/v1beta1/grid/params
SourceRoutes QuerySourceRequest QueryRoutesResponse GET /cyber/grid/v1beta1/grid/source_routes
DestinationRoutes QueryDestinationRequest QueryRoutesResponse GET /cyber/grid/v1beta1/grid/destination_routes
DestinationRoutedEnergy QueryDestinationRequest QueryRoutedEnergyResponse GET /cyber/grid/v1beta1/grid/destination_routed_energy
SourceRoutedEnergy QuerySourceRequest QueryRoutedEnergyResponse GET /cyber/grid/v1beta1/grid/source_routed_energy
Route QueryRouteRequest QueryRouteResponse GET /cyber/grid/v1beta1/grid/route
Routes QueryRoutesRequest QueryRoutesResponse GET /cyber/grid/v1beta1/grid/routes

Top

cyber/grid/v1beta1/tx.proto

MsgCreateRoute

Field Type Label Description
source string
destination string
name string

MsgCreateRouteResponse

MsgDeleteRoute

Field Type Label Description
source string
destination string

MsgDeleteRouteResponse

MsgEditRoute

Field Type Label Description
source string
destination string
value cosmos.base.v1beta1.Coin

MsgEditRouteName

Field Type Label Description
source string
destination string
name string

MsgEditRouteNameResponse

MsgEditRouteResponse

MsgUpdateParams

Field Type Label Description
authority string
params Params

MsgUpdateParamsResponse

Msg

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateRoute MsgCreateRoute MsgCreateRouteResponse
EditRoute MsgEditRoute MsgEditRouteResponse
DeleteRoute MsgDeleteRoute MsgDeleteRouteResponse
EditRouteName MsgEditRouteName MsgEditRouteNameResponse
UpdateParams MsgUpdateParams MsgUpdateParamsResponse

Top

cyber/liquidity/v1beta1/tx.proto

MsgCreatePool

MsgCreatePool defines an sdk.Msg type that supports submitting a create liquidity pool tx.

See: https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md

Field Type Label Description
pool_creator_address string
pool_type_id uint32 id of the target pool type, must match the value in the pool. Only pool-type-id 1 is supported.
deposit_coins cosmos.base.v1beta1.Coin repeated reserve coin pair of the pool to deposit.

MsgCreatePoolResponse

MsgCreatePoolResponse defines the Msg/CreatePool response type.

MsgDepositWithinBatch

MsgDepositWithinBatch defines an sdk.Msg type that supports submitting a deposit request to the batch of the liquidity pool. Deposit is submitted to the batch of the Liquidity pool with the specified pool_id, deposit_coins for reserve. This request is stacked in the batch of the liquidity pool, is not processed immediately, and is processed in the endblock at the same time as other requests.

See: https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md

Field Type Label Description
depositor_address string
pool_id uint64 id of the target pool
deposit_coins cosmos.base.v1beta1.Coin repeated reserve coin pair of the pool to deposit

MsgDepositWithinBatchResponse

MsgDepositWithinBatchResponse defines the Msg/DepositWithinBatch response type.

MsgSwapWithinBatch

MsgSwapWithinBatch defines an sdk.Msg type that supports submitting a swap offer request to the batch of the liquidity pool. Submit swap offer to the liquidity pool batch with the specified the pool_id, swap_type_id, demand_coin_denom with the coin and the price you're offering and offer_coin_fee must be half of offer coin amount * current params.swap_fee_rate and ceil for reservation to pay fees. This request is stacked in the batch of the liquidity pool, is not processed immediately, and is processed in the endblock at the same time as other requests. You must request the same fields as the pool. Only the default swap_type_id 1 is supported.

See: https://github.com/gravity-devs/liquidity/tree/develop/doc https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md

Field Type Label Description
swap_requester_address string address of swap requester
pool_id uint64 id of swap type, must match the value in the pool. Only swap_type_id 1 is supported.
swap_type_id uint32 id of swap type. Must match the value in the pool.
offer_coin cosmos.base.v1beta1.Coin offer sdk.coin for the swap request, must match the denom in the pool.
demand_coin_denom string denom of demand coin to be exchanged on the swap request, must match the denom in the pool.
offer_coin_fee cosmos.base.v1beta1.Coin half of offer coin amount * params.swap_fee_rate and ceil for reservation to pay fees.
order_price string limit order price for the order, the price is the exchange ratio of X/Y where X is the amount of the first coin and Y is the amount of the second coin when their denoms are sorted alphabetically.

MsgSwapWithinBatchResponse

MsgSwapWithinBatchResponse defines the Msg/Swap response type.

MsgWithdrawWithinBatch

MsgWithdrawWithinBatch defines an sdk.Msg type that supports submitting a withdraw request to the batch of the liquidity pool. Withdraw is submitted to the batch from the Liquidity pool with the specified pool_id, pool_coin of the pool. This request is stacked in the batch of the liquidity pool, is not processed immediately, and is processed in the endblock at the same time as other requests.

See: https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md

Field Type Label Description
withdrawer_address string
pool_id uint64 id of the target pool
pool_coin cosmos.base.v1beta1.Coin

MsgWithdrawWithinBatchResponse

MsgWithdrawWithinBatchResponse defines the Msg/WithdrawWithinBatch response type.

Msg

Msg defines the liquidity Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreatePool MsgCreatePool MsgCreatePoolResponse Submit a create liquidity pool message.
DepositWithinBatch MsgDepositWithinBatch MsgDepositWithinBatchResponse Submit a deposit to the liquidity pool batch.
WithdrawWithinBatch MsgWithdrawWithinBatch MsgWithdrawWithinBatchResponse Submit a withdraw from the liquidity pool batch.
Swap MsgSwapWithinBatch MsgSwapWithinBatchResponse Submit a swap to the liquidity pool batch.

Top

cyber/liquidity/v1beta1/liquidity.proto

DepositMsgState

DepositMsgState defines the state of deposit message that contains state information as it is processed in the next batch or batches.

Field Type Label Description
msg_height int64 height where this message is appended to the batch
msg_index uint64 index of this deposit message in this liquidity pool
executed bool true if executed on this batch, false if not executed
succeeded bool true if executed successfully on this batch, false if failed
to_be_deleted bool true if ready to be deleted on kvstore, false if not ready to be deleted
msg MsgDepositWithinBatch MsgDepositWithinBatch

Params

Params defines the parameters for the liquidity module.

Field Type Label Description
pool_types PoolType repeated list of available pool types
min_init_deposit_amount string Minimum number of coins to be deposited to the liquidity pool on pool creation.
init_pool_coin_mint_amount string Initial mint amount of pool coins upon pool creation.
max_reserve_coin_amount string Limit the size of each liquidity pool to minimize risk. In development, set to 0 for no limit. In production, set a limit.
pool_creation_fee cosmos.base.v1beta1.Coin repeated Fee paid to create a Liquidity Pool. Set a fee to prevent spamming.
swap_fee_rate string Swap fee rate for every executed swap.
withdraw_fee_rate string Reserve coin withdrawal with less proportion by withdrawFeeRate.
max_order_amount_ratio string Maximum ratio of reserve coins that can be ordered at a swap order.
unit_batch_height uint32 The smallest unit batch height for every liquidity pool.
circuit_breaker_enabled bool Circuit breaker enables or disables transaction messages in liquidity module.

Pool

Pool defines the liquidity pool that contains pool information.

Field Type Label Description
id uint64 id of the pool
type_id uint32 id of the pool_type
reserve_coin_denoms string repeated denoms of reserve coin pair of the pool
reserve_account_address string reserve account address of the pool
pool_coin_denom string denom of pool coin of the pool

PoolBatch

PoolBatch defines the batch or batches of a given liquidity pool that contains indexes of deposit, withdraw, and swap messages. Index param increments by 1 if the pool id is same.

Field Type Label Description
pool_id uint64 id of the pool
index uint64 index of this batch
begin_height int64 height where this batch is started
deposit_msg_index uint64 last index of DepositMsgStates
withdraw_msg_index uint64 last index of WithdrawMsgStates
swap_msg_index uint64 last index of SwapMsgStates
executed bool true if executed, false if not executed

PoolMetadata

Metadata for the state of each pool for invariant checking after genesis export or import.

Field Type Label Description
pool_id uint64 id of the pool
pool_coin_total_supply cosmos.base.v1beta1.Coin pool coin issued at the pool
reserve_coins cosmos.base.v1beta1.Coin repeated reserve coins deposited in the pool

PoolType

Structure for the pool type to distinguish the characteristics of the reserve pools.

Field Type Label Description
id uint32 This is the id of the pool_type that is used as pool_type_id for pool creation. In this version, only pool-type-id 1 is supported. {"id":1,"name":"ConstantProductLiquidityPool","min_reserve_coin_num":2,"max_reserve_coin_num":2,"description":""}
name string name of the pool type.
min_reserve_coin_num uint32 minimum number of reserveCoins for LiquidityPoolType, only 2 reserve coins are supported.
max_reserve_coin_num uint32 maximum number of reserveCoins for LiquidityPoolType, only 2 reserve coins are supported.
description string description of the pool type.

SwapMsgState

SwapMsgState defines the state of the swap message that contains state information as the message is processed in the next batch or batches.

Field Type Label Description
msg_height int64 height where this message is appended to the batch
msg_index uint64 index of this swap message in this liquidity pool
executed bool true if executed on this batch, false if not executed
succeeded bool true if executed successfully on this batch, false if failed
to_be_deleted bool true if ready to be deleted on kvstore, false if not ready to be deleted
order_expiry_height int64 swap orders are cancelled when current height is equal to or higher than ExpiryHeight
exchanged_offer_coin cosmos.base.v1beta1.Coin offer coin exchanged until now
remaining_offer_coin cosmos.base.v1beta1.Coin offer coin currently remaining to be exchanged
reserved_offer_coin_fee cosmos.base.v1beta1.Coin reserve fee for pays fee in half offer coin
msg MsgSwapWithinBatch MsgSwapWithinBatch

WithdrawMsgState

WithdrawMsgState defines the state of the withdraw message that contains state information as the message is processed in the next batch or batches.

Field Type Label Description
msg_height int64 height where this message is appended to the batch
msg_index uint64 index of this withdraw message in this liquidity pool
executed bool true if executed on this batch, false if not executed
succeeded bool true if executed successfully on this batch, false if failed
to_be_deleted bool true if ready to be deleted on kvstore, false if not ready to be deleted
msg MsgWithdrawWithinBatch MsgWithdrawWithinBatch

Top

cyber/liquidity/v1beta1/genesis.proto

GenesisState

GenesisState defines the liquidity module's genesis state.

Field Type Label Description
params Params params defines all the parameters for the liquidity module.
pool_records PoolRecord repeated

PoolRecord

records the state of each pool after genesis export or import, used to check variables

Field Type Label Description
pool Pool
pool_metadata PoolMetadata
pool_batch PoolBatch
deposit_msg_states DepositMsgState repeated
withdraw_msg_states WithdrawMsgState repeated
swap_msg_states SwapMsgState repeated

Top

cyber/liquidity/v1beta1/query.proto

QueryLiquidityPoolBatchRequest

the request type for the QueryLiquidityPoolBatch RPC method. requestable including specified pool_id.

Field Type Label Description
pool_id uint64 id of the target pool for query

QueryLiquidityPoolBatchResponse

the response type for the QueryLiquidityPoolBatchResponse RPC method. Returns the liquidity pool batch that corresponds to the requested pool_id.

Field Type Label Description
batch PoolBatch

QueryLiquidityPoolByPoolCoinDenomRequest

the request type for the QueryLiquidityByPoolCoinDenomPool RPC method. Requestable specified pool_coin_denom.

Field Type Label Description
pool_coin_denom string

QueryLiquidityPoolByReserveAccRequest

the request type for the QueryLiquidityByReserveAcc RPC method. Requestable specified reserve_acc.

Field Type Label Description
reserve_acc string

QueryLiquidityPoolRequest

the request type for the QueryLiquidityPool RPC method. requestable specified pool_id.

Field Type Label Description
pool_id uint64

QueryLiquidityPoolResponse

the response type for the QueryLiquidityPoolResponse RPC method. Returns the liquidity pool that corresponds to the requested pool_id.

Field Type Label Description
pool Pool

QueryLiquidityPoolsRequest

the request type for the QueryLiquidityPools RPC method. Requestable including pagination offset, limit, key.

Field Type Label Description
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryLiquidityPoolsResponse

the response type for the QueryLiquidityPoolsResponse RPC method. This includes a list of all existing liquidity pools and paging results that contain next_key and total count.

Field Type Label Description
pools Pool repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response. not working on this version.

QueryParamsRequest

QueryParamsRequest is request type for the QueryParams RPC method.

QueryParamsResponse

the response type for the QueryParamsResponse RPC method. This includes current parameter of the liquidity module.

Field Type Label Description
params Params params holds all the parameters of this module.

QueryPoolBatchDepositMsgRequest

the request type for the QueryPoolBatchDeposit RPC method. requestable including specified pool_id and msg_index.

Field Type Label Description
pool_id uint64 id of the target pool for query
msg_index uint64 target msg_index of the pool

QueryPoolBatchDepositMsgResponse

the response type for the QueryPoolBatchDepositMsg RPC method. This includes a batch swap message of the batch.

Field Type Label Description
deposit DepositMsgState

QueryPoolBatchDepositMsgsRequest

the request type for the QueryPoolBatchDeposit RPC method. Requestable including specified pool_id and pagination offset, limit, key.

Field Type Label Description
pool_id uint64 id of the target pool for query
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryPoolBatchDepositMsgsResponse

the response type for the QueryPoolBatchDeposit RPC method. This includes a list of all currently existing deposit messages of the batch and paging results that contain next_key and total count.

Field Type Label Description
deposits DepositMsgState repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response. not working on this version.

QueryPoolBatchSwapMsgRequest

the request type for the QueryPoolBatchSwap RPC method. Requestable including specified pool_id and msg_index.

Field Type Label Description
pool_id uint64 id of the target pool for query
msg_index uint64 target msg_index of the pool

QueryPoolBatchSwapMsgResponse

the response type for the QueryPoolBatchSwapMsg RPC method. This includes a batch swap message of the batch.

Field Type Label Description
swap SwapMsgState

QueryPoolBatchSwapMsgsRequest

the request type for the QueryPoolBatchSwapMsgs RPC method. Requestable including specified pool_id and pagination offset, limit, key.

Field Type Label Description
pool_id uint64 id of the target pool for query
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryPoolBatchSwapMsgsResponse

the response type for the QueryPoolBatchSwapMsgs RPC method. This includes list of all currently existing swap messages of the batch and paging results that contain next_key and total count.

Field Type Label Description
swaps SwapMsgState repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response. not working on this version.

QueryPoolBatchWithdrawMsgRequest

the request type for the QueryPoolBatchWithdraw RPC method. requestable including specified pool_id and msg_index.

Field Type Label Description
pool_id uint64 id of the target pool for query
msg_index uint64 target msg_index of the pool

QueryPoolBatchWithdrawMsgResponse

the response type for the QueryPoolBatchWithdrawMsg RPC method. This includes a batch swap message of the batch.

Field Type Label Description
withdraw WithdrawMsgState

QueryPoolBatchWithdrawMsgsRequest

the request type for the QueryPoolBatchWithdraw RPC method. Requestable including specified pool_id and pagination offset, limit, key.

Field Type Label Description
pool_id uint64 id of the target pool for query
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryPoolBatchWithdrawMsgsResponse

the response type for the QueryPoolBatchWithdraw RPC method. This includes a list of all currently existing withdraw messages of the batch and paging results that contain next_key and total count.

Field Type Label Description
withdraws WithdrawMsgState repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response. Not supported on this version.

Query

Query defines the gRPC query service for the liquidity module.

Method Name Request Type Response Type Description HTTP Verb Endpoint
LiquidityPools QueryLiquidityPoolsRequest QueryLiquidityPoolsResponse Get existing liquidity pools. GET /cosmos/liquidity/v1beta1/pools
LiquidityPool QueryLiquidityPoolRequest QueryLiquidityPoolResponse Get specific liquidity pool. GET /cosmos/liquidity/v1beta1/pools/{pool_id}
LiquidityPoolByPoolCoinDenom QueryLiquidityPoolByPoolCoinDenomRequest QueryLiquidityPoolResponse Get specific liquidity pool corresponding to the pool_coin_denom. GET /cosmos/liquidity/v1beta1/pools/pool_coin_denom/{pool_coin_denom}
LiquidityPoolByReserveAcc QueryLiquidityPoolByReserveAccRequest QueryLiquidityPoolResponse Get specific liquidity pool corresponding to the reserve account. GET /cosmos/liquidity/v1beta1/pools/reserve_acc/{reserve_acc}
LiquidityPoolBatch QueryLiquidityPoolBatchRequest QueryLiquidityPoolBatchResponse Get the pool's current batch. GET /cosmos/liquidity/v1beta1/pools/{pool_id}/batch
PoolBatchSwapMsgs QueryPoolBatchSwapMsgsRequest QueryPoolBatchSwapMsgsResponse Get all swap messages in the pool's current batch. GET /cosmos/liquidity/v1beta1/pools/{pool_id}/batch/swaps
PoolBatchSwapMsg QueryPoolBatchSwapMsgRequest QueryPoolBatchSwapMsgResponse Get a specific swap message in the pool's current batch. GET /cosmos/liquidity/v1beta1/pools/{pool_id}/batch/swaps/{msg_index}
PoolBatchDepositMsgs QueryPoolBatchDepositMsgsRequest QueryPoolBatchDepositMsgsResponse Get all deposit messages in the pool's current batch. GET /cosmos/liquidity/v1beta1/pools/{pool_id}/batch/deposits
PoolBatchDepositMsg QueryPoolBatchDepositMsgRequest QueryPoolBatchDepositMsgResponse Get a specific deposit message in the pool's current batch. GET /cosmos/liquidity/v1beta1/pools/{pool_id}/batch/deposits/{msg_index}
PoolBatchWithdrawMsgs QueryPoolBatchWithdrawMsgsRequest QueryPoolBatchWithdrawMsgsResponse Get all withdraw messages in the pool's current batch. GET /cosmos/liquidity/v1beta1/pools/{pool_id}/batch/withdraws
PoolBatchWithdrawMsg QueryPoolBatchWithdrawMsgRequest QueryPoolBatchWithdrawMsgResponse Get a specific withdraw message in the pool's current batch. GET /cosmos/liquidity/v1beta1/pools/{pool_id}/batch/withdraws/{msg_index}
Params QueryParamsRequest QueryParamsResponse Get all parameters of the liquidity module. GET /cosmos/liquidity/v1beta1/params

Top

cyber/rank/v1beta1/types.proto

Params

Field Type Label Description
calculation_period int64
damping_factor string
tolerance string

RankedParticle

Field Type Label Description
particle string
rank uint64

Top

cyber/rank/v1beta1/genesis.proto

GenesisState

Field Type Label Description
params Params

Top

cyber/rank/v1beta1/pagination.proto

PageRequest

Field Type Label Description
page uint32
per_page uint32

PageResponse

Field Type Label Description
total uint32

Top

cyber/rank/v1beta1/query.proto

QueryIsAnyLinkExistRequest

Field Type Label Description
from string
to string

QueryIsLinkExistRequest

Field Type Label Description
from string
to string
address string

QueryKarmaRequest

Field Type Label Description
neuron string

QueryKarmaResponse

Field Type Label Description
karma uint64

QueryLinkExistResponse

Field Type Label Description
exist bool

QueryNegentropyParticleResponse

Field Type Label Description
entropy uint64

QueryNegentropyPartilceRequest

Field Type Label Description
particle string

QueryNegentropyRequest

QueryNegentropyResponse

Field Type Label Description
negentropy uint64

QueryParamsRequest

QueryParamsResponse

Field Type Label Description
params Params

QueryRankRequest

Field Type Label Description
particle string

QueryRankResponse

Field Type Label Description
rank uint64

QuerySearchRequest

Field Type Label Description
particle string
pagination PageRequest

QuerySearchResponse

Field Type Label Description
result RankedParticle repeated
pagination PageResponse

QueryTopRequest

Field Type Label Description
pagination PageRequest

Query

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse GET /cyber/rank/v1beta1/rank/params
Rank QueryRankRequest QueryRankResponse GET /cyber/rank/v1beta1/rank/rank/{particle}
Search QuerySearchRequest QuerySearchResponse GET /cyber/rank/v1beta1/rank/search/{particle}
Backlinks QuerySearchRequest QuerySearchResponse GET /cyber/rank/v1beta1/rank/backlinks/{particle}
Top QueryTopRequest QuerySearchResponse GET /cyber/rank/v1beta1/rank/top
IsLinkExist QueryIsLinkExistRequest QueryLinkExistResponse GET /cyber/rank/v1beta1/is_link_exist
IsAnyLinkExist QueryIsAnyLinkExistRequest QueryLinkExistResponse GET /cyber/rank/v1beta1/is_any_link_exist
ParticleNegentropy QueryNegentropyPartilceRequest QueryNegentropyParticleResponse GET /cyber/rank/v1beta1/negentropy/{particle}
Negentropy QueryNegentropyRequest QueryNegentropyResponse GET /cyber/rank/v1beta1/negentropy
Karma QueryKarmaRequest QueryKarmaResponse GET /cyber/rank/v1beta1/karma/{neuron}

Top

cyber/rank/v1beta1/tx.proto

MsgUpdateParams

Field Type Label Description
authority string
params Params

MsgUpdateParamsResponse

Msg

Method Name Request Type Response Type Description HTTP Verb Endpoint
UpdateParams MsgUpdateParams MsgUpdateParamsResponse

Top

cyber/resources/v1beta1/types.proto

Params

Field Type Label Description
max_slots uint32
halving_period_volt_blocks uint32
halving_period_ampere_blocks uint32
base_investmint_period_volt uint32
base_investmint_period_ampere uint32
min_investmint_period uint32
base_investmint_amount_volt cosmos.base.v1beta1.Coin
base_investmint_amount_ampere cosmos.base.v1beta1.Coin

Top

cyber/resources/v1beta1/genesis.proto

GenesisState

Field Type Label Description
params Params

Top

cyber/resources/v1beta1/query.proto

QueryAdjustedPriceRequest

Field Type Label Description
base cosmos.base.v1beta1.Coin
resource string

QueryAdjustedPriceResponse

Field Type Label Description
adjusted cosmos.base.v1beta1.Coin

QueryInvestmintRequest

Field Type Label Description
amount cosmos.base.v1beta1.Coin
resource string
length uint64

QueryInvestmintResponse

Field Type Label Description
amount cosmos.base.v1beta1.Coin

QueryParamsRequest

QueryParamsResponse

Field Type Label Description
params Params

Query

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse GET /cyber/resources/v1beta1/resources/params
Investmint QueryInvestmintRequest QueryInvestmintResponse GET /cyber/resources/v1beta1/resources/investmint
AdjustedPrice QueryAdjustedPriceRequest QueryAdjustedPriceResponse GET /cyber/resources/v1beta1/resources/adjusted_price

Top

cyber/resources/v1beta1/tx.proto

MsgInvestmint

Field Type Label Description
neuron string
amount cosmos.base.v1beta1.Coin
resource string
length uint64

MsgInvestmintResponse

MsgUpdateParams

Field Type Label Description
authority string
params Params

MsgUpdateParamsResponse

Msg

Method Name Request Type Response Type Description HTTP Verb Endpoint
Investmint MsgInvestmint MsgInvestmintResponse
UpdateParams MsgUpdateParams MsgUpdateParamsResponse

Top

osmosis/tokenfactory/v1beta1/authority_metadata.proto

DenomAuthorityMetadata

DenomAuthorityMetadata specifies metadata for addresses that have specific capabilities over a token factory denom. Right now there is only one Admin permission, but is planned to be extended to the future.

Field Type Label Description
admin string Can be empty for no admin, or a valid osmosis address

Top

osmosis/tokenfactory/v1beta1/params.proto

Params

Params defines the parameters for the tokenfactory module.

Field Type Label Description
denom_creation_fee cosmos.base.v1beta1.Coin repeated
denom_creation_gas_consume uint64 if denom_creation_fee is an empty array, then this field is used to add more gas consumption to the base cost. https://github.com/CosmWasm/token-factory/issues/11

Top

osmosis/tokenfactory/v1beta1/genesis.proto

GenesisDenom

GenesisDenom defines a tokenfactory denom that is defined within genesis state. The structure contains DenomAuthorityMetadata which defines the denom's admin.

Field Type Label Description
denom string
authority_metadata DenomAuthorityMetadata

GenesisState

GenesisState defines the tokenfactory module's genesis state.

Field Type Label Description
params Params params defines the parameters of the module.
factory_denoms GenesisDenom repeated

Top

osmosis/tokenfactory/v1beta1/query.proto

QueryDenomAuthorityMetadataRequest

QueryDenomAuthorityMetadataRequest defines the request structure for the DenomAuthorityMetadata gRPC query.

Field Type Label Description
denom string

QueryDenomAuthorityMetadataResponse

QueryDenomAuthorityMetadataResponse defines the response structure for the DenomAuthorityMetadata gRPC query.

Field Type Label Description
authority_metadata DenomAuthorityMetadata

QueryDenomsFromCreatorRequest

QueryDenomsFromCreatorRequest defines the request structure for the DenomsFromCreator gRPC query.

Field Type Label Description
creator string

QueryDenomsFromCreatorResponse

QueryDenomsFromCreatorRequest defines the response structure for the DenomsFromCreator gRPC query.

Field Type Label Description
denoms string repeated

QueryParamsRequest

QueryParamsRequest is the request type for the Query/Params RPC method.

QueryParamsResponse

QueryParamsResponse is the response type for the Query/Params RPC method.

Field Type Label Description
params Params params defines the parameters of the module.

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params defines a gRPC query method that returns the tokenfactory module's parameters. GET /osmosis/tokenfactory/v1beta1/params
DenomAuthorityMetadata QueryDenomAuthorityMetadataRequest QueryDenomAuthorityMetadataResponse DenomAuthorityMetadata defines a gRPC query method for fetching DenomAuthorityMetadata for a particular denom. GET /osmosis/tokenfactory/v1beta1/denoms/{denom}/authority_metadata
DenomsFromCreator QueryDenomsFromCreatorRequest QueryDenomsFromCreatorResponse DenomsFromCreator defines a gRPC query method for fetching all denominations created by a specific admin/creator. GET /osmosis/tokenfactory/v1beta1/denoms_from_creator/{creator}

Top

osmosis/tokenfactory/v1beta1/tx.proto

MsgBurn

MsgBurn is the sdk.Msg type for allowing an admin account to burn a token. For now, we only support burning from the sender account.

Field Type Label Description
sender string
amount cosmos.base.v1beta1.Coin
burnFromAddress string

MsgBurnResponse

MsgChangeAdmin

MsgChangeAdmin is the sdk.Msg type for allowing an admin account to reassign adminship of a denom to a new account

Field Type Label Description
sender string
denom string
new_admin string

MsgChangeAdminResponse

MsgChangeAdminResponse defines the response structure for an executed MsgChangeAdmin message.

MsgCreateDenom

MsgCreateDenom defines the message structure for the CreateDenom gRPC service method. It allows an account to create a new denom. It requires a sender address and a sub denomination. The (sender_address, sub_denomination) tuple must be unique and cannot be re-used.

The resulting denom created is defined as <factory/{creatorAddress}/{subdenom}>. The resulting denom's admin is originally set to be the creator, but this can be changed later. The token denom does not indicate the current admin.

Field Type Label Description
sender string
subdenom string subdenom can be up to 44 "alphanumeric" characters long.

MsgCreateDenomResponse

MsgCreateDenomResponse is the return value of MsgCreateDenom It returns the full string of the newly created denom

Field Type Label Description
new_token_denom string

MsgForceTransfer

Field Type Label Description
sender string
amount cosmos.base.v1beta1.Coin
transferFromAddress string
transferToAddress string

MsgForceTransferResponse

MsgMint

MsgMint is the sdk.Msg type for allowing an admin account to mint more of a token. For now, we only support minting to the sender account

Field Type Label Description
sender string
amount cosmos.base.v1beta1.Coin
mintToAddress string

MsgMintResponse

MsgSetDenomMetadata

MsgSetDenomMetadata is the sdk.Msg type for allowing an admin account to set the denom's bank metadata

Field Type Label Description
sender string
metadata cosmos.bank.v1beta1.Metadata

MsgSetDenomMetadataResponse

MsgSetDenomMetadataResponse defines the response structure for an executed MsgSetDenomMetadata message.

MsgUpdateParams

MsgUpdateParams is the Msg/UpdateParams request type.

Since: cosmos-sdk 0.47

Field Type Label Description
authority string authority is the address of the governance account.
params Params params defines the x/mint parameters to update.

NOTE: All parameters must be supplied. |

MsgUpdateParamsResponse

MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message.

Since: cosmos-sdk 0.47

Msg

Msg defines the tokefactory module's gRPC message service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateDenom MsgCreateDenom MsgCreateDenomResponse
Mint MsgMint MsgMintResponse
Burn MsgBurn MsgBurnResponse
ChangeAdmin MsgChangeAdmin MsgChangeAdminResponse
SetDenomMetadata MsgSetDenomMetadata MsgSetDenomMetadataResponse
ForceTransfer MsgForceTransfer MsgForceTransferResponse
UpdateParams MsgUpdateParams MsgUpdateParamsResponse UpdateParams defines a governance operation for updating the x/mint module parameters. The authority is hard-coded to the x/gov module account.

Since: cosmos-sdk 0.47 | |

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)

Local Graph