@pushprotocol/restapi

v1.7.15

Published

3 hours ago

This package gives access to Push Protocol (Push Nodes) APIs. Visit [Developer Docs](https://push.org/docs) or [Push.org](https://push.org) to learn more.

Downloads

8,309

0High
0Medium
0Low

pushprotocol

restapi

This package gives access to Push Protocol (Push Nodes) APIs. Visit Developer Docs or Push.org to learn more.

Index

How to use in your app?

Installation

yarn add @pushprotocol/restapi@latest

npm install @pushprotocol/restapi@latest

Note - ethers is an optional peer dependency and is required only when sdk is used with ethers signer.

Import SDK

import { PushAPI } from '@pushprotocol/restapi';

About generating the "signer" object for different platforms

When using in SERVER-SIDE code:

const ethers = require('ethers');
const PK = 'your_channel_address_secret_key';
const Pkey = `0x${PK}`;
const _signer = new ethers.Wallet(Pkey);

When using in FRONT-END code:

// any other web3 ui lib is also acceptable
import { useWeb3React } from "@web3-react/core";
.
.
.
const { account, library, chainId } = useWeb3React();
const _signer = library.getSigner(account);

About blockchain agnostic address format

In any of the below methods (unless explicitly stated otherwise) we accept either -

CAIP format: for any on chain addresses We strongly recommend using this address format. Learn more about the format and examples. (Example : eip155:1:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb)
ETH address format: only for backwards compatibility. (Example: 0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb)

Chat blockchain agnostic address format

Note - For chat related apis, the address is in the format: eip155:<address> instead of eip155:<chainId>:<address>, we call this format Partial CAIP (Example : eip155:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb)

SDK Features

Manage User

APIs to Initialise User and User APIs.

Initialize

// Initialize PushAPI class instance
const userAlice = await PushAPI.initialize(signer, {
  env: 'staging',
});

Parameters

| Param | Type | Default | Remarks | | ------------------------ | --------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------- | | signer | SignerType | - | Ethers or Viem Signer. | | options * | PushAPIInitializeProps | - | Optional configuration properties for initializing the PushAPI. | | options.env * | ENV | staging | API env - 'prod', 'staging', 'dev'. | | options.progressHook* | (progress: ProgressHookType) => void | - | A callback function to receive progress updates during initialization. | | options.account * | string | - | The account to associate with the PushAPI. If not provided, it is derived from signer. | | options.version * | string | ENC_TYPE_V3 | The encryption version to use for the PushAPI. | | options.versionMeta * | { NFTPGP_V1 ?: { password: string } } | - | Metadata related to the encryption version, including a password if needed, and reset for resetting nft profile | | options.autoUpgrade * | boolean | true | If true, upgrades encryption keys to the latest encryption version. | | options.origin * | string | - | Specify origin or source while creating a Push Profile. |

* - Optional

Reinitialize

// Reinitialize PushAPI for fresh start of NFT Account
// Reinitialize only succeeds if the signer account is the owner of the NFT
await userAlice.reinitialize({
  versionMeta: { NFTPGP_V1: { password: 'NewPassword' } },
});

Parameters

| Param | Type | Default | Remarks | | --------------------- | ----------------------------------- | ------- | --------------------------------------------------------------------------- | | options | PushAPIInitializeProps | - | Optional configuration properties for initializing the PushAPI. | | options.versionMeta | { NFTPGP_V1 ?: password: string } | - | Metadata related to the encryption version, including a password if needed. |

Fetch User Info

// userAlice.info({options?})
const response = await userAlice.info();

Parameters: | Param | Type | Default | Remarks| | ---------- | ---------- | ------------- | ---------------------- | | options | InfoOptions | - | Optional configuration properties | | - | options.overrideAccount | - | The account for which info is retrieved, can override to get info of other accounts not owned by the user. If not provided, it is derived from signer. |

Fetch Profile Info

// userAlice.profile.info({options?})
const response = await userAlice.profile.info();

Parameters: | Param | Type | Default | Remarks| | ---------- | --------- | ------------- | ---------------------- | | options | InfoOptions | - | Optional configuration properties | | - | options.overrideAccount | - | The account for which info is retrieved, can override to get info of other accounts not owned by the user. If not provided, it is derived from signer. |

Update Profile Info

// Update Push Profile
// userAlice.profile.update({options?})
const response = await userAlice.profile.update({
  name: 'Alice',
  description: 'Alice is a software developer',
  picture: imageInBase64Format, // base64 encoded image
});

| Param | Type | Default | Remarks | | ------------------------ | -------- | ------- | ------------------------------------------ | | options | object | - | Configuration options for updating profile | | options.name * | string | - | Profile Name | | options.description * | string | - | Profile Description | | options.picture * | string | - | Profile Picture |

* - Optional

Fetch Encryption Info

// Fetch Encryption Info
const aliceEncryptionInfo = await userAlice.encryption.info();

Update Encryption

// userAlice.encryption.update(ENCRYPTION_TYPE, {options?})
// Wallet User Update,
// Usually not required as it's handled internally by the SDK to automatically update to recommended encryption type
const walletAlice = await userAlice.encryption.update(
  CONSTANTS.USER.ENCRYPTION_TYPE.PGP_V3
);

// NFT User Update
// Should be done when the NFT is transferred to a different user
// so messages and connections can be migrated to the new user
const nftAlice = await userAlice.encryption.update(
  CONSTANTS.USER.ENCRYPTION_TYPE.NFTPGP_V1,
  {
    versionMeta: {
      NFTPGP_V1: {
        password: 'new_password',
      },
    },
  }
);

| Param | Type | Default | Remarks | | ----------------------- | --------------------------------------- | ------- | ---------------------------------------------- | | options * | object | - | Optional Configuration for updating encryption | | options.versionMeta* | { NFTPGP_V1 ?: { password : string} } | - | New Password ( In case of NFT Profile ) |

* - Optional

For Push Notifications

Initializing User is the first step before proceeding to sending/interacting with Notification APIs. Please refer Initialize User Section

Fetch Inbox Or Spam notifications

// lists feeds
const aliceInfo = await userAlice.notification.list('INBOX');

Parameters:

| Parameter | Type | Default | Description | | -------------------- | ----------------- | ------- | ----------------------------------------------------------------------- | | spam | INBOX or SPAM | INBOX | A string representing the type of feed to retrieve. | | options* | object | - | An object containing additional options for filtering and pagination. | | options.account* | string | - | Account in full CAIP | | options.channels* | string[] | - | An array of channels to filter feeds by. | | options.page* | number | - | A number representing the page of results to retrieve. | | options.limit* | number | - | A number representing the maximum number of feeds to retrieve per page. | | options.raw* | boolean | - | A boolean indicating whether to retrieve raw feed data. |

* - Optional

Fetch user subscriptions

// fetches list of channels to which the user is subscribed
const subscriptions = await userAlice.notification.subscriptions();

Parameters:

| Parameter | Type | Default | Description | | ------------------- | -------- | ------- | -------------------------------------------------------------------- | | options* | object | - | An object containing additional options for subscriptions. | | options.account* | string | - | Account in supported address format. | | options.page* | number | - | page of results to retrieve. | | options.limit* | number | - | represents the maximum number of subscriptions to retrieve per page. |

* - Optional

Subscribe to a channel

// subscribes to a channel
const subscribeStatus = await userAlice.notification.subscribe(channelInCAIP, {
  settings,
});

Parameters:

| Parameter | Type | Default | Description | | ------------ | ------------ | ------- | -------------------------------------------- | | channel | string | - | Channel/Alias address in CAIP format | | settings* | objects[] | - | Contain array of individual setting object |

Individual setting object:

| Param | Type | Subtype | Default | Remarks | | --------- | --------- | --------- | ------- | ------------------------------------------- | | setting | object | - | - | Individual setting object | | - | enabled | boolean | true | Indicates if setting is enabled or disabled | | - | value | string | - | The value set by the user |

* - Optional

Unsubscribe to a channel

// unsubscribes to the channel
const unsubscribeResponse = await userAlice.notification.unsubscribe(
  channelAddressInCAIP
);

Parameters:

| Parameter | Type | Default | Description | | --------- | -------- | ------- | ------------------------------------ | | channel | string | - | Channel/Alias address in CAIP format |

* - Optional

Channel information

// fetches information about the channel
const channelInfo = await userAlice.channel.info(channelAddressInCAIP);

Parameters:

| Parameter | Type | Default | Description | | ----------- | -------- | ------- | ------------------------------ | | channel* | string | - | Channel address in CAIP format |

* - Optional

Search Channels

// returns channel matching the query
const searchResult = await userAlice.channel.search('push');

Parameters:

| Parameter | Type | Default | Description | | --------------- | -------------------- | ------- | ------------------------------------------------------------------------- | | query | string | - | The search query to find channels. | | options* | ChannelSearchOptions | - | Configuration options for the search. | | options.page* | number | - | The page of results to retrieve. Default is set to 1 | | options.limit* | number | - | The maximum number of channels to retrieve per page. Default is set to 10 |

* - Optional

Get Subscribers Of A Channel

// userAlice.channel.subscribers({options?})
const channelSubscribers = await userAlice.channel.subscribers();

Parameters:

| Param | Type | Subtype | Default | Remarks | | --------- | ------------------ | --------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | options | object | - | - | Configuration options for retrieving subscribers. | | - | options.channel | string | Derived from signer | Channel address in chain specific wallet format. If no channel address is passed, then signer is used to derive the channel | | - | options.page | number | - | A number representing the page of results to retrieve. | | - | options.limit | number | - | Represents the maximum number of subscriptions to retrieve per page | | - | options.setting | boolean | false | A boolean flag if when set to true, fetches user settings along with the subscriber | | - | options.category | number | - | Filters out subscribers that have enabled a specific category of notification settings |

* - Optional

Send a notification

// sends a notification
// userAlice.channel.send([recipients], {options?})
const sendNotifRes = await userAlice.channel.send(['*'], {
  notification: { title: 'test', body: 'test' },
});

Parameters:

| Param | ---------------------------------- | recipients | options | options.notification | options.notification.title | options.notification.body | options.payload* | options.payload.title* | options.payload.body* | options.payload.cta* | options.payload.embed* | options.payload.category* | options.payload.meta* | options.config* | options.config.expiry* | options.config.silent* | options.config.hidden* | options.advanced* | options.advanced.graph* | options.advanced.ipfs* | options.advanced.minimal* | options.advanced.chatid* | options.advanced.pgpPrivateKey* | options.channel* | Type | Remarks | | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | string[] | An array of recipient addresses passed in any supported wallet address format. Possible values are: Broadcast -> [*], Targeted -> [0xA], Subset -> [0xA, 0xB], see types of notifications for more info. | | NotificationOptions | Configuration options for sending notifications. | | INotification | An object containing the notification's title and body. (Mandatory) | | string | The title for the notification. If not provided, it is taken from notification.title. | | string | The body of the notification. If not provided, it is taken from notification.body. | | IPayload | An object containing additional payload information for the notification. | | string | The title for the notification. If not provided, it is taken from notification.title. | | string | The body of the notification. If not provided, it is taken from notification.body. | | string | Call to action for the notification. | | string | Media information like image/video links | | string | Don't pass category if you are sending a generic notification. Notification category represents index point of each individual settings. Pass this if you want to indicate what category of notification you are sending (If channel has settings enabled). For example, if a channel has 10 settings, then a notification of category 7 indicates it's a notification sent for setting 7, if user has turned setting 7 off then Push ndoes will stop notif from getting to the user. | | { domain?: string, type: string, data: string } | Metadata for the notification, including domain, type, and data. | | IConfig | An object containing configuration options for the notification. | | number | Expiry time for the notification in seconds | | boolean | Indicates whether the notification is silent. | | boolean | Indicates whether the notification is hidden. | | IAdvance | An object containing advanced options for the notification. | | { id: string, counter: number } | Advanced options related to the graph based notification. | | string | IPFS information for the notification. | | string | Minimal Payload type notification. | | string | For chat based notification. | | string | PGP private key for chat based notification. | | string | Channel address in CAIP. Mostly used when a delegator sends a notification on behalf of the channel |

* - Optional

Create a channel

// creates a channel
// userAlice.channel.create({options})
const response = await userAlice.channel.create({
  name: 'Test Channel',
  description: 'Test Description',
  icon: imageBase64Format,
  url: 'https://push.org',
});

Parameters:

| Param | Type | Default | Remarks | | ----------------------- | ------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | options | object | - | Configuration options for creating a channel | | options.name | string | - | The name of the channel | | options.description | string | - | A description of the channel | | options.icon | string (base64 encoded) | - | The channel's icon in base64 encoded string format | | options.url | string | - | The URL associated with the channel | | options.alias | string | - | alias address in in chain specific wallet format | | options.progresshook | (progress) => void | - | A callback function that's called during channel creation progress, see progress object |

* - Optional

Optional: Informs about individual progress stages during channel creation if progresshook is function is passed during channel creation API call.

| Param | Type | Default | Remarks | | ---------------- | -------- | ------- | ------------------------------------------------------ | | progress | object | - | progress object that is passed in the callback | | Progress.id | string | - | Predefined, ID associated with the progress objects | | Progress.level | string | - | Predefined, Level associated with the progress objects | | Progress.title | string | - | Predefined, title associated with the progress objects | | Progress.info | string | - | Predefined, info associated with the progress objects |

Progress object details

| Progress.id | Progress.level | Progress.title | Progress.info | | ------------------------ | -------------- | --------------------------------------------------- | ------------------------------------------------------- | | PUSH-CHANNEL-CREATE-01 | INFO | Uploading data to IPFS | The channel’s data is getting uploaded to IPFS | | PUSH-CHANNEL-CREATE-02 | INFO | Approving PUSH tokens | Gives approval to Push Core contract to spend 50 $PUSH | | PUSH-CHANNEL-CREATE-03 | INFO | Channel is getting created | Calls Push Core contract to create your channel | | PUSH-CHANNEL-CREATE-04 | SUCCESS | Channel creation is done, Welcome to Push Ecosystem | Channel creation is completed | | PUSH-CHANNEL-UPDATE-01 | INFO | Uploading new data to IPFS | The channel’s new data is getting uploaded to IPFS | | PUSH-CHANNEL-UPDATE-02 | INFO | Approving PUSH tokens | Gives approval to Push Core contract to spend 50 $PUSH | | PUSH-CHANNEL-UPDATE-03 | INFO | Channel is getting updated | Calls Push Core contract to update your channel details | | PUSH-CHANNEL-UPDATE-04 | SUCCESS | Channel is updated with new data | Channel is successfully updated | | PUSH-ERROR-02 | ERROR | Transaction failed for a function call | Transaction failed |

Update channel information

// updates channel info
// userAlice.channel.update({options?})
const updateChannelRes = await userAlice.channel.update({
  name: newChannelName,
  description: newChannelDescription,
  url: newChannelURL,
  icon: newBase64FormatImage,
  alias: newAliasAddressInCAIP,
});

Parameters:

| Parameter | Type | Default | Description | | ------------------------ | ------------------------- | ------- | -------------------------------------------------------------------- | | options | - | - | Configuration options for creating a channel. | | options\.name | string | - | New name of the channel. | | options.description | string | - | New description of the channel. | | options.icon | string (base64 encoded) | - | The channel's new icon in base64 encoded string format. | | options.url | string | - | New URL associated with the channel. | | options.alias* | string | - | New alias address in CAIP | | options.progresshook* | () => void | - | A callback function to execute when the channel updation progresses. |

* - Optional

Optional: Informs about individual progress stages during channel creation if progresshook is function is passed during channel creation API call.

Progress object details

Verify a channel

const verifyChannelRes = await userAlice.channel.verify(channel);

Parameters:

| Parameter | Type | Default | Description | | --------- | -------- | ------- | -------------------------------------- | | channel | string | - | Channel address in CAIP to be verified |

Create channel Setting

// creates channel settings
const createChannelSettingRes = userAlice.channel.setting([
  {
    type: 1, // Boolean type
    default: 1,
    description: 'Receive marketing notifications',
  },
  {
    type: 2, // Slider type
    default: 10,
    description: 'Notify when loan health breaches',
    data: { upper: 100, lower: 5, ticker: 1 },
  },
]);

Parameters:

| Property | Type | Default | Description | | --------------- | -------- | ------- | -------------------------------------------------------------------------- | | type | number | - | The type of notification setting. 1 for boolean type and 2 for slider type | | default | number | - | The default value for the setting. | | description | string | - | A description of the setting. | | data.upper* | number | - | Valid for slider type only. The upper limit for the setting. | | data.lower* | number | - | Valid for slider type only. The lower limit for the setting. | | data.ticker* | number | | Valid for slider type only. The ticker by which the slider moves. |

| * - Optional

Get delegators information

// fetch delegate information
const delegates = await userAlice.channel.delegate.get();

Parameters:

| Parameter | Type | Default | Description | | ------------------- | -------------------- | ------- | ----------------------------------------------------------- | | options* | ChannelInfoOptions | - | Configuration options for retrieving delegator information. | | options.channel* | string | - | channel address in CAIP |

* - Optional

Add delegator to a channel or alias

// adds a delegate
const addedDelegate = await userAlice.channel.delegate.add(delegate);

Parameters:

| Parameter | Type | Default | Description | | -------------------------------------------------------------- | -------- | ------- | ------------------------- | | delegate | string | - | delegator address in CAIP | | Note: Support for contract interaction via viem is coming soon | | | |

Remove delegator from a channel or alias

// removes a delegate
const removeDelegate = await userAlice.channel.delegate.remove(delegate);

Parameters:

Alias Information

// fetch alias info
const aliasInfo = userAlice.channel.alias.info({
  alias: aliasAddress,
  aliasChain: 'POLYGON',
});

Parameters:

| Param | Type | Default | Description | | -------------------- | ------------- | ------- | -------------------------------------------------------------------------------------------- | | options | object | - | Configuration options for retrieving alias information. | | options.alias | string | - | The alias address | | options.aliasChain | ALIAS_CHAIN | - | The name of the alias chain, which can be 'POLYGON' or 'BSC' or 'OPTIMISM' or 'POLYGONZKEVM' |

Stream Notifications

// userAlice.stream(listen, {options?})
// Initial setup
const stream = await userAlice.initStream([CONSTANTS.STREAM.NOTIF], {
  filter: {
    channels: ['*'], // pass in specific channels to only listen to those
    chats: ['*'], // pass in specific chat ids to only listen to those
  },
  connection: {
    retries: 3, // number of retries in case of error
  },
  raw: false, // enable true to show all data
});

// Listen for notifications events
stream.on(CONSTANTS.STREAM.NOTIF, (data: any) => {
  console.log(data);
});

// Connect stream, Important to setup up listen events first
stream.connect();

// stream supports other products as well, such as STREAM.CHAT, STREAM.CHAT_OPS
// more info can be found at push.org/docs/chat

Parameters: | Param | Type | Default | Remarks | | ----- | ---- | ------- | ------- | | listen | constant | - | can be CONSTANTS.STREAM.CHAT, CONSTANTS.STREAM.CHAT_OPS, CONSTANTS.STREAM.NOTIF, CONSTANTS.STREAM.CONNECT, CONSTANTS.STREAM.DISCONNECT | | options* | PushStreamInitializeProps | - | Optional configuration properties for initializing the stream. | | options.filter* | object | - | Option to configure to enable listening to only certain chats or notifications. | | options.filter.channels* | array of strings | ['*'] | pass list of channels over here to only listen to notifications coming from them. | | options.filter.chats* | array of strings | ['*'] | pass list of chatids over here to only listen to chats coming from them. | | options.connection* | object | - | Option to configure the connection settings of the stream | | options.connection.retries* | number | 3 | Number of automatic retries incase of error | | options.raw* | boolean | false | If enabled, will also respond with meta data useful in verifying the integrity of incoming chats or notifications among other things. |

Stream Notification Events

| Listen events | When is it triggered? | | ----------------------------- | ------------------------------------------------------ | | CONSTANTS.STREAM.NOTIF | Whenever a new notification is emitted for the wallet. | | CONSTANTS.STREAM.CONNECT | Whenever the stream establishes connection. | | CONSTANTS.STREAM.DISCONNECT | Whenever the stream gets disconnected. |

For Push Chat

Initializing User is the first step before proceeding to Chat APIs. Please refer Manage User Section

Fetch List of Chats

// List all chats
const aliceChats = await userAlice.chat.list('CHATS');
// List all chat requests
const aliceRequests = await userAlice.chat.list('REQUESTS');

| Param | Type | Default | Remarks | | ------------------ | --------------------- | ------- | -------------------------------------------------- | | type | CHATS or REQUESTS | - | Type of Chats to be listed | | options * | Object | - | Optional configuration properties for listing chat | | options.page * | number | 1 | The page number for pagination | | options.limit * | number | 10 | The maximum number of items to retrieve per page |

* - Optional

Fetch Latest Chat

// Latest Chat message with the target(bob) user
const aliceChats = await userAlice.chat.latest(bobAddress);

| Param | Type | Default | Remarks | | ----------- | -------- | ------- | ----------------------------------------------------------------------------------- | | recipient | string | - | Target DID ( For Group Chats target is chatId, for 1 To 1 chat target is Push DID ) |

Fetch Chat History

// userAlice.chat.history(recipient. {options?})
const aliceChatHistoryWithBob = await userAlice.chat.history(bobAddress);

| Param | Type | Default | Remarks | | --------------------- | ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------- | | recipient | string | - | Target DID ( For Group Chats target is chatId, for 1 To 1 chat target is Push DID ) | | options * | object | - | Optional Configuration for fetching chat history | | options.reference* | string or null | - | Refers to message refernce hash from where the previous messages are fetched. If null, messages are fetched from latest message | | options.limit * | number | 10 | No. of messages to be loaded |

* - Optional

Send Message

// Alice sends message to bob
const aliceMessagesBob = await userAlice.chat.send(bobAddress, {
  content: 'Hello Bob!',
  type: 'Text',
});

| Param | Type | Default | Remarks | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------- | | recipient | string | - | Recipient ( For Group Chats target is chatId, for 1 To 1 chat target is Push DID ) | | options | object | - | Configuration for message to be sent | | options.type * | Text or Image or Audio or Video or File or MediaEmbed or GIF or Meta or Reaction or Receipt or Intent or Reply or Composite | - | Type of message Content | | options.content | string or {type: TextorImageorAudioorVideoorFileorMediaEmbedorGIF ; content: string} [For Reply] or {type: TextorImageorAudioorVideoorFileorMediaEmbedorGIF ; content: string}[] [For Composite] | - | Message Content | | options.reference * | string | - | Message reference hash ( Only available for Reaction & Reply Messages ) | | options.info * | { affected : string[]: arbitrary?: { [key: string]: any } } | - | Message reference hash ( Only available for Meta & UserActivity Messages ) |

* - Optional

Accept Chat Request

// Accept Chat Request of Alice
const bobAcceptAliceRequest = await userBob.chat.accept(aliceAddress);

| Param | Type | Default | Remarks | | ----------- | -------- | ------- | ----------------------------------------------------------------------------------- | | recipient | string | - | Target ( For Group Chats target is chatId, for 1 To 1 chat target is Push Account ) |

Reject Chat Request

// Accept Chat Request of alice
await userBob.chat.reject(aliceAddress);

| Param | Type | Default | Remarks | | ----------- | -------- | ------- | ----------------------------------------------------------------------------------- | | recipient | string | - | Target ( For Group Chats target is chatId, for 1 To 1 chat target is Push Account ) |

Block Chat User

// Block chat user
const AliceBlocksBob = await userAlice.chat.block([bobAddress]);

| Param | Type | Default | Remarks | | ------- | ---------- | ------- | -------------------- | | users | string[] | - | Users to be blocked. |

Unblock Chat User

// Unblock chat user
const AliceUnblocksBob = await userAlice.chat.unblock([bobAddress]);

| Param | Type | Default | Remarks | | ------- | ---------- | ------- | ---------------------- | | users | string[] | - | Users to be unblocked. |

Create Group

// Create a Group
// userAlice.chat.group.create(name, {options?})
const createdGroup = await userAlice.chat.group.create(name);

| Param | Type | Default | Remarks | | ------------------------ | ---------- | ------- | ------------------------------------------ | | name | string | - | The name of the group to be created. | | options * | object | - | Optional Configuration for creating group. | | options.description * | string | - | A description of the group. | | options.image * | string | - | Image for the group. | | options.members * | string[] | [] | An array of member DID. | | options.admins * | string[] | - | An array of admin DID. | | options.private * | boolean | false | Indicates if the group is private. | | options.rules * | any[] | - | Conditions for entry to the group. |

* - Optional

Fetch Group Info

// Fetch Group Info
const fetchGroupInfo = await userAlice.chat.group.info(groupChatId);

| Param | Type | Default | Remarks | | -------- | -------- | ------- | ------------ | | chatId | string | - | Group ChatId |

Fetch Group Permissions

// Fetch Group Permissions
const fetchGroupPermissions = await userAlice.chat.group.permissions(
  groupChatId
);

| Param | Type | Default | Remarks | | -------- | -------- | ------- | ------------ | | chatId | string | - | Group ChatId |

Update Group

// Update Group Info
// userAlice.chat.group.update(chatid, {options?})
const updatedGroup = await userAlice.chat.group.update(chatid, options);

| Param | Type | Default | Remarks | | ----------------------- | ------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | chatId | string | - | Unique identifier of the group. | | options * | object | - | Optional Configuration for updating group. | | options.name * | string | - | Updated Group Name | | options.description* | string | - | Updated Description | | options.image* | string(base 64 format) | - | Updated Image | | options.private* | boolean | false | Indicates if the group is private. | | options.rules * | any[] | - | Define conditions such as token gating, nft gating, custom endpoint for joining or sending message in a group. See conditional group gating to understand rule engine and how to fine tune conditional rules of your group Rules |

* - Optional

Add To Group

// await userAlice.chat.group.add(chatid, {options?})
const addAdminToGroup = await userAlice.chat.group.add(groupChatId, {
  role: 'ADMIN', // 'ADMIN' or 'MEMBER'
  accounts: [account1, account2],
});

| Param | Type | Default | Remarks | | ------------------ | ------------------- | ------- | ----------------------------------------------- | | chatId | string | - | Unique identifier of the group. | | options | object | - | Configuration for adding participants to group. | | options.role | ADMIN or MEMBER | - | Role of added participant | | options.accounts | string[] | - | Added participant addresses |

Remove From Group

// await userAlice.chat.group.remove(chatid, {options?})
const removeAdminFromGroup = await userAlice.chat.group.remove(groupChatId, {
  role: 'ADMIN', // 'ADMIN' or 'MEMBER'
  accounts: [account1, account2],
});

Join Group

const joinGroup = await userAlice.chat.group.join(groupChatId);

| Param | Type | Default | Remarks | | -------- | -------- | ------- | ------------------------------- | | chatId | string | - | Unique identifier of the gro

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

restapi

Index

How to use in your app?

Installation

Import SDK

About generating the "signer" object for different platforms

When using in SERVER-SIDE code:

When using in FRONT-END code:

About blockchain agnostic address format

Chat blockchain agnostic address format

SDK Features

Manage User

Initialize

Reinitialize

Fetch User Info

Fetch Profile Info

Update Profile Info

Fetch Encryption Info

Update Encryption

For Push Notifications

Fetch Inbox Or Spam notifications

Fetch user subscriptions

Subscribe to a channel

Unsubscribe to a channel

Channel information

Search Channels

Get Subscribers Of A Channel

Send a notification

Create a channel

Update channel information

Verify a channel

Create channel Setting

Get delegators information

Add delegator to a channel or alias

Remove delegator from a channel or alias

Alias Information

Stream Notifications

For Push Chat

Fetch List of Chats

Fetch Latest Chat

Fetch Chat History

Send Message

Accept Chat Request

Reject Chat Request

Block Chat User

Unblock Chat User

Create Group

Fetch Group Info

Fetch Group Permissions

Update Group

Add To Group

Remove From Group

Join Group