Tokenomics by bwhm · Pull Request #7 · Joystream/joystream-api-examples

bwhm · 2020-07-09T13:46:52Z

Made a very rough version in #6 , but will replace with this now.

Not exactly clean code, as I am both not the best coder, and have had to do it in patches. Not sure we can have this in a public repo w/o cleaning it up...?

mnaamani · 2020-07-10T08:53:29Z

Building works, but then I tried to run get-tokenomics-history:

MokoBook:api-examples mokhtar$ node lib/tokenomics/get-tokenomics-history
/Users/mokhtar/joystream/api-examples/lib/tokenomics/get-history-events.js:78
        title: proposalData.get("title")?.toString(),
                                         ^

SyntaxError: Unexpected token '.'
    at wrapSafe (internal/modules/cjs/loader.js:1054:16)
    at Module._compile (internal/modules/cjs/loader.js:1102:27)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1158:10)
    at Module.load (internal/modules/cjs/loader.js:986:32)
    at Function.Module._load (internal/modules/cjs/loader.js:879:14)
    at Module.require (internal/modules/cjs/loader.js:1026:19)
    at require (internal/modules/cjs/helpers.js:72:18)
    at Object.<anonymous> (/Users/mokhtar/joystream/api-examples/lib/tokenomics/get-tokenomics-history.js:6:30)
    at Module._compile (internal/modules/cjs/loader.js:1138:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1158:10)

tsconfig.json might need some tweaking because that ?. syntax is valid in TS but doesn't seem to have been transpiled into valid javascript.

mnaamani · 2020-07-10T09:16:23Z

I guess I was using old version of node v12.18.2 so I changed target from esnext to es2019 and running now works.
waiting for program to complete to report my results..

mnaamani

Works, as long as you connect to an archival node.

Left a few tips and suggestions. If you just need a quick and dirty script, I would say just update the trarget in tsconfig.json to es2019 to make it work with node LTS (v12.x)

mnaamani · 2020-07-10T09:44:06Z

src/tokenomics/functions.ts

+}
+
+
+export async function getPoolStart(api: ApiPromise, burnAddress:string, firstBlock:number, topUps:PoolTopup[], allExchanges: ExchangeInfo[]): Promise<PoolStatus> {


I was gonna suggest a better name would be getPoolStatus()
But I see the other getPoolEnd() which also returns the same type.

After understanding more what you are computing at the start and end, it makes more sense to actually rename PoolStatus to something more appropriate but its difficult to pick a name because it contains both status values and delta values, which suggests you need two separate types, one for each category.

But I think its overkill so carry on :)

src/tokenomics/functions.ts

mnaamani · 2020-07-10T09:47:19Z

src/tokenomics/functions.ts

+    feesPaid: feesPaid,
+    slashAmount: slashAmount,
+    proposalsAddedInRange: proposalsAddedInRange,
+    proposalsFinalizedInRange: proposalsFinalizedInRange,


a nice shorthand way of writing this when the key and value names are identical is:

const proposalData: OverviewProposal = { activeProposalsAtStart, activeProposalsAtEnd, fundingCosts, feesPaid, slashAmount, proposalsAddedInRange, proposalsFinalizedInRange, }

mnaamani · 2020-07-10T09:56:40Z

src/tokenomics/functions.ts

+
+
+export async function getPoolStart(api: ApiPromise, burnAddress:string, firstBlock:number, topUps:PoolTopup[], allExchanges: ExchangeInfo[]): Promise<PoolStatus> {
+  let totalAddedToPool = 0


The code is fragile because you are using a plain javascript number for the Balance type which in the runtime is u128.

This is fine as long as the values we are dealing with are not larger than

mnaamani · 2020-07-10T09:58:50Z

src/tokenomics/functions.ts

+export async function getGeneralOverview(api: ApiPromise, firstBlockHash:Hash,lastBlockHash:Hash): Promise<OverviewGeneral> {
+  const forumCategoriesAtStart = await api.query.forum.nextCategoryId.at(firstBlockHash) as CategoryId;
+  const forumCategoriesAtEnd = await api.query.forum.nextCategoryId.at(lastBlockHash) as CategoryId;
+  const newCategories = forumCategoriesAtEnd.toNumber()-forumCategoriesAtStart.toNumber()


Suggested change

const newCategories = forumCategoriesAtEnd.toNumber()-forumCategoriesAtStart.toNumber()

const newCategories = forumCategoriesAtEnd.sub(forumCategoriesAtStart).toNumber()

Easier on the eyes :)

mnaamani · 2020-07-10T11:42:13Z

src/tokenomics/get-history-events.ts

+          proposals[index].executedAt = blockHeight
+        }
+      } else {
+        if (decision.type === "Canceled" ||decision.type === "Cancelled") {


why are we checking for two different spellings ?

I thought Canceled was incorrect (one "l"), so I figured it may be changed in the future :)

A quick search uncovered that it's one of the US/British English differences, so it makes less sense!

mnaamani · 2020-07-10T11:43:05Z

src/tokenomics/get-history-events.ts

+        }
+      } else {
+        if (decision.type === "Canceled" ||decision.type === "Cancelled") {
+          proposals[index].feePaid = 10000


wondering where this number comes from?

I didn't know how to find them with the API, so I used manual inputs. From memory, they're hardcoded in pioneer even.

If I'm wrong, I'd be happy to correct it!

src/tokenomics/get-history-events.ts

mnaamani · 2020-07-10T11:56:49Z

src/tokenomics/get-tokenomics-history.ts

+      }
+      // Get tokens burned from tx fees
+      if (
+        sectionName === "actors" || sectionName ==="contentWorkingGroup" || sectionName === "councilElection" || 


a pattern like this could work well here:

let sectionNames = ['actors', 'contentWorkingGroup', ....] if ( sectionNamesToLookFor.contains(sectionName) && otherChecks ...){ }

mnaamani · 2020-07-10T12:01:26Z

src/tokenomics/get-tokenomics-history.ts

+        (sectionName === "members" && methodName !== "buyMembership") ||
+        (sectionName === "session" && methodName=== "setKeys")
+      ) {
+        transactionFees ++


assumption that transaction fee is always 1 token is okay, but we will miss this when that changes.

in network integration tests there are some examples on how tx fees are calculated. It could get more complicated in future if weights of transactions also affect the transaction fee (like gas).

To keep it very simple I would have some function at the top function getFeePerTransaction() { return 1 },

and instead of transactionFees++ do transactionFees += getFeePerTransaction() so it will be easy to update later

bwhm · 2020-09-26T10:49:45Z

Closing, as it's pretty much outdated...

bwhm added 4 commits June 21, 2020 15:08

gitignore .DS_Store

9ba059e

tsconfig.json

b37d268

update package.json and yarn.lock

5e28ed3

add tools for getting testnet history

5a38059

bwhm added the enhancement New feature or request label Jul 9, 2020

bwhm requested a review from mnaamani July 9, 2020 13:46

mnaamani requested changes Jul 10, 2020

View reviewed changes

bwhm closed this Sep 26, 2020

		}


		export async function getPoolStart(api: ApiPromise, burnAddress:string, firstBlock:number, topUps:PoolTopup[], allExchanges: ExchangeInfo[]): Promise<PoolStatus> {



		export async function getPoolStart(api: ApiPromise, burnAddress:string, firstBlock:number, topUps:PoolTopup[], allExchanges: ExchangeInfo[]): Promise<PoolStatus> {
		let totalAddedToPool = 0

	const newCategories = forumCategoriesAtEnd.toNumber()-forumCategoriesAtStart.toNumber()
	const newCategories = forumCategoriesAtEnd.sub(forumCategoriesAtStart).toNumber()

Conversation

bwhm commented Jul 9, 2020

Uh oh!

mnaamani commented Jul 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mnaamani commented Jul 10, 2020

Uh oh!

mnaamani left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bwhm commented Sep 26, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mnaamani commented Jul 10, 2020 •

edited

Loading