Skip to content

Latest commit

 

History

History
115 lines (71 loc) · 4.06 KB

README.md

File metadata and controls

115 lines (71 loc) · 4.06 KB
Raw

Origin Protocol Dshop Backend

This is the supporting backend for Origin DShop. It's primary functions are:

  • Handling off-chain payments, such as credit card transactions
  • Sending out confirmation emails
  • Order management
  • Discount code management

It works by watching the Ethereum blockchain for relevant activity on the Origin Marketplace contract. Order data is downloaded from IPFS, decrypted and stored in a Postgres database.

Local development

Follow the steps on the Front-end README to start a local back-end.

Manual Deploy

This assumes you have already followed the steps to setup and deploy a store to IPFS. You will need your Public URL, PGP Private Key and password, and a websocket provider URL (eg via Infura or Alchemy).

Manual deploy to Heroku

Please note that Heroku's free tier puts processes to sleep after some inactivity. This causes the process watching the blockchain to stop, meaning new orders will not be processed. Please use a paid Heroku dyno ($7/month) to ensure this does not happen.

# Install and login to heroku if you have not already done so...
curl https://cli-assets.heroku.com/install.sh | sh
heroku login

# Create a new heroku app called 'myshop'
heroku create myshop

# Enable Postgres and Sendgrid addons
heroku addons:create heroku-postgresql:hobby-dev
heroku addons:create heroku-redis:hobby-dev
heroku addons:create sendgrid:starter

# Set environment variables
heroku config:set ENCRYPTION_KEY=randomstring

# Commit files
git add .
git commit -m "Origin Shop backend"

# Deploy app to Heroku

git push heroku master

# Switch to 'hobby' type dyno to prevent sleeping ($7/month)

heroku ps:type hobby

PGP/GPG Key Export

Export key pair in base64 with no newlines:

gpg --list-keys
gpg --armor --export KEY_ID | base64 -w0
gpg --armor --export-secret-key KEY_ID | base64 -w0

Creating a new table in the database [Work in Progress]

Reference: https://sequelize.org/master/manual/

Checklist:

  • Determine the names of the columns in your table. Plan to include a created_at and an updated_at column with type DATE to prevent issues with the following steps.

  • Create a skeleton of the table by adding a new migration:

    npx sequelize migration:generate --name migrationName --migrations-path=./db/migrations

    By convention, column names are written with snake case (e.g. my_column). After making changes to your migration file, you can commit the changes to the database using the command

    npm run migrate

  • Navigate to the models folder and create a new file with an appropriate name. Note: While it is common for column names in migration files to be written in snake case, column names in models are written in lower camel case (e.g. myColumn). To correctly instruct Sequelize to associate these columns with their couterparts in the DB, set the underscored option to true See more

  • To be continued...

Sync Repos

npm run build:dist
rsync -rv --exclude=.git --exclude=.gitignore --exclude=/db/dshop.db --exclude=/node_modules --exclude=/data --delete backend/ DESTINATION

Running unit tests

To run the full test suite:

yarn run test

To run a specific test or group of tests:

yarn run test -g "Discounts"

To run a single test, you can change its function definition from it('blah blah...') to it.only('blah blah...') then run yarn run test

Optionally, if you are going to run tests several times in a row (typically during development), you can speed up the test setup phase by starting the services in a separate terminal and leave them up and running.

cd ../packages/services
yarn run start -g -i -d

Then in another window:

env USE_RUNNING_SERVICES=true yarn run test