SpaceDapp: set description when creating or updating channel (#114)

Signed-off-by: Evan Salzbrenner <[email protected]>
towns-protocol · Jun 10, 2024 · 6f29cc9 · 6f29cc9
1 parent 9ab3185
commit 6f29cc9
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 4 deletions.
diff --git a/packages/sdk/src/util.test.ts b/packages/sdk/src/util.test.ts
@@ -712,7 +712,7 @@ export async function createChannel(
 
     const channelId = makeUniqueChannelStreamId(spaceId)
     try {
-        txn = await spaceDapp.createChannel(spaceId, channelName, channelId, roleIds, signer)
+        txn = await spaceDapp.createChannel(spaceId, channelName, '', channelId, roleIds, signer)
     } catch (err) {
         error = spaceDapp.parseSpaceError(spaceId, err)
         return { channelId: undefined, error }

diff --git a/packages/stress/src/utils/stressClient.ts b/packages/stress/src/utils/stressClient.ts
@@ -156,6 +156,7 @@ export class StressClient {
         const tx = await this.spaceDapp.createChannel(
             spaceId,
             channelName,
+            '',
             channelId,
             roles.filter((role) => role.name !== 'Owner').map((role) => role.roleId),
             this.connection.baseProvider.wallet,

diff --git a/packages/web3/src/ISpaceDapp.ts b/packages/web3/src/ISpaceDapp.ts
@@ -92,6 +92,7 @@ export interface ISpaceDapp {
     createChannel: (
         spaceId: string,
         channelName: string,
+        channelDescription: string,
         channelNetworkId: string,
         roleIds: number[],
         signer: SignerType,

diff --git a/packages/web3/src/Utils.ts b/packages/web3/src/Utils.ts
@@ -80,6 +80,16 @@ export const findDynamicPricingModule = (pricingModules: PricingModuleStruct[])
 export const findFixedPricingModule = (pricingModules: PricingModuleStruct[]) =>
     pricingModules.find((module) => module.name === FIXED_PRICING)
 
+export function stringifyChannelMetadataJSON({
+    name,
+    description,
+}: {
+    name: string
+    description: string
+}): string {
+    return JSON.stringify({ name, description })
+}
+
 export function parseChannelMetadataJSON(metadataStr: string): {
     name: string
     description: string

diff --git a/packages/web3/src/v3/SpaceDapp.ts b/packages/web3/src/v3/SpaceDapp.ts
@@ -27,7 +27,7 @@ import { IRuleEntitlement, UNKNOWN_ERROR, UserEntitlementShim } from './index'
 import { PricingModules } from './PricingModules'
 import { IPrepayShim } from './IPrepayShim'
 import { dlogger, isJest } from '@river-build/dlog'
-import { EVERYONE_ADDRESS } from '../Utils'
+import { EVERYONE_ADDRESS, stringifyChannelMetadataJSON } from '../Utils'
 import { evaluateOperationsForEntitledWallet, ruleDataToOperations } from '../entitlement'
 import { RuleEntitlementShim } from './RuleEntitlementShim'
 
@@ -149,6 +149,7 @@ export class SpaceDapp implements ISpaceDapp {
     public async createChannel(
         spaceId: string,
         channelName: string,
+        channelDescription: string,
         channelNetworkId: string,
         roleIds: number[],
         signer: ethers.Signer,
@@ -162,7 +163,15 @@ export class SpaceDapp implements ISpaceDapp {
             ? channelNetworkId
             : `0x${channelNetworkId}`
         return wrapTransaction(
-            () => space.Channels.write(signer).createChannel(channelId, channelName, roleIds),
+            () =>
+                space.Channels.write(signer).createChannel(
+                    channelId,
+                    stringifyChannelMetadataJSON({
+                        name: channelName,
+                        description: channelDescription,
+                    }),
+                    roleIds,
+                ),
             txnOpts,
         )
     }
@@ -532,7 +541,10 @@ export class SpaceDapp implements ISpaceDapp {
         encodedCallData.push(
             space.Channels.interface.encodeFunctionData('updateChannel', [
                 params.channelId.startsWith('0x') ? params.channelId : `0x${params.channelId}`,
-                params.channelName,
+                stringifyChannelMetadataJSON({
+                    name: params.channelName,
+                    description: params.channelDescription,
+                }),
                 params.disabled ?? false, // default to false
             ]),
         )