packages/core: add tests and docs for subclassed contracts, add docs for instance contracts

Author: raykyri

docs/ref/contract.md

@@ -27,12 +27,37 @@ class Chat extends Contract<typeof Chat.models> {
     })
   }
 }
+```
+
+A constructor is optional, but if provided, it should pass the topic to super(). Additionally, actions will only be generated for methods on the contract directly.
+
+```ts
+class NamespacedChat extends Contract<typeof Chat.models> {
+  createMessage(content: string) {
+    super(content)
+  }
+  constructor(namespace: string) {
+    super(namespace + ".chat.canvas.xyz")
+  }
+}
+```
 
+You can initialize a class contract by providing it to `Canvas.initialize`, or calling `initialize()` on it directly:
+
+```ts
 const app = await Canvas.initialize({
   contract: Chat,
   topic: "example.xyz"
 })
+```
+
+```ts
+const app = await NamespacedChat.initialize("mynamespace")
+```
 
+Once initialized, methods on the contract are called via `this.actions`.
+
+```ts
 app.actions.createMessage("I'm a scary and powerful fire demon!")
 ```
 

packages/core/test/contract.instance.test.ts

@@ -5,7 +5,7 @@ import { ethers } from "ethers"
 import { SIWESigner } from "@canvas-js/signer-ethereum"
 import { Canvas, ModelSchema, Contract, GetActionsType } from "@canvas-js/core"
 
-test("inline contract initializes with instance topic", async (t) => {
+test("initialize contract with instance topic", async (t) => {
 	const wallet = ethers.Wallet.createRandom()
 
 	class Blog extends Contract<typeof Blog.models> {
@@ -32,7 +32,7 @@ test("inline contract initializes with instance topic", async (t) => {
 	t.is(posts.length, 2)
 })
 
-test("string contract initializes with instance topic", async (t) => {
+test("initialize string contract with instance topic", async (t) => {
 	const wallet = ethers.Wallet.createRandom()
 
 	const contract = `import { Contract } from "@canvas-js/core/contract";
@@ -62,3 +62,78 @@ test("string contract initializes with instance topic", async (t) => {
 	const posts = await app.db.query("posts")
 	t.is(posts.length, 2)
 })
+
+test("initialize subclassed contract with instance topic", async (t) => {
+	const wallet = ethers.Wallet.createRandom()
+
+	class Blog extends Contract<typeof Blog.models> {
+		static models = { posts: { id: "primary", creator: "string", content: "string" } } satisfies ModelSchema
+		async createPostParent(content: string) {
+			await this.db.create("posts", { id: this.id, creator: this.address, content })
+		}
+	}
+
+	class NamespacedBlog extends Blog {
+		async createPostParent(content: string) {
+			super.createPostParent(content)
+		}
+		async createPostChild(content: string) {
+			await this.db.create("posts", { id: this.id, creator: this.address, content })
+		}
+		constructor(topic: string) {
+			super(topic + ".test")
+		}
+	}
+
+	const app = await NamespacedBlog.initialize("example.xyz")
+	app.updateSigners([new SIWESigner({ signer: wallet })])
+
+	t.teardown(() => app.stop())
+
+	t.is(app.topic, "example.xyz.test")
+
+	await app.actions.createPostParent("hello world")
+	await app.actions.createPostChild("second post")
+
+	const posts = await app.db.query("posts")
+	t.is(posts.length, 2)
+})
+
+test("initialize subclassed string contract with instance topic", async (t) => {
+	const wallet = ethers.Wallet.createRandom()
+
+	const contract = `import { Contract } from "@canvas-js/core/contract";
+
+	class Chat extends Contract {
+		static models = { posts: { id: "primary", creator: "string", content: "string" } }
+		async createPostParent(content) {
+			await this.db.create("posts", { id: this.id, creator: this.address, content })
+		}
+  }
+  export default class extends Chat {
+		async createPostParent(content) {
+			super.createPostParent(content)
+		}
+		async createPostChild(content) {
+			await this.db.create("posts", { id: this.id, creator: this.address, content })
+		}
+		constructor(topic) {
+			super(topic + ".test")
+		}
+	}`
+
+	const app = await Canvas.initialize({
+		topic: "example.xyz",
+		contract,
+	})
+
+	t.teardown(() => app.stop())
+
+	t.is(app.topic, "example.xyz.test")
+
+	await app.actions.createPostParent("hello world")
+	await app.actions.createPostChild("second post")
+
+	const posts = await app.db.query("posts")
+	t.is(posts.length, 2)
+})