feat(core): ink! message origin (#781)

Author: tien

.changeset/long-knives-send.md

@@ -0,0 +1,5 @@
+---
+"@reactive-dot/core": minor
+---
+
+Added support for specifying an `origin` (caller) when invoking a read-message on an Ink! contract.

packages/core/src/ink/query-builder.test.ts

@@ -146,6 +146,7 @@ describe("message", () => {
           "body": undefined,
           "instruction": "send-message",
           "name": "test-message",
+          "origin": undefined,
         },
       ]
     `);
@@ -162,6 +163,7 @@ describe("message", () => {
           },
           "instruction": "send-message",
           "name": "test-message",
+          "origin": undefined,
         },
       ]
     `);
@@ -182,6 +184,7 @@ describe("message", () => {
           },
           "instruction": "send-message",
           "name": "test-message",
+          "origin": undefined,
         },
       ]
     `);
@@ -212,6 +215,7 @@ describe("messages", () => {
           "instruction": "send-message",
           "multi": true,
           "name": "test-message",
+          "origin": undefined,
         },
       ]
     `);
@@ -241,6 +245,7 @@ describe("messages", () => {
           "instruction": "send-message",
           "multi": true,
           "name": "test-message",
+          "origin": undefined,
         },
       ]
     `);

packages/core/src/ink/query-builder.ts

@@ -8,7 +8,7 @@ import type {
   StringKeyOf,
 } from "../types.js";
 import type { UnwrapResult } from "./result.js";
-import type { GenericInkDescriptors } from "./types.js";
+import type { ContractAddress, GenericInkDescriptors } from "./types.js";
 
 type StorageReadInstruction = BaseInstruction<"read-storage"> & {
   path: string;
@@ -36,6 +36,7 @@ type MessageSendInstruction = BaseInstruction<"send-message"> & {
         [Str: string]: unknown;
       }
     | undefined;
+  origin: ContractAddress | undefined;
   at: Finality | undefined;
 };
 
@@ -196,18 +197,19 @@ export class InkQuery<
     > extends never
       ? [
           body: TDescriptor["__types"]["messages"][TName]["message"],
-          options?: { at?: Finality },
+          options?: { origin?: ContractAddress; at?: Finality },
         ]
       : [
           body?: TDescriptor["__types"]["messages"][TName]["message"],
-          options?: { at?: Finality },
+          options?: { origin?: ContractAddress; at?: Finality },
         ]
   ) {
     return this.#append({
       instruction: "send-message",
       // TODO: this is needed for some reason
       name: name as typeof name,
       body: bodyAndOptions[0] as any,
+      origin: bodyAndOptions[1]?.origin,
       at: bodyAndOptions[1]?.at,
     } satisfies MessageSendInstruction);
   }
@@ -221,7 +223,7 @@ export class InkQuery<
   >(
     name: TName,
     bodies: Array<TDescriptor["__types"]["messages"][TName]["message"]>,
-    options?: { at?: Finality; stream?: TStream },
+    options?: { origin?: ContractAddress; at?: Finality; stream?: TStream },
   ) {
     return this.#append({
       instruction: "send-message",
@@ -232,6 +234,7 @@ export class InkQuery<
       // TODO: this is needed for some reason
       name: name as typeof name,
       bodies,
+      origin: options?.origin,
       at: options?.at,
     } satisfies MultiMessageSendInstruction);
   }

packages/core/src/ink/query.ts

@@ -63,7 +63,7 @@ export async function queryInk<
       }
 
       const response = await api.apis.ReviveApi.call(
-        toSs58Address(address, undefined, 238),
+        toSs58Address(instruction.origin ?? address, undefined, 238),
         toH160Bytes(address),
         0n,
         undefined,

packages/core/src/query-builder.test.ts

@@ -175,6 +175,7 @@ it("should append a read-contract instruction", () => {
           "body": {},
           "instruction": "send-message",
           "name": "testMessage",
+          "origin": undefined,
         },
       ],
     }
@@ -208,6 +209,7 @@ it("should append a multi read-contract instruction using contracts", () => {
           "body": {},
           "instruction": "send-message",
           "name": "testMessage",
+          "origin": undefined,
         },
       ],
       "multi": true,