Skip to content

Commit

Permalink
DRAFT
Browse files Browse the repository at this point in the history
  • Loading branch information
tracysanders committed May 25, 2021
1 parent 2ae159b commit ee1db50
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 27 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The DSCSA is a [FDA regulation](https://www.fda.gov/drugs/drug-supply-chain-secu

## Installation

Reference [OpenZeppelin](https://docs.openzeppelin.com/learn/) for details in setting up the development environment. A summary is provided in the [80_Installation.md](doc/80_Installation.md).
Reference [OpenZeppelin](https://docs.openzeppelin.com/learn/) for details in setting up the development environment. A summary is provided in the [31_Installation.md](doc/31_Installation.md).

## Usage

Expand Down
28 changes: 2 additions & 26 deletions doc/20_Design.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,33 +15,9 @@ A similar design was presented by [Middle East Medicine](https://www.middleeastm
## Initial Design

- Track the smallest sealable unit (package) identified by the Serial Number (S/N)
- Use [ERC1155 Multi Token Standard](https://docs.openzeppelin.com/contracts/4.x/erc1155)
- Use [AccessControl](https://docs.openzeppelin.com/contracts/4.x/api/access#AccessControl)
- Include composite key information (GTIN+LOT)
- Include state information (Expiration Date)
- Obfuscate additional data like Trade name into the referenced Metadata which can encrypted if desired
- Create DSCSA blockchain

## Common Development Commands

1. Launch Ganache to initialize local blockchain
2. npx truffle init
3. npx truffle compile ./contracts/DSCSAOwnerMock.sol
4. npx truffle migrate --network development
5. npx truffle test ./test/DSCSAOwnerMock.test.js

### Unit Testing

The unit tests for each function are organized as follows:

- happy cases
- trigger requires
- check modifiers
- edge cases (1 boundary)
- corner cases (n edges)

### NPM

- npm cache clean --force

### Windows

In your VS code powershell terminal: Set-ExecutionPolicy Unrestricted
19 changes: 19 additions & 0 deletions doc/30_Development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# ![LDC Logo](99_images/LDC_32_32.ico) Development and Coding

## Common Development Commands

1. Launch Ganache to initialize local blockchain
2. npx truffle init
3. npx truffle compile ./contracts/DSCSAOwnerMock.sol
4. npx truffle migrate --network development
5. npx truffle test ./test/DSCSAOwnerMock.test.js

## Miscellaneous Notes

### NPM

- npm cache clean --force

### Windows

In your VS code powershell terminal: Set-ExecutionPolicy Unrestricted
File renamed without changes.
11 changes: 11 additions & 0 deletions doc/40_Testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ![LDC Logo](99_images/LDC_32_32.ico) Integration and Testing

## Unit Testing

The unit tests for each function are organized as follows:

- happy cases
- trigger requires
- check modifiers
- edge cases (1 boundary)
- corner cases (n edges)
2 changes: 2 additions & 0 deletions doc/50_Deployment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# ![LDC Logo](99_images/LDC_32_32.ico) Implementation and Deployment

0 comments on commit ee1db50

Please sign in to comment.