Alpha to main

packages/examples/sdk-backend-node/pushAPI/channel.ts

@@ -0,0 +1,192 @@
+import { PushAPI } from '@pushprotocol/restapi';
+import { config } from '../config';
+import { ethers } from 'ethers';
+
+// CONFIGS
+const { env, showAPIResponse } = config;
+
+export const runPushAPIChannelCases = async (): Promise<void> => {
+  if (!process.env.WALLET_PRIVATE_KEY) {
+    console.log(
+      'skipping PushAPI.channel examples, no private key passed in .env'
+    );
+    return;
+  }
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  // Signer Generation
+  const provider = new ethers.providers.JsonRpcProvider(
+    'https://goerli.blockpi.network/v1/rpc/public' // Goerli Provider
+  );
+  const signer = new ethers.Wallet(
+    `0x${process.env.WALLET_PRIVATE_KEY}`,
+    provider
+  );
+  const randomWallet1 = ethers.Wallet.createRandom().address;
+  const randomWallet2 = ethers.Wallet.createRandom().address;
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  const userAlice = await PushAPI.initialize(signer, { env });
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.info');
+  const channelInfo = await userAlice.channel.info();
+  if (showAPIResponse) {
+    console.log(channelInfo);
+  }
+  console.log('PushAPI.channel.info | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.search');
+  const searchedChannels = await userAlice.channel.search(
+    'push' // search by name or address
+  );
+  if (showAPIResponse) {
+    console.log(searchedChannels);
+  }
+  console.log('PushAPI.channel.search | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.subscribers');
+  const channelSubscribers = await userAlice.channel.subscribers();
+  if (showAPIResponse) {
+    console.log(channelSubscribers);
+  }
+  console.log('PushAPI.channel.subscribers | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.send');
+  if (channelInfo) {
+    const broadcastNotif = await userAlice.channel.send(['*'], {
+      notification: {
+        title: 'test',
+        body: 'test',
+      },
+    });
+    const targetedNotif = await userAlice.channel.send([randomWallet1], {
+      notification: {
+        title: 'test',
+        body: 'test',
+      },
+    });
+    const subsetNotif = await userAlice.channel.send(
+      [randomWallet1, randomWallet2],
+      {
+        notification: {
+          title: 'test',
+          body: 'test',
+        },
+      }
+    );
+    if (showAPIResponse) {
+      console.log(broadcastNotif, targetedNotif, subsetNotif);
+    }
+    console.log('PushAPI.channel.send | Response - 200 OK\n\n');
+  } else {
+    console.log(
+      'skipping PushAPI.channel.send as no channel exists with the signer\n\n'
+    );
+  }
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  // These Examples requires wallet to hold some ETH & PUSH
+  const balance = await provider.getBalance(signer.address);
+  if (parseFloat(ethers.utils.formatEther(balance)) < 0.001) {
+    console.log(
+      'skipping PushAPI.channel examples, wallet does not have enough balance to pay fee'
+    );
+  }
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.create');
+  if (channelInfo) {
+    console.log('skipping PushAPI.channel.create as it already exists\n\n');
+  } else {
+    const createdChannel = await userAlice.channel.create({
+      name: 'Test Channel',
+      description: 'Test Description',
+      icon: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAz0lEQVR4AcXBsU0EQQyG0e+saWJ7oACiKYDMEZVs6GgSpC2BIhzRwAS0sgk9HKn3gpFOAv3v3V4/3+4U4Z1q5KTy42Ql940qvFONnFSGmCFmiN2+fj7uCBlihpgh1ngwcvKfwjuVIWaIGWKNB+GdauSk8uNkJfeNKryzYogZYoZY40m5b/wlQ8wQM8TayMlKeKcaOVkJ71QjJyuGmCFmiDUe+HFy4VyEd57hx0mV+0ZliBlihlgL71w4FyMnVXhnZeSkiu93qheuDDFDzBD7BcCyMAOfy204AAAAAElFTkSuQmCC',
+      url: 'https://push.org',
+    });
+    if (showAPIResponse) {
+      console.log(createdChannel);
+    }
+    console.log('PushAPI.channel.create | Response - 200 OK\n\n');
+  }
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.update');
+  const updatedChannel = await userAlice.channel.update({
+    name: 'Updated Name',
+    description: 'Testing new description',
+    url: 'https://google.com',
+    icon: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAz0lEQVR4AcXBsU0EQQyG0e+saWJ7oACiKYDMEZVs6GgSpC2BIhzRwAS0sgk9HKn3gpFOAv3v3V4/3+4U4Z1q5KTy42Ql940qvFONnFSGmCFmiN2+fj7uCBlihpgh1ngwcvKfwjuVIWaIGWKNB+GdauSk8uNkJfeNKryzYogZYoZY40m5b/wlQ8wQM8TayMlKeKcaOVkJ71QjJyuGmCFmiDUe+HFy4VyEd57hx0mV+0ZliBlihlgL71w4FyMnVXhnZeSkiu93qheuDDFDzBD7BcCyMAOfy204AAAAAElFTkSuQmCC',
+  });
+  if (showAPIResponse) {
+    console.log(updatedChannel);
+  }
+  console.log('PushAPI.channel.update | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.verify');
+  // only verified channels can verify other channels (otherwise this action is skipped by sdk)
+  if (channelInfo.verified_status) {
+    const verifiedTrx = await userAlice.channel.verify(
+      '0x35B84d6848D16415177c64D64504663b998A6ab4'
+    );
+    if (showAPIResponse) {
+      console.log(verifiedTrx);
+    }
+  }
+  console.log('PushAPI.channel.verify | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.setting');
+  const channelSettingTrx = await userAlice.channel.setting([
+    { type: 0, default: 1, description: 'My Notif Settings' },
+  ]);
+  if (showAPIResponse) {
+    console.log(channelSettingTrx);
+  }
+  console.log('PushAPI.channel.setting | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.delegate.add');
+  const addedDelegate = await userAlice.channel.delegate.add(
+    `eip155:5:${randomWallet1}`
+  );
+
+  if (showAPIResponse) {
+    console.log(addedDelegate);
+  }
+  console.log('PushAPI.channel.delegate.add | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.delegate.get');
+  const delegates = await userAlice.channel.delegate.get();
+  if (showAPIResponse) {
+    console.log(delegates);
+  }
+  console.log('PushAPI.channel.delegate.get | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.delegate.remove');
+  const removedDelegate = await userAlice.channel.delegate.remove(
+    `eip155:5:${randomWallet1}`
+  );
+  if (showAPIResponse) {
+    console.log(removedDelegate);
+  }
+  console.log('PushAPI.channel.delegate.remove | Response - 200 OK\n\n');
+  // -------------------------------------------------------------------
+  // -------------------------------------------------------------------
+  console.log('PushAPI.channel.alias.info');
+  const aliasInfo = await userAlice.channel.alias.info({
+    alias: '0x35B84d6848D16415177c64D64504663b998A6ab4',
+    aliasChain: 'POLYGON',
+  });
+  if (showAPIResponse) {
+    console.log(aliasInfo);
+  }
+  console.log('PushAPI.channel.alias.info | Response - 200 OK\n\n');
+};