Comment

Creating a comment will only succeed for a Sui address that has an associated Sage user.

Create a new Sage comment

In this case data, description, and title are expected to be a markdown string. This allows for formatting, creating links, and more without causing downstream security risks.

The SDK sanitizes inputs on entry, removing html tags and attributes, as well as escaping text.

import { useSignAndExecuteTransaction } from '@mysten/dapp-kit';
import { usePost } from '@sage-app/sdk/react';

interface CommentCreateInput {
  amounts: number[];           // payment amounts set to [0, 0]
  data: string;                // markdown string input
  description: string;         // markdown string input
  parentPostId: string;        // address of parent post
  self: string;                // user's wallet address
  soulId: string;              // address of user's owned soul
  title: string;               // markdown string input
}

...

const { mutateAsync: signAndExecuteTransaction } = useSignAndExecuteTransaction();
const { comment } = usePost();

...

const createComment = async (data: CommentCreateInput) => {
  const { ok, err, transaction } = comment(data);
    
  const { digest } = await signAndExecuteTransaction({
    transaction
  });
};

Error Codes

Authentication module

Code	Value	Meaning
370	ENotAuthenticated	User soul object does not exist, is the wrong type, or not owned by the wallet.

Post Fees module

Code	Value	Meaning
370	EIncorrectCoinType	Custom payment type does not match configured custom payment coin.
371	EIncorrectCustomPayment	Incorrect custom payment value.
372	EIncorrectSuiPayment	Incorrect sui payment value.

Querying for New Comment Events

The query API in the SDK sanitizes input from data, description, and title. The contract is not able to sanitizes these values for the developer performantly so that responsibility is placed here.

Developers must ensure for themselves that `data`, `description`, and `title` are safe before they are used.

import { EventId, SuiClient, getFullnodeUrl } from '@mysten/sui/client';
import { SageClient } from '@sage-app/sdk/client';

...

interface QueryInput {
  cursor?: EventId;
}
const appId = '<YOUR_APP_ID>';
const network = 'mainnet' | 'testnet';
const suiClient = new SuiClient({ url: getFullnodeUrl(network) });

const sageClient = new SageClient({ appId, network, suiClient });

...

const pollNewComments = async ({ cursor }) => {
  const {
    eventCount,
    events,
    hasNextPage,
    nextCursor
  } = await sageClient.queryCommentCreateEvents({ cursor }: QueryInput);
  
  // do something with events
  
  setTimeout(() => pollNewComments({ cursor: nextCursor }), 5000);
};

In this case events will take the shape of an array of CommentCreatedEvents:

interface CommentCreatedEvent {
  id: string;              // post object address
  app: string;             // name of app where post was created (e.g. "sage")
  createdAt: string;
  createdBy: string;       // user's wallet address
  data: string;            // sanitized markdown string
  description: string;     // sanitized markdown string
  parentPostId: string;    // unique post key (parent)
  title: string;           // sanitized markdown string
}