History

James Grugett 76f27d1a93 Numeric range markets!! (#146 ) * Numeric contract type * Create market numeric type * Add numeric graph (coded without testing) * Outline of numeric bet panel * Update bet panel logic * create numeric contracts * remove batching for antes for numeric markets * Remove focus * numeric market range [1, 100] * Zoom graph * Hide bet panels * getNumericBets * Add numeric resolution panel * Use getNumericBets in bet panel calc * Switch bucket count to 100 * Parallelize ante creation * placeBet for numeric markets * halve std of numeric bets * Update resolveMarket with numeric type * Set min and max for contract * lower std for numeric bets * calculateNumericDpmShares: use sorted order * Use min and max to map the input * Fix probability calc * normpdf variance mislabeled * range input * merge * change numeric graph color * fix getNewContract params * bet panel labels * validation * number input * fix bucketing * bucket input, numeric resolution panel * outcome label * merge * numeric bet panel on mobile * Make text underneath filled green answer bar selectable * Default to 'all' feed category when loading page. * fix numeric resolution panel * fix numeric bet panel calculations * display numeric resolution * don't render NumericBetPanel for non numeric markets * numeric bets: store shares, bet amounts across buckets in each bet object * restore your bets for numeric markets * numeric pnl calculations * remove hasUserHitManaLimit * contrain contract type * handle undefined allOutcomeShares * numeric ante bet amount * use correct amount for numeric dpm payouts * change numeric graph/outcome color * numeric constants * hack to show correct numeric payout in calculateDpmPayoutAfterCorrectBet * remove comment * fix ante display in bet list * halve bucket count * cast to NumericContract * fix merge imports * OUTCOME_TYPES * typo * lower bucket count to 200 * store raw numeric value with bet * store raw numeric resolution value * number input max length * create page: min, max to undefined if not numeric market * numeric resolution formatting * expected value for numeric markets * expected value for numeric markets * rearrange lines for readability * move normalpdf to util/math * show bets tab * check if outcomeMode is undefined * remove extraneous auto-merge cruft * hide comment status for numeric markets * import Co-authored-by: mantikoros <sgrugett@gmail.com>		2022-05-19 12:42:03 -05:00
..
src	Numeric range markets!! (#146 )	2022-05-19 12:42:03 -05:00
.gitignore	Separate free response answers & comments (#100 )	2022-04-26 07:24:57 -06:00
package.json	Implement `onRequest` versions of `createContract`, `placeBet` functions (#227 )	2022-05-16 21:43:40 -07:00
README.md	Readme: must be in dev for emulators to work	2022-04-28 12:29:02 -06:00
tsconfig.json	More absolute imports (#156 )	2022-05-09 09:04:36 -04:00

README.md

NOTE: Adapted from One Word's /functions doc. Fix any errors you see!

Firestore Cloud Functions

This is code that doesn't make sense on the frontend client, e.g.

Long-running or slow operation (database)
Tasks that need to be run every so often (syncing email list to Mailjet)
Anything we should't trust to clients (secrets, auth)

If you want to make and test changes, you'll have to do a bit of setup...

Installing

Adapted from https://firebase.google.com/docs/functions/get-started

$ cd functions to switch to this folder
$ yarn global add firebase-tools to install the Firebase CLI globally
$ yarn to install JS dependencies
$ firebase login to authenticate the CLI tools to Firebase
$ firebase use dev to choose the dev project

For local development

$ firebase functions:config:get > .runtimeconfig.json to cache secrets for local dev
Install gcloud CLI
$ brew install java to install java if you don't already have it
1. $ echo 'export PATH="/usr/local/opt/openjdk/bin:$PATH"' >> ~/.zshrc to add java to your path
$ gcloud auth login to authenticate the CLI tools to Google Cloud
$ gcloud config set project <project-id> to choose the project ($ gcloud projects list to see options)
$ mkdir firestore_export to create a folder to store the exported database
$ yarn db:update-local-from-remote to pull the remote db from Firestore to local
1. TODO: this won't work when open source, we'll have to point to the public db

Developing locally

$ firebase use dev if you haven't already
$ yarn serve to spin up the emulators
1. The Emulator UI is at http://localhost:4000; the functions are hosted on :5001. Note: You have to kill and restart emulators when you change code; no hot reload =(
$ yarn dev:emulate in /web to connect to emulators with the frontend
1. Note: emulated database is cleared after every shutdown

Firestore Commands

db:update-local-from-remote - Pull the remote db from Firestore to local, also calls:
- db:backup-remote - Exports the remote dev db to the backup folder on Google Cloud Storage (called on every db:update-local-from-remote)
- db:rename-remote-backup-folder - Renames the remote backup folder (called on every db:backup-remote to preserve the previous db backup)
db:backup-local - Save the local db changes to the disk (overwrites existing)

Debugging

Find local logs directly in the shell that ran $ yarn dev
Find deployed logs here

Deploying

$ firebase use prod to switch to prod
$ yarn deploy to push your changes live! (Future TODO: auto-deploy functions on Git push)

Secrets management

Secrets are strings that shouldn't be checked into Git (eg API keys, passwords). We store these using environment config on Firebase Functions. Some useful workflows:

Set a secret: $ firebase functions:config:set stripe.test_secret="THE-API-KEY"
Preview all secrets: $ firebase functions:config:get
Cache for local dev:$ firebase functions:config:get > .runtimeconfig.json