Regen Ledger Documentation

MsgRetire

a valid message

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "credits": [
    {
      "batch_denom": "C01-001-20200101-20210101-001",
      "amount": "100"
    }
  ],
  "jurisdiction": "US-WA",
  "reason": "offsetting electricity consumption"
}

When the message is validated

Then expect no error.

a valid message without reason

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "credits": [
    {
      "batch_denom": "C01-001-20200101-20210101-001",
      "amount": "100"
    }
  ],
  "jurisdiction": "US-WA"
}

When the message is validated

Then expect no error.

a valid message with multiple credits

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "credits": [
    {
      "batch_denom": "C01-001-20200101-20210101-001",
      "amount": "100"
    },
    {
      "batch_denom": "C01-001-20200101-20210101-002",
      "amount": "100"
    }
  ],
  "jurisdiction": "US-WA",
  "reason": "offsetting electricity consumption"
}

When the message is validated

Then expect no error.

an error is returned if credits is empty

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6"
}

When the message is validated

Then expect the error "credits cannot be empty: invalid request".

an error is returned if credits batch denom is empty

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "credits": [
    {}
  ]
}

When the message is validated

Then expect the error "credits[0]: batch denom: empty string is not allowed: parse error: invalid request".

an error is returned if credits amount is empty

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "credits": [
    {
      "batch_denom": "C01-001-20200101-20210101-001"
    }
  ]
}

When the message is validated

Then expect the error "credits[0]: amount cannot be empty: invalid request".

an error is returned if jurisdiction is empty

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "credits": [
    {
      "batch_denom": "C01-001-20200101-20210101-001",
      "amount": "100"
    }
  ]
}

When the message is validated

Then expect the error "jurisdiction: empty string is not allowed: parse error: invalid request".

an error is returned if jurisdiction is not formatted

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "credits": [
    {
      "batch_denom": "C01-001-20200101-20210101-001",
      "amount": "100"
    }
  ],
  "jurisdiction": "foo"
}

When the message is validated

Then expect the error "jurisdiction: expected format [country-code][-[region-code][ [postal-code]]]: parse error: invalid request".

an error is returned if reason exceeds 512 characters

Given the message

{
  "owner": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "credits": [
    {
      "batch_denom": "C01-001-20200101-20210101-001",
      "amount": "100"
    }
  ],
  "jurisdiction": "US-WA"
}

And reason with length "513"

When the message is validated

Then expect the error "reason: max length 512: limit exceeded".