Msg/Put
Credits can be put into a basket:
- when the basket exists
- when the credit batch exists
- when the credit class is allowed
- when the user has a credit balance
- when the user has the credit amount
- when the credit amount does not exceed maximum decimal places
- when the credit batch start date is after or equal to minimum start date
- when the credit batch start date is within or at the limit of start date window
- when the credit batch start date is after or equal to years in the past
- the user credit balance is updated
- the basket credit balance is updated
- the user token balance is updated
- the basket token supply is updated
- the response includes basket token amount received
The basket must exist
Background
Given a credit type with abbreviation "C" and precision "6"
And alice owns credits.
basket exists
Given a basket with denom "eco.uC.NCT"
When alice attempts to put credits into basket with denom "eco.uC.NCT"
Then expect no error.
basket does not exist
When alice attempts to put credits into basket with denom "eco.uC.NCT"
Then expect the error "basket eco.uC.NCT not found: not found".
The credit batch must exist
Background
Given a credit type with abbreviation "C"
And a basket.
batch denom exists
Given alice owns credits from credit batch "C01-001-20200101-20210101-001"
When alice attempts to put credits from credit batch "C01-001-20200101-20210101-001" into the basket
Then expect no error.
batch denom does not exist
When alice attempts to put credits from credit batch "C01-001-20200101-20210101-001" into the basket
Then expect the error "could not get batch C01-001-20200101-20210101-001: not found: invalid request".
The credit batch must be from a credit class that is allowed in the basket
Background
Given a credit type with abbreviation "C"
And a basket with allowed credit class "C01".
credit class is allowed
Given alice owns credits from credit batch "C01-001-20200101-20210101-001"
When alice attempts to put credits from credit batch "C01-001-20200101-20210101-001" into the basket
Then expect no error.
credit class is not allowed
Given alice owns credits from credit batch "A01-20200101-20210101-001"
When alice attempts to put credits from credit batch "A01-20200101-20210101-001" into the basket
Then expect the error "credit class A01 is not allowed in this basket: invalid request".
The user must have a credit balance for the credits being put into the basket
Background
Given a credit type with abbreviation "C"
And a basket.
user has a credit balance
Given alice owns credits from credit batch "C01-001-20200101-20210101-001"
When alice attempts to put credits from credit batch "C01-001-20200101-20210101-001" into the basket
Then expect no error.
user does not have a credit balance
Given a credit batch with denom "C01-001-20200101-20210101-001"
When alice attempts to put credits from credit batch "C01-001-20200101-20210101-001" into the basket
Then expect error contains "could not get batch C01-001-20200101-20210101-001 balance".
The user must have a credit balance more than or equal to the credits being put into the basket
Background
Given a credit type
And a basket.
user owns more than or equal amount of credits being put into the basket
Given alice owns credit amount "[balance-before]"
When alice attempts to put credit amount "[credit-amount]" into the basket
Then expect no error.
Examples
| description | balance-before | credit-amount |
|---|---|---|
| more than | 100 | 50 |
| equal to | 100 | 100 |
user owns less than amount of credits being put into the basket
Given alice owns credit amount "100"
When alice attempts to put credit amount "150" into the basket
Then expect error contains "cannot put 150 credits into the basket with a balance of 100".
Credit amount must not exceed maximum decimal places
credit amount does not exceed maximum decimal places
Given a credit type with abbreviation "C" and precision "[precision]"
And a basket with credit type "C"
And alice owns credit amount "[credit-amount]"
When alice attempts to put credit amount "[credit-amount]" into the basket
Then expect no error.
Examples
| description | precision | credit-amount |
|---|---|---|
| no decimals | 0 | 2 |
| one decimal | 1 | 2.5 |
| two decimals | 2 | 2.25 |
credit amount exceeds maximum decimal places
Given a credit type with abbreviation "C" and precision "[precision]"
And a basket with credit type "C"
And alice owns credit amount "[credit-amount]"
When alice attempts to put credit amount "[credit-amount]" into the basket
Then expect error contains "exceeds maximum decimal places".
Examples
| description | precision | credit-amount |
|---|---|---|
| no decimals | 0 | 2.5 |
| one decimal | 1 | 2.25 |
| two decimals | 2 | 2.333 |
Credits from a batch with a start date before basket minimum start date cannot be put into the basket
Background
Given a credit type
And a basket with minimum start date "2021-01-01".
batch start date after or equal to minimum start date
Given alice owns credits with start date "[batch-start-date]"
When alice attempts to put credits into the basket
Then expect no error.
Examples
| description | batch-start-date |
|---|---|
| after | 2022-01-01 |
| equal to | 2021-01-01 |
batch start date before minimum start date
Given alice owns credits with start date "2020-01-01"
When alice attempts to put credits into the basket
Then expect error contains "cannot put a credit from a batch with start date".
Credits from a batch with a start date outside basket start date window cannot be put into the basket
Background
Given a credit type
And the block time "2022-01-01"
And a basket with start date window "31536000".
batch start date within or at the limit of basket start date window
Given alice owns credits with start date "[batch-start-date]"
When alice attempts to put credits into the basket
Then expect no error.
Examples
| description | batch-start-date |
|---|---|
| less than | 2022-01-01 |
| equal to | 2021-01-01 |
batch start date outside of basket start date window
Given alice owns credits with start date "2020-01-01"
When alice attempts to put credits into the basket
Then expect error contains "cannot put a credit from a batch with start date".
Credits from a batch with a start date before basket years in the past cannot be put into the basket
Background
Given a credit type.
batch start date after or equal to years in the past
Given the block time "2022-04-01"
And a basket with years in the past "10"
And alice owns credits with start date "[batch-start-date]"
When alice attempts to put credits into the basket
Then expect no error.
Examples
| description | batch-start-date |
|---|---|
| year after, day before | 2013-01-01 |
| year after, day equal | 2013-04-01 |
| year after, day after | 2013-07-01 |
| year equal, day before | 2012-01-01 |
| year equal, day equal | 2012-04-01 |
| year equal, day after | 2012-07-01 |
batch start date before years in the past
Given the block time "2022-04-01"
And a basket with years in the past "10"
And alice owns credits with start date "[batch-start-date]"
When alice attempts to put credits into the basket
Then expect error contains "cannot put a credit from a batch with start date".
Examples
| description | batch-start-date |
|---|---|
| year before, day before | 2011-01-01 |
| year before, day equal | 2011-04-01 |
| year before, day after | 2011-07-01 |
The user credit balance is updated when credits are put into the basket
user credit balance is updated
Given a credit type
And a basket
And alice owns credit amount "100"
When alice attempts to put credit amount "100" into the basket
Then expect alice credit balance amount "0".
The basket credit balance is updated when credits are put into the basket
basket credit balance is updated
Given a credit type
And a basket
And alice owns credit amount "100"
When alice attempts to put credit amount "100" into the basket
Then expect basket credit balance amount "100".
The user token balance is updated when credits are put into the basket
user token balance is updated
Given a credit type with abbreviation "C" and precision "[precision]"
And a basket with credit type "C"
And alice owns credit amount "[credit-amount]"
And alice owns basket token amount "0"
When alice attempts to put credit amount "[credit-amount]" into the basket
And expect alice basket token balance amount "[token-amount]".
Examples
| description | precision | credit-amount | token-amount |
|---|---|---|---|
| precision zero, amount whole | 0 | 2 | 2 |
| precision non-zero, amount whole | 6 | 2 | 2000000 |
| precision non-zero, amount decimal | 6 | 2.5 | 2500000 |
The basket token supply is updated when credits are put into the basket
basket token supply is updated
Given a credit type with abbreviation "C" and precision "[precision]"
And a basket with credit type "C"
And basket token supply amount "0"
And alice owns credit amount "[credit-amount]"
When alice attempts to put credit amount "[credit-amount]" into the basket
Then expect basket token supply amount "[token-amount]".
Examples
| description | precision | credit-amount | token-amount |
|---|---|---|---|
| precision zero, amount whole | 0 | 2 | 2 |
| precision non-zero, amount whole | 6 | 2 | 2000000 |
| precision non-zero, amount decimal | 6 | 2.5 | 2500000 |
The message response includes basket token amount received when credits are put into the basket
message response includes basket token amount received
Given a credit type with abbreviation "C" and precision "[precision]"
And a basket with credit type "C"
And alice owns credit amount "[credit-amount]"
When alice attempts to put credit amount "[credit-amount]" into the basket
Then expect the response
{
"amount_received": "[token-amount]"
}
Examples
| description | precision | credit-amount | token-amount |
|---|---|---|---|
| precision zero, amount whole | 0 | 2 | 2 |
| precision non-zero, amount whole | 6 | 2 | 2000000 |
| precision non-zero, amount decimal | 6 | 2.5 | 2500000 |
Events are emitted
Background
Given a credit type with abbreviation "C" and precision "6"
And a basket with credit type "C"
And Alice's address "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6"
And Ecocredit module's address "regen1k82wewrfkhdmegw6uxrgwwzrsd7593t8tej2d5"
And Alice owns credit amount "2".
EventTransfer is emitted
When alice attempts to put credit amount "2" into the basket
Then expect event transfer with properties
{
"sender": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
"recipient": "regen1k82wewrfkhdmegw6uxrgwwzrsd7593t8tej2d5",
"batch_denom": "C01-001-20200101-20210101-001",
"tradable_amount": "2"
}
EventPut is emitted
When alice attempts to put credit amount "2" into the basket
Then expect event put with properties
{
"owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
"basket_denom": "eco.uC.NCT",
"credits": [
{
"batch_denom": "C01-001-20200101-20210101-001",
"amount": "2"
}
],
"amount": "2000000"
}