;
- };
-}
-```
-
-#### Rules Object Description
-
-The rules object consists of two main sections: `entry` and `chat`, both of which contain conditions to manage access and permissions within a chat application. These conditions may involve different criteria related to token holdings or guild membership.
-
-#### Conditions
-
-Conditions can be either an "any" or "all" logic structure. If a condition has an "any" property, it means that only one of the nested conditions needs to be met. If a condition has an "all" property, it means that all the nested conditions must be satisfied.
-
-#### Types
-
-There are two main types of conditions: `PUSH` and `GUILD`.
-
-#### PUSH Conditions
-
-PUSH conditions may relate to:
-
-- **ERC721**: Needs an address and an amount, and can only have the `owner` subcategory.
-- **ERC20**: Needs an address, an amount, and a decimals value. It can only have the `holder` subcategory.
-- **CustomEndpoint**: The `CustomEndpoint` provides a flexible way to validate a condition based on the response from a custom API endpoint. This is particularly useful when you want to incorporate data or validation logic that is external to your main application. As of now the Get API is supported and should return the 200 OK if the user is allowed to access.
-
- {
- "type": "PUSH",
- "category": "CustomEndpoint",
- "subcategory": "GET",
- "data": {
- "url": "https://api.example.com/user/{{user_address}}/validate"
- }
- }
-
-
- Explanation:
-
-- **_type_**: Represents the type of the condition, in this case "PUSH".
-- **_category_**: Specifies that this is a condition based on a custom endpoint.
-- **_subcategory_**: Represents the HTTP method for the request, in this case, a "GET" request.
-- **_data_**: Contains the properties for the condition.
-- **_url_**: The endpoint URL with a placeholder ({{user_address}}) which will be replaced with the actual user address when the condition is being evaluated.
-
-#### GUILD Conditions
-
-Sample GUILD condition schema
-
-
-{
- "type": "GUILD",
- "category": "guildRoles",
- "subcategory": ,
- "data": {
- "guildId": ,
- "guildRoleId":
- }
-}
-
-
-- **Working**:
-
-Fields:
-type:
-Always set to: "GUILD"
-category:
-Always set to: "guildRoles"
-subcategory:
-Role type classification.
-Values:
-specificRole: For a singular role.
-allRoles: Pertaining to all roles in the guild.
-anyRole: Referring to any role within the guild.
-data:
-guildId: Unique identifier of a guild.
-guildRoleId: Role ID within the guild. (Required only for the specificRole subcategory.)
-Usage:
-This structure governs user permissions within a guild. The subcategory dictates the manner of role-based operations, from checking permissions of a single role (specificRole) to broad checks across any or all roles (anyRole, allRoles).
-
-
- Expected response (create group)
-
----
-
-### **To check user access of a token gated group**
-
-```typescript
-
-// actual api
-const response = await PushAPI.chat.getGroupAccess({
- chatId:'8f7be0068a677df166c2e5b8a9030fe8a4341807150339e588853c0049df3106',
- did: '0x9e60c47edF21fa5e5Af33347680B3971F2FfD464'
- env: 'staging',
-});
-```
-
-Allowed Options (params with \_ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| chatId | string | - | group address |
-| did | string | - | user address |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (group access)
-
----
-
-### **To update group details**
-
-Note - updateGroup is an idompotent call
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get(account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7', env: 'staging');
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: _signer);
-
-// actual api
-const response = await PushAPI.chat.updateGroup({
- chatId: '870cbb20f0b116d5e461a154dc723dc1485976e97f61a673259698aa7f48371c',
- groupName: 'Push Group Chat 3',
- groupDescription: 'This is the oficial group for Push Protocol',
- members: ['0x2e60c47edF21fa5e5A333347680B3971F1FfD456','0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- groupImage: <group image link> ,
- admins: ['0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- account: '0xD993eb61B8843439A23741C0A3b5138763aE11a4',
- env: 'staging',
- pgpPrivateKey: pgpDecryptedPvtKey, //decrypted private key
-});
-```
-
-### **To update token gated group details**
-
-Note - updateGroup is an idompotent call
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get(account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7', env: 'staging');
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: _signer);
-
-// actual api
-const response = await PushAPI.chat.updateGroup({
- chatId: '870cbb20f0b116d5e461a154dc723dc1485976e97f61a673259698aa7f48371c',
- groupName: 'Push Group Chat 3',
- groupDescription: 'This is the oficial group for Push Protocol',
- members: ['0x2e60c47edF21fa5e5A333347680B3971F1FfD456','0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- groupImage: <group image link> ,
- admins: ['0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- rules: {
- 'entry': {
- 'conditions': [
- {
- 'any': [
- {
- 'type': 'PUSH',
- 'category': 'ERC20',
- 'subcategory': 'holder',
- 'data': {
- 'contract': 'eip155:5:0x2b9bE9259a4F5Ba6344c1b1c07911539642a2D33',
- 'amount': 1000,
- 'decimals': 18
- }
- },
- {
- 'type': 'GUILD',
- 'category': 'guildRoles',
- 'subcategory': 'specificRole',
- 'data': {
- 'guildId': '13468',
- 'guidlRoleId': '19924'
- }
- }
- ]
- }
- ]
- },
- 'chat': {
- 'conditions': [
- {
- 'all': [
- {
- 'type': 'PUSH',
- 'category': 'ERC20',
- 'subcategory': 'holder',
- 'data': {
- 'contract': 'eip155:5:0x2b9bE9259a4F5Ba6344c1b1c07911539642a2D33',
- 'amount': 1000,
- 'decimals': 18
- }
- },
- {
- 'type': 'GUILD',
- 'category': 'guildRoles',
- 'subcategory': 'specificRole',
- 'data': {
- 'guildId': '13468',
- 'guildRoleId': '19924'
- }
- }
- ]
- }
- ]
- }
- },
- account: '0xD993eb61B8843439A23741C0A3b5138763aE11a4',
- env: 'staging',
- pgpPrivateKey: pgpDecryptedPvtKey, //decrypted private key
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| chatId_ | string | - | chatId of the group |
-| account* | string | - | user address |
-| groupName* | string | - | group name |
-| groupDescription* | string | - | group description |
-| groupImage* | string | - | group image link |
-| members* | Array | - | wallet addresses of all members except admins and groupCreator |
-| admins* | Array | - | wallet addresses of all admins except members and groupCreator |
-| contractAddressERC20 (deprecated) | string | null | ERC20 Contract Address |
-| numberOfERC20 (deprecated) | int | 0 | Minimum number of tokens required to join the group |
-| contractAddressNFT (deprecated) | string | null | NFT Contract Address |
-| numberOfNFTTokens (deprecated) | int | 0 | Minimum number of nfts required to join the group |
-| rules | Rules | - | conditions for group and chat access (see format below) |
-| pgpPrivateKey | string | null | mandatory for users having pgp keys|
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-### **To get group details by group name**
-
-```typescript
-const response = await PushAPI.chat.getGroupByName({
- groupName: 'Push Group Chat 3',
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| groupName_ | string | - | name of the group |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (get group by name)
-
----
-
-### **To get group details by chatId**
-
-```typescript
-const response = await PushAPI.chat.getGroup({
- chatId: '190591e84108cdf12e62eecabf02ddb123ea92f1c06fb98ee9b5cf3871f46fa9',
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| chatId_ | string | - | group chat id |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (get group by chat id)
-
----
-
-### **Chat Helper Utils**
-
-#### **Decrypting messages**
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get(account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7', env: 'staging');
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: _signer);
-
-// get threadhash, this will fetch the latest conversation hash
-// you can also use older conversation hash (called link) by iterating over to fetch more historical messages
-// conversation hash are also called link inside chat messages
-const conversationHash = await PushAPI.chat.conversationHash({
- account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7',
- conversationId: 'eip155:0x0F1AAC847B5720DDf01BFa07B7a8Ee641690816d', // receiver's address or chatId of a group
- env: 'staging'
-});
-
-// chat history but with decrypt helper so everything is encrypted
-const encryptedChats = await PushAPI.chat.history({
- threadhash: conversationHash.threadHash,
- account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7',
- limit: 2,
- toDecrypt: false,
- pgpPrivateKey: pgpDecryptedPvtKey,
- env: 'staging',
-});
-
-// actual api
-const decryptedChat = await PushAPI.chat.decryptConversation({
- messages: encryptedChats, // array of message object fetched from chat.history method
- connectedUser: user, // user meta data object fetched from chat.get method
- pgpPrivateKey: pgpDecrpyptedPvtKey, //decrypted private key
- env: _env,
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| messages_ | string | - | array of message object fetched from chat.history method |
-| connectedUser\* | IUser | false | user meta data object|
-| pgpPrivateKey | string | null | mandatory for users having pgp keys|
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (decrypt conversation)
-
----
diff --git a/packages/dist/packages/restapi/packages/restapi/PushNotificationLowLevelAPI.md b/packages/dist/packages/restapi/packages/restapi/PushNotificationLowLevelAPI.md
deleted file mode 100644
index d3989b354..000000000
--- a/packages/dist/packages/restapi/packages/restapi/PushNotificationLowLevelAPI.md
+++ /dev/null
@@ -1,1490 +0,0 @@
-# PushNotificationLowLevelAPI
-
-This file documents the usage of Low Level Push Notification Functions. Visit [Developer Docs](https://docs.push.org/developers) or [Push.org](https://push.org) to learn more.
-
-# Index
-- [PushNotificationLowLevelAPI](#pushnotificationlowlevelapi)
-- [Index](#index)
- - [For Notification](#for-notification)
- - [Fetching user notifications](#fetching-user-notifications)
- - [Fetching user spam notifications](#fetching-user-spam-notifications)
- - [Fetching user subscriptions](#fetching-user-subscriptions)
- - [Fetching channel details](#fetching-channel-details)
- - [Searching for channel(s)](#searching-for-channels)
- - [Opt in to a channel](#opt-in-to-a-channel)
- - [Opt out to a channel](#opt-out-to-a-channel)
- - [Sending notification](#sending-notification)
- - [Direct payload for single recipient(target)](#direct-payload-for-single-recipienttarget)
- - [Direct payload for group of recipients(subset)](#direct-payload-for-group-of-recipientssubset)
- - [Direct payload for all recipients(broadcast)](#direct-payload-for-all-recipientsbroadcast)
- - [IPFS payload for single recipient(target)](#ipfs-payload-for-single-recipienttarget)
- - [IPFS payload for group of recipients(subset)](#ipfs-payload-for-group-of-recipientssubset)
- - [IPFS payload for all recipients(broadcast)](#ipfs-payload-for-all-recipientsbroadcast)
- - [Minimal payload for single recipient(target)](#minimal-payload-for-single-recipienttarget)
- - [Minimal payload for a group of recipient(subset)](#minimal-payload-for-a-group-of-recipientsubset)
- - [Minimal payload for all recipients(broadcast)](#minimal-payload-for-all-recipientsbroadcast)
- - [Graph payload for single recipient(target)](#graph-payload-for-single-recipienttarget)
- - [Graph payload for group of recipients(subset)](#graph-payload-for-group-of-recipientssubset)
- - [Graph payload for all recipients(broadcast)](#graph-payload-for-all-recipientsbroadcast)
- - [Notification Helper Utils](#notification-helper-utils)
- - [Parsing notifications](#parsing-notifications)
- - [Advanced Notifications (WIP)](#advanced-notifications-wip)
- - [DEPRECATED](#deprecated)
- - [Get a channel's subscriber list of addresses](#get-a-channels-subscriber-list-of-addresses)
-
-
-## For Notification
-
-### **Fetching user notifications**
-
-```typescript
-const notifications = await PushAPI.user.getFeeds({
- user: 'eip155:11155111:0xD8634C39BBFd4033c0d3289C4515275102423681', // user address in CAIP
- env: 'staging',
-});
-```
-
-
- Expected response (Fetching user notifications)
-
----
-
-### **Fetching user spam notifications**
-
-```typescript
-const spams = await PushAPI.user.getFeeds({
- user: 'eip155:11155111:0xD8634C39BBFd4033c0d3289C4515275102423681', // user address in CAIP
- spam: true,
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| user_ | string | - | user account address (CAIP) |
-| page | number | 1 | page index of the results |
-| limit | number | 10 | number of items in 1 page |
-| spam | boolean | false | if "true" it will fetch spam feeds |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-| raw | boolean | false | if "true" the method will return unformatted raw API response|
-
-
- Expected response (Fetching user spam notifications)
-
----
-
-### **Fetching user subscriptions**
-
-```typescript
-const subscriptions = await PushAPI.user.getSubscriptions({
- user: 'eip155:11155111:0xD8634C39BBFd4033c0d3289C4515275102423681', // user address in CAIP
- env: 'staging',
-});
-```
-
-where `subscriptions` is a list of channels `[{ channel: '0xaddress', ... }]` subscribed by the user.
-
-_Note: We can find out if a user is subscribed to a channel by checking if the channel address is present in the subscriptions list_
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| user_ | string | - | user address (CAIP) |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (Fetching user opted in channels / subscriptions)
-
----
-
-### **Fetching channel details**
-
-```typescript
-const channelData = await PushAPI.channels.getChannel({
- channel: 'eip155:11155111:0xD8634C39BBFd4033c0d3289C4515275102423681', // channel address in CAIP
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| channel_ | string | - | channel address (CAIP) |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (Fetching channel details)
-
----
-
-### **Searching for channel(s)**
-
-```typescript
-const channelsData = await PushAPI.channels.search({
- query: 'push', // a search query
- page: 1, // page index
- limit: 20, // no of items per page
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| query_ | string | - | search query |
-| page | number | 1 | page index of the results |
-| limit | number | 10 | number of items in 1 page |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (Searching for channel)
-
----
-
-### **Opt in to a channel**
-
-```typescript
-await PushAPI.channels.subscribe({
- signer: _signer,
- channelAddress: 'eip155:11155111:0xD8634C39BBFd4033c0d3289C4515275102423681', // channel address in CAIP
- userAddress: 'eip155:11155111:0x52f856A160733A860ae7DC98DC71061bE33A28b3', // user address in CAIP
- onSuccess: () => {
- console.log('opt in success');
- },
- onError: () => {
- console.error('opt in error');
- },
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| signer_ | - | - | Signer object |
-| channelAddress* | string | - | channel address (CAIP) |
-| userAddress* | string | - | user address (CAIP) | |
-| verifyingContractAddress | string | - | Push communicator contract address|
-| onSuccess | function | - | on success callback |
-| onError | function | - | on error callback |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (Opt in to channel)
-
----
-
-### **Opt out to a channel**
-
-```typescript
-await PushAPI.channels.unsubscribe({
- signer: _signer,
- channelAddress: 'eip155:11155111:0xD8634C39BBFd4033c0d3289C4515275102423681', // channel address in CAIP
- userAddress: 'eip155:11155111:0x52f856A160733A860ae7DC98DC71061bE33A28b3', // user address in CAIP
- onSuccess: () => {
- console.log('opt out success');
- },
- onError: () => {
- console.error('opt out error');
- },
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| signer_ | - | - | Signer object |
-| channelAddress* | string | - | channel address (CAIP) |
-| userAddress* | string | - | user address (CAIP) | |
-| verifyingContractAddress | string | - | Push communicator contract address|
-| onSuccess | function | - | on success callback |
-| onError | function | - | on error callback |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (Opt out of a channel)
-
----
-
-### **Sending notification**
-
-```typescript
-async function sendNotification(options: {
- senderType?: 0 | 1;
- signer: any;
- type: NOTIFICATION_TYPE;
- identityType: IDENTITY_TYPE;
- notification?: {
- title: string;
- body: string;
- };
- payload?: {
- sectype?: string;
- title: string;
- body: string;
- cta: string;
- img: string;
- metadata?: any;
- additionalMeta?: any;
- };
- recipients?: string | string[]; // CAIP or plain ETH
- channel: string; // CAIP or plain ETH
- expiry?: number;
- hidden?: boolean;
- graph?: {
- id: string;
- counter: number;
- };
- ipfsHash?: string;
- env?: ENV;
- chatId?: string;
- pgpPrivateKey?: string;
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| senderType_ | number | 0 | 0 for channel notification. 1 for chat notification |
-| signer* | - | - | Signer object |
-| channel* | string | - | channel address (CAIP) |
-| type* | number | - | Notification Type
- Expected response (Send Notification)
-
----
-
-### Notification Helper Utils
-
-#### **Parsing notifications**
-
-Utils method to parse raw Push Feeds API response into a pre-defined shape as below.
-
-```typescript
-// fetch some raw feeds data
-const apiResponse = await PushAPI.user.getFeeds({
- user: 'eip155:11155111:0xD8634C39BBFd4033c0d3289C4515275102423681', // user address
- raw: true,
- env: 'staging',
-});
-// parse it to get a specific shape of object.
-const parsedResults = PushAPI.utils.parseApiResponse(apiResponse);
-
-const [oneNotification] = parsedResults;
-
-// Now this object can be directly used by for e.g. "@pushprotocol/uiweb" NotificationItem component as props.
-
-const {
- cta,
- title,
- message,
- app,
- icon,
- image,
- url,
- blockchain,
- secret,
- notification,
-} = oneNotification;
-```
-
-_We get the above `keys` after the parsing of the API repsonse._
-
----
-
-### Advanced Notifications (WIP)
-
-### DEPRECATED
-
-#### **Get a channel's subscriber list of addresses**
-
-```typescript
-const subscribers = await PushAPI.channels.getSubscribers({
- channel: 'eip155:11155111:0xD8634C39BBFd4033c0d3289C4515275102423681', // channel address in CAIP
- page: 1, // Optional, defaults to 1
- limit : 10 // Optional, defaults to 10
- env: 'staging'
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| channel_ | string | - | channel address (CAIP) |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (Get channel's subscribers list)
-
----
\ No newline at end of file
diff --git a/packages/dist/packages/restapi/packages/restapi/README.md b/packages/dist/packages/restapi/packages/restapi/README.md
deleted file mode 100644
index fc79d6c2a..000000000
--- a/packages/dist/packages/restapi/packages/restapi/README.md
+++ /dev/null
@@ -1,5857 +0,0 @@
-# restapi
-
-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.
-
-# Index
-
-- [How to use in your app?](#how-to-use-in-your-app)
- - [Installation](#installation)
- - [Import SDK](#import-sdk)
- - [About generating the "signer" object for different platforms](#about-generating-the-signer-object-for-different-platforms)
- - [When using in SERVER-SIDE code:](#when-using-in-server-side-code)
- - [When using in FRONT-END code:](#when-using-in-front-end-code)
- - [About blockchain agnostic address format](#about-blockchain-agnostic-address-format)
- - [Chat blockchain agnostic address format](#chat-blockchain-agnostic-address-format)
-- [SDK Features](#sdk-features)
- - [For Push Notifications](#for-push-notifications)
- - [Initialize](#initialize)
- - [Fetch Inbox Or Spam notifications](#fetch-inbox-or-spam-notifications)
- - [Fetch user subscriptions](#fetch-user-subscriptions)
- - [Subscribe to a channel](#subscribe-to-a-channel)
- - [Unsubscribe to a channel](#unsubscribe-to-a-channel)
- - [Channel information](#channel-information)
- - [Search Channels](#search-channels)
- - [Get Subscribers Of A Channel](#get-subscribers-of-a-channel)
- - [Send a notification](#send-a-notification)
- - [Create a channel](#create-a-channel)
- - [Update channel information](#update-channel-information)
- - [Verify a channel](#verify-a-channel)
- - [Create channel Setting (WIP)](#create-channel-setting)
- - [Get delegators information](#get-delegators-information)
- - [Add delegator to a channel or alias](#add-delegator-to-a-channel-or-alias)
- - [Remove delegator from a channel or alias](#remove-delegator-from-a-channel-or-alias)
- - [Alias Information](#alias-information)
- - [Stream Notifications](#stream-notifications)
- - [For Push Chat](#for-push-chat)
- - [Initialize](#initialize)
- - [Reinitialize](#reinitialize)
- - [Fetch Info](#fetch-info)
- - [Fetch Profile Info](#fetch-profile-info)
- - [Update Profile Info](#update-profile-info)
- - [Fetch Latest Chat](#fetch-latest-chat)
- - [Fetch Chat History](#fetch-chat-history)
- - [Send Message](#send-message)
- - [Accept Chat Request](#accept-chat-request)
- - [Reject Chat Request](#reject-chat-request)
- - [Block Chat User](#block-chat-user)
- - [Unblock Chat User](#unblock-chat-user)
- - [Create Group](#create-group)
- - [Fetch Group Info](#fetch-group-info)
- - [Fetch Group Permission](#fetch-group-permissions)
- - [Update Group](#update-group)
- - [Add To Group](#add-to-group)
- - [Remove From Group](#remove-from-group)
- - [Join Group](#join-group)
- - [Leave Group](#leave-group)
- - [Reject Group Joining Request](#reject-group-joining-request)
- - [Fetch Encryption Info](#fetch-encryption-info)
- - [Update Encryption](#update-encryption)
- - [Stream Chat Events](#stream-chat-events)
- - [Stream Chat Ops Events](#stream-chat-ops-events)
- - [For Push Spaces](#for-push-spaces)
- - [To create a space](#to-create-a-space)
- - [To create a token gated space](#to-create-a-token-gated-space)
- - [To check user access of a token gated space](#to-check-user-access-of-a-token-gated-space)
- - [To update space details](#to-update-space-details)
- - [To update token gated space details](#to-update-token-gated-space-details)
- - [To get space details by spaceId](#to-get-space-details-by-spaceid)
- - [To start a space](#to-start-a-space)
- - [To stop a space](#to-stop-a-space)
- - [To approve a space request](#to-approve-a-space-request)
- - [To add listeners to space](#to-add-listeners-to-space)
- - [To remove listeners from space](#to-remove-listeners-from-space)
- - [To add speakers to space](#to-add-speakers-to-space)
- - [To remove speakers from space](#to-remove-speakers-from-space)
- - [Fetching list of user spaces](#fetching-list-of-user-spaces)
- - [Fetching list of user space requests](#fetching-list-of-user-space-requests)
- - [Fetching list of trending spaces](#fetching-list-of-trending-spaces)
- - [For Push Video](#for-push-video)
- - [Instance Variables](#instance-variables)
- - [peerInstance](#peerinstance)
- - [signer](#signer)
- - [chainId](#chainid)
- - [pgpPrivateKey](#pgpprivatekey)
- - [env](#env)
- - [data](#data)
- - [setData](#setdata)
- - [Methods](#methods)
- - [constructor](#constructor)
- - [create](#create)
- - [request](#request)
- - [acceptRequest](#acceptrequest)
- - [connect](#connect)
- - [disconnect](#disconnect)
- - [enableVideo](#enablevideo)
- - [enableAudio](#enableaudio)
- - [isInitiator](#isinitiator)
-
-# How to use in your app?
-
-## Installation
-
-```bash
-yarn add @pushprotocol/restapi@latest ethers
-```
-
-or
-
-```bash
-npm install @pushprotocol/restapi@latest ethers
-```
-
-## Import SDK
-
-```typescript
-import * as PushAPI from '@pushprotocol/restapi';
-```
-
-## **About generating the "signer" object for different platforms**
-
-### When using in SERVER-SIDE code:
-
-```typescript
-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:
-
-```typescript
-// 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](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-10.md#test-cases): for any on chain addresses **_We strongly recommend using this address format_**. [Learn more about the format and examples](https://docs.push.org/developers/concepts/web3-notifications).
- (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
-
-## For Push Notifications
-
-### **Initialize**
-
-```typescript
-// 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
-
-## STREAM Options
-
-| Option | Value |
-|-----------------------|------------------------|
-| `PROFILE` | `STREAM.PROFILE` |
-| `ENCRYPTION` | `STREAM.ENCRYPTION` |
-| `NOTIF` | `STREAM.NOTIF` |
-| `NOTIF_OPS` | `STREAM.NOTIF_OPS` |
-| `CHAT` | `STREAM.CHAT` |
-| `CHAT_OPS` | `STREAM.CHAT_OPS` |
-
-
----
-
-### **Fetch Inbox Or Spam notifications**
-
-```tsx
-// lists feeds
-const aliceInfo = await userAlice.notification.list();
-
-```
-
-**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**
-
-```tsx
-// 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 CAIP . |
-| 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**
-
-```tsx
-// subscribes to a channel
-const subscribeStatus = await userAlice.notification.subscribe(channelInCAIP)
-
-```
-
-**Parameters:**
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| channel | string | - | Channel/Alias address in CAIP format |
-| options* | SubscribeUnsubscribeOptions | - | Optional configuration |
-| options.onSuccess* | () => void | - | A callback function to execute when the subscription is successful. |
-| options.onError* | (err: Error) => void | - | A callback function to execute when an error occurs during subscription. |
-
-\* - Optional
-
----
-
-### **Unsubscribe to a channel**
-
-```tsx
-// unsubscribes to the channel
-const unsubscribeStatus = await userAlice.notification.unsubscribe(channelInCAIP)
-
-```
-
-**Parameters:**
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| channel | string | - | Channel/Alias address in CAIP format |
-| options* | SubscribeUnsubscribeOptions | - | Optional configuration |
-| options.onSuccess* | () => void | - | A callback function to execute when the unsubscription is successful. |
-| options.onError* | (err: Error) => void | - | A callback function to execute when an error occurs during unsubscription. |
-
-\* - Optional
-
----
-
-### **Channel information**
-
-```tsx
-// fetches information about the channel
-const channelInfo = await userAlice.channel.info(pushChannelInCAIP)
-
-```
-
-**Parameters:**
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| channel* | string | - | Channel address in CAIP format |
-
-\* - Optional
-
----
-
-### **Search Channels**
-
-```tsx
-// 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**
-
-```tsx
-// fetches subscribers of a channel in a paginated manner
-const subscribersResult = await userAlice.channel.subscribers({page: 1, limit: 10})
-
-```
-
-**Parameters:**
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| options* | ChannelInfoOptions | - | Configuration options for retrieving subscribers. |
-| options.channel* | string | - | Channel address in CAIP |
-| options.page* | number | - | The page number for pagination |
-| options.limit* | number | - | The maximum number of items to retrieve per page |
-\* - Optional
-
----
-
-### **Send a notification**
-
-```tsx
-// sends a notification
-const sendNotifRes = await userAlice.channel.send(['*'], {notification: {title: 'test',body: 'test',},})
-
-```
-
-**Parameters:**
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| recipients | string[] | - | An array of recipient addresses. Possible values are: Broadcast -> [*], Targeted -> [0xA], Subset -> [0xA, 0xB] |
-| options | NotificationOptions | - | Configuration options for sending notifications. |
-| options.notification | INotification | - | An object containing the notification's title and body. (Mandatory) |
-| options.payload* | IPayload | - | An object containing additional payload information for the notification. |
-| options.payload.title* | string | - | The title for the notification. If not provided, it is taken from notification.title. |
-| options.payload.body* | string | - | The body of the notification. If not provided, it is taken from notification.body. |
-| options.payload.cta* | string | - | Call to action for the notification. |
-| options.payload.embed | string | - | Media information like image/video links |
-| options.payload.meta* | { domain?: string, type: string, data: string } | - | Metadata for the notification, including domain, type, and data. |
-| options.config* | IConfig | - | An object containing configuration options for the notification. |
-| options.config.expiry* | number | - | Expiry time for the notification in seconds |
-| options.config.silent* | boolean | - | Indicates whether the notification is silent. |
-| options.config.hidden* | boolean | - | Indicates whether the notification is hidden. |
-| options.advanced* | IAdvance | - | An object containing advanced options for the notification. |
-| options.advanced.graph* | { id: string, counter: number } | - | Advanced options related to the graph based notification. |
-| options.advanced.ipfs* | string | - | IPFS information for the notification. |
-| options.advanced.minimal* | string | - | Minimal Payload type notification. |
-| options.advanced.chatid* | string | - | For chat based notification. |
-| options.advanced.pgpPrivateKey* | string | - | PGP private key for chat based notification. |
-| options.channel* | string | - | Channel address in CAIP. Mostly used when a delegator sends a notification on behalf of the channel |
-
-\* - Optional
-
----
-
-### **Create a channel**
-
-```tsx
-// creates a channel
-const createChannelRes = await userAlice.channel.create({name: channelName, description: channelDescription, url: channelURL, icon: base64FormatImage, alias?: aliasAddressInCAIP})
-
-```
-
-**Parameters:**
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| options | CreateChannelOptions | - | 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 CAIP |
-| options.progresshook* | () => void | - | (Optional) A callback function to execute when the channel creation progresses. |
-
-\* - Optional
-
-
----
-
-### **Update channel information**
-
-```tsx
-// updates channel info
-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
-
----
-
-### **Verify a channel**
-
-```tsx
-const verifyChannelRes = await userAlice.channel.verify(channelToBeVerified)
-
-```
-
-**Parameters:**
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| channelToBeVerified | string | - | Channel address in CAIP to be verified |
-
----
-
-### **Create channel Setting**
-
-```tsx
-// creates channel settings
-const createChannelSettingRes = userAlice.channel.settings([{ type: 0, default: 1, description: 'marketing' }, {type: 2, default: 10, description: 'loan liquidation threshold', data: {upper: 100, lower: 5, enabled: true, ticker: 5}}])
-
-```
-
-**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.enabled* | boolean | - | Valid for slider type only. If the settting should be enabled by default. |
-| data.ticker* | number | - | Valid for slider type only. Offset for slider values |
-
-| \* - Optional
-
----
-
-### **Get delegators information**
-
-```tsx
-// fetch delegate information
-const delegatorsInfo = 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 | | | |
-
-
- Expected response (Get Delegates)
-
----
-
-### **Add delegator to a channel or alias**
-
-```tsx
-// adds a delegate
-const addDelegatorRes = userAlice.channel.delegate.add(delegatorAddressInCAIP)
-
-```
-
-**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**
-
-```tsx
-// removes a delegate
-const removeDelegatorRes = userAlice.channel.delegate.remove(delegatorAddressInCAIP)
-
-```
-
-**Parameters:**
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| delegate | string | - | delegator address in CAIP |
-| Note: Support for contract interaction via viem is coming soon | | | |
-
-
----
-
-### **Alias Information**
-
-```tsx
-// fetch alias info
-const aliasInfo = userAlice.channel.alias.info({alias: '0xABC', aliasChain:'POLYGON'})
-
-```
-
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| options | AliasOptions | - | 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**
-
-```tsx
- // userAlice.stream(account?, {options?})
- // Initial setup
- const stream = userAlice.stream(account?, {
- // stream supports other products as well, such as STREAM.CHAT, STREAM.CHAT_OPS
- // more info can be found at push.org/docs/chat
- listen: [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?: {
- auto?: true, // should connection be automatic, else need to call stream.connect();
- retries?: 3, // number of retries in case of error
- },
- raw?: false // enable true to show all data
- })
-
- // recevive stream of notification
- userAlice.stream.on(STREAM.NOTIF, (data: any) => {
- console.log(data)
- })
-```
-
-
- Expected response (Inbox)
-
----
-
-
- Expected response (Spam)
-
----
-
-## For Push Chat
-
-### **Initialize**
-
-```typescript
-// Initialize PushAPI class instance
-const userAlice = await PushAPI.initialize(signer, {
- env: ENV.LOCAL,
- streamOptions: {
- listen: [STREAM.PROFILE, STREAM.ENCRYPTION, ...Object.values(STREAM)],
- filter: {
- channels: ['Channel1', 'Channel2'],
- chats: ['Chat1', 'Chat2']
- },
- connection: {
- auto: true,
- retries: 3
- },
- raw: true,
- enabled: true
- },
- });
-```
-
-
-
-## 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. |
-| `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. |
-| `options.streamOptions` \* | `PushStreamInitializeProps` | - | Configuration options for the stream. |
-| `options.streamOptions.listen` \* | `STREAM[]` | - | Specifies which streams to listen to. |
-| `options.streamOptions.filter` \* | `{ channels?: string[]; chats?: string[]; }` | - | Specifies which channels or chats to filter for. |
-| `options.streamOptions.connection` \* | `{ auto?: boolean; retries?: number; }` | - | Connection settings, including auto-connect and number of retries. |
-| `options.streamOptions.raw` \* | `boolean` | - | If set to `true`, will provide raw stream data. |
-| `options.streamOptions.enabled` \* | `boolean` | - | Specifies if the stream is enabled or not. |
-
-
-
-
-\* - Optional
-
-## STREAM Options
-
-| Option | Value |
-|-----------------------|------------------------|
-| `PROFILE` | `STREAM.PROFILE` |
-| `ENCRYPTION` | `STREAM.ENCRYPTION` |
-| `NOTIF` | `STREAM.NOTIF` |
-| `NOTIF_OPS` | `STREAM.NOTIF_OPS` |
-| `CHAT` | `STREAM.CHAT` |
-| `CHAT_OPS` | `STREAM.CHAT_OPS` |
-
-
----
-
-### **Reinitialize**
-
-```typescript
-// 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 Info**
-
-```typescript
-// Fetch Info
-const aliceInfo = await userAlice.info();
-```
-
-
-
- Expected response
-
----
-
-### **Fetch Profile Info**
-
-```typescript
-// Fetch Push Profile
-const aliceProfileInfo = await userAlice.profile.info();
-```
-
-
-
- Expected response
-
----
-
-### **Update Profile Info**
-
-```typescript
-// Update Push Profile
-const updatedProfile = await userAlice.profile.update({ name: updatedName });
-```
-
-| Param | Type | Default | Remarks |
-| -------------------- | -------- | ------- | ------------------------------------------ |
-| `options` | `object` | - | Configuration options for updating profile |
-| `options.name` \* | `string` | - | Profile Name |
-| `options.desc` \* | `string` | - | Profile Description |
-| `options.picture` \* | `string` | - | Profile Picture |
-
-\* - Optional
-
-
-
- Expected response
-
----
-
-### **Fetch List of Chats**
-
-```typescript
-// 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
-
-
-
- Expected response
-
----
-
-### **Fetch Latest Chat**
-
-```typescript
-// Latest Chat message with the target user
-const aliceChats = await userAlice.chat.latest(bobAddress);
-```
-
-| Param | Type | Default | Remarks |
-| -------- | -------- | ------- | ----------------------------------------------------------------------------------- |
-| `target` | `string` | - | Target DID ( For Group Chats target is chatId, for 1 To 1 chat target is Push DID ) |
-
-
-
- Expected response
-
----
-
-### **Fetch Chat History**
-
-```typescript
-// Chat History with the target user
-const aliceChatHistoryWithBob = await userAlice.chat.history(bobAddress);
-```
-
-| Param | Type | Default | Remarks |
-| ---------------------- | ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `target` | `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
-
-
-
- Expected response
-
----
-
-### **Send Message**
-
-```typescript
-// 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: `Text`or`Image`or`Audio`or`Video`or`File`or`MediaEmbed`or`GIF` ; content: string}` [For Reply] or `{type: `Text`or`Image`or`Audio`or`Video`or`File`or`MediaEmbed`or`GIF` ; 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
-
-
-
- Expected response
-
----
-
-### **Accept Chat Request**
-
-```typescript
-// Accept Chat Request
-const bobAcceptAliceRequest = await userBob.chat.accept(aliceAddress);
-```
-
-| Param | Type | Default | Remarks |
-| -------- | -------- | ------- | ----------------------------------------------------------------------------------- |
-| `target` | `string` | - | Target ( For Group Chats target is chatId, for 1 To 1 chat target is Push Account ) |
-
-
-
- Expected response
-
----
-
-### **Reject Chat Request**
-
-```typescript
-// Accept Chat Request
-await userBob.chat.reject(aliceAddress);
-```
-
-| Param | Type | Default | Remarks |
-| -------- | -------- | ------- | ----------------------------------------------------------------------------------- |
-| `target` | `string` | - | Target ( For Group Chats target is chatId, for 1 To 1 chat target is Push Account ) |
-
----
-
-### **Block Chat User**
-
-```typescript
-// Block chat user
-const AliceBlocksBob = await userAlice.chat.block([bobAddress]);
-```
-
-| Param | Type | Default | Remarks |
-| ------- | ---------- | ------- | -------------------- |
-| `users` | `string[]` | - | Users to be blocked. |
-
-
-
- Expected response
-
----
-
-### **Unblock Chat User**
-
-```typescript
-// Unblock chat user
-const AliceUnblocksBob = await userAlice.chat.unblock([bobAddress]);
-```
-
-| Param | Type | Default | Remarks |
-| ------- | ---------- | ------- | ---------------------- |
-| `users` | `string[]` | - | Users to be unblocked. |
-
-
-
- Expected response
-
----
-
-### **Create Group**
-
-```typescript
-// Create a Group
-const createdGroup = await userAlice.chat.group.create(groupName, {
- description: groupDescription,
- image: groupImage,
- members: [walletAddress1, walletAddress2, walletAddress3],
- admins: [],
- private: false,
-});
-```
-
-| 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.entry.conditions` \* | `any[]` | - | Conditions for entry to the group. |
-| `options.rules.chat.conditions` \* | `any[]` | - | Conditions for chat within the group. |
-
-\* - Optional
-
-
-
- Expected response ` | An array containing member objects. |
-| `members.wallet` | `string` | The wallet address of the member. |
-| `members.publicKey` | `string` | The member's public PGP key (if available). |
-| `members.isAdmin` | `boolean` | Indicates whether the member is an admin. |
-| `members.image` | `string` | Image associated with the member. |
-| `pendingMembers` | `Array` | An array containing pending member objects. |
-| `pendingMembers.wallet` | `string` | The wallet address of the pending member. |
-| `pendingMembers.publicKey` | `string` | The pending member's public PGP key (if available). |
-| `pendingMembers.isAdmin` | `boolean` | Indicates whether the pending member is an admin. |
-| `pendingMembers.image` | `string` | Image associated with the pending member. |
-| `contractAddressERC20` | `string` or `null` | Contract address for ERC20 tokens (Used for tokenGating). |
-| `numberOfERC20` | `number` | The number of ERC20 tokens associated. (Used for tokenGating). |
-| `contractAddressNFT` | `string` or `null` | Contract address for NFT tokens (Used for tokenGating) |
-| `numberOfNFTTokens` | `number` | The number of NFT tokens associated. (Used for tokenGating) |
-| `verificationProof` | `string` | Verification proof associated with group data. |
-| `groupImage` | `string` | Group's image. |
-| `groupName` | `string` | The name of the group. |
-| `groupDescription` | `string` | Description of the group. |
-| `isPublic` | `boolean` | Indicates whether the group is public or private. |
-| `groupCreator` | `string` | Push Profile DID of the group creator. |
-| `chatId` | `string` | Unique chat ID associated with the group. |
-| `meta` | `object` or `null` | Additional metadata (if available). |
-| `scheduleAt` | `timestamp` or `null` | Scheduled start time (if available). |
-| `scheduleEnd` | `timestamp` or `null` | Scheduled end time (if available). |
-| `groupType` | `string` | Type of the group (default, spaces, live etc). |
-| `status` | `string` or `null` | Status information ( active, expired etc) |
-| `rules` | `Object` | Group-specific moderation rules |
-| `eventType` | `string` | The type of event (create, update etc) |
-
-
-
----
-
-### **Fetch Group Info**
-
-```typescript
-// Fetch Group Info
-const fetchGroupInfo = await userAlice.chat.group.info(groupChatId);
-```
-
-| Param | Type | Default | Remarks |
-| -------- | -------- | ------- | ------------ |
-| `chatId` | `string` | - | Group ChatId |
-
----
-
-### **Fetch Group Permissions**
-
-```typescript
-// Fetch Group Permissions
-const fetchGroupPermissions = await userAlice.chat.group.permissions(
- groupChatId
-);
-```
-
-| Param | Type | Default | Remarks |
-| -------- | -------- | ------- | ------------ |
-| `chatId` | `string` | - | Group ChatId |
-
-
-
- Expected response
-
----
-
-### **Update Group**
-
-```typescript
-// Update Group Info
-const createdGroup = await userAlice.chat.group.create(groupChatId, {
- description: newGroupDescription,
- image: newGroupImage,
-});
-```
-
-| 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` | - | Updated Image |
-| `options.scheduleAt` \* | `date` or `null` | - | Updated Start Schedule |
-| `options.scheduleEnd` \* | `date` or `null` | - | Updated End Schedule |
-| `options.status` \* | `string` or `null` | - | Updated group Status |
-| `options.meta` \* | `object` or `null` | - | Updated Group Meta |
-| `options.rules` \* | `object` | - | Updated Group Moderation Rules |
-
-\* - Optional
-
-
-
- Expected response ` | An array containing member objects. |
-| `members.wallet` | `string` | The wallet address of the member. |
-| `members.publicKey` | `string` | The member's public PGP key (if available). |
-| `members.isAdmin` | `boolean` | Indicates whether the member is an admin. |
-| `members.image` | `string` | Image associated with the member. |
-| `pendingMembers` | `Array` | An array containing pending member objects. |
-| `pendingMembers.wallet` | `string` | The wallet address of the pending member. |
-| `pendingMembers.publicKey` | `string` | The pending member's public PGP key (if available). |
-| `pendingMembers.isAdmin` | `boolean` | Indicates whether the pending member is an admin. |
-| `pendingMembers.image` | `string` | Image associated with the pending member. |
-| `contractAddressERC20` | `string` or `null` | Contract address for ERC20 tokens (Used for tokenGating). |
-| `numberOfERC20` | `number` | The number of ERC20 tokens associated. (Used for tokenGating). |
-| `contractAddressNFT` | `string` or `null` | Contract address for NFT tokens (Used for tokenGating) |
-| `numberOfNFTTokens` | `number` | The number of NFT tokens associated. (Used for tokenGating) |
-| `verificationProof` | `string` | Verification proof associated with group data. |
-| `groupImage` | `string` | Group's image. |
-| `groupName` | `string` | The name of the group. |
-| `groupDescription` | `string` | Description of the group. |
-| `isPublic` | `boolean` | Indicates whether the group is public or private. |
-| `groupCreator` | `string` | Push Profile DID of the group creator. |
-| `chatId` | `string` | Unique chat ID associated with the group. |
-| `meta` | `object` or `null` | Additional metadata (if available). |
-| `scheduleAt` | `timestamp` or `null` | Scheduled start time (if available). |
-| `scheduleEnd` | `timestamp` or `null` | Scheduled end time (if available). |
-| `groupType` | `string` | Type of the group (default, spaces, live etc). |
-| `status` | `string` or `null` | Status information ( active, expired etc) |
-| `rules` | `Object` | Group-specific moderation rules |
-| `eventType` | `string` | The type of event (create, update etc) |
-
-
-
----
-
-### **Add To Group**
-
-```typescript
-// Add Member To Group
-const addMemberToGroup = await userAlice.chat.group.add(groupChatId, {
- role : 'MEMBER'
- accounts: [account1, account2]
-});
-
-// Add Admin To Group
-const addAdminToGroup = await userAlice.chat.group.add(groupChatId, {
- role : 'ADMIN'
- 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 |
-
-
-
- Expected response ` | An array containing member objects. |
-| `members.wallet` | `string` | The wallet address of the member. |
-| `members.publicKey` | `string` | The member's public PGP key (if available). |
-| `members.isAdmin` | `boolean` | Indicates whether the member is an admin. |
-| `members.image` | `string` | Image associated with the member. |
-| `pendingMembers` | `Array` | An array containing pending member objects. |
-| `pendingMembers.wallet` | `string` | The wallet address of the pending member. |
-| `pendingMembers.publicKey` | `string` | The pending member's public PGP key (if available). |
-| `pendingMembers.isAdmin` | `boolean` | Indicates whether the pending member is an admin. |
-| `pendingMembers.image` | `string` | Image associated with the pending member. |
-| `contractAddressERC20` | `string` or `null` | Contract address for ERC20 tokens (Used for tokenGating). |
-| `numberOfERC20` | `number` | The number of ERC20 tokens associated. (Used for tokenGating). |
-| `contractAddressNFT` | `string` or `null` | Contract address for NFT tokens (Used for tokenGating) |
-| `numberOfNFTTokens` | `number` | The number of NFT tokens associated. (Used for tokenGating) |
-| `verificationProof` | `string` | Verification proof associated with group data. |
-| `groupImage` | `string` | Group's image. |
-| `groupName` | `string` | The name of the group. |
-| `groupDescription` | `string` | Description of the group. |
-| `isPublic` | `boolean` | Indicates whether the group is public or private. |
-| `groupCreator` | `string` | Push Profile DID of the group creator. |
-| `chatId` | `string` | Unique chat ID associated with the group. |
-| `meta` | `object` or `null` | Additional metadata (if available). |
-| `scheduleAt` | `timestamp` or `null` | Scheduled start time (if available). |
-| `scheduleEnd` | `timestamp` or `null` | Scheduled end time (if available). |
-| `groupType` | `string` | Type of the group (default, spaces, live etc). |
-| `status` | `string` or `null` | Status information ( active, expired etc) |
-| `rules` | `Object` | Group-specific moderation rules |
-| `eventType` | `string` | The type of event (create, update etc) |
-
-
-
----
-
-### **Remove From Group**
-
-```typescript
-// Remove Members To Group
-const addMemberToGroup = await userAlice.chat.group.remove(groupChatId, {
- role : 'MEMBER'
- accounts: [account1, account2] // these accounts should be a part of group
-});
-
-// Remove Admin To Group
-const addAdminToGroup = await userAlice.chat.group.remove(groupChatId, {
- role : 'ADMIN'
- accounts: [account1, account2] // // these accounts should be a part of group
-});
-```
-
-| 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 |
-
-
-
- Expected response ` | An array containing member objects. |
-| `members.wallet` | `string` | The wallet address of the member. |
-| `members.publicKey` | `string` | The member's public PGP key (if available). |
-| `members.isAdmin` | `boolean` | Indicates whether the member is an admin. |
-| `members.image` | `string` | Image associated with the member. |
-| `pendingMembers` | `Array` | An array containing pending member objects. |
-| `pendingMembers.wallet` | `string` | The wallet address of the pending member. |
-| `pendingMembers.publicKey` | `string` | The pending member's public PGP key (if available). |
-| `pendingMembers.isAdmin` | `boolean` | Indicates whether the pending member is an admin. |
-| `pendingMembers.image` | `string` | Image associated with the pending member. |
-| `contractAddressERC20` | `string` or `null` | Contract address for ERC20 tokens (Used for tokenGating). |
-| `numberOfERC20` | `number` | The number of ERC20 tokens associated. (Used for tokenGating). |
-| `contractAddressNFT` | `string` or `null` | Contract address for NFT tokens (Used for tokenGating) |
-| `numberOfNFTTokens` | `number` | The number of NFT tokens associated. (Used for tokenGating) |
-| `verificationProof` | `string` | Verification proof associated with group data. |
-| `groupImage` | `string` | Group's image. |
-| `groupName` | `string` | The name of the group. |
-| `groupDescription` | `string` | Description of the group. |
-| `isPublic` | `boolean` | Indicates whether the group is public or private. |
-| `groupCreator` | `string` | Push Profile DID of the group creator. |
-| `chatId` | `string` | Unique chat ID associated with the group. |
-| `meta` | `object` or `null` | Additional metadata (if available). |
-| `scheduleAt` | `timestamp` or `null` | Scheduled start time (if available). |
-| `scheduleEnd` | `timestamp` or `null` | Scheduled end time (if available). |
-| `groupType` | `string` | Type of the group (default, spaces, live etc). |
-| `status` | `string` or `null` | Status information ( active, expired etc) |
-| `rules` | `Object` | Group-specific moderation rules |
-| `eventType` | `string` | The type of event (create, update etc) |
-
-
-
----
-
-### **Join Group**
-
-```typescript
-const joinGroup = await userAlice.chat.group.join(groupChatId);
-```
-
-| Param | Type | Default | Remarks |
-| -------- | -------- | ------- | ------------------------------- |
-| `chatId` | `string` | - | Unique identifier of the group. |
-
-
-
- Expected response ` | An array containing member objects. |
-| `members.wallet` | `string` | The wallet address of the member. |
-| `members.publicKey` | `string` | The member's public PGP key (if available). |
-| `members.isAdmin` | `boolean` | Indicates whether the member is an admin. |
-| `members.image` | `string` | Image associated with the member. |
-| `pendingMembers` | `Array` | An array containing pending member objects. |
-| `pendingMembers.wallet` | `string` | The wallet address of the pending member. |
-| `pendingMembers.publicKey` | `string` | The pending member's public PGP key (if available). |
-| `pendingMembers.isAdmin` | `boolean` | Indicates whether the pending member is an admin. |
-| `pendingMembers.image` | `string` | Image associated with the pending member. |
-| `contractAddressERC20` | `string` or `null` | Contract address for ERC20 tokens (Used for tokenGating). |
-| `numberOfERC20` | `number` | The number of ERC20 tokens associated. (Used for tokenGating). |
-| `contractAddressNFT` | `string` or `null` | Contract address for NFT tokens (Used for tokenGating) |
-| `numberOfNFTTokens` | `number` | The number of NFT tokens associated. (Used for tokenGating) |
-| `verificationProof` | `string` | Verification proof associated with group data. |
-| `groupImage` | `string` | Group's image. |
-| `groupName` | `string` | The name of the group. |
-| `groupDescription` | `string` | Description of the group. |
-| `isPublic` | `boolean` | Indicates whether the group is public or private. |
-| `groupCreator` | `string` | Push Profile DID of the group creator. |
-| `chatId` | `string` | Unique chat ID associated with the group. |
-| `meta` | `object` or `null` | Additional metadata (if available). |
-| `scheduleAt` | `timestamp` or `null` | Scheduled start time (if available). |
-| `scheduleEnd` | `timestamp` or `null` | Scheduled end time (if available). |
-| `groupType` | `string` | Type of the group (default, spaces, live etc). |
-| `status` | `string` or `null` | Status information ( active, expired etc) |
-| `rules` | `Object` | Group-specific moderation rules |
-| `eventType` | `string` | The type of event (create, update etc) |
-
-
-
----
-
-### **Leave Group**
-
-```typescript
-// Leave Group
-const leaveGrp = await userAlice.chat.group.leave(groupChatId);
-```
-
-| Param | Type | Default | Remarks |
-| -------- | -------- | ------- | ------------------------------- |
-| `chatId` | `string` | - | Unique identifier of the group. |
-
-
-
- Expected response ` | An array containing member objects. |
-| `members.wallet` | `string` | The wallet address of the member. |
-| `members.publicKey` | `string` | The member's public PGP key (if available). |
-| `members.isAdmin` | `boolean` | Indicates whether the member is an admin. |
-| `members.image` | `string` | Image associated with the member. |
-| `pendingMembers` | `Array` | An array containing pending member objects. |
-| `pendingMembers.wallet` | `string` | The wallet address of the pending member. |
-| `pendingMembers.publicKey` | `string` | The pending member's public PGP key (if available). |
-| `pendingMembers.isAdmin` | `boolean` | Indicates whether the pending member is an admin. |
-| `pendingMembers.image` | `string` | Image associated with the pending member. |
-| `contractAddressERC20` | `string` or `null` | Contract address for ERC20 tokens (Used for tokenGating). |
-| `numberOfERC20` | `number` | The number of ERC20 tokens associated. (Used for tokenGating). |
-| `contractAddressNFT` | `string` or `null` | Contract address for NFT tokens (Used for tokenGating) |
-| `numberOfNFTTokens` | `number` | The number of NFT tokens associated. (Used for tokenGating) |
-| `verificationProof` | `string` | Verification proof associated with group data. |
-| `groupImage` | `string` | Group's image. |
-| `groupName` | `string` | The name of the group. |
-| `groupDescription` | `string` | Description of the group. |
-| `isPublic` | `boolean` | Indicates whether the group is public or private. |
-| `groupCreator` | `string` | Push Profile DID of the group creator. |
-| `chatId` | `string` | Unique chat ID associated with the group. |
-| `meta` | `object` or `null` | Additional metadata (if available). |
-| `scheduleAt` | `timestamp` or `null` | Scheduled start time (if available). |
-| `scheduleEnd` | `timestamp` or `null` | Scheduled end time (if available). |
-| `groupType` | `string` | Type of the group (default, spaces, live etc). |
-| `status` | `string` or `null` | Status information ( active, expired etc) |
-| `rules` | `Object` | Group-specific moderation rules |
-| `eventType` | `string` | The type of event (create, update etc) |
-
-
-
----
-
-### **Reject Group Joining Request**
-
-```typescript
-// Reject Group Request
-await userAlice.chat.group.reject(groupChatId);
-```
-
-| Param | Type | Default | Remarks |
-| -------- | -------- | ------- | ------------------------------- |
-| `chatId` | `string` | - | Unique identifier of the group. |
-
----
-
-### **Fetch Encryption Info**
-
-```typescript
-// Fetch Encryption Info
-const aliceEncryptionInfo = await userAlice.encryption.info();
-```
-
-
-
- Expected response
-
----
-
-### **Update Encryption**
-
-```typescript
-// Update keys encryption
-const aliceUpdateEncryption = await userAlice.encryption.update(
- CONSTANTS.USER.ENCRYPTION_VERSION.PGP_V3
-);
-```
-
-| Param | Type | Default | Remarks |
-| ------------------------ | --------------------------------------- | ------- | ----------------------------------------------------- |
-| `updatedEncryptionType` | `ENCRYPTION_TYPE` | - | New Encryption Scheme to which keys are to be updated |
-| `options` \* | `object` | - | Optional Configuration for updating encryption |
-| `options.versionMeta` \* | `{ NFTPGP_V1 ?: { password : string} }` | - | New Password ( In case of NFT Profile ) |
-
-\* - Optional
-
-
-
- Expected response
-
----
-
-### **Stream Chat Events**
-
-```tsx
- // recevive stream related to chat
- userAlice.stream.on(STREAM.CHAT, (data: any) => {
- console.log(data)
- })
-```
-
-
- Expected response (Chat Request Stream)
-
-
----
-
-
- Expected response (Chat Request Stream)
-
----
-
- Expected response (Chat Message Stream)
-
----
-
-
- Expected response (Chat Rejection Stream)
-
----
-
-
- Expected response (Group Chat Message)
-
-
----
-
-
- Expected response (Group Chat Request)
-
----
-
- Expected response (Group Chat Request Accepted)
-
----
-
-
- Expected response (Group Chat Request Rejected)
-
----
-
-
- Expected response (Participant is Removed from a Group)
-
----
-
-
- Expected response (Participant Joins a Group)
-
----
-
-
- Expected response (Participant Leaves a Group)
-
----
-
-### **Stream Chat Ops Events**
-
-```tsx
- // recevive stream realated to group creation and updation
- userAlice.stream.on(STREAM.CHAT_OPS, (data: any) => {
- console.log(data)
- })
-```
-
-
- Expected response (Group Created)
-
----
-
-
- Expected response (Group Updated)
-
----
-
-## For Push Spaces
-
-### **To create a space**
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get(account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7', env: 'staging');
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: _signer);
-
-// actual api
-const response = await PushAPI.space.create({
- spaceName:'wasteful_indigo_warbler',
- spaceDescription: 'boring_emerald_gamefowl',
- listeners: ['0x9e60c47edF21fa5e5Af33347680B3971F2FfD464','0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- spaceImage: <space image link> ,
- speakers: ['0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- isPublic: true,
- account: '0xD993eb61B8843439A23741C0A3b5138763aE11a4',
- env: 'staging',
- pgpPrivateKey: pgpDecryptedPvtKey, //decrypted private key
- scheduleAt: new Date("2024-07-15T14:48:00.000Z"),
- scheduleEnd: new Date("2024-07-15T15:48:00.000Z")
-});
-```
-
-### **To create a token gated space**
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get(account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7', env: 'staging');
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: _signer);
-
-// actual api
-const response = await PushAPI.space.create({
- spaceName:'wasteful_indigo_warbler',
- spaceDescription: 'boring_emerald_gamefowl',
- listeners: ['0x9e60c47edF21fa5e5Af33347680B3971F2FfD464','0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- spaceImage: <space image link> ,
- speakers: ['0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- rules: {
- 'spaceAccess': {
- 'conditions': [
- {
- 'any': [
- {
- 'type': 'PUSH',
- 'category': 'ERC20',
- 'subcategory': 'holder',
- 'data': {
- 'contract': 'eip155:5:0x2b9bE9259a4F5Ba6344c1b1c07911539642a2D33',
- 'amount': 1000,
- 'decimals': 18
- }
- },
- {
- 'type': 'GUILD',
- 'category': 'guildRoles',
- 'subcategory': 'specificRole',
- 'data': {
- 'guildId': '13468',
- 'guildRoleId': '19924'
- }
- }
- ]
- }
- ]
- }
- },
- isPublic: true,
- account: '0xD993eb61B8843439A23741C0A3b5138763aE11a4',
- env: 'staging',
- pgpPrivateKey: pgpDecryptedPvtKey, //decrypted private key
- scheduleAt: new Date("2024-07-15T14:48:00.000Z"),
- scheduleEnd: new Date("2024-07-15T15:48:00.000Z")
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| account_ | string | - | user address |
-| spaceName* | string | - | group name |
-| spaceDescription* | string | - | group description |
-| spaceImage* | string | - | group image link |
-| listeners* | Array | - | wallet addresses of all listeners except speakers and spaceCreator |
-| speakers* | Array | - | wallet addresses of all speakers except listeners and spaceCreator |
-| isPublic* | boolean | - | true for public space, false for private space |
-| scheduleAt\* | Date | - | Date time when the space is scheduled to start |
-| scheduleEnd | Date | - | Date time when the space is scheduled to end |
-| contractAddressERC20 (deprecated) | string | null | ERC20 Contract Address |
-| numberOfERC20 (deprecated) | int | 0 | Minimum number of tokens required to join the group |
-| contractAddressNFT (deprecated) | string | null | NFT Contract Address |
-| numberOfNFTTokens (deprecated) | int | 0 | Minimum number of nfts required to join the group |
-| rules | Rules | - | conditions for space access (see format below) |
-| pgpPrivateKey | string | null | mandatory for users having pgp keys|
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-## **Rules format**
-
-```typescript
-export enum ConditionType {
- PUSH = 'PUSH',
- GUILD = 'GUILD',
-}
-
-export type Data = {
- contract?: string;
- amount?: number;
- decimals?: number;
- guildId?: string;
- guildRoleId?: string;
- guildRoleAction?: 'all' | 'any';
- url?: string;
- comparison?: '>' | '<' | '>=' | '<=' | '==' | '!=';
-};
-
-export type ConditionBase = {
- type?: ConditionType;
- category?: string;
- subcategory?: string;
- data?: Data;
- access?: Boolean;
-};
-
-export type Condition = ConditionBase & {
- any?: ConditionBase[];
- all?: ConditionBase[];
-};
-
-export interface Rules {
- entry?: {
- conditions: Array;
- };
- chat?: {
- conditions: Array;
- };
-}
-```
-
-
- Expected response (create space)
-
----
-
-### **To check user access of a token gated space**
-
-```typescript
-
-// actual api
-const response = await PushAPI.space.getAccess({
- spaceId:'8f7be0068a677df166c2e5b8a9030fe8a4341807150339e588853c0049df3106',
- did: '0x9e60c47edF21fa5e5Af33347680B3971F2FfD464'
- env: 'staging',
-});
-```
-
-Allowed Options (params with \_ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId | string | - | space address |
-| did | string | - | user address |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (space access)
-
----
-
-### **To update space details**
-
-Note - updateSpace is an idompotent call
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get(account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7', env: 'staging');
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: _signer);
-
-// actual api
-const response = await PushAPI.space.update({
- spaceId: 'spaces:e0553610da88dacac70b406d1222a6881c0bde2c5129e58b526b5ae729d82116',
- spaceName: 'Push Space 3',
- spaceDescription: 'This is the oficial space for Push Protocol',
- listeners: ['0x2e60c47edF21fa5e5A333347680B3971F1FfD456','0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- spaceImage: <group image link> ,
- speakers: ['0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- scheduleAt: '2023-07-15T14:48:00.000Z',
- scheduleEnd: '2023-07-15T15:48:00.000Z',
- status: PushAPI.ChatStatus.PENDING,
- account: '0xD993eb61B8843439A23741C0A3b5138763aE11a4',
- env: 'staging',
- pgpPrivateKey: pgpDecryptedPvtKey, //decrypted private key
-});
-```
-
-### **To update token gated space details**
-
-Note - updateSpace is an idompotent call
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get(account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7', env: 'staging');
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: _signer);
-
-// actual api
-const response = await PushAPI.space.update({
- spaceId: 'spaces:e0553610da88dacac70b406d1222a6881c0bde2c5129e58b526b5ae729d82116',
- spaceName: 'Push Space 3',
- spaceDescription: 'This is the oficial space for Push Protocol',
- listeners: ['0x2e60c47edF21fa5e5A333347680B3971F1FfD456','0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- spaceImage: <group image link> ,
- speakers: ['0x3829E53A15856d1846e1b52d3Bdf5839705c29e5'],
- scheduleAt: '2023-07-15T14:48:00.000Z',
- scheduleEnd: '2023-07-15T15:48:00.000Z',
- status: PushAPI.ChatStatus.PENDING,
- rules: {
- 'entry': {
- 'conditions': [
- {
- 'any': [
- {
- 'type': 'PUSH',
- 'category': 'ERC20',
- 'subcategory': 'token_holder',
- 'data': {
- 'address': 'eip155:5:0x2b9bE9259a4F5Ba6344c1b1c07911539642a2D33',
- 'amount': 1000,
- 'decimals': 18
- }
- },
- {
- 'type': 'GUILD',
- 'category': 'guildRoles',
- 'subcategory': 'allRoles',
- 'data': {
- 'guildId': '13468'
- }
- }
- ]
- }
- ]
- },
- 'chat': {
- 'conditions': [
- {
- 'all': [
- {
- 'type': 'PUSH',
- 'category': 'ERC20',
- 'subcategory': 'token_holder',
- 'data': {
- 'address': 'eip155:5:0x2b9bE9259a4F5Ba6344c1b1c07911539642a2D33',
- 'amount': 1000,
- 'decimals': 18
- }
- },
- {
- 'type': 'GUILD',
- 'category': 'guildRoles',
- 'subcategory': 'specificRole',
- 'data': {
- 'guildId': '13468',
- 'guildRoleId': '19924'
- }
- }
- ]
- }
- ]
- }
- },
- account: '0xD993eb61B8843439A23741C0A3b5138763aE11a4',
- env: 'staging',
- pgpPrivateKey: pgpDecryptedPvtKey, //decrypted private key
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId_ | string | - | Id of the space |
-| account* | string | - | user address |
-| spaceName* | string | - | space name |
-| spaceDescription* | string | - | space description |
-| spaceImage* | string | - | space image |
-| status* | string | - | space status - 'ACTIVE', 'PENDING', 'ENDED' |
-| listeners* | Array | - | wallet addresses of all listeners except speakers and spaceCreator |
-| speakers* | Array | - | wallet addresses of all speakers except listeners and spaceCreator |
-| scheduleAt* | Date | - | Date time when the space is scheduled to start |
-| scheduleEnd | Date | - | Date time when the space is scheduled to end |
-| contractAddressERC20 (deprecated) | string | null | ERC20 Contract Address |
-| numberOfERC20 (deprecated) | int | 0 | Minimum number of tokens required to join the space |
-| contractAddressNFT (deprecated) | string | null | NFT Contract Address |
-| numberOfNFTTokens (deprecated) | int | 0 | Minimum number of nfts required to join the space |
-| rules | Rules | - | conditions for space and chat access (see format above) |
-| pgpPrivateKey | string | null | mandatory for users having pgp keys|
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (update space)
-
----
-
-### **To get space details by spaceId**
-
-```typescript
-const response = await PushAPI.space.get({
- spaceId:
- 'spaces:108f766a5053e2b985d0843e806f741da5ad754d128aff0710e526eebc127afc',
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId_ | string | - | space id |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (get space by space id)
-
----
-
-### **To start a space**
-
-```typescript
-const response = await PushAPI.space.start({
- spaceId:
- 'spaces:108f766a5053e2b985d0843e806f741da5ad754d128aff0710e526eebc127afc',
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId_ | string | - | space id |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (start space by space id)
-
----
-
-### **To stop a space**
-
-```typescript
-const response = await PushAPI.space.stop({
- spaceId:
- 'spaces:108f766a5053e2b985d0843e806f741da5ad754d128aff0710e526eebc127afc',
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId_ | string | - | space id |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (stop space by space id)
-
----
-
-### **To approve a space request**
-
-```typescript
-const response = await PushAPI.space.approve({
- status: 'Approved',
- account: '0x18C0Ab0809589c423Ac9eb42897258757b6b3d3d',
- senderAddress: '0x873a538254f8162377296326BB3eDDbA7d00F8E9', // spaceId
- env: 'staging',
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| status | 'Approved' | 'Approved' | flag for approving and rejecting space request, supports only approving for now|
-| senderAddress_ | string | - | space request sender's address or spaceId of a space |
-| signer\* | - | - | signer object |
-| pgpPrivateKey | string | null | mandatory for users having pgp keys|
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (approve space request for a spaceId)
-
----
-
-### **To add listeners to space**
-
-```typescript
-const response = await PushAPI.space.addListeners({
- spaceId,
- listeners: [
- `eip155:0x65585D8D2475194A26C0B187e6bED494E5D68d5F`,
- `eip155:0xE99F29C1b2A658a478E7766D5A2bB28322326C45`,
- ],
- signer: signer,
- pgpPrivateKey: pgpDecrpyptedPvtKey,
- env: env as ENV,
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId_ | string | - | space id |
-| listeners | Array | - | new listeners that needs to be added to the space. Don't add listeners which are already part of space |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (add Listeners to space)
-
----
-
-### **To remove listeners from space**
-
-```typescript
-const response = await PushAPI.space.removeListeners({
- spaceId,
- listeners: [
- `eip155:0xB12869BD3a0F9109222D67ba71e8b109B46908f9`,
- `eip155:0x2E3af36E1aC6EEEA2C0d59E43Be1926aBB9eE0BD`,
- ],
- signer: signer,
- pgpPrivateKey: pgpDecrpyptedPvtKey,
- env: env as ENV,
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId_ | string | - | space id |
-| listeners | Array | - | existing listeners that needs to be removed from the space. Don't add listeners which are not part of space |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (remove Listeners from space)
-
----
-
-### **To add speakers to space**
-
-```typescript
-const response = await PushAPI.space.addSpeakers({
- spaceId,
- listeners: [
- `eip155:0x65585D8D2475194A26C0B187e6bED494E5D68d5F`,
- `eip155:0xE99F29C1b2A658a478E7766D5A2bB28322326C45`,
- ],
- signer: signer,
- pgpPrivateKey: pgpDecrpyptedPvtKey,
- env: env as ENV,
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId_ | string | - | space id |
-| speakers | Array | - | new speakers that needs to be added to the space. Don't add speakers which are already part of space |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (add Speakers to space)
-
----
-
-### **To remove speakers from space**
-
-```typescript
-const response = await PushAPI.space.removeSpeakers({
- spaceId,
- speakers: [
- `eip155:0xB12869BD3a0F9109222D67ba71e8b109B46908f9`,
- `eip155:0x2E3af36E1aC6EEEA2C0d59E43Be1926aBB9eE0BD`,
- ],
- signer: signer,
- pgpPrivateKey: pgpDecrpyptedPvtKey,
- env: env as ENV,
-});
-```
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| spaceId_ | string | - | space id |
-| speakers | Array | - | existing speakers that needs to be removed from the space. Don't add speakers which are not part of space |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-
-
- Expected response (remove Speakers to space)
-
----
-
-### **Fetching list of user spaces**
-
-```typescript
-const spaces = await PushAPI.space.spaces({
- account: string;
- pgpPrivateKey?: string;
- /**
- * If true, the method will return decrypted message content in response
- */
- toDecrypt?: boolean;
- /**
- * Environment variable
- */
- env?: ENV;
-});
-```
-
-| Param | Type | Default | Remarks |
-| ------------- | ------- | ------- | ---------------------------------------------------------------------- |
-| account | string | - | user address (Partial CAIP) |
-| toDecrypt | boolean | false | if "true" the method will return decrypted message content in response |
-| pgpPrivateKey | string | null | mandatory for users having pgp keys |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev' |
-
-**Example normal user:**
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get({
- account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7',
- env: ENV.STAGING,
-})
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: signer);
-
-// actual api
-const spaces = await PushAPI.space.spaces({
- account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7',
- toDecrypt: true,
- pgpPrivateKey: pgpDecryptedPvtKey,
- env: ENV.STAGING,
-});
-```
-
-**Example NFT user:**
-
-```typescript
-// Fetch user
-const user = await PushAPI.user.get({
- account: `nft:eip155:${nftChainId}:${nftContractAddress}:${nftTokenId}`,
- env: env as ENV,
-});
-
-// Decrypt PGP Key
-const pgpDecrpyptedPvtKey = await PushAPI.chat.decryptPGPKey({
- encryptedPGPPrivateKey: user.encryptedPrivateKey,
- signer: nftSigner,
-});
-
-// Actual api
-const spaces = await PushAPI.space.spaces({
- account: `nft:eip155:${nftChainId}:${nftContractAddress}:${nftTokenId}`,
- toDecrypt: true,
- pgpPrivateKey: pgpDecrpyptedPvtKey,
- env: env as ENV,
-});
-```
-
-
- Expected response (Get spaces of a specific user)
-
----
-
-### **Fetching list of user space requests**
-
-```typescript
-const spaces = await PushAPI.space.requests({
- account: string;
- pgpPrivateKey?: string;
- /**
- * If true, the method will return decrypted message content in response
- */
- toDecrypt?: boolean;
- /**
- * Environment variable
- */
- env?: ENV;
-});
-```
-
-| Param | Type | Default | Remarks |
-| ------------- | ------- | ------- | ---------------------------------------------------------------------- |
-| account | string | - | user address (Partial CAIP) |
-| toDecrypt | boolean | false | if "true" the method will return decrypted message content in response |
-| pgpPrivateKey | string | null | mandatory for users having pgp keys |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev' |
-
-**Example normal user:**
-
-```typescript
-// pre-requisite API calls that should be made before
-// need to get user and through that encryptedPvtKey of the user
-const user = await PushAPI.user.get({
- account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7',
- env: ENV.STAGING,
-})
-
-// need to decrypt the encryptedPvtKey to pass in the api using helper function
-const pgpDecryptedPvtKey = await PushAPI.chat.decryptPGPKey(encryptedPGPPrivateKey: user.encryptedPrivateKey, signer: signer);
-
-// actual api
-const spaces = await PushAPI.space.requests({
- account: 'eip155:0xFe6C8E9e25f7bcF374412c5C81B2578aC473C0F7',
- toDecrypt: true,
- pgpPrivateKey: pgpDecryptedPvtKey,
- env: ENV.STAGING,
-});
-```
-
-**Example NFT user:**
-
-```typescript
-// Fetch user
-const user = await PushAPI.user.get({
- account: `nft:eip155:${nftChainId}:${nftContractAddress}:${nftTokenId}`,
- env: env as ENV,
-});
-
-// Decrypt PGP Key
-const pgpDecrpyptedPvtKey = await PushAPI.chat.decryptPGPKey({
- encryptedPGPPrivateKey: user.encryptedPrivateKey,
- signer: nftSigner,
-});
-
-// Actual api
-const spaces = await PushAPI.space.requests({
- account: `nft:eip155:${nftChainId}:${nftContractAddress}:${nftTokenId}`,
- toDecrypt: true,
- pgpPrivateKey: pgpDecrpyptedPvtKey,
- env: env as ENV,
-});
-```
-
-
- Expected response (Get spaces requests of a specific user)
-
----
-
-### **Fetching list of trending spaces**
-
-```typescript
-const spaces = await PushAPI.space.trending({
- env?: ENV;
-});
-```
-
-| Param | Type | Default | Remarks |
-| ----- | ------ | ------- | ---------------------------------- |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev' |
-| page | number | 1 | page index of the results |
-| limit | number | 10 | number of items in 1 page |
-
-
-
- Expected response (Get trending spaces)
-
----
-
-## For Push Video
-
-### **Instance Variables**
-
-#### **peerInstance**
-
-- Used to store the simple peer instance used for the webRTC connection.
-
-```typescript
-private peerInstance: any = null;
-```
-
----
-
-#### **signer**
-
-- Used to store the signer of a user.
-- Used in the request, acceptRequest and disconnect methods to send notifications.
-
-```typescript
- private signer: SignerType;
-```
-
----
-
-#### **chainId**
-
-The chain id of the chain on which the call is being conducted.
-
-```typescript
- private chainId: number;
-```
-
----
-
-#### **pgpPrivateKey**
-
-- Used to store the PGP private key of a user.
-- Used in the request, acceptRequest and disconnect methods to send notifications.
-
-```typescript
- private pgpPrivateKey: string;
-```
-
----
-
-#### **env**
-
-- The environment on which the call is being conducted.
-
-```typescript
-private env: ENV;
-```
-
----
-
-### **data**
-
-- Stores data related to the video call.
-
-```typescript
-export type IMediaStream = MediaStream | null;
-
-export enum VideoCallStatus {
- UNINITIALIZED,
- INITIALIZED,
- RECEIVED,
- CONNECTED,
- DISCONNECTED,
- RETRY_INITIALIZED,
- RETRY_RECEIVED,
-}
-
-export type PeerData = {
- stream: IMediaStream; // incoming media stream
- audio: boolean | null; // incoming audio status
- video: boolean | null; // incoming video status
- address: string; // incoming address
- status: VideoCallStatus; // status for the connection with incoming peer
- retryCount: number; // number of retires done
-};
-
-export type VideoCallData = {
- meta: {
- chatId: string; // unique chatId for the corresponding push w2w chat
- initiator: {
- address: string; // initiator's address
- signal: any; // initiator's signaling data for webRTC connection
- };
- broadcast?: {
- livepeerInfo: any;
- hostAddress: string;
- coHostAddress: string;
- };
- };
- local: {
- stream: IMediaStream; // local media stream
- audio: boolean | null; // local audio status
- video: boolean | null; // local video status
- address: string; // local address
- };
- incoming: PeerData[];
-};
-
-private data: VideoCallData;
-```
-
----
-
-#### **setData**
-
-- This function can be used to update the video call `data`
-
-```typescript
-setData: (fn: (data: VideoCallData) => VideoCallData) => void;
-
-// usage
-
-import { produce } from 'immer';
-
-setData((oldData) => {
- return produce(oldData, (draft) => {
- // update the draft object, example
- draft.incoming.status = VideoCallStatus.INITIALIZED;
- });
-});
-```
-
----
-
-### **Methods**
-
-#### **constructor**
-
-```typescript
-constructor({
- signer,
- chainId,
- pgpPrivateKey,
- env,
- setData,
- }: {
- signer: SignerType;
- chainId: number;
- pgpPrivateKey: string;
- env?: ENV;
- setData: (fn: (data: VideoCallData) => VideoCallData) => void;
- }) {}
-```
-
-Allowed Options (params with * are optional)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| signer | SignerType | - | signer object for a user |
-| chainId | number | - | chainId for the video call - Eth Mainnet: 1, Polygon Mainnet: 137 |
-| pgpPrivatekey | string | - | PGP private key of the user, used while sending video call notifications |
-| env* | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-| setData | `(fn: (data: VideoCallData) => VideoCallData) => void` | - | Function to update video call data |
-
----
-
-#### **create**
-
-- This method is used to create a local stream
-- Assigns the local stream obtained from the `navigator.mediaDevices.getUserMedia` to `data.local.stream` state.
-
-```typescript
-export type VideoCreateInputOptions = {
- video?: boolean;
- audio?: boolean;
- stream?: MediaStream; // for backend use
-};
-
-async create(options: VideoCreateInputOptions): Promise {}
-```
-
-Allowed Options (params with * are optional)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| video* | boolean | true | video status for the local stream |
-| audio* | boolean | true | audio status for the local stream |
-| stream* | MediaStream | null | local stream, for backend use |
-
-Note - If audio, video aren't enabled in create() then they wont be available during the call respectively.
-
----
-
-#### **request**
-
-- This method is used to request a push video call.
-- Will be triggered on the initiator's end.
-
-```typescript
-export type VideoRequestInputOptions = {
- senderAddress: string;
- recipientAddress: string | string[];
- chatId: string;
- onReceiveMessage?: (message: string) => void;
- retry?: boolean;
-};
-
-async request(options: VideoRequestInputOptions): Promise {}
-```
-
-Allowed Options (params with * are optional)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| senderAddress | string | - | Wallet address of the local user |
-| recipientAddress | string, string[] | - | Wallet addresses of users you want to call, single address for wallet to wallet call and array of addresses for group call |
-| chatId | string | - | Unique identifier for every wallet-to-wallet push chat, will be used during verification proof generation |
-| onReceiveMessage* | `(message: string) => void` | `(message: string) => {console.log('received a meesage', message);}` | Function which will be called when the sender receives a message via webRTC data channel |
-| retry* | boolean | false | If we are retrying the call, only for internal use |
-
----
-
-#### **acceptRequest**
-
-- This method is used to accept a push video call.
-- Will be triggered on the receiver's end.
-
-```typescript
-export type VideoAcceptRequestInputOptions = {
- signalData: any;
- senderAddress: string;
- recipientAddress: string;
- chatId: string;
- onReceiveMessage?: (message: string) => void;
- retry?: boolean;
-};
-
-async acceptRequest(options: VideoAcceptRequestInputOptions): Promise {}
-```
-
-Allowed Options (params with * are optional)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| signalData | any | - | Signal data received from the initiator peer via psuh notification upon call request |
-| senderAddress | string | - | Local peer address |
-| recipientAddress | string | - | Incoming/remote peer address |
-| chatId | string | - | Unique identifier for every wallet-to-wallet push chat, will be used during verification proof generation |
-| onReceiveMessage* | `(message: string) => void` | `(message: string) => {console.log('received a meesage', message);}` | Function which will be called when the sender receives a message via webRTC data channel |
-| retry* | boolean | false | If we are retrying the call, only for internal use |
-
----
-
-#### **connect**
-
-- This is the final method which is used to connect a push video call.
-- Will be triggered on the initiator's end.
-
-```typescript
-export type VideoConnectInputOptions = {
- signalData: any;
- peerAddress?: string;
-};
-
-connect(options: VideoConnectInputOptions): void {}
-```
-
-Allowed Options (params with * are optional)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| signalData | any | - | Signal data received from the receiver peer via push notification upon call acceptRequest |
-| peerAddress* | string | data.incoming[0].address | Address of the receiver peer, received via push notification upon call acceptRequest |
-
----
-
-#### **disconnect**
-
-- This method is used to end a push video call.
-- Can be triggered on the initiator as well as receivers end.
-
-```typescript
-export type VideoDisconnectOptions = {
- peerAddress: string;
-};
-
-disconnect(options?: VideoDisconnectOptions): void {}
-```
-
-Allowed Options (params with * are optional)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| peerAddress* | string | data.incoming[0].address | Address of the peer to be disconnected from |
-
----
-
-#### **enableVideo**
-
-- This method is used to enable/disable the video (from `data.local.stream`) for a push video call.
-- Can be triggered on the initiator as well as receivers end.
-- **Note -** If video was not enabled during `create()` then it will always remain off.
-
-```typescript
-export type EnableVideoInputOptions = {
- state: boolean;
-}
-
-enableVideo(options: EnableVideoInputOptions): void
-```
-
-Allowed Options (params with * are optional)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| state | boolean | - | true for enable and false for disable |
-
----
-
-#### **enableAudio**
-
-- This method is used to enable/disable the audio (from `data.local.stream`) for a push video call.
-- Can be triggered on the initiator as well as receivers end.
-- **Note -** If audio was not enabled during `create()` then it will always remain off.
-
-```typescript
-export type EnableAudioInputOptions = {
- state: boolean;
-}
-
-enableAudio(options: EnableAudioInputOptions): void
-```
-
-Allowed Options (params with * are optional)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| state | boolean | - | true for enable and false for disable |
-
----
-
-#### **isInitiator**
-
-- This method is used to tell if the current peer is the initator of the push video call or not.
-- Can be triggered on the initiator as well as receivers end.
-
-```typescript
-isInitiator(): boolean
-```
-
----
diff --git a/packages/dist/packages/socket/packages/socket/CHANGELOG.md b/packages/dist/packages/socket/packages/socket/CHANGELOG.md
deleted file mode 100644
index 98aad4563..000000000
--- a/packages/dist/packages/socket/packages/socket/CHANGELOG.md
+++ /dev/null
@@ -1,119 +0,0 @@
-# Changelog
-
-This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
-
-## [0.5.2](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.5.1...socket-0.5.2) (2023-08-03)
-
-
-### Bug Fixes
-
-* socket options ([#601](https://github.com/ethereum-push-notification-service/push-sdk/issues/601)) ([d821535](https://github.com/ethereum-push-notification-service/push-sdk/commit/d821535d3e800c8821206fc387b346c990c02b5a))
-
-
-
-## [0.5.1](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.5.0...socket-0.5.1) (2023-05-22)
-
-
-### Bug Fixes
-
-* fixed nft socket ([#413](https://github.com/ethereum-push-notification-service/push-sdk/issues/413)) ([0d8c3ab](https://github.com/ethereum-push-notification-service/push-sdk/commit/0d8c3ab628ec29903bcc051254e5c54e94a2325e))
-
-
-
-# [0.5.0](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.4.1...socket-0.5.0) (2023-04-27)
-
-
-### Bug Fixes
-
-* **component:** env type in demo react and uiweb ([#225](https://github.com/ethereum-push-notification-service/push-sdk/issues/225)) ([ff1113a](https://github.com/ethereum-push-notification-service/push-sdk/commit/ff1113adb226aee4c9f6ccdfa488e59b47ca9b9e))
-* **component:** group chat socket event ([#251](https://github.com/ethereum-push-notification-service/push-sdk/issues/251)) ([17f0892](https://github.com/ethereum-push-notification-service/push-sdk/commit/17f0892570a6f2318d515a7d6e297a71463fe490))
-
-
-### Features
-
-* add local env to socket config file ([#334](https://github.com/ethereum-push-notification-service/push-sdk/issues/334)) ([db4171e](https://github.com/ethereum-push-notification-service/push-sdk/commit/db4171e57bcba2b86f798072fc37d9f082236ad0))
-
-
-
-## [0.4.2](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.4.1...socket-0.4.2) (2023-03-22)
-
-
-### Bug Fixes
-
-* **component:** env type in demo react and uiweb ([#225](https://github.com/ethereum-push-notification-service/push-sdk/issues/225)) ([ff1113a](https://github.com/ethereum-push-notification-service/push-sdk/commit/ff1113adb226aee4c9f6ccdfa488e59b47ca9b9e))
-* **component:** group chat socket event ([#251](https://github.com/ethereum-push-notification-service/push-sdk/issues/251)) ([17f0892](https://github.com/ethereum-push-notification-service/push-sdk/commit/17f0892570a6f2318d515a7d6e297a71463fe490))
-
-
-
-## [0.4.1](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.4.0...socket-0.4.1) (2023-02-28)
-
-
-### Bug Fixes
-
-* remove mandatory api key for chat socket connection ([dd79bf7](https://github.com/ethereum-push-notification-service/push-sdk/commit/dd79bf7fc3a4a7e0913e399fff3e1325b9143e13))
-
-
-
-# [0.4.0](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.3.1...socket-0.4.0) (2023-02-28)
-
-
-### Bug Fixes
-
-* send message signature fixes ([#203](https://github.com/ethereum-push-notification-service/push-sdk/issues/203)) ([9a3c448](https://github.com/ethereum-push-notification-service/push-sdk/commit/9a3c4484f2c1ac5f7abd2796801da626caa91629))
-
-
-### Features
-
-* **component:** Added Group Chat Functionality ([#122](https://github.com/ethereum-push-notification-service/push-sdk/issues/122)) ([5bf341f](https://github.com/ethereum-push-notification-service/push-sdk/commit/5bf341f6f60a6786be47f668fa3ed1b15a66be88))
-
-
-
-# [0.4.0](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.3.1...socket-0.4.0) (2023-02-15)
-
-
-### Features
-
-* **component:** Added Group Chat Functionality ([#122](https://github.com/ethereum-push-notification-service/push-sdk/issues/122)) ([5bf341f](https://github.com/ethereum-push-notification-service/push-sdk/commit/5bf341f6f60a6786be47f668fa3ed1b15a66be88))
-
-
-
-## [0.3.1](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.3.0...socket-0.3.1) (2023-02-03)
-
-
-### Bug Fixes
-
-* Metamask reject handled ([#136](https://github.com/ethereum-push-notification-service/push-sdk/issues/136)) ([46a20b7](https://github.com/ethereum-push-notification-service/push-sdk/commit/46a20b751e655a526168c8ae7c400211f3b62b15))
-
-
-
-# [0.3.0](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.2.0...socket-0.3.0) (2023-01-27)
-
-
-### Features
-
-* inc version ([74c7e63](https://github.com/ethereum-push-notification-service/push-sdk/commit/74c7e63a3e5e5131fcd53d192a076c09c37989e9))
-
-
-
-# [0.2.1](https://github.com/ethereum-push-notification-service/push-sdk/compare/socket-0.1.0...socket-0.2.0) (2023-01-27)
-
-
-### Features
-
-* add chat wss ([aba9f17](https://github.com/ethereum-push-notification-service/push-sdk/commit/aba9f17c037fe59e44729c9b49c8eaa9e2a71630))
-* add new chat events for websocket ([429061f](https://github.com/ethereum-push-notification-service/push-sdk/commit/429061f2f906420f5fe3d854d3602277dae1021b))
-* add new types for create wss function ([d5a11ed](https://github.com/ethereum-push-notification-service/push-sdk/commit/d5a11ed9f5336f0a8197707cbe29848eb2faad54))
-* add validation for chat websocket ([9b77ff7](https://github.com/ethereum-push-notification-service/push-sdk/commit/9b77ff7102475f8b4187028c9fc5cb68c94c4985))
-
-
-
-# [0.1.0](https://github.com/ethereum-push-notification-service/sdk/compare/socket-0.0.1...socket-0.1.0) (2022-10-07)
-
-
-### Features
-
-* **socket:** make it stable ([d0db84f](https://github.com/ethereum-push-notification-service/sdk/commit/d0db84fb6f53c0e612b2fa209eae813cc6dc51c2))
-
-
-
-## 0.0.1 (2022-10-05)
diff --git a/packages/dist/packages/socket/packages/socket/README.md b/packages/dist/packages/socket/packages/socket/README.md
deleted file mode 100644
index f6e06c9b0..000000000
--- a/packages/dist/packages/socket/packages/socket/README.md
+++ /dev/null
@@ -1,229 +0,0 @@
-# Deprecation Notice
-
-**Important**: This package will be deprecated in future releases. We recommend migrating to [@pushprotocol/restapi](https://www.npmjs.com/package/@pushprotocol/restapi) for continued support and updates. Please refer to the [Stream Documentation](https://push.org/docs/chat/build/stream-chat/) for instructions on transitioning to the new package.
-
-# socket
-
-This package gives access to Push Protocol (Push Nodes) using Websockets built on top of [Socket.IO](https://socket.io/docs/v4/client-api/). Visit [Developer Docs](https://docs.push.org/developers) or [Push.org](https://push.org) to learn more.
-
-# Index
-
-- [How to use in your app?](#how-to-use-in-your-app)
- - [Installation](#installation)
- - [Import SDK](#import-sdk)
- - [About blockchain agnostic address format](#about-blockchain-agnostic-address-format)
-- [Socket SDK Features](#socket-sdk-features)
- - [Creating a socket connection object](#creating-a-socket-connection-object)
- - [For notification](#for-notification)
- - [For chat](#for-chat)
- - [Connect the socket connection object](#connect-the-socket-connection-object)
- - [Disconnect the socket connection object](#disconnect-the-socket-connection-object)
- - [Subscribing to Socket Events](#subscribing-to-socket-events)
- - [Examples](#examples)
- - [Basic example of using SDK sockets in a React App](#basic-example-of-using-sdk-sockets-in-a-react-app)
-
-# How to use in your app?
-
-## Installation
-
-```
- yarn add @pushprotocol/socket@latest ethers@^5.6
-```
-
-or
-
-```
- npm install @pushprotocol/socket@latest ethers@^5.6
-```
-
-## Import SDK
-
-```typescript
-import { createSocketConnection, EVENTS } from '@pushprotocol/socket';
-```
-
-## **About blockchain agnostic address format**
-
-In any of the below methods (unless explicitly stated otherwise) we accept either -
-
-- [CAIP format](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-10.md#test-cases): for any on chain addresses **_We strongly recommend using this address format_**. [Learn more about the format and examples](https://docs.push.org/developers/concepts/web3-notifications).
- (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`)
-
-# Socket SDK Features
-
-## **Creating a socket connection object**
-
-### **For notification**
-
-```typescript
-const pushSDKSocket = createSocketConnection({
- user: 'eip155:11155111:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb', // CAIP, see below
- env: 'staging',
- socketOptions: { autoConnect: false },
-});
-```
-
-### **For chat**
-
-```typescript
-const pushSDKSocket = createSocketConnection({
- user: 'eip155:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb',
- env: 'staging',
- socketType: 'chat',
- socketOptions: { autoConnect: true, reconnectionAttempts: 3 },
-});
-```
-
-IMPORTANT: create the connection object in your app only when you have the `user` address available since its mandatory.
-
-**`autoConnect`**: Generally if we don't pass `autoConnect: false` then the socket connection is automatic once the object is created. Now since we may or may not have the account address handy and wish to start the connection during instantiation so this option makes it easier for us to choose when we want to `connect` or not!
-
-Allowed Options (params with _ are mandatory)
-| Param | Type | Default | Remarks |
-|----------|---------|---------|--------------------------------------------|
-| user_ | string | - | user account address (CAIP) |
-| env | string | 'prod' | API env - 'prod', 'staging', 'dev'|
-| socketType | 'notification' | 'chat' | 'notification' | socket type |
-| socketOptions | object | - | supports the same as [SocketIO Options](https://socket.io/docs/v4/client-options/) |
-
-## **Connect the socket connection object**
-
-```typescript
-pushSDKSocket.connect();
-```
-
-## **Disconnect the socket connection object**
-
-```typescript
-pushSDKSocket.disconnect();
-```
-
-## **Subscribing to Socket Events**
-
-```typescript
-pushSDKSocket.on(EVENTS.CONNECT, () => {});
-
-pushSDKSocket.on(EVENTS.DISCONNECT, () => {});
-
-pushSDKSocket.on(EVENTS.USER_FEEDS, (feedItem) => {
- // feedItem is the notification data when that notification was received
-});
-
-pushSDKSocket.on(EVENT.CHAT_RECEIVED_MESSAGE, (message) => {
- // message is the message object data whenever a new message is received
-});
-
-pushSDKSocket.on(EVENT.CHAT_GROUPS, (message) => {
- // message is the message object data whenever a group is created or updated
-});
-```
-
-Supported EVENTS
-| EVENT name | When is it triggered? |
-|------------|--------------------------------------------|
-| EVENTS.CONNECT | whenever the socket is connected |
-| EVENTS.DISCONNECT | whenever the socket is disconneted |
-| EVENTS.USER_FEEDS | whenever a new notification is received by the user after the last socket connection |
-| EVENTS.USER_SPAM_FEEDS | whenever a new spam notification is received by the user after the last socket connection |
-| EVENT.CHAT_RECEIVED_MESSAGE | whenever a new message is received |
-| EVENT.CHAT_GROUPS | whenever a group is created or updated |
-
-# Examples
-
-## Basic example of using SDK sockets in a React App
-
-```
-import { useState, useEffect } from "react";
-import { createSocketConnection, EVENTS } from '@pushprotocol/socket';
-
-const user = '0xD8634C39BBFd4033c0d3289C4515275102423681';
-const chainId = 11155111;
-
-const userCAIP = `eip155:${chainId}:${user}`;
-
-function App() {
- const [sdkSocket, setSDKSocket] = useState(null);
- const [isConnected, setIsConnected] = useState(sdkSocket?.connected);
-
- const addSocketEvents = () => {
- sdkSocket?.on(EVENTS.CONNECT, () => {
- setIsConnected(true);
- })
-
- sdkSocket?.on(EVENTS.DISCONNECT, () => {
- setIsConnected(false);
- })
-
- sdkSocket?.on(EVENTS.USER_FEEDS, (feedItem) => {
- /**
- * "feedItem" is the latest notification received
- */
- console.log(feedItem);
- })
- };
-
- const removeSocketEvents = () => {
- sdkSocket?.off(EVENTS.CONNECT);
- sdkSocket?.off(EVENTS.DISCONNECT);
- };
-
- const toggleConnection = () => {
- if (sdkSocket?.connected) {
- sdkSocket.disconnect();
- } else {
- sdkSocket.connect();
- }
- };
-
-
- useEffect(() => {
- if (sdkSocket) {
- addSocketEvents();
- }
- return () => {
- removeSocketEvents();
- };
- }, [sdkSocket]);
-
- useEffect(() => {
- const connectionObject = createSocketConnection({
- user: userCAIP,
- env: 'dev',
- socketOptions: { autoConnect: false }
- });
-
-
- setSDKSocket(connectionObject);
-
- return () => {
- if (sdkSocket) {
- sdkSocket.disconnect();
- }
- };
- }, []);
-
- return (
-
-
Socket Hello World
-
-
-
Connection Status : {JSON.stringify(isConnected)}
-
-
{isConnected ? 'disconnect' : 'connect'}
-
-
trigger button
-```
-
-or any component with the ID ***sdk-trigger-id***
-
-***Make sure the ID you give to the "button" is same as that of the targetID you pass to the init() below***
-
-After the wallet connect happens in your app flow trigger the below code snippet.
-
-**Note:** You have to have the wallet connected with an account to execute the below code because internally the SDK calls the PUSH `get_feeds()` API which needs the account address. You will see notifications if you have opted-in to a channel using [PUSH](https://staging.push.org/)
-
-```typescript
- useEffect(() => {
- if (account) { // 'your connected wallet address'
- EmbedSDK.init({
- headerText: 'Hello DeFi', // optional
- targetID: 'sdk-trigger-id', // mandatory
- appName: 'consumerApp', // mandatory
- user: account, // mandatory
- chainId: 1, // mandatory
- viewOptions: {
- type: 'sidebar', // optional [default: 'sidebar', 'modal']
- showUnreadIndicator: true, // optional
- unreadIndicatorColor: '#cc1919',
- unreadIndicatorPosition: 'bottom-right',
- },
- theme: 'light',
- onOpen: () => {
- console.log('-> client dApp onOpen callback');
- },
- onClose: () => {
- console.log('-> client dApp onClose callback');
- }
- });
- }
-
- return () => {
- EmbedSDK.cleanup();
- };
- }, []);
-```
-**Init Config Options**
-
-| option | type | mandatory | remarks |
-| --- | --- | --- | --- |
-| `targetID` | `string` | yes | can be any string but has to match the ID given to the trigger button in the HTML/JSX |
-| `chainId` | `number` | yes | the chain ID of the blockchain network. by default is 1 |
-| `appName` | `string` | yes | your app name e.g. - 'appName' |
-| `user` | `string` | yes | public wallet address e.g. - '0x1434A7882cDD877B458Df5b83c993e9571c65813' |
-| `viewOptions.type` | `string` | no | default 'sidebar', can give 'modal' |
-| `viewOptions.showUnreadIndicator` | `boolean` | no | will show the unread indicator |
-| `viewOptions.unreadIndicatorColor` | `string` | no | color for the unread indicator e.g. - '#cc1919' |
-| `viewOptions.unreadIndicatorPosition` | `string` | no | default is 'top-right', other possible options - 'top-left', 'bottom-left', 'bottom-right' |
-| `headerText` | `string` | no | any header text |
-| `theme` | `string` | no | default is 'light', can give 'dark' |
-| `onOpen` | `function` | no | callback you want to trigger when the modal/sidebar opens |
-| `onClose` | `function` | no | callback you want to trigger when the modal/sidebar closes |
-
-
-## Building
-
-Run `nx build uiembed` to build the library.
-
-## Running unit tests
-
-Run `nx test uiembed` to execute the unit tests via [Jest](https://jestjs.io).
diff --git a/packages/uiweb/src/lib/components/chat/ChatPreviewList/ChatPreviewList.tsx b/packages/uiweb/src/lib/components/chat/ChatPreviewList/ChatPreviewList.tsx
index 766b9004f..e185f1466 100644
--- a/packages/uiweb/src/lib/components/chat/ChatPreviewList/ChatPreviewList.tsx
+++ b/packages/uiweb/src/lib/components/chat/ChatPreviewList/ChatPreviewList.tsx
@@ -27,6 +27,7 @@ import {
} from '../helpers';
import { IChatTheme } from '../theme';
import { ThemeContext } from '../theme/ThemeProvider';
+import useUserProfile from '../../../hooks/useUserProfile';
// Define Interfaces
/**
@@ -67,7 +68,7 @@ export const ChatPreviewList: React.FC = (
) => {
// get hooks
const { env, signer, account, user } = useChatData();
- const { fetchChatProfile } = useChatProfile();
+ const { fetchUserProfile } = useUserProfile();
const { getGroupByIDnew } = useGetGroupByIDnew();
const { fetchLatestMessage, fetchChatList } = useFetchMessageUtilities();
@@ -99,14 +100,12 @@ export const ChatPreviewList: React.FC = (
const { chatStream, chatRequestStream, chatAcceptStream } =
usePushChatStream();
-
// Helper Functions
// Add to chat items
const addChatItems: (items: IChatPreviewPayload[]) => void = (
items: IChatPreviewPayload[]
) => {
- console.debug(items)
const combinedItems: IChatPreviewPayload[] = [
...items,
...chatPreviewList.items,
@@ -114,7 +113,6 @@ export const ChatPreviewList: React.FC = (
(item, index, self) =>
index === self.findIndex((t) => t.chatId === item.chatId)
);
- console.debug(combinedItems)
setChatPreviewList((prev) => ({
...prev,
@@ -247,7 +245,6 @@ export const ChatPreviewList: React.FC = (
) {
return;
}
-
setChatPreviewList((prev) => ({
nonce: generateRandomNonce(),
items: transformedChats,
@@ -411,21 +408,21 @@ export const ChatPreviewList: React.FC = (
// Effects
// If account, env or signer changes
- useEffect(() => {
- setChatPreviewList({
- nonce: generateRandomNonce(),
- items: [],
- page: 1,
- preloading: true,
- loading: false,
- loaded: false,
- reset: false,
- resume: false,
- errored: false,
- error: null,
- });
- resetBadge();
- }, [account, signer, env]);
+ // useEffect(() => {
+ // setChatPreviewList({
+ // nonce: generateRandomNonce(),
+ // items: [],
+ // page: 1,
+ // preloading: true,
+ // loading: false,
+ // loaded: false,
+ // reset: false,
+ // resume: false,
+ // errored: false,
+ // error: null,
+ // });
+ // resetBadge();
+ // }, [account, env]);
useEffect(() => {
if (options?.onLoading) {
@@ -444,9 +441,11 @@ export const ChatPreviewList: React.FC = (
]);
// If push user changes | preloading
useEffect(() => {
+
if (!user) {
return;
}
+ console.debug('************',user,chatPreviewList)
// reset the entire state
setChatPreviewList({
@@ -462,12 +461,14 @@ export const ChatPreviewList: React.FC = (
error: null,
});
}, [
+
options?.searchParamter,
user,
options.listType,
options.overrideAccount,
]);
+
useEffect(() => {
if (
listInnerRef &&
@@ -493,16 +494,18 @@ export const ChatPreviewList: React.FC = (
// If reset is called
useEffect(() => {
- if (!user) {
- return;
- }
-
- // reset badge as well
- resetBadge();
+ if (!user) {
+ return;
+ }
+
+ // reset badge as well
+ resetBadge();
+ if (chatPreviewList.reset) {
+ console.debug('********',chatPreviewList)
+ initializeChatList();
+ }
- if (chatPreviewList.reset) {
- initializeChatList();
- }
+
}, [chatPreviewList.reset]);
// If loading becomes active
@@ -532,35 +535,28 @@ export const ChatPreviewList: React.FC = (
Object.keys(chatStream).length > 0 &&
chatStream.constructor === Object
) {
- console.debug('Chat stream', chatStream);
if (options.listType === CONSTANTS.CHAT.LIST_TYPE.CHATS) {
transformStreamMessage(chatStream);
}
}
}, [chatStream]);
- console.debug(chatRequestStream)
useEffect(() => {
- console.debug(chatRequestStream)
if (
Object.keys(chatRequestStream).length > 0 &&
chatRequestStream.constructor === Object
) {
- console.debug('Chat request stream', chatRequestStream);
if (options.listType === CONSTANTS.CHAT.LIST_TYPE.CHATS && chatRequestStream.origin === "self") {
- console.debug('to transform stream')
transformStreamMessage(chatRequestStream);
}else if(options.listType === CONSTANTS.CHAT.LIST_TYPE.REQUESTS && chatRequestStream.origin === "other" ){
transformStreamMessage(chatRequestStream);
}
}
}, [chatRequestStream]);
-
useEffect(() => {
if (
Object.keys(chatAcceptStream).length > 0 &&
chatAcceptStream.constructor === Object
) {
- console.debug('Chat accept stream', chatAcceptStream);
transformAcceptedRequest(chatAcceptStream);
}
}, [chatAcceptStream]);
@@ -600,7 +596,7 @@ export const ChatPreviewList: React.FC = (
if (!error) {
if (await ethers.utils.isAddress(formattedChatId)) {
//fetch profile
- userProfile = await fetchChatProfile({
+ userProfile = await fetchUserProfile({
profileId: formattedChatId,
user
});
diff --git a/packages/uiweb/src/lib/components/chat/ChatProfile/ChatProfile.tsx b/packages/uiweb/src/lib/components/chat/ChatProfile/ChatProfile.tsx
index 1ec951dde..240945fd1 100644
--- a/packages/uiweb/src/lib/components/chat/ChatProfile/ChatProfile.tsx
+++ b/packages/uiweb/src/lib/components/chat/ChatProfile/ChatProfile.tsx
@@ -33,6 +33,7 @@ import GreyImage from '../../../icons/greyImage.png';
import InfoIcon from '../../../icons/infodark.svg';
import VerticalEllipsisIcon from '../../../icons/VerticalEllipsis.svg';
import { TokenGatedSvg } from '../../../icons/TokenGatedSvg';
+import useUserProfile from '../../../hooks/useUserProfile';
export const ChatProfile: React.FC = ({
chatId,
@@ -44,7 +45,7 @@ export const ChatProfile: React.FC = ({
const theme = useContext(ThemeContext);
const { account, env, user } = useChatData();
const { getGroupByIDnew } = useGetGroupByIDnew();
- const { fetchChatProfile } = useChatProfile();
+ const { fetchUserProfile } = useUserProfile();
// const [isGroup, setIsGroup] = useState(false);
const [options, setOptions] = useState(false);
@@ -67,7 +68,7 @@ export const ChatProfile: React.FC = ({
const fetchProfileData = async () => {
if (isValidETHAddress(chatId)) {
- const ChatProfile = await fetchChatProfile({ profileId: chatId, env,user });
+ const ChatProfile = await fetchUserProfile({ profileId: chatId, env,user });
const result = await resolveNewEns(chatId, provider, env);
setWeb3Name(result);
setChatInfo(ChatProfile);
diff --git a/packages/uiweb/src/lib/components/chat/ChatProfile/GroupInfoModal.tsx b/packages/uiweb/src/lib/components/chat/ChatProfile/GroupInfoModal.tsx
index b3b62b352..84ab6a668 100644
--- a/packages/uiweb/src/lib/components/chat/ChatProfile/GroupInfoModal.tsx
+++ b/packages/uiweb/src/lib/components/chat/ChatProfile/GroupInfoModal.tsx
@@ -44,6 +44,7 @@ import { GROUP_ROLES } from '../types';
import useGroupMemberUtilities from '../../../hooks/chat/useGroupMemberUtilities';
import useChatProfile from '../../../hooks/chat/useChatProfile';
import { resolvePromisesSeq, transformIUserToChatMemberProfile } from '../helpers';
+import useUserProfile from '../../../hooks/useUserProfile';
export interface MemberPaginationData {
page: number;
@@ -507,7 +508,7 @@ export const GroupInfoModal = ({
const {user} = useChatData();
const { addMember } = useUpdateGroup();
const { fetchMembersCount } = useGroupMemberUtilities();
- const { fetchChatProfile } = useChatProfile();
+ const { fetchUserProfile } = useUserProfile();
const {
chatAcceptStream,
@@ -744,7 +745,7 @@ export const GroupInfoModal = ({
};
const transformParticipantJoin = async (item: any): Promise => {
if (groupInfo?.chatId === item?.chatId) {
- const profile = await fetchChatProfile({ profileId: item?.from,user });
+ const profile = await fetchUserProfile({ profileId: item?.from,user });
const transformedProfile = transformIUserToChatMemberProfile(profile,true);
addAcceptedMember([transformedProfile]);
}
diff --git a/packages/uiweb/src/lib/components/chat/reusables/AddWallets.tsx b/packages/uiweb/src/lib/components/chat/reusables/AddWallets.tsx
index 19fb4b477..f78333f3c 100644
--- a/packages/uiweb/src/lib/components/chat/reusables/AddWallets.tsx
+++ b/packages/uiweb/src/lib/components/chat/reusables/AddWallets.tsx
@@ -23,6 +23,7 @@ import {
ModalHeader,
} from '../reusables';
import useChatProfile from '../../../hooks/chat/useChatProfile';
+import useUserProfile from '../../../hooks/useUserProfile';
type AddWalletProps = {
onSubmit: () => void;
@@ -55,7 +56,7 @@ export const AddWallets = ({
const [filteredUserData, setFilteredUserData] = useState(null);
const { env } = useChatData();
const isMobile = useMediaQuery(device.mobileL);
- const { fetchChatProfile } = useChatProfile();
+ const { fetchUserProfile } = useUserProfile();
const groupInfoToast = useToast();
const customSearchStyle: CustomStyleParamsType = {
background: theme.backgroundColor?.modalInputBackground,
@@ -73,7 +74,7 @@ export const AddWallets = ({
//fix ens search
const newChatUser = await getNewChatUser({
searchText: searchedText,
- fetchChatProfile,
+ fetchChatProfile:fetchUserProfile,
env,
});
if (newChatUser) {
diff --git a/packages/uiweb/src/lib/components/widget/ConnectButton/ConnectButton.tsx b/packages/uiweb/src/lib/components/widget/ConnectButton/ConnectButton.tsx
index e22e8f5e3..33239ade1 100644
--- a/packages/uiweb/src/lib/components/widget/ConnectButton/ConnectButton.tsx
+++ b/packages/uiweb/src/lib/components/widget/ConnectButton/ConnectButton.tsx
@@ -1,13 +1,10 @@
-import { useContext, useEffect, useState } from 'react';
+import { useContext, useEffect, } from 'react';
import styled from 'styled-components';
-import { ethers } from 'ethers';
import { useAccount, useWidgetData } from '../../../hooks';
import { ThemeContext } from '../theme/ThemeProvider';
-
-import { getAddressFromSigner } from '../../../helpers';
import { IWidgetTheme } from '../theme';
import { device } from '../../../config';
import { SignerType } from '@pushprotocol/restapi';
@@ -20,83 +17,62 @@ interface IThemeProps {
theme?: IWidgetTheme;
}
-
interface IConnectButtonSubProps {
autoconnect?: boolean;
- setAccount: React.Dispatch>;
+ setAccount: React.Dispatch>;
signer: SignerType | undefined;
setSigner: React.Dispatch>;
-
}
-export const ConnectButtonSub: React.FC = ({autoconnect = false,setAccount,setSigner,signer }) => {
- const {env} = useWidgetData();
- const {wallet, connecting , connect, disconnect,provider,account} = useAccount({env});
+export const ConnectButtonSub: React.FC = ({
+ autoconnect = false,
+ setAccount,
+ setSigner,
+ signer,
+}) => {
+ const { env } = useWidgetData();
+ const { wallet, connecting, connect, disconnect, provider, account } =
+ useAccount({ env });
const theme = useContext(ThemeContext);
const setUserData = () => {
if (wallet) {
(async () => {
-
const librarySigner = provider?.getSigner(account);
- setSigner(librarySigner)
+ setSigner(librarySigner);
setAccount(account!);
- })()
+ })();
} else if (!wallet) {
- setAccount('')
- setSigner(undefined)
+ setAccount('');
+ setSigner(undefined);
}
- }
+ changeModalStyle('zIndex', '2000');
+ };
useEffect(() => {
- if(wallet && !autoconnect){
+ if (wallet && !autoconnect) {
disconnect(wallet);
}
setUserData();
-
-
-
- }, [wallet])
+ }, [wallet]);
- const handleConnect = () =>{
-
- const onboardModal = document.getElementById("onboard-container");
- if(onboardModal){
+ const changeModalStyle = (property: any, value: string) => {
+ const widgetmodal = document.getElementById('widget-modal-overlay');
+ if (widgetmodal) {
+ widgetmodal.style[property] = value;
+ }
+ };
-
- onboardModal.style.display = 'block';
- // Open the onboard modal
+ const handleConnect = () => {
+ changeModalStyle('zIndex', 'unset');
connect();
-
- // Create a resize observer to detect when the onboard modal is rendered
- const observer = new ResizeObserver(() => {
- const sectionElement = document.querySelector('onboard-v2')?.shadowRoot?.querySelector('.svelte-baitaa');
- const divElement = sectionElement?.querySelector('div');
- if (divElement) {
- // Disconnect the observer once the divElement is found
- observer.unobserve(onboardModal);
- observer.disconnect();
-
- // Apply custom styles
- divElement.style.position = 'fixed';
- divElement.style.top = '0px';
- divElement.style.right = '0px';
- divElement.style.height = '100vh';
- divElement.style.left = '0px';
- divElement.style.zIndex = '999999';
- divElement.style.backgroundColor = 'rgba(0, 0, 0, 0.2)';
- divElement.style.backdropFilter = 'blur(5px)';
- }
- });
-
- // Start observing the DOM for changes
- observer.observe(onboardModal);
- }
- }
+ };
return !signer ? (
- (wallet ? disconnect(wallet) : handleConnect())}>{connecting ? 'connecting' : wallet ? 'disconnect' : 'Connect Wallet'}
+ (wallet ? disconnect(wallet) : handleConnect())}>
+ {connecting ? 'connecting' : wallet ? 'disconnect' : 'Connect Wallet'}
+
) : (
<>
@@ -106,23 +82,23 @@ export const ConnectButtonSub: React.FC = ({autoconnect
//styles
const ConnectButtonDiv = styled.div`
width: 100%;
-
- button{
- background: ${(props) => `${props.theme.backgroundColor?.buttonBackground}!important`};
+
+ button {
+ background: ${(props) =>
+ `${props.theme.backgroundColor?.buttonBackground}!important`};
color: ${(props) => `${props.theme.textColor?.buttonText}!important`};
- text-align:center;
+ text-align: center;
font-size: 1em;
- cursor:pointer;
+ cursor: pointer;
border-radius: 10px;
padding: 10px 20px;
outline: none;
border: none;
cursor: pointer;
- width:100%;
+ width: 100%;
font-weight: 600;
-
}
- button:hover{
+ button:hover {
scale: 1.05;
transition: 0.3s;
}
@@ -131,9 +107,8 @@ const ConnectButtonDiv = styled.div`
}
body.modal-open {
overflow-y: hidden;
-
}
body.svelte-baitaa {
- z-index:99999;
+ z-index: 99999;
}
-`;
\ No newline at end of file
+`;
diff --git a/packages/uiweb/src/lib/components/widget/ConnectButton/index.tsx b/packages/uiweb/src/lib/components/widget/ConnectButton/index.tsx
index 78da6c167..25c631a52 100644
--- a/packages/uiweb/src/lib/components/widget/ConnectButton/index.tsx
+++ b/packages/uiweb/src/lib/components/widget/ConnectButton/index.tsx
@@ -3,7 +3,7 @@ import coinbaseWalletModule from '@web3-onboard/coinbase'
import { ConnectButtonSub } from './ConnectButton';
import { BLOCKNATIVE_PROJECT_ID, InfuraAPIKey } from '../../../config';
import { Web3OnboardProvider } from '@web3-onboard/react';
-import injectedModule, { ProviderLabel } from '@web3-onboard/injected-wallets';
+import injectedModule from '@web3-onboard/injected-wallets';
import walletConnectModule from '@web3-onboard/walletconnect'
import init from '@web3-onboard/core';
import PushIcon from "../../../icons/Bell.svg"
@@ -87,9 +87,6 @@ const web3OnBoard = init({
connect: {
autoConnectLastWallet: true,
},
- containerElements: {
- connectModal: "#onboard-container"
- },
})
interface IConnectButtonCompProps {
diff --git a/packages/uiweb/src/lib/components/widget/reusables/Modal.tsx b/packages/uiweb/src/lib/components/widget/reusables/Modal.tsx
index db402f722..1522a30f7 100644
--- a/packages/uiweb/src/lib/components/widget/reusables/Modal.tsx
+++ b/packages/uiweb/src/lib/components/widget/reusables/Modal.tsx
@@ -57,7 +57,7 @@ const ClickawayCloseModal = ({
export const Modal = ({ clickawayClose, children, width,modalBackground = MODAL_BACKGROUND_TYPE.OVERLAY,modalPositionType = MODAL_POSITION_TYPE.GLOBAL }: IModalProps) => {
const theme = useContext(ThemeContext);
return (
-
+
{clickawayClose ? (
{children}
diff --git a/packages/uiweb/src/lib/components/widget/subscriptionManager/SubscriptionManager.tsx b/packages/uiweb/src/lib/components/widget/subscriptionManager/SubscriptionManager.tsx
index c1f781366..39e60e9c5 100644
--- a/packages/uiweb/src/lib/components/widget/subscriptionManager/SubscriptionManager.tsx
+++ b/packages/uiweb/src/lib/components/widget/subscriptionManager/SubscriptionManager.tsx
@@ -197,7 +197,6 @@ export const SubscriptionManager: React.FC = (
`
border: ${(props) => props.theme.border?.modal};
`;
-const OnboardDiv = styled.div`
-position: absolute;
-top: 14rem;
-margin: auto;
-background-color: transparent;
-left: 20px;
-right: 20px;
-margin-left: auto;
-margin-right: auto;
-border-radius: var(--w3o-border-radius);
-overflow: auto;
-z-index: 99999;
-
-`
diff --git a/packages/uiweb/src/lib/dataProviders/ChatDataProvider.tsx b/packages/uiweb/src/lib/dataProviders/ChatDataProvider.tsx
index 3749523c8..48b644fb3 100644
--- a/packages/uiweb/src/lib/dataProviders/ChatDataProvider.tsx
+++ b/packages/uiweb/src/lib/dataProviders/ChatDataProvider.tsx
@@ -16,6 +16,7 @@ import useInitializeUser from '../hooks/useInitializeUser';
import useChatProfile from '../hooks/chat/useChatProfile';
import usePushUserInfoUtilities from '../hooks/chat/useUserInfoUtilities';
+import useUserProfile from '../hooks/useUserProfile';
export interface IChatUIProviderProps {
children: ReactNode;
@@ -56,7 +57,7 @@ export const ChatUIProvider = ({
useState(false);
const { fetchEncryptionInfo } = usePushUserInfoUtilities();
const { initializeUser } = useInitializeUser();
- const { fetchChatProfile } = useChatProfile();
+ const { fetchUserProfile } = useUserProfile();
const [isPushChatStreamConnected, setIsPushChatStreamConnected] =
useState(false);
@@ -69,7 +70,7 @@ export const ChatUIProvider = ({
const address = await getAddressFromSigner(signer!);
setAccountVal(address);
} else if (!signer && user) {
- const profile = await fetchChatProfile({user});
+ const profile = await fetchUserProfile({user});
setAccountVal(pCAIP10ToWallet(profile?.wallets));
} else {
setAccountVal(GUEST_MODE_ACCOUNT);
@@ -83,7 +84,7 @@ export const ChatUIProvider = ({
useEffect(() => {
(async () => {
- if (accountVal && envVal && !userVal) {
+ if ((accountVal && envVal && signerVal) ||(accountVal == GUEST_MODE_ACCOUNT && envVal && !userVal) ) {
const pushUser = await initializeUser({
signer: signerVal,
account: accountVal!,
@@ -103,7 +104,6 @@ export const ChatUIProvider = ({
})();
}, [userVal]);
-
const resetStates = () => {
setPushChatSocket(null);
setIsPushChatSocketConnected(false);
@@ -115,7 +115,7 @@ export const ChatUIProvider = ({
(async () => {
let user;
if (account) {
- user = await fetchChatProfile({ profileId: account, env,user });
+ user = await fetchUserProfile({ profileId: account, env,user });
if (user) setConnectedProfile(user);
}
})();
diff --git a/packages/uiweb/src/lib/dataProviders/WidgetProvider.tsx b/packages/uiweb/src/lib/dataProviders/WidgetProvider.tsx
index a7d4a9c68..8fb52ed24 100644
--- a/packages/uiweb/src/lib/dataProviders/WidgetProvider.tsx
+++ b/packages/uiweb/src/lib/dataProviders/WidgetProvider.tsx
@@ -6,7 +6,6 @@ import {
} from '../context/widgetContext';
import { PushAPI, SignerType } from '@pushprotocol/restapi';
import { getAddressFromSigner, pCAIP10ToWallet } from '../helpers';
-import useInitializePushUser from '../hooks/useInitializeUser';
import { GUEST_MODE_ACCOUNT } from '../config/constants';
import { IWidgetTheme, lightWidgetTheme } from '../components/widget/theme';
import { ThemeContext } from '../components/widget/theme/ThemeProvider';
@@ -36,20 +35,19 @@ export const WidgetUIProvider = ({
const [signerVal, setSignerVal] = useState(signer);
const [userVal, setUserVal] = useState(user);
const [envVal, setEnvVal] = useState(env);
-
const { initializeUser } = useInitializeUser();
const { fetchUserProfile } = useUserProfile();
useEffect(() => {
(async () => {
- // resetStates();
+ // resetStates();
setEnvVal(env);
if (Object.keys(signer || {}).length && !user) {
const address = await getAddressFromSigner(signer!);
setAccountVal(address);
} else if (!signer && user) {
- const profile = await fetchUserProfile({user});
-
+ const profile = await fetchUserProfile({ user });
+
setAccountVal(pCAIP10ToWallet(profile?.wallets));
} else {
setAccountVal(GUEST_MODE_ACCOUNT);
@@ -57,14 +55,11 @@ export const WidgetUIProvider = ({
setSignerVal(signer);
setUserVal(user);
})();
- }, [env, account, signer,user]);
-
-
+ }, [env, account, signer, user]);
useEffect(() => {
(async () => {
- if (accountVal && envVal ) {
-
+ if (accountVal && envVal) {
const pushUser = await initializeUser({
signer: signerVal,
account: accountVal!,
@@ -73,17 +68,14 @@ export const WidgetUIProvider = ({
setUserVal(pushUser);
}
})();
- }, [ accountVal, envVal,signerVal]);
-
-
-
-// const resetStates = () => {
-// setPushChatSocket(null);
-// setIsPushChatSocketConnected(false);
-// setPushChatStream(null);
-// setIsPushChatStreamConnected(false);
-// };
+ }, [accountVal, envVal, signerVal]);
+ // const resetStates = () => {
+ // setPushChatSocket(null);
+ // setIsPushChatSocketConnected(false);
+ // setPushChatStream(null);
+ // setIsPushChatStreamConnected(false);
+ // };
const value: IWidgetDataContextValues = {
@@ -103,6 +95,8 @@ export const WidgetUIProvider = ({
{children}
-
+
);
};
+
+
diff --git a/packages/uiweb/src/lib/hooks/chat/useFetchMessageUtilities.ts b/packages/uiweb/src/lib/hooks/chat/useFetchMessageUtilities.ts
index 1426ffa12..7e63379c7 100644
--- a/packages/uiweb/src/lib/hooks/chat/useFetchMessageUtilities.ts
+++ b/packages/uiweb/src/lib/hooks/chat/useFetchMessageUtilities.ts
@@ -31,19 +31,20 @@ const useFetchMessageUtilities
const [historyLoading, setHistoryLoading] = useState(false);
const [latestLoading, setLatestLoading] = useState(false);
const [chatListLoading, setChatListLoading] = useState(false);
-
-
- const { account, env,pgpPrivateKey ,user} = useChatData();
+ const { account, env,pgpPrivateKey ,user,signer} = useChatData();
const fetchChatList = useCallback(async ({type,page,limit,overrideAccount = undefined}:FetchChatListParams) => {
+
setChatListLoading(true);
try {
+ console.debug(user)
const chats = await user?.chat
.list(type, {
overrideAccount: overrideAccount,
page: page,
limit: limit,
})
+ console.debug(chats,'chats from hook')
return chats;
} catch (error: Error | any) {
setChatListLoading(false);
@@ -53,7 +54,7 @@ const useFetchMessageUtilities
} finally {
setChatListLoading(false);
}
- }, [user,account,env]);
+ }, [user,account,env,signer]);
const fetchLatestMessage = useCallback(async ({chatId}:FetchLatestMessageParams) => {
setLatestLoading(true);
diff --git a/packages/uiweb/src/lib/hooks/chat/usePushChatStream.ts b/packages/uiweb/src/lib/hooks/chat/usePushChatStream.ts
index e6283c860..76f982f75 100644
--- a/packages/uiweb/src/lib/hooks/chat/usePushChatStream.ts
+++ b/packages/uiweb/src/lib/hooks/chat/usePushChatStream.ts
@@ -25,7 +25,7 @@ export const usePushChatStream = () => {
const [groupCreateStream, setGroupCreateStream] = useState({}); // to track if group is created
const [groupUpdateStream, setGroupUpdateStream] = useState({}); //group updation stream
-
+console.debug('in stream')
const attachListenersAndConnect = async (stream: any) => {
stream?.on(CONSTANTS.STREAM.CONNECT, (err: Error) => {
console.debug(' stream connected .........',err)
@@ -82,6 +82,8 @@ export const usePushChatStream = () => {
* - create a new connection object
*/
useEffect(() => {
+ console.debug('in stream',user)
+
if (!user) {
return;
}