@graphprotocol/grc-20 0.0.8 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # Knowledge Graph SDK
 
-A collection of tools for interacting with the The Graph.
+A collection of tools for interacting with The Graph.
 
 ## Installing
 
@@ -54,7 +54,7 @@ Entities throughout The Graph are referenced via globally unique identifiers. Th
 ```ts
 import { ID } from 'graphprotocol/grc-20';
 
-const newId = ID.make();
+const newId = ID.generate();
 ```
 
 ### Making ops
@@ -102,26 +102,16 @@ Currently the indexer only supports reading a specific gateway. You should use o
 
 Additionally, the indexer expects that IPFS CIDs be prefixed with `ipfs://` so it knows how to process it correctly. The API already returns the CID prefixed with `ipfs://`. 
 
+We've abstracted the IPFS publishing and binary encoding into a single API.
+
 ```ts
-import { EditProposal } from '@graphprotocol/grc-20/proto';
+import { IPFS } from '@graphprotocol/grc-20';
 
-const binaryEncodedEdit = EditProposal.make({
+const cid = await IPFS.publishEdit({
   name: 'Edit name',
   ops: ops,
-  author: '0x000000000000000000000000000000000000',
-});
-
-// Upload binary via Geo API
-const blob = new Blob([binaryEncodedEdit], { type: 'application/octet-stream' });
-const formData = new FormData();
-formData.append('file', blob);
-
-const result = await fetch('https://geobrowser.io/api/ipfs/upload', {
-  method: 'POST',
-  body: formData,
-});
-
-const { cid } = await result.json();
+  author: '0x000000000000000000000000000000000000', 
+})
 ```
 
 ### Publishing an edit onchain
@@ -130,14 +120,18 @@ Once you've uploaded the binary encoded Edit to IPFS and have correctly formed `
 
 The calldata used to write the edit onchain depends on the governance structure of the space. Currently The Graph supports two governance modes, one with voting and one without. The API exposes metadata about each space, its governance structure, and what smart contracts exist for it.
 
-We expose an API for fetching the appropriate calldata for the correct contract address based for each space.
+We expose an API for fetching the appropriate calldata for the correct contract addresses for each space.
 
 ```ts
-// You'll need to know your space id ahead of time
+// You'll need to know your space id and have an IPFS hash ahead of time
 const spaceId = 'space-id';
+const cid = 'ipfs://hash';
 
 // This returns the correct contract address and calldata depending on the space id
-const result = await fetch(`https://geobrowser.io/api/get-edit-calldata?spaceId=${spaceId}&cid=${cid}`);
+const result = await fetch(`https://api.geobrowser.io/space/${spaceId}/edit/calldata`, {
+  method: "POST",
+  body: JSON.stringify({ cid }),
+});
 
 const { to, data } = await result.json();
 
@@ -150,14 +144,13 @@ const txResult = await walletClient.sendTransaction({
 
 ### Deploying a space
 
-You can deploy spaces programmatically using the API. Currently there are two types of governance modes for spaces: one with voting and one without. They're called PUBLIC or PERSONAL spaces respectively.
+You can deploy spaces programmatically using the API. Currently there are two types of governance modes for spaces: one with voting and one without. They're called PUBLIC or PERSONAL spaces respectively. The API only supports deploying the PERSONAL governance mode currently.
 
 ```ts
 const editorAddress = '0x000000000000000000000000000000000000';
-const spaceId = await fetch(`https://geobrowser.io/api/space/deploy?type=PERSONAL&initialEditorAddress=${editorAddress}`);
-
-
+const spaceName = 'Example-Name';
+const spaceId = await fetch("https://api.geobrowser.io/deploy", {
+  method: "POST",
+  body: JSON.stringify({ editorAddress, spaceName }),
+});
 ```
-
-
-### Smart accounts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/grc-20",
-  "version": "0.0.8",
+  "version": "0.2.0",
   "license": "MIT",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,6 +32,7 @@
     "@ethersproject/abi": "^5.6.4",
     "@ethersproject/providers": "^5.6.8",
     "@types/uuid": "^9.0.8",
+    "effect": "^3.12.11",
     "ethers": "^5.7.2",
     "position-strings": "^2.0.1",
     "uuid": "^9.0.0",