Regen Ledger Documentation

Msg/UpdateBatchMetadata

The metadata of a credit batch can be updated:

  • message validation
  • when the credit batch exists
  • when the credit batch is open
  • when the issuer is the issuer of the credit batch
  • the credit batch metadata is updated

Message validation

a valid message

Given the message

{
  "issuer": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "batch_denom": "C01-001-20200101-20210101-001",
  "new_metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf"
}

When the message is validated

Then expect no error.

an error is returned if batch denom is empty

Given the message

{
  "issuer": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6"
}

When the message is validated

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

an error is returned if batch denom is not formatted

Given the message

{
  "issuer": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "batch_denom": "foo"
}

When the message is validated

Then expect the error "batch denom: expected format [project-id]-<start_date>-<end_date>-<batch_sequence>: parse error: invalid request".

an error is returned if new metadata is empty

Given the message

{
  "issuer": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "batch_denom": "C01-001-20200101-20210101-001"
}

When the message is validated

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

an error is returned if new metadata exceeds 256 characters

Given the message

{
  "issuer": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "batch_denom": "C01-001-20200101-20210101-001"
}

And new metadata with length "257"

When the message is validated

Then expect the error "metadata: max length 256: limit exceeded".

The credit batch must exist

Background

Given a credit type with abbreviation "C"

And a credit class with id "C01" and issuer alice

And a project with id "C01-001"

And a credit batch with batch denom "C01-001-20200101-20210101-001" and issuer alice.

the credit batch exists

When alice attempts to update batch metadata with batch denom "C01-001-20200101-20210101-001"

Then expect no error.

the credit batch does not exist

When alice attempts to update batch metadata with batch denom "C01-001-20200101-20210101-002"

Then expect the error "could not get credit batch with denom C01-001-20200101-20210101-002: not found: invalid request".

The credit batch must be open

Background

Given a credit type with abbreviation "C"

And a credit class with id "C01" and issuer alice

And a project with id "C01-001".

the credit batch is open

Given a credit batch with batch denom "C01-001-20200101-20210101-001" issuer alice and open "true"

When alice attempts to update batch metadata with batch denom "C01-001-20200101-20210101-001"

Then expect no error.

the credit batch is not open

Given a credit batch with batch denom "C01-001-20200101-20210101-001" issuer alice and open "false"

When alice attempts to update batch metadata with batch denom "C01-001-20200101-20210101-001"

Then expect the error "credit batch C01-001-20200101-20210101-001 is not open: unauthorized".

The issuer must be the issuer of the credit batch

Background

Given a credit type with abbreviation "C"

And a credit class with id "C01" and issuer alice

And a project with id "C01-001"

And a credit batch with batch denom "C01-001-20200101-20210101-001" and issuer alice.

the issuer is the issuer of the credit batch

When alice attempts to update batch metadata with batch denom "C01-001-20200101-20210101-001"

Then expect no error.

the issuer is not the issuer of the credit batch

When bob attempts to update batch metadata with batch denom "C01-001-20200101-20210101-001"

Then expect error contains "is not the issuer of credit batch C01-001-20200101-20210101-001: unauthorized".

The credit batch metadata is updated

Background

Given a credit type with abbreviation "C"

And a credit class with id "C01" and issuer alice

And a project with id "C01-001"

And a credit batch with batch denom "C01-001-20200101-20210101-001" and issuer alice.

the credit batch metadata is updated

When alice attempts to update batch metadata with batch denom "C01-001-20200101-20210101-001" and new metadata

regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf

Then expect credit batch with batch denom "C01-001-20200101-20210101-001" and metadata

regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf

The event is emitted

Background

Given a credit type with abbreviation "C"

And a credit class with id "C01" and issuer alice

And a project with id "C01-001"

And a credit batch with batch denom "C01-001-20200101-20210101-001" and issuer alice.

EventUpdateBatchMetadata is emitted

When alice updates the batch metadata

Then expect event with properties

{
  "batch_denom": "C01-001-20200101-20210101-001"
}