package
7.0.1+incompatible
Repository: https://github.com/dydxprotocol/v4-chain.git
Documentation: pkg.go.dev

# Functions

BigIntToNumShares returns a NumShares given a big.Int.
DefaultGenesis returns the default stats genesis state.
DefaultOperatorParams returns a default set of `x/vault` operator parameters.
DefaultQuotingParams returns a default set of `x/vault` parameters.
GetVaultClobOrderClientId returns the client ID for a CLOB order where - 1st bit is `side-1` (subtract 1 as buy_side = 1, sell_side = 2) - next 8 bits are `layer`.
GetVaultIdFromStateKey returns a vault ID from a given state key.
NewDepositToMegavaultEvent constructs a new deposit_to_megavault sdk.Event.
No description provided by the author
No description provided by the author
No description provided by the author
NewWithdrawFromMegavaultEvent constructs a new withdraw_from_megavault sdk.Event.
No description provided by the author
No description provided by the author
No description provided by the author
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultQuotingParams is the key to retrieve DefaultQuotingParams.
No description provided by the author
No description provided by the author
No description provided by the author
MegavaultAccountName defines the root string for megavault module account.
ModuleName defines the module name.
MostRecentClientIdsKeyPrefix is the prefix to retrieve all most recent client IDs.
OperatorParamsKey is the key to retrieve OperatorParams.
OwnerSharesKeyPrefix is the prefix to retrieve all OwnerShares.
OwnerShareUnlocksKeyPrefix is the prefix to retrieve all OwnerShareUnlocks.
StoreKey defines the primary module store key.
TotalSharesKey is the key to retrieve total shares.
VaultAddressKeyPrefix is the prefix to retrieve all vault addresses.
VaultParamsKeyPrefix is the prefix to retrieve all VaultParams.
Only place orders that close the position.
Don’t place orders.
Places orders on both sides of the book.
Don’t place orders.
Default value, invalid and unused.
Vault is associated with a CLOB pair.
Default value, invalid and unused.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MegavaultMainSubaccount is subaccount 0 of the module account derived from string "megavault".
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

GenesisState defines `x/vault`'s genesis state.
GenesisStateV6 defines `x/vault`'s genesis state in v6.x.
MsgAllocateToVault is the Msg/AllocateToVault request type.
MsgAllocateToVaultResponse is the Msg/AllocateToVault response type.
MsgDepositToMegavault deposits the specified asset from the subaccount to megavault.
MsgDepositToMegavaultResponse is the Msg/DepositToMegavault response type.
MsgRetrieveFromVault is the Msg/RetrieveFromVault request type.
MsgRetrieveFromVaultResponse is the Msg/RetrieveFromVault response type.
MsgSetVaultParams is the Msg/SetVaultParams request type.
MsgSetVaultParamsResponse is the Msg/SetVaultParams response type.
MsgSetVaultQuotingParams is the Msg/SetVaultQuotingParams request type.
MsgUnlockShares is the Msg/UnlockShares request type.
MsgUnlockSharesResponse is the Msg/UnlockShares response type.
MsgUpdateDefaultQuotingParams is the Msg/UpdateDefaultQuotingParams request type.
MsgUpdateDefaultQuotingParamsResponse is the Msg/UpdateDefaultQuotingParams response type.
MsgUpdateOperatorParams is the Msg/UpdateOperatorParams request type.
MsgUpdateVaultParamsResponse is the Msg/UpdateOperatorParams response type.
MsgUpdateParams is the Msg/UpdateParams request type.
MsgWithdrawFromMegavault withdraws the specified shares from megavault to a subaccount.
MsgWithdrawFromMegavaultResponse is the Msg/WithdrawFromMegavault response type.
NumShares represents the number of shares.
OperatorParams stores parameters regarding megavault operator.
OwnerShare is a type for owner shares.
OwnerShareUnlocks stores share unlocks for an owner.
Deprecated: Params stores `x/vault` parameters.
QueryAllVaultsRequest is a request type for the AllVaults RPC method.
QueryAllVaultsResponse is a response type for the AllVaults RPC method.
QueryMegavaultAllOwnerSharesRequest is a request type for the MegavaultAllOwnerShares RPC method.
QueryMegavaultAllOwnerSharesResponse is a response type for the MegavaultAllOwnerShares RPC method.
QueryMegavaultOwnerSharesRequest is a request type for the MegavaultOwnerShares RPC method.
QueryMegavaultOwnerSharesResponse is a response type for the MegavaultOwnerShares RPC method.
QueryMegavaultTotalSharesRequest is a request type for the MegavaultTotalShares RPC method.
QueryMegavaultTotalSharesResponse is a response type for the MegavaultTotalShares RPC method.
QueryMegavaultWithdrawalInfoRequest is a request type for the MegavaultWithdrawalInfo RPC method.
QueryMegavaultWithdrawalInfoResponse is a response type for the MegavaultWithdrawalInfo RPC method.
QueryParamsRequest is a request type for the Params RPC method.
QueryParamsResponse is a response type for the Params RPC method.
QueryVaultParamsRequest is a request for the VaultParams RPC method.
QueryVaultParamsResponse is a response for the VaultParams RPC method.
QueryVaultRequest is a request type for the Vault RPC method.
QueryVaultResponse is a response type for the Vault RPC method.
QuotingParams stores vault quoting parameters.
ShareUnlock stores a single instance of `shares` number of shares unlocking at block height `unlock_block_height`.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.
Vault defines the state of a vault.
VaultId uniquely identifies a vault by its type and number.
VaultParams stores vault parameters.
VaultV6 defines the state of a vault.

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
No description provided by the author
No description provided by the author
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

VaultStatus represents the status of a vault.
VaultType represents different types of vaults.