Regen Ledger Documentation

CreateProject

Projects can be created:

  • message validations
  • when the credit class exists
  • when the admin is an allowed credit class issuer
  • when the non-empty reference id is unique within the scope of the credit class
  • the project sequence is updated
  • the project properties are added
  • the response includes the project id

Message validations

a valid message

Given the message

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "class_id": "C01",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "jurisdiction": "US-WA",
  "reference_id": "VCS-001"
}

When the message is validated

Then expect no error.

a valid message without metadata

Given the message

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "class_id": "C01",
  "jurisdiction": "US-WA",
  "reference_id": "VCS-001"
}

When the message is validated

Then expect no error.

a valid message without reference id

Given the message

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "class_id": "C01",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "jurisdiction": "US-WA"
}

When the message is validated

Then expect no error.

an error is returned if class id is empty

Given the message

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6"
}

When the message is validated

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

an error is returned if class id is not formatted

Given the message

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "class_id": "foo"
}

When the message is validated

Then expect the error "class id: expected format [credit-type-abbrev][class-sequence]: parse error: invalid request".

an error is returned if metadata is exceeds 256 characters

Given the message

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "class_id": "C01"
}

And metadata with length "257"

When the message is validated

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

an error is returned if jurisdiction is empty

Given the message

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "class_id": "C01",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf"
}

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

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "class_id": "C01",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "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 reference id is exceeds 32 characters

Given the message

{
  "admin": "regen1depk54cuajgkzea6zpgkq36tnjwdzv4ak663u6",
  "class_id": "C01",
  "metadata": "regen:13toVgf5aZqSVSeJQv562xkkeoe3rr3bJWa29PHVKVf77VAkVMcDvVd.rdf",
  "jurisdiction": "US-WA"
}

And a reference id with length "33"

When the message is validated

Then expect the error "reference id: max length 32: limit exceeded".

The credit class must exist

Background

Given a credit type with abbreviation "C"

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

the credit class exists

When alice attempts to create a project with class id "C01"

Then expect no error.

the credit class does not exist

When alice attempts to create a project with class id "C02"

Then expect the error "could not get class with id C02: not found: invalid request".

The admin must be an allowed credit class issuer

Background

Given a credit type with abbreviation "C"

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

the issuer is an allowed credit class issuer

When alice attempts to create a project with class id "C01"

Then expect no error.

the issuer is not an allowed credit class issuer

When bob attempts to create a project with class id "C01"

Then expect error contains "is not an issuer for the class: unauthorized".

A non-empty reference id must be unique within the scope of a credit class

Background

Given a credit type with abbreviation "C"

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

non-empty reference id is unique within credit class

Given a project with project id "C01-001" and reference id "VCS-001"

When alice attempts to create a project with class id "C01" and reference id "VCS-002"

Then expect no error.

empty reference id is allowed for multiple projects

Given a project with project id "C01-001" and reference id ""

When alice attempts to create a project with class id "C01" and reference id ""

Then expect no error.

non-empty reference id is not unique within credit class

Given a project with project id "C01-001" and reference id "VCS-001"

When alice attempts to create a project with class id "C01" and reference id "VCS-001"

Then expect the error "a project with reference id VCS-001 already exists within this credit class: invalid request".

the project sequence is updated

Background

Given a credit type with abbreviation "C"

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

And a credit class with class id "C02" and issuer alice.

the project sequence is updated

Given a project sequence with class id "C01" and next sequence "1"

When alice attempts to create a project with class id "C01"

Then expect project sequence with class id "C01" and next sequence "2".

the project sequence is not updated

Given a project sequence with class id "C01" and next sequence "1"

When alice attempts to create a project with class id "C02"

Then expect project sequence with class id "C01" and next sequence "1".

the project properties are added

Background

Given a credit type with abbreviation "C"

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

the project properties are added

When alice attempts to create a project with properties

{
  "class_id": "C01",
  "metadata": "regen:13toVfvC2YxrrfSXWB5h2BGHiXZURsKxWUz72uDRDSPMCrYPguGUXSC.rdf",
  "jurisdiction": "US-WA",
  "reference_id": "VCS-001"
}

Then expect project properties

{
  "id": "C01-001",
  "metadata": "regen:13toVfvC2YxrrfSXWB5h2BGHiXZURsKxWUz72uDRDSPMCrYPguGUXSC.rdf",
  "jurisdiction": "US-WA",
  "reference_id": "VCS-001"
}

the response includes the project id

Background

Given a credit type with abbreviation "C"

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

the response includes the project id

When alice attempts to create a project with class id "C01"

Then expect the response

{
  "project_id": "C01-001"
}

event is emitted

Background

Given a credit type with abbreviation "C"

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

EventCreateProject is emitted

When alice attempts to create a project with class id "C01"

Then expect event with properties

{
  "project_id": "C01-001"
}