[FIP-nn] Milestone Checklist

Definition

Create FIP

Follow FIP process to create and get to accepted

• Include section on what will be done to ensure the feature is deployed as expected in Mainnet

Create initial Epic or Story

Create initial Epic or Story

Create FIP Dev Wiki Directory

Create directory for FIP docs under Development Documents wiki

Create stories and subtasks

Subtasks/stories created for items in the Development Milestone Checklist

Requirements and Scoping

FIP-NN Requirements - Project kickoff

Kickoff meeting held with Product Manager to review requirements

FIP-NN Requirements - Complete FIP

FIP reviewed and moved to Accepted status

FIP-NN Master release schedule

Update master release schedule with feature actions and endpoints

Design and Scoping

FIP-NN Requirements - Functional / Technical design

Complete technical design and save to wiki. Design draft should include a first draft of all elements outlined in the Development Spec.

Template: [FIP-nn] Development - Spec

FIP-NN Estimate stories

Each story should be unit of work that is deliverable in a 2 week sprint. An initial estimate should be included with every development story.

FIP-NN Design review

Functional spec approved by architecture champions and team

FIP-NN Design - Update FIP

Update FIP with any changes resulting from design review

Development

FIP-NN Complete development

Complete all development for feature. This may include multiple stories and subtasks for larger features. Include link to PR in story.

Includes

• Create bug/feature branch and draft PR for new feature (e.g., feature/fip-16-lock-tokens, See: https://developers.fioprotocol.io/docs/developers/git )

• Create fio.devtools branch and draft PR for new feature (e.g., feature/fip-16-lock-tokens). Add new fees and actions, etc.

FIP-NN Ram bump analysis

Determine RAM allocation for new actions and set RAM bump accordingly. This information should be added to the FIP.

See: https://developers.fioprotocol.io/docs/developers/ram

FIP-NN Fee analysis

Estimate initial fees for all actions.

In cases where the action requires additional RAM, the fees should be correlated with the RAM estimates. This informationshould be added to the FIP

FIP-NN ABI Validation

Validate json for any new ABIs or ABIs that have been updated. If deploying new contract, make sure ABI copy command is in fio.devtools contracts/build.sh

FIP-NN History Plugin

For transactions that automatically create accounts (e.g., regdomain) if the public key used is new, we need to make sure that the correct entries are added to the the history_plugin.cpp. See for example: [FIP-42] Chain plugin API updates by adsorptionenthalpy · Pull Request #363 · fioprotocol/fio

FIP-NN Dev - Update FIP and development spec

Update the FIP and development spec to make sure they are aligned with the latest code. This includes:

• Ensure the error messages are the same between the code and the FIP.

FIP-NN Code review

Code review of PR from all core devs, release management, and QA

FIO does DAC-style code reviews wherein the following core team members are required to review all major PRs:

• Core developers - Full review

• Security - Full review. TBD on how this will be handled.

• QA and Release Management- Summary review to acknowledge understanding that the feature is in development

If a developer approves a PR, it is assumed that they have taken the time to do a thorough review. Just checking the box is inadequate and puts the chain at risk. If a bug or structural issue escapes, we will be taking joint responsibility for not finding it during our reviews. If a developer wants to dig deeper and has questions for the main developer, they should initiate a discussion with the developer.

FIP-NN Deployment release guide

Create deployment release guide. This is used by release management to define needed msigs during testnet and mainnet deployments

Includes:

• New actions (addaction)

• New fees (createfee)

• List of contracts modified

Template: [FIP-nn] Deployment and rollout guide

Unit Testing

FIP-NN Unit testing - Action and getter unit tests

Includes initial development of unit tests for handoff to QA:

• Create fio.test branch and draft PR for initial unit tests created on fio.test (e.g., feature/fip-16-lock-tokens)

• Development of initial action and getter unit tests

• Tests run cleanly

FIP-NN Unit testing - Performance tests

Create first level performance testing results reviewed with architecture champions (can be performed on dev machine, try to uncover any obvious perf limits)

FIP-NN Dev - Test guide

Add testing info to this story for QA. This is a brainstorming list of items from the developer to make sure specific items are tested. Includes:

• Note any areas of existing code that are impacted by the new feature and should be tested as part of this feature testing

• Any use cases that need to be included

FIP-NN Dev - QA handoff

Review code and unit tests with QA and Release Management.

SDKs

FIP-NN SDK updates

Create stories for FE team for any needed changes are needed for new features.

QA

FIP-NN QA - Feature Testing

Complete feature testing, including:

• Create test cases / test plan

• Review test plan with lead developer

• Create tests in fio.test

Deliverables include:

• fio.test enhanced with functional tests

• Tests run cleanly

• Functional tests well documented (in fio.test) and reviewed with team

FIP-NN QA - Performance testing

Complete performance testing, including:

• Work with Dev Lead to create performance test plan

• fio.test enhanced with performance tests

Getter performance testing:

• For any look where the number of items in the table might grow to be > 1000 items for a parameter, make sure that it is possible to directly call get_table_rows with a limit and a lower_bound on that parameter.

FIP-NN QA - History node testing

Test against node with V1 History and confirm no errors in log file (add results to Dev Spec)

For transactions that automatically create accounts (e.g., regdomain) if the public key used is new, we need to make sure that the correct entries are added to the the history_plugin.cpp. See for example: [FIP-42] Chain plugin API updates by adsorptionenthalpy · Pull Request #363 · fioprotocol/fio

To test, the transaction should be run, and a history get_actions for the target account should show the (regdomain, etc.) action.

When released to testnet, it should be confirmed that http://bloks.io shows the appropriate transaction history.

FIP-NN Testnet smoketest

Add new actions and getters to testnet-smoketest.js script.

FIP-NN QA - Test review

System and performance tests and results reviewed with Dev team

UAT

FIP-NN UAT - Install release on DEV server

Install release on DEV server. This is a task to ensure that their feature or fix is on a publicly accessible DEV server so it can be reviewed by Product Management. This should be done after system testing is complete.

FIP-NN UAT - System testing

Complete system testing, including:

• All bugs and outstanding items completed

• JS tests completed and run cleanly against DEV server

FIP-NN UAT - Confirm feature and QA complete

Confirm all bugs and outstanding items completed

FIP-NN UAT - Product Management signoff

Get signoff from Product Management

• Include copy of the fio.test output for the FIP Epic

• Move Epic to Ready for UAT

• Notify Pawel on Discord

FIP-NN UAT - Complete UAT

Tracks completion of UAT by the Product Manager

• This task is left to the discretion of the Product Manager as to the extent of UAT that will be done for the feature.

• Once complete the Epic should be moved to “Ready to Deploy” status