Regen Ledger Documentation

Batch

a valid batch

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "C01-001-20200101-20210101-001",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "start_date": "2020-01-01T00:00:00Z",
  "end_date": "2021-01-01T00:00:00Z",
  "issuance_date": "2022-01-01T00:00:00Z"
}

When the batch is validated

Then expect no error.

a valid batch with open true

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "C01-001-20200101-20210101-001",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "start_date": "2020-01-01T00:00:00Z",
  "end_date": "2021-01-01T00:00:00Z",
  "issuance_date": "2022-01-01T00:00:00Z",
  "open": true
}

When the batch is validated

Then expect no error.

an error is returned if key is empty

Given the batch

{}

When the batch is validated

Then expect the error "key cannot be zero: parse error".

an error is returned if issuer is empty

Given the batch

{
  "key": 1
}

When the batch is validated

Then expect the error "issuer: empty address string is not allowed: parse error".

an error is returned if project key is empty

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y="
}

When the batch is validated

Then expect the error "project key cannot be zero: parse error".

an error is returned if denom is empty

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1
}

When the batch is validated

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

an error is returned if denom is not formatted

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "foo"
}

When the batch is validated

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

an error is returned if metadata exceeds 256 characters

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "C01-001-20200101-20210101-001"
}

And metadata with length "257"

When the batch is validated

Then expect the error "metadata cannot be more than 256 characters: parse error".

an error is returned if start date is empty

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "C01-001-20200101-20210101-001",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf"
}

When the batch is validated

Then expect the error "must provide a start date for the credit batch: parse error".

an error is returned if end date is empty

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "C01-001-20200101-20210101-001",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "start_date": "2020-01-01T00:00:00Z"
}

When the batch is validated

Then expect the error "must provide an end date for the credit batch: parse error".

an error is returned if start date is equal to end date

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "C01-001-20200101-20210101-001",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "start_date": "2020-01-01T00:00:00Z",
  "end_date": "2020-01-01T00:00:00Z"
}

When the batch is validated

Then expect the error "the batch end date (2020-01-01T00:00:00Z) must be the same as or after the batch start date (2020-01-01T00:00:00Z): parse error".

an error is returned if start date after end date

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "C01-001-20200101-20210101-001",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "start_date": "2021-01-01T00:00:00Z",
  "end_date": "2020-01-01T00:00:00Z"
}

When the batch is validated

Then expect the error "the batch end date (2020-01-01T00:00:00Z) must be the same as or after the batch start date (2021-01-01T00:00:00Z): parse error".

an error is returned if issuance date is empty

Given the batch

{
  "key": 1,
  "issuer": "BTZfSbi0JKqguZ/tIAPUIhdAa7Y=",
  "project_key": 1,
  "denom": "C01-001-20200101-20210101-001",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "start_date": "2020-01-01T00:00:00Z",
  "end_date": "2021-01-01T00:00:00Z"
}

When the batch is validated

Then expect the error "must provide an issuance date for the credit batch: parse error".