# Protobuf Documentation

# Table of Contents

Top

# regen/ecocredit/v1alpha1/events.proto

# EventAllowAskDenom

EventAllowAskDenom is an event emitted when an ask denom is added.

Field Type Label Description
denom string denom is the denom to allow (ex. ibc/GLKHDSG423SGS)
display_denom string display_denom is the denom to display to the user and is informational
exponent uint32 exponent is the exponent that relates the denom to the display_denom and is informational

# EventBuyOrderCreated

EventBuyOrderCreated is an event emitted when a buy order is created.

Field Type Label Description
buy_order_id uint64 buy_order_id is the unique ID of buy order.
sell_order_id uint64 sell_order_id is the sell order ID against which the buyer is trying to buy.
quantity string quantity is the quantity of credits to buy. If the quantity of credits available is less than this amount the order will be partially filled unless disable_partial_fill is true.
bid_price cosmos.base.v1beta1.Coin bid price is the bid price for this buy order. A credit unit will be settled at a purchase price that is no more than the bid price. The buy order will fail if the buyer does not have enough funds available to complete the purchase.
disable_auto_retire bool disable_auto_retire allows auto-retirement to be disabled. If it is set to true the credits will not auto-retire and can be resold assuming that the corresponding sell order has auto-retirement disabled. If the sell order hasn't disabled auto-retirement and the buy order tries to disable it, that buy order will fail.
disable_partial_fill bool disable_partial_fill disables the default behavior of partially filling buy orders if the requested quantity is not available.

# EventBuyOrderFilled

EventBuyOrderFilled is an event emitted when a buy order is filled.

Field Type Label Description
buy_order_id uint64 buy_order_id is the unique ID of the buy order.
sell_order_id uint64 sell_order_id is the unique ID of the sell order.
batch_denom string batch_denom is the credit batch ID of the purchased credits.
quantity string quantity is the quantity of the purchased credits.
total_price cosmos.base.v1beta1.Coin total_price is the total price for the purchased credits.

# EventCancel

EventCancel is an event emitted when credits are cancelled. When credits are cancelled from multiple batches in the same transaction, a separate event is emitted for each batch_denom. This allows for easier indexing.

Field Type Label Description
canceller string canceller is the account which has cancelled the credits, which should be the holder of the credits.
batch_denom string batch_denom is the unique ID of credit batch.
amount string amount is the decimal number of credits that have been cancelled.

# EventCreateBatch

EventCreateBatch is an event emitted when a credit batch is created.

Field Type Label Description
class_id string class_id is the unique ID of credit class.
batch_denom string batch_denom is the unique ID of credit batch.
issuer string issuer is the account address of the issuer of the credit batch.
total_amount string total_amount is the total number of credits in the credit batch.
start_date string start_date is the beginning of the period during which this credit batch was quantified and verified.
end_date string end_date is the end of the period during which this credit batch was quantified and verified.
project_location string project_location is the location of the project backing the credits in this batch. Full documentation can be found in MsgCreateBatch.project_location.

# EventCreateClass

EventCreateClass is an event emitted when a credit class is created.

Field Type Label Description
class_id string class_id is the unique ID of credit class.
admin string admin is the admin of the credit class.

# EventReceive

EventReceive is an event emitted when credits are received either upon creation of a new batch or upon transfer. Each batch_denom created or transferred will result in a separate EventReceive for easy indexing.

Field Type Label Description
sender string sender is the sender of the credits in the case that this event is the result of a transfer. It will not be set when credits are received at initial issuance.
recipient string recipient is the recipient of the credits
batch_denom string batch_denom is the unique ID of credit batch.
tradable_amount string tradable_amount is the decimal number of tradable credits received.
retired_amount string retired_amount is the decimal number of retired credits received.

# EventRetire

EventRetire is an event emitted when credits are retired. When credits are retired from multiple batches in the same transaction, a separate event is emitted for each batch_denom. This allows for easier indexing.

Field Type Label Description
retirer string retirer is the account which has done the "retiring". This will be the account receiving credits in the case that credits were retired upon issuance using Msg/CreateBatch or retired upon transfer using Msg/Send.
batch_denom string batch_denom is the unique ID of credit batch.
amount string amount is the decimal number of credits that have been retired.
location string location is the location of the beneficiary or buyer of the retired credits. It is a string of the form [-[ ]], with the first two fields conforming to ISO 3166-2, and postal-code being up to 64 alphanumeric characters.

# EventSell

EventSell is an event emitted when a sell order is created.

Field Type Label Description
order_id uint64 order_id is the unique ID of sell order.
batch_denom string batch_denom is the credit batch being sold.
quantity string quantity is the quantity of credits being sold.
ask_price cosmos.base.v1beta1.Coin ask_price is the price the seller is asking for each unit of the batch_denom. Each credit unit of the batch will be sold for at least the ask_price or more.
disable_auto_retire bool disable_auto_retire disables auto-retirement of credits which allows a buyer to disable auto-retirement in their buy order enabling them to resell the credits to another buyer.

# EventUpdateSellOrder

EventUpdateSellOrder is an event emitted when a sell order is updated.

Field Type Label Description
owner string owner is the owner of the sell orders.
sell_order_id uint64 sell_order_id is the ID of an existing sell order.
batch_denom string batch_denom is the credit batch being sold.
new_quantity string new_quantity is the updated quantity of credits available to sell, if it is set to zero then the order is cancelled.
new_ask_price cosmos.base.v1beta1.Coin new_ask_price is the new ask price for this sell order
disable_auto_retire bool disable_auto_retire updates the disable_auto_retire field in the sell order.

Top

# regen/ecocredit/v1alpha1/types.proto

# AskDenom

AskDenom represents the information for an ask denom.

Field Type Label Description
denom string denom is the denom to allow (ex. ibc/GLKHDSG423SGS)
display_denom string display_denom is the denom to display to the user and is informational
exponent uint32 exponent is the exponent that relates the denom to the display_denom and is informational

# BatchInfo

BatchInfo represents the high-level on-chain information for a credit batch.

Field Type Label Description
class_id string class_id is the unique ID of credit class.
batch_denom string batch_denom is the unique ID of credit batch.
issuer string issuer is the issuer of the credit batch.
total_amount string total_amount is the total number of active credits in the credit batch. Some of the issued credits may be cancelled and will be removed from total_amount and tracked in amount_cancelled. total_amount and amount_cancelled will always sum to the original amount of credits that were issued.
metadata bytes metadata is any arbitrary metadata attached to the credit batch.
amount_cancelled string amount_cancelled is the number of credits in the batch that have been cancelled, effectively undoing there issuance. The sum of total_amount and amount_cancelled will always sum to the original amount of credits that were issued.
start_date google.protobuf.Timestamp start_date is the beginning of the period during which this credit batch was quantified and verified.
end_date google.protobuf.Timestamp end_date is the end of the period during which this credit batch was quantified and verified.
project_location string project_location is the location of the project backing the credits in this batch. Full documentation can be found in MsgCreateBatch.project_location.

# BuyOrder

BuyOrder represents the information for a buy order.

Field Type Label Description
buy_order_id uint64 buy_order_id is the unique ID of buy order.
selection BuyOrder.Selection selection is the buy order selection.
quantity string quantity is the quantity of credits to buy. If the quantity of credits available is less than this amount the order will be partially filled unless disable_partial_fill is true.
bid_price cosmos.base.v1beta1.Coin bid price is the bid price for this buy order. A credit unit will be settled at a purchase price that is no more than the bid price. The buy order will fail if the buyer does not have enough funds available to complete the purchase.
disable_auto_retire bool disable_auto_retire allows auto-retirement to be disabled. If it is set to true the credits will not auto-retire and can be resold assuming that the corresponding sell order has auto-retirement disabled. If the sell order hasn't disabled auto-retirement and the buy order tries to disable it, that buy order will fail.
disable_partial_fill bool disable_partial_fill disables the default behavior of partially filling buy orders if the requested quantity is not available.

# BuyOrder.Selection

Selection defines a buy order selection.

Field Type Label Description
sell_order_id uint64 sell_order_id is the sell order ID against which the buyer is trying to buy. When sell_order_id is set, this is known as a direct buy order because it is placed directly against a specific sell order.

# ClassInfo

ClassInfo represents the high-level on-chain information for a credit class.

Field Type Label Description
class_id string class_id is the unique ID of credit class.
admin string admin is the admin of the credit class.
issuers string repeated issuers are the approved issuers of the credit class.
metadata bytes metadata is any arbitrary metadata to attached to the credit class.
credit_type CreditType credit_type describes the type of credit (e.g. carbon, biodiversity), as well as unit and precision.
num_batches uint64 The number of batches issued in this credit class.

# CreditType

CreditType defines the measurement unit/precision of a certain credit type (e.g. carbon, biodiversity...)

Field Type Label Description
name string the type of credit (e.g. carbon, biodiversity, etc)
abbreviation string abbreviation is a 1-3 character uppercase abbreviation of the CreditType name, used in batch denominations within the CreditType. It must be unique.
unit string the measurement unit (e.g. kg, ton, etc)
precision uint32 the decimal precision

# CreditTypeSeq

CreditTypeSeq associates a sequence number with a credit type abbreviation. This represents the number of credit classes created with that credit type.

Field Type Label Description
abbreviation string The credit type abbreviation
seq_number uint64 The sequence number of classes of the credit type

# Params

Params defines the updatable global parameters of the ecocredit module for use with the x/params module.

Field Type Label Description
credit_class_fee cosmos.base.v1beta1.Coin repeated credit_class_fee is the fixed fee charged on creation of a new credit class
allowed_class_creators string repeated allowed_class_creators is an allowlist defining the addresses with the required permissions to create credit classes
allowlist_enabled bool allowlist_enabled is a param that enables/disables the allowlist for credit creation
credit_types CreditType repeated credit_types is a list of definitions for credit types

# SellOrder

SellOrder represents the information for a sell order.

Field Type Label Description
order_id uint64 order_id is the unique ID of sell order.
owner string owner is the address of the owner of the credits being sold.
batch_denom string batch_denom is the credit batch being sold.
quantity string quantity is the quantity of credits being sold.
ask_price cosmos.base.v1beta1.Coin ask_price is the price the seller is asking for each unit of the batch_denom. Each credit unit of the batch will be sold for at least the ask_price or more.
disable_auto_retire bool disable_auto_retire disables auto-retirement of credits which allows a buyer to disable auto-retirement in their buy order enabling them to resell the credits to another buyer.

Top

# regen/ecocredit/v1alpha1/genesis.proto

# Balance

Balance represents tradable or retired units of a credit batch with an account address, batch_denom, and balance.

Field Type Label Description
address string address is the account address of the account holding credits.
batch_denom string batch_denom is the unique ID of the credit batch.
tradable_balance string tradable_balance is the tradable balance of the credit batch.
retired_balance string retired_balance is the retired balance of the credit batch.

# GenesisState

GenesisState defines ecocredit module's genesis state.

Field Type Label Description
params Params Params contains the updateable global parameters for use with the x/params module
class_info ClassInfo repeated class_info is the list of credit class info.
batch_info BatchInfo repeated batch_info is the list of credit batch info.
sequences CreditTypeSeq repeated sequences is the list of credit type sequence.
balances Balance repeated balances is the list of credit batch tradable/retired units.
supplies Supply repeated supplies is the list of credit batch tradable/retired supply.

# Supply

Supply represents a tradable or retired supply of a credit batch.

Field Type Label Description
batch_denom string batch_denom is the unique ID of the credit batch.
tradable_supply string tradable_supply is the tradable supply of the credit batch.
retired_supply string retired_supply is the retired supply of the credit batch.

Top

# regen/ecocredit/v1alpha1/query.proto

# QueryBalanceRequest

QueryBalanceRequest is the Query/Balance request type.

Field Type Label Description
account string account is the address of the account whose balance is being queried.
batch_denom string batch_denom is the unique ID of credit batch balance to query.

# QueryBalanceResponse

QueryBalanceResponse is the Query/Balance response type.

Field Type Label Description
tradable_amount string tradable_amount is the decimal number of tradable credits.
retired_amount string retired_amount is the decimal number of retired credits.

# QueryBatchInfoRequest

QueryBatchInfoRequest is the Query/BatchInfo request type.

Field Type Label Description
batch_denom string batch_denom is the unique ID of credit batch to query.

# QueryBatchInfoResponse

QueryBatchInfoResponse is the Query/BatchInfo response type.

Field Type Label Description
info BatchInfo info is the BatchInfo for the credit batch.

# QueryBatchesRequest

QueryBatchesRequest is the Query/Batches request type.

Field Type Label Description
class_id string class_id is the unique ID of the credit class to query.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

# QueryBatchesResponse

QueryBatchesResponse is the Query/Batches response type.

Field Type Label Description
batches BatchInfo repeated batches are the fetched credit batches within the class.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

# QueryClassInfoRequest

QueryClassInfoRequest is the Query/ClassInfo request type.

Field Type Label Description
class_id string class_id is the unique ID of credit class to query.

# QueryClassInfoResponse

QueryClassInfoResponse is the Query/ClassInfo request type.

Field Type Label Description
info ClassInfo info is the ClassInfo for the credit class.

# QueryClassesRequest

QueryClassesRequest is the Query/Classes request type.

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

# QueryClassesResponse

QueryClassesResponse is the Query/Classes response type.

Field Type Label Description
classes ClassInfo repeated classes are the fetched credit classes.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

# QueryCreditTypesRequest

QueryCreditTypesRequest is the Query/Credit_Types request type

# QueryCreditTypesResponse

QueryCreditTypesRequest is the Query/Credit_Types response type

Field Type Label Description
credit_types CreditType repeated list of credit types

# QueryParamsRequest

QueryParamsRequest is the Query/Params request type.

# QueryParamsResponse

QueryParamsResponse is the Query/Params response type.

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

# QuerySupplyRequest

QuerySupplyRequest is the Query/Supply request type.

Field Type Label Description
batch_denom string batch_denom is the unique ID of credit batch to query.

# QuerySupplyResponse

QuerySupplyResponse is the Query/Supply response type.

Field Type Label Description
tradable_supply string tradable_supply is the decimal number of tradable credits in the batch supply.
retired_supply string retired_supply is the decimal number of retired credits in the batch supply.

# Query

Msg is the regen.ecocredit.v1alpha1 Query service.

Method Name Request Type Response Type Description
Classes QueryClassesRequest QueryClassesResponse Classes queries for all credit classes with pagination.
ClassInfo QueryClassInfoRequest QueryClassInfoResponse ClassInfo queries for information on a credit class.
Batches QueryBatchesRequest QueryBatchesResponse Batches queries for all batches in the given credit class with pagination.
BatchInfo QueryBatchInfoRequest QueryBatchInfoResponse BatchInfo queries for information on a credit batch.
Balance QueryBalanceRequest QueryBalanceResponse Balance queries the balance (both tradable and retired) of a given credit batch for a given account.
Supply QuerySupplyRequest QuerySupplyResponse Supply queries the tradable and retired supply of a credit batch.
CreditTypes QueryCreditTypesRequest QueryCreditTypesResponse CreditTypes returns the list of allowed types that credit classes can have. See Types/CreditType for more details.
Params QueryParamsRequest QueryParamsResponse Params queries the ecocredit module parameters.

Top

# regen/ecocredit/v1alpha1/tx.proto

# MsgAllowAskDenom

MsgAllowAskDenom is the Msg/AllowAskDenom request type.

Field Type Label Description
root_address string root_address is the address of the governance account which can authorize ask denoms
denom string denom is the denom to allow (ex. ibc/GLKHDSG423SGS)
display_denom string display_denom is the denom to display to the user and is informational
exponent uint32 exponent is the exponent that relates the denom to the display_denom and is informational

# MsgAllowAskDenomResponse

MsgAllowAskDenomResponse is the Msg/AllowAskDenom response type.

# MsgBuy

MsgBuy is the Msg/Buy request type.

Field Type Label Description
buyer string buyer is the address of the credit buyer.
orders MsgBuy.Order repeated orders are the new buy orders.

# MsgBuy.Order

Order is a buy order.

Field Type Label Description
selection MsgBuy.Order.Selection selection is the buy order selection.
quantity string quantity is the quantity of credits to buy. If the quantity of credits available is less than this amount the order will be partially filled unless disable_partial_fill is true.
bid_price cosmos.base.v1beta1.Coin bid price is the bid price for this buy order. A credit unit will be settled at a purchase price that is no more than the bid price. The buy order will fail if the buyer does not have enough funds available to complete the purchase.
disable_auto_retire bool disable_auto_retire allows auto-retirement to be disabled. If it is set to true the credits will not auto-retire and can be resold assuming that the corresponding sell order has auto-retirement disabled. If the sell order hasn't disabled auto-retirement and the buy order tries to disable it, that buy order will fail.
disable_partial_fill bool disable_partial_fill disables the default behavior of partially filling buy orders if the requested quantity is not available.

# MsgBuy.Order.Selection

Selection defines a buy order selection.

Field Type Label Description
sell_order_id uint64 sell_order_id is the sell order ID against which the buyer is trying to buy. When sell_order_id is set, this is known as a direct buy order because it is placed directly against a specific sell order.

# MsgBuyResponse

MsgBuyResponse is the Msg/Buy response type.

Field Type Label Description
buy_order_ids uint64 repeated buy_order_ids are the buy order IDs of the newly created buy orders. Buy orders may not settle instantaneously, but rather in batches at specified batch epoch times.

# MsgCancel

MsgCancel is the Msg/Cancel request type.

Field Type Label Description
holder string holder is the credit holder address.
credits MsgCancel.CancelCredits repeated credits are the credits being cancelled.

# MsgCancel.CancelCredits

CancelCredits specifies a batch and the number of credits being cancelled.

Field Type Label Description
batch_denom string batch_denom is the unique ID of the credit batch.
amount string amount is the number of credits being cancelled. Decimal values are acceptable within the precision returned by Query/Precision.

# MsgCancelResponse

MsgCancelResponse is the Msg/Cancel response type.

# MsgCreateBatch

MsgCreateBatch is the Msg/CreateBatch request type.

Field Type Label Description
issuer string issuer is the address of the batch issuer.
class_id string class_id is the unique ID of the class.
issuance MsgCreateBatch.BatchIssuance repeated issuance are the credits issued in the batch.
metadata bytes metadata is any arbitrary metadata attached to the credit batch.
start_date google.protobuf.Timestamp start_date is the beginning of the period during which this credit batch was quantified and verified.
end_date google.protobuf.Timestamp end_date is the end of the period during which this credit batch was quantified and verified.
project_location string project_location is the location of the project backing the credits in this batch. It is a string of the form [-[ ]], with the first two fields conforming to ISO 3166-2, and postal-code being up to 64 alphanumeric characters. country-code is required, while sub-national-code and postal-code can be added for increasing precision.

# MsgCreateBatch.BatchIssuance

BatchIssuance represents the issuance of some credits in a batch to a single recipient.

Field Type Label Description
recipient string recipient is the account of the recipient.
tradable_amount string tradable_amount is the number of credits in this issuance that can be traded by this recipient. Decimal values are acceptable.
retired_amount string retired_amount is the number of credits in this issuance that are effectively retired by the issuer on receipt. Decimal values are acceptable.
retirement_location string retirement_location is the location of the beneficiary or buyer of the retired credits. This must be provided if retired_amount is positive. It is a string of the form [-[ ]], with the first two fields conforming to ISO 3166-2, and postal-code being up to 64 alphanumeric characters.

# MsgCreateBatchResponse

MsgCreateBatchResponse is the Msg/CreateBatch response type.

Field Type Label Description
batch_denom string batch_denom is the unique denomination ID of the newly created batch.

# MsgCreateClass

MsgCreateClass is the Msg/CreateClass request type.

Field Type Label Description
admin string admin is the address of the account that created the credit class.
issuers string repeated issuers are the account addresses of the approved issuers.
metadata bytes metadata is any arbitrary metadata to attached to the credit class.
credit_type_name string credit_type_name describes the type of credit (e.g. "carbon", "biodiversity").

# MsgCreateClassResponse

MsgCreateClassResponse is the Msg/CreateClass response type.

Field Type Label Description
class_id string class_id is the unique ID of the newly created credit class.

# MsgRetire

MsgRetire is the Msg/Retire request type.

Field Type Label Description
holder string holder is the credit holder address.
credits MsgRetire.RetireCredits repeated credits are the credits being retired.
location string location is the location of the beneficiary or buyer of the retired credits. It is a string of the form [-[ ]], with the first two fields conforming to ISO 3166-2, and postal-code being up to 64 alphanumeric characters.

# MsgRetire.RetireCredits

RetireCredits specifies a batch and the number of credits being retired.

Field Type Label Description
batch_denom string batch_denom is the unique ID of the credit batch.
amount string amount is the number of credits being retired. Decimal values are acceptable within the precision returned by Query/Precision.

# MsgRetireResponse

MsgRetire is the Msg/Retire response type.

# MsgSell

MsgSell is the Msg/Sell request type.

Field Type Label Description
owner string owner is the address of the owner of the credits being sold.
orders MsgSell.Order repeated orders are the sell orders being created.

# MsgSell.Order

Order is the content of a new sell order.

Field Type Label Description
batch_denom string batch_denom is the credit batch being sold.
quantity string quantity is the quantity of credits being sold from this batch. If it is less then the balance of credits the owner has available at the time this sell order is matched, the quantity will be adjusted downwards to the owner's balance. However, if the balance of credits is less than this quantity at the time the sell order is created, the operation will fail.
ask_price cosmos.base.v1beta1.Coin ask_price is the price the seller is asking for each unit of the batch_denom. Each credit unit of the batch will be sold for at least the ask_price or more.
disable_auto_retire bool disable_auto_retire disables auto-retirement of credits which allows a buyer to disable auto-retirement in their buy order enabling them to resell the credits to another buyer.

# MsgSellResponse

MsgSellResponse is the Msg/Sell response type.

Field Type Label Description
sell_order_ids uint64 repeated sell_order_ids are the sell order IDs of the newly created sell orders.

# MsgSend

MsgSend is the Msg/Send request type.

Field Type Label Description
sender string sender is the address of the account sending credits.
recipient string sender is the address of the account receiving credits.
credits MsgSend.SendCredits repeated credits are the credits being sent.

# MsgSend.SendCredits

SendCredits specifies a batch and the number of credits being transferred. This is split into tradable credits, which will remain tradable on receipt, and retired credits, which will be retired on receipt.

Field Type Label Description
batch_denom string batch_denom is the unique ID of the credit batch.
tradable_amount string tradable_amount is the number of credits in this transfer that can be traded by the recipient. Decimal values are acceptable within the precision returned by Query/Precision.
retired_amount string retired_amount is the number of credits in this transfer that are effectively retired by the issuer on receipt. Decimal values are acceptable within the precision returned by Query/Precision.
retirement_location string retirement_location is the location of the beneficiary or buyer of the retired credits. This must be provided if retired_amount is positive. It is a string of the form [-[ ]], with the first two fields conforming to ISO 3166-2, and postal-code being up to 64 alphanumeric characters.

# MsgSendResponse

MsgSendResponse is the Msg/Send response type.

# MsgUpdateClassAdmin

MsgUpdateClassAdmin is the Msg/UpdateClassAdmin request type.

Field Type Label Description
admin string admin is the address of the account that is the admin of the credit class.
class_id string class_id is the unique ID of the credit class.
new_admin string new_admin is the address of the new admin of the credit class.

# MsgUpdateClassAdminResponse

MsgUpdateClassAdminResponse is the MsgUpdateClassAdmin response type.

# MsgUpdateClassIssuers

MsgUpdateClassIssuers is the Msg/UpdateClassIssuers request type.

Field Type Label Description
admin string admin is the address of the account that is the admin of the credit class.
class_id string class_id is the unique ID of the credit class.
issuers string repeated issuers are the updated account addresses of the approved issuers.

# MsgUpdateClassIssuersResponse

MsgUpdateClassIssuersResponse is the MsgUpdateClassIssuers response type.

# MsgUpdateClassMetadata

MsgUpdateClassMetadata is the Msg/UpdateClassMetadata request type.

Field Type Label Description
admin string admin is the address of the account that is the admin of the credit class.
class_id string class_id is the unique ID of the credit class.
metadata bytes metadata is the updated arbitrary metadata to be attached to the credit class.

# MsgUpdateClassMetadataResponse

MsgUpdateClassMetadataResponse is the MsgUpdateClassMetadata response type.

# MsgUpdateSellOrders

MsgUpdateSellOrders is the Msg/UpdateSellOrders request type.

Field Type Label Description
owner string owner is the owner of the sell orders.
updates MsgUpdateSellOrders.Update repeated updates are updates to existing sell orders.

# MsgUpdateSellOrders.Update

Update is an update to an existing sell order.

Field Type Label Description
sell_order_id uint64 sell_order_id is the ID of an existing sell order.
new_quantity string new_quantity is the updated quantity of credits available to sell, if it is set to zero then the order is cancelled.
new_ask_price cosmos.base.v1beta1.Coin new_ask_price is the new ask price for this sell order
disable_auto_retire bool disable_auto_retire updates the disable_auto_retire field in the sell order.

# MsgUpdateSellOrdersResponse

MsgUpdateSellOrdersResponse is the Msg/UpdateSellOrders response type.

# Msg

Msg is the regen.ecocredit.v1alpha1 Msg service.

Method Name Request Type Response Type Description
CreateClass MsgCreateClass MsgCreateClassResponse CreateClass creates a new credit class with an approved list of issuers and optional metadata.
CreateBatch MsgCreateBatch MsgCreateBatchResponse CreateBatch creates a new batch of credits for an existing credit class. This will create a new batch denom with a fixed supply. Issued credits can be distributed to recipients in either tradable or retired form.
Send MsgSend MsgSendResponse Send sends tradable credits from one account to another account. Sent credits can either be tradable or retired on receipt.
Retire MsgRetire MsgRetireResponse Retire retires a specified number of credits in the holder's account.
Cancel MsgCancel MsgCancelResponse Cancel removes a number of credits from the holder's account and also deducts them from the tradable supply, effectively cancelling their issuance on Regen Ledger
UpdateClassAdmin MsgUpdateClassAdmin MsgUpdateClassAdminResponse UpdateClassAdmin updates the credit class admin
UpdateClassIssuers MsgUpdateClassIssuers MsgUpdateClassIssuersResponse UpdateClassIssuers updates the credit class issuer list
UpdateClassMetadata MsgUpdateClassMetadata MsgUpdateClassMetadataResponse UpdateClassMetadata updates the credit class metadata
Sell MsgSell MsgSellResponse Sell creates new sell orders.
UpdateSellOrders MsgUpdateSellOrders MsgUpdateSellOrdersResponse UpdateSellOrders updates existing sell orders.
Buy MsgBuy MsgBuyResponse Buy creates credit buy orders.
AllowAskDenom MsgAllowAskDenom MsgAllowAskDenomResponse AllowAskDenom is a governance operation which authorizes a new ask denom to be used in sell orders

# 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)