Skip to content

Commit

Permalink
docs(x/ecocredit): clarify EventReceive.sender (#778)
Browse files Browse the repository at this point in the history
* docs(x/ecocredit): clarify EventReceive.sender

* update docs

* update docs

* feat: add field for basket_denom in event receive

* fix: proto order

Co-authored-by: technicallyty <48813565+tytech3@users.noreply.github.com>
  • Loading branch information
aaronc and technicallyty authored Feb 17, 2022
1 parent b8cd057 commit 3948500
Show file tree
Hide file tree
Showing 2 changed files with 129 additions and 44 deletions.
156 changes: 117 additions & 39 deletions api/regen/ecocredit/v1alpha1/events.pulsar.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 12 additions & 5 deletions proto/regen/ecocredit/v1alpha1/events.proto
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,18 @@ message EventCreateBatch {
string project_location = 7;
}

// 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.
// EventReceive is an event emitted when credits are received either via
// creation of a new batch, transfer of credits, or taking credits from a
// basket. Each batch_denom created, transferred or taken from a baset will
// result in a separate EventReceive for easy indexing.
message EventReceive {

// 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.
// initial issuance or taken from a basket.
string sender = 1;

// recipient is the recipient of the credits
// recipient is the recipient of the credits.
string recipient = 2;

// batch_denom is the unique ID of credit batch.
Expand All @@ -62,6 +64,11 @@ message EventReceive {

// retired_amount is the decimal number of retired credits received.
string retired_amount = 5;

// basket_denom is the denom of the basket. when the basket_denom field is set, it indicates that this event was
// triggered by the transfer of credits from a basket. It will not be set if the credits were sent by a user, or
// by initial issuance.
string basket_denom = 6;
}

// EventRetire is an event emitted when credits are retired. When credits are
Expand Down

0 comments on commit 3948500

Please sign in to comment.