feat: update id generation fn to "generate" (#17)

baiirun · web-flow · commit a6fa1daa7984 · 2025-02-13T12:28:25.000-08:00
* feat: update id generation from "make" to "generate"

* changeset

* fix: id test

* fix: update references to ID.make
diff --git a/.changeset/perfect-cobras-destroy.md b/.changeset/perfect-cobras-destroy.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # @graphprotocol/grc-20
 
+## 0.1.0
+
+### Minor Changes
+
+- Update ID generation fn name from make -> generate
+
+### Patch Changes
+
+- f8035bf: Add docs for deploying space and generating calldata to publish edits.
+
 ## 0.0.9
 
 ### Patch Changes
diff --git a/README.md b/README.md
@@ -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
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@graphprotocol/grc-20",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "license": "MIT",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
diff --git a/src/core/account.ts b/src/core/account.ts
@@ -5,7 +5,7 @@
  * @since 0.0.6
  */
 
-import { make as makeId } from '../id.js';
+import { generate } from '../id.js';
 import { Relation } from '../relation.js';
 import type { CreateRelationOp, SetTripleOp } from '../types.js';
 import { getChecksumAddress } from './get-checksum-address.js';
@@ -32,7 +32,7 @@ type MakeAccountReturnType = {
  * @returns ops – The ops for the Account entity: {@link MakeAccountReturnType}
  */
 export function make(address: string): MakeAccountReturnType {
-  const accountId = makeId();
+  const accountId = generate();
   const checkedAddress = getChecksumAddress(address);
 
   return {
diff --git a/src/core/base58.test.ts b/src/core/base58.test.ts
@@ -10,7 +10,7 @@ describe('base58', () => {
 
     const encoded = encodeBase58(given);
 
-    // We check the length should be 22 in the ID.make() function and
+    // We check the length should be 22 in the ID.generate() function and
     // re-run encodeBase58 if not.
     expect(encoded.length === 22 || encoded.length === 21).toBe(true);
 
diff --git a/src/core/blocks/data.ts b/src/core/blocks/data.ts
@@ -5,7 +5,7 @@
  * @since 0.0.6
  */
 
-import { make as makeId } from '../../id.js';
+import { generate } from '../../id.js';
 import { Relation } from '../../relation.js';
 import { SYSTEM_IDS } from '../../system-ids.js';
 import type { CreateRelationOp, SetTripleOp } from '../../types.js';
@@ -43,7 +43,7 @@ type DataBlockArgs = { fromId: string; sourceType: DataBlockSourceType; position
  * @returns ops – The ops for the Data Block entity: {@link Op}[]
  */
 export function make({ fromId, sourceType, position, name }: DataBlockArgs): (SetTripleOp | CreateRelationOp)[] {
-  const newBlockId = makeId();
+  const newBlockId = generate();
 
   const dataBlockType = Relation.make({
     fromId: newBlockId,
diff --git a/src/core/blocks/text.ts b/src/core/blocks/text.ts
@@ -5,7 +5,7 @@
  * @since 0.0.6
  */
 
-import { make as makeId } from '../../id.js';
+import { generate } from '../../id.js';
 import { Relation } from '../../relation.js';
 import { SYSTEM_IDS } from '../../system-ids.js';
 import type { Op } from '../../types.js';
@@ -29,7 +29,7 @@ type TextBlockArgs = { fromId: string; text: string; position?: string };
  * @returns ops – The ops for the Text Block entity: {@link Op}[]
  */
 export function make({ fromId, text, position }: TextBlockArgs): Op[] {
-  const newBlockId = makeId();
+  const newBlockId = generate();
 
   const textBlockType = Relation.make({
     fromId: newBlockId,
diff --git a/src/core/image.ts b/src/core/image.ts
@@ -5,7 +5,7 @@
  * @since 0.0.6
  */
 
-import { make as makeId } from '../id.js';
+import { generate } from '../id.js';
 import { Relation } from '../relation.js';
 import { SYSTEM_IDS } from '../system-ids.js';
 import type { CreateRelationOp, Op, SetTripleOp } from '../types.js';
@@ -29,7 +29,7 @@ type MakeImageReturnType = {
  * @returns ops – The ops for the Image entity: {@link MakeImageReturnType}
  */
 export function make(src: string): MakeImageReturnType {
-  const entityId = makeId();
+  const entityId = generate();
 
   return {
     imageId: entityId,
diff --git a/src/core/relation.ts b/src/core/relation.ts
@@ -5,7 +5,7 @@
  */
 
 import { INITIAL_RELATION_INDEX_VALUE } from '../../constants.js';
-import { make as makeId } from '../id.js';
+import { generate } from '../id.js';
 import { SYSTEM_IDS } from '../system-ids.js';
 import type { CreateRelationOp, DeleteRelationOp } from '../types.js';
 import { Position } from './position.js';
@@ -46,7 +46,7 @@ interface CreateRelationArgs {
  * @returns – {@link CreateRelationOp}
  */
 export function make(args: CreateRelationArgs): CreateRelationOp {
-  const newEntityId = args.relationId ?? makeId();
+  const newEntityId = args.relationId ?? generate();
 
   return {
     type: 'CREATE_RELATION',
diff --git a/src/id.test.ts b/src/id.test.ts
@@ -1,11 +1,11 @@
 import { expect, it } from 'vitest';
 
 import { BASE58_ALLOWED_CHARS } from './core/base58.js';
-import { make } from './id.js';
+import { generate } from './id.js';
 
 // @NOTE this would be a good candidate for DST-style tests
 it('should generate valid base58 encoded id with length of 22', () => {
-  const id = make();
+  const id = generate();
   expect(id).toBeTypeOf('string');
   expect(id.length).toBe(22);
   expect(id.split('').every(char => BASE58_ALLOWED_CHARS.includes(char))).toBe(true);
diff --git a/src/id.ts b/src/id.ts
@@ -16,13 +16,13 @@ import { encodeBase58 } from './core/base58.js';
  * ```
  * import { ID } from '@graphprotocol/grc-20'
  *
- * const id = ID.make();
+ * const id = ID.generate();
  * console.log(id) // Gw9uTVTnJdhtczyuzBkL3X
  * ```
  *
  * @returns base58 encoded v4 UUID
  */
-export function make() {
+export function generate(): string {
   const uuid = uuidv4();
   const stripped = uuid.replaceAll(/-/g, '');
   const id = encodeBase58(stripped);
@@ -36,5 +36,5 @@ export function make() {
     return id;
   }
 
-  return make();
+  return generate();
 }
diff --git a/src/proto/edit.ts b/src/proto/edit.ts
@@ -1,4 +1,4 @@
-import { make as makeId } from '../id.js';
+import { generate } from '../id.js';
 import type { Op } from '../types.js';
 import { ActionType, Edit, Entity, Op as OpBinary, OpType, Relation, Triple } from './gen/src/proto/ipfs_pb.js';
 
@@ -12,7 +12,7 @@ export function make({ name, ops, author }: MakeeEditProposalArgs): Uint8Array {
   return new Edit({
     type: ActionType.ADD_EDIT,
     version: '1.0.0',
-    id: makeId(),
+    id: generate(),
     name,
     ops: opsToBinary(ops),
     authors: [author],

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@graphprotocol/grc-20",`
`3`		`- "version": "0.0.9",`
	`3`	`+ "version": "0.1.0",`
`4`	`4`	`"license": "MIT",`
`5`	`5`	`"module": "./dist/index.js",`
`6`	`6`	`"types": "./dist/index.d.ts",`