Skip to content

1582 v3 for subscribe #1342

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

Open
akp111 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

1582 v3 for subscribe #1342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2254062
fix: added sub/unsub v3
akp111 Jun 5, 2024
c03c161
fix: fixed export
akp111 Jun 6, 2024
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
2 changes: 2 additions & 0 deletions packages/restapi/src/lib/channels/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ export * from './subscribe';
export * from './subscribeV2';
export * from './unsubscribe';
export * from './unsubscribeV2';
export {subscribeV3} from "./subscribeV3";
export {unsubscribeV3} from "./unsubscribeV3";

26 changes: 26 additions & 0 deletions packages/restapi/src/lib/channels/signature.helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,32 @@ export const getSubscriptionMessageV2 = (
}
};

export const getSubscriptionMessageV3 = (
channel: string,
userAddress: string,
action: channelActionType,
userSetting?: string | null
) => {
const actionTypeKey =
action === 'Unsubscribe' ? 'unsubscriber' : 'subscriber';
if (action == 'Subscribe') {
return JSON.stringify({
channel,
[actionTypeKey]: userAddress,
action: action,
userSetting: userSetting?? '',
timestamp: Math.floor(Date.now() / 1000),
}, null, 4);
} else {
return JSON.stringify({
channel,
[actionTypeKey]: userAddress,
action: action,
timestamp: Math.floor(Date.now() / 1000),
}, null, 4);
}
};

export const getTypeInformation = (action: string) => {
if (action === 'Subscribe') {
return {
Expand Down
106 changes: 106 additions & 0 deletions packages/restapi/src/lib/channels/subscribeV3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
import { getCAIPAddress, getConfig, getCAIPDetails, Signer } from '../helpers';
import {
getDomainInformation,
getTypeInformationV2,
getSubscriptionMessageV3,
} from './signature.helpers';
import Constants, { ENV } from '../constants';
import { SignerType } from '../types';
import { axiosPost } from '../utils/axiosUtil';

export type SubscribeOptionsV2Type = {
signer: SignerType;
channelAddress: string;
userAddress: string;
settings?: string | null;
verifyingContractAddress?: string;
env?: ENV;
origin?: string;
onSuccess?: () => void;
onError?: (err: Error) => void;
};

export const subscribeV3 = async (options: SubscribeOptionsV2Type) => {
const {
signer,
channelAddress,
userAddress,
settings = undefined,
verifyingContractAddress,
env = Constants.ENV.PROD,
origin,
onSuccess,
onError,
} = options || {};
try {
const _channelAddress = await getCAIPAddress(
env,
channelAddress,
'Channel'
);

const channelCAIPDetails = getCAIPDetails(_channelAddress);
if (!channelCAIPDetails) throw Error('Invalid Channel CAIP!');

const chainId = parseInt(channelCAIPDetails.networkId, 10);

const _userAddress = await getCAIPAddress(env, userAddress, 'User');

const userCAIPDetails = getCAIPDetails(_userAddress);
if (!userCAIPDetails) throw Error('Invalid User CAIP!');

const { API_BASE_URL, EPNS_COMMUNICATOR_CONTRACT } = getConfig(
env,
channelCAIPDetails
);

const requestUrl = `${API_BASE_URL}/v1/channels/${_channelAddress}/subscribe`;
// get domain information
const domainInformation = getDomainInformation(
chainId,
verifyingContractAddress || EPNS_COMMUNICATOR_CONTRACT
);

// get type information
const typeInformation = getTypeInformationV2();

// get message
const messageInformation = {
data: getSubscriptionMessageV3(
channelCAIPDetails.address,
userCAIPDetails.address,
'Subscribe',
settings
),
};
// sign a message using EIP712
const pushSigner = new Signer(signer);
const signature = await pushSigner.signTypedData(
domainInformation,
typeInformation,
messageInformation,
'Data'
);

const verificationProof = signature; // might change

const body = {
verificationProof: `eip712v3:${verificationProof}`,
message: messageInformation.data,
origin: origin
};

const res = await axiosPost(requestUrl, body);

if (typeof onSuccess === 'function') onSuccess();

return { status: res.status, message: 'successfully opted into channel' };
} catch (err: any) {
if (typeof onError === 'function') onError(err as Error);

return {
status: err?.response?.status ?? '',
message: err instanceof Error ? err.message : JSON.stringify(err),
};
}
};
103 changes: 103 additions & 0 deletions packages/restapi/src/lib/channels/unsubscribeV3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
import { getCAIPAddress, getConfig, getCAIPDetails, Signer } from '../helpers';
import {
getDomainInformation,
getTypeInformationV2,
getSubscriptionMessageV3,
} from './signature.helpers';
import Constants, { ENV } from '../constants';
import { SignerType } from '../types';
import { axiosPost } from '../utils/axiosUtil';

export type UnSubscribeOptionsV2Type = {
signer: SignerType;
channelAddress: string;
userAddress: string;
verifyingContractAddress?: string;
env?: ENV;
onSuccess?: () => void;
onError?: (err: Error) => void;
};

export const unsubscribeV3 = async (options: UnSubscribeOptionsV2Type) => {
const {
signer,
channelAddress,
userAddress,
verifyingContractAddress,
env = Constants.ENV.PROD,
onSuccess,
onError,
} = options || {};

try {
const _channelAddress = await getCAIPAddress(
env,
channelAddress,
'Channel'
);

const channelCAIPDetails = getCAIPDetails(_channelAddress);
if (!channelCAIPDetails) throw Error('Invalid Channel CAIP!');

const chainId = parseInt(channelCAIPDetails.networkId, 10);

const _userAddress = await getCAIPAddress(env, userAddress, 'User');

const userCAIPDetails = getCAIPDetails(_userAddress);
if (!userCAIPDetails) throw Error('Invalid User CAIP!');

const { API_BASE_URL, EPNS_COMMUNICATOR_CONTRACT } = getConfig(
env,
channelCAIPDetails
);

const requestUrl = `${API_BASE_URL}/v1/channels/${_channelAddress}/unsubscribe`;

// get domain information
const domainInformation = getDomainInformation(
chainId,
verifyingContractAddress || EPNS_COMMUNICATOR_CONTRACT
);

// get type information
const typeInformation = getTypeInformationV2();

// get message
const messageInformation = {
data: getSubscriptionMessageV3(
channelCAIPDetails.address,
userCAIPDetails.address,
'Unsubscribe'
),
};

// sign a message using EIP712
const pushSigner = new Signer(signer);
const signature = await pushSigner.signTypedData(
domainInformation,
typeInformation,
messageInformation,
'Data'
);

const verificationProof = signature; // might change

const body = {
verificationProof: `eip712v3:${verificationProof}`,
message: messageInformation.data,
};

const res = await axiosPost(requestUrl, body);

if (typeof onSuccess === 'function') onSuccess();

return { status: res.status, message: 'successfully opted out channel' };
} catch (err: any) {
if (typeof onError === 'function') onError(err as Error);

return {
status: err?.response?.status ?? '',
message: err instanceof Error ? err.message : JSON.stringify(err),
};
}
};
4 changes: 2 additions & 2 deletions packages/restapi/src/lib/pushNotification/notification.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ export class Notification extends PushNotificationBaseClass {
);
// convert the setting to minimal version
const minimalSetting = this.getMinimalUserSetting(settings!);
return await PUSH_CHANNEL.subscribeV2({
return await PUSH_CHANNEL.subscribeV3({
signer: this.signer!,
channelAddress: channel,
userAddress: userAddressInCaip,
Expand Down Expand Up @@ -218,7 +218,7 @@ export class Notification extends PushNotificationBaseClass {
this.account!,
parseInt(caipDetail?.networkId as string)
);
return await PUSH_CHANNEL.unsubscribeV2({
return await PUSH_CHANNEL.unsubscribeV3({
signer: this.signer!,
channelAddress: channel,
userAddress: userAddressInCaip,
Expand Down