Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: NFTChat High Level Fixes #938

Merged
merged 3 commits into from
Dec 22, 2023
Merged

fix: NFTChat High Level Fixes #938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
79cb7b9
fix: nftchat profile
Aman035 Dec 19, 2023
47918e3
fix: fix tests and examples
Aman035 Dec 19, 2023
881f5b1
fix: added reinitialize for nft profiles
Aman035 Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/examples/sdk-backend-node/.env.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@ NFT_HOLDER_WALLET_PRIVATE_KEY_2=your_nft_holder_wallet_private_key
# NFT PROFILE WALLET PASSWORD
NFT_PROFILE_PASSWORD_2=your_nft_profile_password

# NFT CONTRACT ADDRESS
NFT_CONTRACT_ADDRESS_3=your_nft_contract_address

# NFT CHAIN ID
NFT_CHAIN_ID_3=your_nft_chain_id

# NFT TOKEN ID
NFT_TOKEN_ID_3=your_nft_token_id

# NFT HOLDER WALLET PRIVATE KEY
NFT_HOLDER_WALLET_PRIVATE_KEY_3=your_nft_holder_wallet_private_key

# NFT PROFILE WALLET PASSWORD
NFT_PROFILE_PASSWORD_3=your_nft_profile_password

# VIDEO CHAIN ID
VIDEO_CHAIN_ID=your_video_chain_id

Expand Down
14 changes: 14 additions & 0 deletions packages/examples/sdk-backend-node/chat/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { runChatLowlevelUseCases } from './chat.lowlevel';
import { runNFTChatLowLevelUseCases } from './nftChat.lowlevel';
import { runChatClassUseCases } from './chat';
import { runNFTChatClassUseCases } from './nftChat';

export const runChatUseCases = async (): Promise<void> => {
console.log(`
Expand All @@ -13,12 +14,25 @@ export const runChatUseCases = async (): Promise<void> => {
`);

await runChatClassUseCases();

console.log(`
███╗░░██╗███████╗████████╗ ░█████╗░██╗░░██╗░█████╗░████████╗
████╗░██║██╔════╝╚══██╔══╝ ██╔══██╗██║░░██║██╔══██╗╚══██╔══╝
██╔██╗██║█████╗░░░░░██║░░░ ██║░░╚═╝███████║███████║░░░██║░░░
██║╚████║██╔══╝░░░░░██║░░░ ██║░░██╗██╔══██║██╔══██║░░░██║░░░
██║░╚███║██║░░░░░░░░██║░░░ ╚█████╔╝██║░░██║██║░░██║░░░██║░░░
╚═╝░░╚══╝╚═╝░░░░░░░░╚═╝░░░ ░╚════╝░╚═╝░░╚═╝╚═╝░░╚═╝░░░╚═╝░░░
`);

await runNFTChatClassUseCases();

console.log(`
▒█▀▀█ ▒█░▒█ ░█▀▀█ ▀▀█▀▀ ░ ▒█░░░ ▒█▀▀▀█ ▒█░░▒█ ▒█░░░ ▒█▀▀▀ ▒█░░▒█ ▒█▀▀▀ ▒█░░░
▒█░░░ ▒█▀▀█ ▒█▄▄█ ░▒█░░ ▄ ▒█░░░ ▒█░░▒█ ▒█▒█▒█ ▒█░░░ ▒█▀▀▀ ░▒█▒█░ ▒█▀▀▀ ▒█░░░
▒█▄▄█ ▒█░▒█ ▒█░▒█ ░▒█░░ █ ▒█▄▄█ ▒█▄▄▄█ ▒█▄▀▄█ ▒█▄▄█ ▒█▄▄▄ ░░▀▄▀░ ▒█▄▄▄ ▒█▄▄█
`);
await runChatLowlevelUseCases();

console.log(`
▒█▄░▒█ ▒█▀▀▀ ▀▀█▀▀ ▒█▀▀█ ▒█░▒█ ░█▀▀█ ▀▀█▀▀ ░ ▒█░░░ ▒█▀▀▀█ ▒█░░▒█ ▒█░░░ ▒█▀▀▀ ▒█░░▒█ ▒█▀▀▀ ▒█░░░
▒█▒█▒█ ▒█▀▀▀ ░▒█░░ ▒█░░░ ▒█▀▀█ ▒█▄▄█ ░▒█░░ ▄ ▒█░░░ ▒█░░▒█ ▒█▒█▒█ ▒█░░░ ▒█▀▀▀ ░▒█▒█░ ▒█▀▀▀ ▒█░░░
Expand Down
343 changes: 343 additions & 0 deletions packages/examples/sdk-backend-node/chat/nftChat.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,343 @@
import { CONSTANTS, PushAPI } from '@pushprotocol/restapi';
import {
adjectives,
animals,
colors,
uniqueNamesGenerator,
} from 'unique-names-generator';
import { config } from '../config';
import { PushStream } from '@pushprotocol/restapi/src/lib/pushstream/PushStream';
import { ethers } from 'ethers';

// CONFIGS
const { env, showAPIResponse } = config;

/*********************** SAMPLE NFT DATA **************************/
const nftChainId1 = process.env.NFT_CHAIN_ID_1 || '11155111';
const nftContractAddress1 = process.env.NFT_CONTRACT_ADDRESS_1 || '';
const nftTokenId1 = process.env.NFT_TOKEN_ID_1 || '';
const nftHolderWalletPrivatekey1 =
process.env.NFT_HOLDER_WALLET_PRIVATE_KEY_1 || '';
const nftSigner1 = new ethers.Wallet(`0x${nftHolderWalletPrivatekey1}`);
// NFT Account structure for Push Chat : nft:eip155:{chainId}:{contractAddress}:{tokenId}
const nftAccount1 = `nft:eip155:${nftChainId1}:${nftContractAddress1}:${nftTokenId1}`;
// NFT Profile Password ( Used for recovery in case of NFT transfers )
const nftProfilePassword1 = process.env.NFT_PROFILE_PASSWORD_1 || '';

const nftChainId2 = process.env.NFT_CHAIN_ID_2 || '11155111';
const nftContractAddress2 = process.env.NFT_CONTRACT_ADDRESS_2 || '';
const nftTokenId2 = process.env.NFT_TOKEN_ID_2 || '';
const nftHolderWalletPrivatekey2 =
process.env.NFT_HOLDER_WALLET_PRIVATE_KEY_2 || '';
const nftSigner2 = new ethers.Wallet(`0x${nftHolderWalletPrivatekey2}`);
const nftAccount2 = `nft:eip155:${nftChainId2}:${nftContractAddress2}:${nftTokenId2}`;
const nftProfilePassword2 = process.env.NFT_PROFILE_PASSWORD_2 || '';

const nftChainId3 = process.env.NFT_CHAIN_ID_3 || '11155111';
const nftContractAddress3 = process.env.NFT_CONTRACT_ADDRESS_3 || '';
const nftTokenId3 = process.env.NFT_TOKEN_ID_3 || '';
const nftHolderWalletPrivatekey3 =
process.env.NFT_HOLDER_WALLET_PRIVATE_KEY_3 || '';
const nftSigner3 = new ethers.Wallet(`0x${nftHolderWalletPrivatekey3}`);
const nftAccount3 = `nft:eip155:${nftChainId3}:${nftContractAddress3}:${nftTokenId3}`;
const nftProfilePassword3 = process.env.NFT_PROFILE_PASSWORD_3 || '';

const randomWallet1 = ethers.Wallet.createRandom().address;
const randomWallet2 = ethers.Wallet.createRandom().address;
const randomWallet3 = ethers.Wallet.createRandom().address;
/****************************************************************/

/***************** SAMPLE GROUP DATA ****************************/
const groupName = uniqueNamesGenerator({
dictionaries: [adjectives, colors, animals],
});
const groupDescription = uniqueNamesGenerator({
dictionaries: [adjectives, colors, animals],
});
const groupImage =
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAvklEQVR4AcXBsW2FMBiF0Y8r3GQb6jeBxRauYRpo4yGQkMd4A7kg7Z/GUfSKe8703fKDkTATZsJsrr0RlZSJ9r4RLayMvLmJjnQS1d6IhJkwE2bT13U/DBzp5BN73xgRZsJMmM1HOolqb/yWiWpvjJSUiRZWopIykTATZsJs5g+1N6KSMiO1N/5DmAkzYTa9Lh6MhJkwE2ZzSZlo7xvRwson3txERzqJhJkwE2bT6+JhoKTMJ2pvjAgzYSbMfgDlXixqjH6gRgAAAABJRU5ErkJggg==';
/***************** SAMPLE GROUP DATA ****************************/

const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));

const eventlistener = async (
stream: PushStream,
eventName: string
): Promise<void> => {
stream.on(eventName, (data: any) => {
if (showAPIResponse) {
console.log('Stream Event Received');
console.log(data);
console.log('\n');
}
});
};

const skipExample = () => {
const requiredEnvVars = [
'NFT_CHAIN_ID_1',
'NFT_CONTRACT_ADDRESS_1',
'NFT_TOKEN_ID_1',
'NFT_HOLDER_WALLET_PRIVATE_KEY_1',
'NFT_PROFILE_PASSWORD_1',
'NFT_CHAIN_ID_2',
'NFT_CONTRACT_ADDRESS_2',
'NFT_TOKEN_ID_2',
'NFT_HOLDER_WALLET_PRIVATE_KEY_2',
'NFT_PROFILE_PASSWORD_2',
'NFT_CHAIN_ID_3',
'NFT_CONTRACT_ADDRESS_3',
'NFT_TOKEN_ID_3',
'NFT_HOLDER_WALLET_PRIVATE_KEY_3',
'NFT_PROFILE_PASSWORD_3',
];

for (const envVar of requiredEnvVars) {
if (!process.env[envVar]) {
return true; // Skip the example if any of the required env vars is missing
}
}

return false; // All required env vars are present, don't skip the example
};

export const runNFTChatClassUseCases = async (): Promise<void> => {
if (skipExample()) {
console.log('Skipping examples as required env vars are missing');
return;
}

const userAlice = await PushAPI.initialize(nftSigner1, {
env,
account: nftAccount1,
versionMeta: { NFTPGP_V1: { password: nftProfilePassword1 } },
});

const stream = await userAlice.initStream(
[CONSTANTS.STREAM.CHAT, CONSTANTS.STREAM.CHAT_OPS],
{
// stream supports other products as well, such as STREAM.CHAT, STREAM.CHAT_OPS
// more info can be found at push.org/docs/chat

filter: {
channels: ['*'],
chats: ['*'],
},
connection: {
auto: true, // should connection be automatic, else need to call stream.connect();
retries: 3, // number of retries in case of error
},
raw: true, // enable true to show all data
}
);

stream.on(CONSTANTS.STREAM.CONNECT, (a) => {
console.log('Stream Connected');
});

await stream.connect();

stream.on(CONSTANTS.STREAM.DISCONNECT, () => {
console.log('Stream Disconnected');
});

const userBob = await await PushAPI.initialize(nftSigner2, {
env,
account: nftAccount2,
versionMeta: { NFTPGP_V1: { password: nftProfilePassword2 } },
});

const userKate = await await PushAPI.initialize(nftSigner3, {
env,
account: nftAccount3,
versionMeta: { NFTPGP_V1: { password: nftProfilePassword3 } },
});

// Listen stream events to receive websocket events
console.log(`Listening ${CONSTANTS.STREAM.CHAT} Events`);
eventlistener(stream, CONSTANTS.STREAM.CHAT);
console.log(`Listening ${CONSTANTS.STREAM.CHAT_OPS} Events`);
eventlistener(stream, CONSTANTS.STREAM.CHAT_OPS);
console.log('\n\n');

// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.chat.list');
const aliceChats = await userAlice.chat.list(CONSTANTS.CHAT.LIST_TYPE.CHATS);
const aliceRequests = await userAlice.chat.list(
CONSTANTS.CHAT.LIST_TYPE.REQUESTS
);
if (showAPIResponse) {
console.log(aliceChats);
console.log(aliceRequests);
}
console.log('PushAPI.chat.list | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.chat.latest');
const aliceLatestChatWithBob = await userAlice.chat.latest(nftAccount2);
if (showAPIResponse) {
console.log(aliceLatestChatWithBob);
}
console.log('PushAPI.chat.latest | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.chat.history');
const aliceChatHistoryWithBob = await userAlice.chat.history(nftAccount2);
if (showAPIResponse) {
console.log(aliceChatHistoryWithBob);
}
console.log('PushAPI.chat.history | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.chat.send');
const aliceMessagesBob = await userAlice.chat.send(nftAccount2, {
content: 'Hello Bob!',
type: CONSTANTS.CHAT.MESSAGE_TYPE.TEXT,
});
if (showAPIResponse) {
console.log(aliceMessagesBob);
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.chat.send | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.chat.accept');
try {
const bobAcceptsRequest = await userBob.chat.accept(nftAccount1);
if (showAPIResponse) {
console.log(bobAcceptsRequest);
}
} catch (e) {
console.log("Ignoring error as Bob's request is already accepted");
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.chat.accept | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.chat.reject');
await userKate.chat.send(nftAccount1, {
content: 'Sending malicious message',
type: CONSTANTS.CHAT.MESSAGE_TYPE.TEXT,
});
const AliceRejectsRequest = await userAlice.chat.reject(nftAccount3);
if (showAPIResponse) {
console.log(AliceRejectsRequest);
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.chat.reject | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.chat.block');
const AliceBlocksBob = await userAlice.chat.block([nftAccount2]);
if (showAPIResponse) {
console.log(AliceBlocksBob);
}
console.log('PushAPI.chat.block | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.chat.unblock');
const AliceUnblocksBob = await userAlice.chat.unblock([nftAccount2]);
if (showAPIResponse) {
console.log(AliceUnblocksBob);
}
console.log('PushAPI.chat.unblock | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.create');
const createdGroup = await userAlice.chat.group.create(groupName, {
description: groupDescription,
image: groupImage,
members: [randomWallet1, randomWallet2],
admins: [],
private: false,
});
const groupChatId = createdGroup.chatId; // to be used in other examples
if (showAPIResponse) {
console.log(createdGroup);
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.group.create | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.permissions');
const grouppermissions = await userAlice.chat.group.permissions(groupChatId);
if (showAPIResponse) {
console.log(grouppermissions);
}
console.log('PushAPI.group.permissions | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.info');
const groupInfo = await userAlice.chat.group.info(groupChatId);
if (showAPIResponse) {
console.log(groupInfo);
}
console.log('PushAPI.group.info | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.update');
const updatedGroup = await userAlice.chat.group.update(groupChatId, {
description: 'Updated Description',
});
if (showAPIResponse) {
console.log(updatedGroup);
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.group.update | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.add');
const addMember = await userAlice.chat.group.add(groupChatId, {
role: 'MEMBER',
accounts: [randomWallet3],
});
if (showAPIResponse) {
console.log(addMember);
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.group.add | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.remove');
const removeMember = await userAlice.chat.group.remove(groupChatId, {
role: 'MEMBER',
accounts: [randomWallet3],
});
if (showAPIResponse) {
console.log(removeMember);
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.group.remove | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.join');
const joinGrp = await userBob.chat.group.join(groupChatId);
if (showAPIResponse) {
console.log(joinGrp);
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.group.join | Response - 200 OK\n\n');
//-------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.leave');
const leaveGrp = await userBob.chat.group.leave(groupChatId);
if (showAPIResponse) {
console.log(leaveGrp);
}
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.group.leave | Response - 200 OK\n\n');
// -------------------------------------------------------------------
// -------------------------------------------------------------------
console.log('PushAPI.group.reject');
const sampleGrp = await userAlice.chat.group.create('Sample Grp', {
description: groupDescription,
image: groupImage,
members: [nftAccount2], // invite bob
admins: [],
private: true,
});
await userBob.chat.group.reject(sampleGrp.chatId);
await delay(2000); // Delay added to log the events in order
console.log('PushAPI.group.reject | Response - 200 OK\n\n');
};
Loading
Loading