Migration away from the hosted service

.github/workflows/test.yml

@@ -23,7 +23,7 @@ jobs:
           cache-name: cache-node-modules
         with:
           path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-build-${{ env.cache-name }}-
             ${{ runner.os }}-build-
@@ -35,13 +35,13 @@ jobs:
           node-version: v16.13.1
 
       - name: Install dependencies
-        run: yarn --frozen-lockfile
+        run: npm install
 
       - name: Build subgraph.yaml for mainnet
-        run: yarn prep:mainnet
+        run: npm run prep:mainnet
 
       - name: Run matchstick tests
-        run: yarn test
+        run: npm run test
 
 #      - name: Generate code coverage report
 #        run: yarn coverage

README.md

@@ -1,4 +1,71 @@
-# KnownOrigin.io Subgraph
+# KnownOrigin.io Indexed Subgraph V2 (Graph Network)
+
+See: https://thegraph.com/docs/en/deploying/subgraph-studio/#publish-your-subgraphs
+
+### URIs
+
+| Chain               | Studio Link (requires auth)                               | Public URL|
+|-----------------------|-----------------------------------------------------------|----|
+| Mainnet  | https://thegraph.com/studio/subgraph/known-origin/        | https://gateway.thegraph.com/api/[api-key]/subgraphs/id/CGZ1hQkiQXTyGLrAFH1yk3H8xPjBy6avbTB8rCLw9sJL ||
+| Goerli    | https://thegraph.com/studio/subgraph/known-origin-goerli/ | https://gateway.testnet.thegraph.com/api/[api-key]/subgraphs/id/CGZ1hQkiQXTyGLrAFH1yk3H8xPjBy6avbTB8rCLw9sJL ||
+
+### Installing the Graph CLI
+
+```bash
+npm install -g @graphprotocol/graph-cli
+```
+
+### Authing with the CLI
+
+To deploy any changes to a subgraph you must be authed with the specific deploy_key for that subgraph, ask a code owner for these keys before attempting to deploy.
+
+```bash
+graph auth --studio DEPLOY_KEY
+```
+
+### Dev cycle
+
+**Requires Node 16 !**
+```bash
+nvm use
+```
+
+Install
+
+```bash
+npm install
+```
+
+Prepare subgraph.yaml for selected chain
+
+```bash
+npm run prep:mainnet || npm run prep:goerli
+```
+
+Codegen
+
+```bash
+npm run codegen
+```
+
+Build Subgraph
+
+```bash
+npm run build
+```
+
+Deploy the Subgraph
+
+```bash
+npm run deploy:mainnet || npm run deploy:goerli
+```
+
+Goerli Faucet for test GRT tokens
+
+* https://discord.com/channels/438038660412342282/1001942596958048440
+
+
+# KnownOrigin.io Hosted Subgraph (Deprecated)
 
 ### Graph UI
 
@@ -25,7 +92,6 @@ https://thegraph.com/hosted-service/subgraph/knownorigin/known-origin-goerli
 | Production (mainnet)  | https://thegraph.com/explorer/subgraph/knownorigin/known-origin                     ||
 | Staging (mainnet)     | https://thegraph.com/explorer/subgraph/knownorigin/known-origin-staging             ||
 | Development (goerli)  | https://thegraph.com/hosted-service/subgraph/knownorigin/known-origin-goerli        ||
-| Development (rinkeby) | ~~https://thegraph.com/explorer/subgraph/knownorigin/knownoriginrinkeby~~ Deprecated ||
 | Alpha Studio (mainnet) | https://thegraph.com/studio/subgraph/known-origin                                   ||
 
 ### Built via
@@ -88,4 +154,4 @@ brew install postgresql
 
 ```
 yarn test
-```
+```

package.json

@@ -4,27 +4,26 @@
   "scripts": {
     "codegen": "graph codegen",
     "build": "graph build",
-    "prep:mainnet": "mustache templates/mainnet.json subgraph.template.yaml > subgraph.yaml && yarn codegen;",
-    "deploy:mainnet": "yarn run prep:mainnet; graph deploy --debug --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ knownorigin/known-origin",
-    "deploy:prod2": "yarn run prep:mainnet; graph deploy --debug --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ knownorigin/knownoriginprod2",
-    "deploy:staging": "yarn run prep:mainnet; graph deploy --debug --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ knownorigin/known-origin-staging",
-    "prep:rinkeby": "mustache templates/rinkeby.json subgraph.template.yaml > subgraph.yaml && yarn codegen;",
-    "deploy:rinkeby": "yarn run prep:rinkeby; graph deploy --debug --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ knownorigin/knownoriginrinkeby",
-    "prep:goerli": "mustache templates/goerli.json subgraph.template.yaml > subgraph.yaml && yarn codegen;",
-    "deploy:goerli": "yarn run prep:goerli; graph deploy --product hosted-service knownorigin/known-origin-goerli",
-    "deploy:mainnet-studio": "yarn run prep:mainnet; graph deploy --studio known-origin",
+    "prep:mainnet": "mustache templates/mainnet.json subgraph.template.yaml > subgraph.yaml && graph codegen;",
+    "prep:goerli": "mustache templates/goerli.json subgraph.template.yaml > subgraph.yaml && graph codegen;",
+    "deploy:mainnet": "npm run prep:mainnet; graph deploy --studio known-origin",
+    "deploy:goerli": "npm run prep:goerli; graph deploy --studio known-origin-goerli",
+    "deploy:mainnet-hosted": "yarn run prep:mainnet; graph deploy --debug --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ knownorigin/known-origin",
+    "deploy:prod2-hosted": "yarn run prep:mainnet; graph deploy --debug --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ knownorigin/knownoriginprod2",
+    "deploy:staging-hosted": "yarn run prep:mainnet; graph deploy --debug --node https://api.thegraph.com/deploy/ --ipfs https://api.thegraph.com/ipfs/ knownorigin/known-origin-staging",
+    "deploy:goerli-hosted": "yarn run prep:goerli; graph deploy --product hosted-service knownorigin/known-origin-goerli",
     "create-local": "graph create --node http://localhost:8020/ knownorigin/known-origin",
     "remove-local": "graph remove --node http://localhost:8020/ knownorigin/known-origin",
     "deploy-local": "graph deploy --node http://localhost:8020/ --ipfs http://localhost:5001 knownorigin/known-origin",
     "test": "graph test",
     "test-docker": "graph test --docker"
   },
   "dependencies": {
-    "@graphprotocol/graph-cli": "0.30.4",
-    "@graphprotocol/graph-ts": "0.27.0",
-    "mustache": "^4.2.0"
+    "@graphprotocol/graph-cli": "0.55.0",
+    "@graphprotocol/graph-ts": "0.31.0",
+    "mustache": "4.2.0"
   },
   "devDependencies": {
-    "matchstick-as": "0.5.1"
+    "matchstick-as": "0.5.2"
   }
 }

schema.graphql

@@ -5,7 +5,7 @@
 
 # Generic activity stream events for history of actions including primary and secondary sales actions & triggers
 # Used for listing out token history on the token pages
-type TokenEvent @entity {
+type TokenEvent @entity(immutable: true) {
     id: ID!                     # Composite key made form multiple items
     version: BigInt!            # KODA 2 or 3
     name: String!
@@ -28,7 +28,7 @@ type TokenEvent @entity {
 }
 
 # Token events for transfers
-type TransferEvent @entity {
+type TransferEvent @entity(immutable: true) {
     id: ID!
     version: BigInt! # KODA 2 or 3
     from: Bytes! # address
@@ -48,7 +48,7 @@ type TransferEvent @entity {
 }
 
 # Edition primary sale auction events
-type AuctionEvent @entity {
+type AuctionEvent @entity(immutable: true) {
     id: ID!
     version: BigInt! # KODA 2 or 3
     edition: Edition!
@@ -70,7 +70,7 @@ type AuctionEvent @entity {
 }
 
 # Common unified event stream spanning KODA versions and various types
-type ActivityEvent @entity {
+type ActivityEvent @entity(immutable: true) {
     id: ID!
     type: String!               # Token, Edition or Creator Contract
     version: BigInt!            # KODA 2 or 3
@@ -305,7 +305,7 @@ type Composable @entity {
 }
 
 # ComposableItem represents one token attached to a composable
-type ComposableItem @entity {
+type ComposableItem @entity  {
     id: ID! # ID made up of combined tokenID/composing contract/composing IDs
     address: String! # Address of the ERC20/ERC721 token
     tokenID: String! # ID of the token
@@ -443,7 +443,7 @@ type Edition @entity {
 }
 
 # A token/editions and its meta data
-type MetaData @entity {
+type MetaData @entity(immutable: true) {
     id: ID!
     name: String
     description: String
@@ -474,7 +474,7 @@ type MetaData @entity {
 }
 
 # Single high level entity capturing the top offer on the secondary marketplace
-type TokenOffer @entity {
+type TokenOffer @entity(immutable: true) {
     id: ID!
     version: BigInt! # KODA 2 or 3
     token: Token!

src/services/Edition.service.ts

@@ -93,7 +93,6 @@ export function loadOrCreateV2Edition(editionNumber: BigInt, block: ethereum.Blo
             let metaData = constructMetaData(editionNumber.toString(), _editionData.value7)
 
             if (metaData != null) {
-                metaData.save()
                 editionEntity.metadata = metaData.id
 
                 editionEntity.metadataName = metaData.name ? metaData.name as string : ''
@@ -249,7 +248,6 @@ function buildEdition(_editionId: BigInt, _originalCreator: Address, _size: BigI
 
         let metaData = constructMetaData(_editionId.toString(), _uri)
         if (metaData != null) {
-            metaData.save()
             editionEntity.metadata = metaData.id
             editionEntity.metadataFormat = metaData.format
             editionEntity.metadataTheme = metaData.theme
@@ -324,7 +322,6 @@ function buildV4Edition(_editionId: BigInt, _originalCreator: Address, _size: Bi
 export function populateEditionMetadata(editionEntity: Edition, _editionId: string, _uri: string): void {
     let metaData = constructMetaData(_editionId, _uri)
     if (metaData != null) {
-        metaData.save()
         editionEntity.metadata = metaData.id
         editionEntity.metadataFormat = metaData.format
         editionEntity.metadataTheme = metaData.theme