Skip to content

feat: Added new setOwner method to establish connection before initialization of the owner #509

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

Draft
roman-nazaruk wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat: Added new setOwner method to establish connection before initialization of the owner #509

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
acf800e
feat: Added new setOwner method to establish connection before initia…
roman-nazaruk Mar 14, 2025
3f7bfa8
Fixed formating
roman-nazaruk Mar 14, 2025
b89b06b
Merge branch 'main' into feat/added-setOwner-method
Mar 25, 2025
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
134 changes: 107 additions & 27 deletions src/signer.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import {IcrcPermissionStateSchema, type IcrcScopedMethod} from './types/icrc-sta
import type {Origin} from './types/post-message';
import {JSON_RPC_VERSION_2} from './types/rpc';
import type {SignerMessageEventData} from './types/signer';
import type {SignerOptions} from './types/signer-options';
import type {IdentityNotAnonymous, SignerInitOptions} from './types/signer-options';
import {
AccountsPromptSchema,
CallCanisterPromptSchema,
Expand All @@ -59,15 +59,15 @@ import {mapIcrc21ErrorToString} from './utils/icrc-21.utils';
import {del, get} from './utils/storage.utils';

describe('Signer', () => {
const owner = Ed25519KeyIdentity.generate();
const owner: IdentityNotAnonymous = Ed25519KeyIdentity.generate();

const signerOptions: SignerOptions = {
owner,
const signerOptions: SignerInitOptions = {
host: 'http://localhost:4943'
};

it('should init a signer', () => {
const signer = Signer.init(signerOptions);
signer.setOwner({owner});
expect(signer).toBeInstanceOf(Signer);
signer.disconnect();
});
Expand All @@ -76,6 +76,7 @@ describe('Signer', () => {
const addEventListenerSpy = vi.spyOn(window, 'addEventListener');

const signer = Signer.init(signerOptions);
signer.setOwner({owner});
expect(addEventListenerSpy).toHaveBeenCalledWith('message', expect.any(Function));
signer.disconnect();
});
Expand All @@ -84,6 +85,7 @@ describe('Signer', () => {
const removeEventListenerSpy = vi.spyOn(window, 'removeEventListener');

const signer = Signer.init(signerOptions);
signer.setOwner({owner});
signer.disconnect();

expect(removeEventListenerSpy).toHaveBeenCalledWith('message', expect.any(Function));
Expand All @@ -93,6 +95,7 @@ describe('Signer', () => {
const removeEventListenerSpy = vi.spyOn(window, 'removeEventListener');

const signer = Signer.init(signerOptions);
signer.setOwner({owner});
signer.disconnect();

expect(removeEventListenerSpy).toHaveBeenCalledWith('message', expect.any(Function));
Expand All @@ -110,6 +113,7 @@ describe('Signer', () => {

beforeEach(() => {
signer = Signer.init(signerOptions);
signer.setOwner({owner});
onMessageListenerSpy = vi.spyOn(signer as unknown as {onMessage: () => void}, 'onMessage');
});

Expand Down Expand Up @@ -163,6 +167,7 @@ describe('Signer', () => {

beforeEach(() => {
signer = Signer.init(signerOptions);
signer.setOwner({owner});
notifyReadySpy = vi.spyOn(signerSuccessHandlers, 'notifyReady');
postMessageMock = vi.fn();
vi.stubGlobal('opener', {postMessage: postMessageMock});
Expand Down Expand Up @@ -387,6 +392,7 @@ describe('Signer', () => {

beforeEach(() => {
signer = Signer.init(signerOptions);
signer.setOwner({owner});
});

afterEach(() => {
Expand Down Expand Up @@ -655,7 +661,7 @@ describe('Signer', () => {
});

it('should notify permissions already confirmed and saved in local storage for icrc25_permissions plus default permissions with ask_on_use', () => {
const owner = signerOptions.owner.getPrincipal();
const ownerIdentity = owner.getPrincipal();

const scopes: IcrcScopesArray = [
{
Expand All @@ -667,7 +673,7 @@ describe('Signer', () => {
];

saveSessionScopes({
owner,
owner: ownerIdentity,
origin: testOrigin,
scopes
});
Expand All @@ -691,11 +697,11 @@ describe('Signer', () => {
testOrigin
);

del({key: `oisy_signer_${testOrigin}_${owner.toText()}`});
del({key: `oisy_signer_${testOrigin}_${ownerIdentity.toText()}`});
});

it('should notify permissions as ask_on_use if expired plus default permissions with ask_on_use as well', () => {
const owner = signerOptions.owner.getPrincipal();
const owner = Ed25519KeyIdentity.generate().getPrincipal();

const scopes: IcrcScopesArray = [
{
Expand Down Expand Up @@ -1030,7 +1036,7 @@ describe('Signer', () => {
];

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes
});
Expand Down Expand Up @@ -1096,7 +1102,7 @@ describe('Signer', () => {
];

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes
});
Expand Down Expand Up @@ -1224,7 +1230,7 @@ describe('Signer', () => {
];

afterEach(() => {
del({key: `oisy_signer_${testOrigin}_${signerOptions.owner.getPrincipal().toText()}`});
del({key: `oisy_signer_${testOrigin}_${owner.getPrincipal().toText()}`});
});

describe.each(testParams)('$method', ({method, requestData}) => {
Expand Down Expand Up @@ -1289,7 +1295,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -1376,7 +1382,7 @@ describe('Signer', () => {

await vi.waitFor(() => {
const storedScopes: SessionPermissions | undefined = get({
key: `oisy_signer_${testOrigin}_${signerOptions.owner.getPrincipal().toText()}`
key: `oisy_signer_${testOrigin}_${owner.getPrincipal().toText()}`
});

expect(storedScopes).not.toBeUndefined();
Expand Down Expand Up @@ -1518,7 +1524,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -1624,7 +1630,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -1836,7 +1842,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -1886,7 +1892,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -1964,7 +1970,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -2025,7 +2031,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -2102,7 +2108,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -2141,7 +2147,7 @@ describe('Signer', () => {
});

saveSessionScopes({
owner: signerOptions.owner.getPrincipal(),
owner: owner.getPrincipal(),
origin: testOrigin,
scopes: [
{
Expand Down Expand Up @@ -2191,6 +2197,7 @@ describe('Signer', () => {

expect(spyCanisterCall).toHaveBeenCalledWith({
...signerOptions,
owner,
params: {
...mockCallCanisterParams,
sender: owner.getPrincipal().toText()
Expand Down Expand Up @@ -2229,6 +2236,7 @@ describe('Signer', () => {

expect(spyCanisterCall).toHaveBeenCalledWith({
...signerOptions,
owner,
params: {
...mockCallCanisterParams,
sender: owner.getPrincipal().toText()
Expand Down Expand Up @@ -2401,7 +2409,7 @@ describe('Signer', () => {
it('should save permissions in storage', async () => {
payload.confirm(scopes);

const expectedKey = `oisy_signer_${testOrigin}_${signerOptions.owner.getPrincipal().toText()}`;
const expectedKey = `oisy_signer_${testOrigin}_${owner.getPrincipal().toText()}`;
const expectedData = {
scopes: scopes.map((scope) => ({
...scope,
Expand Down Expand Up @@ -2433,6 +2441,7 @@ describe('Signer', () => {
sessionPermissionExpirationInMilliseconds
}
});
signerWithOptions.setOwner({owner});
});

afterEach(() => {
Expand All @@ -2451,7 +2460,7 @@ describe('Signer', () => {
});

describe('Permissions', () => {
const owner = signerOptions.owner.getPrincipal();
const ownerIdentity = owner.getPrincipal();

const scopes: IcrcScopesArray = [
{
Expand All @@ -2464,7 +2473,7 @@ describe('Signer', () => {

it('should notify permissions granted if still not expired', () => {
saveSessionScopes({
owner,
owner: ownerIdentity,
origin: testOrigin,
scopes
});
Expand All @@ -2490,12 +2499,12 @@ describe('Signer', () => {
testOrigin
);

del({key: `oisy_signer_${testOrigin}_${owner.toText()}`});
del({key: `oisy_signer_${testOrigin}_${ownerIdentity.toText()}`});
});

it('should notify expired permissions with ask_on_use', () => {
saveSessionScopes({
owner,
owner: ownerIdentity,
origin: testOrigin,
scopes
});
Expand Down Expand Up @@ -2524,7 +2533,7 @@ describe('Signer', () => {
testOrigin
);

del({key: `oisy_signer_${testOrigin}_${owner.toText()}`});
del({key: `oisy_signer_${testOrigin}_${ownerIdentity.toText()}`});
});
});
});
Expand All @@ -2536,6 +2545,7 @@ describe('Signer', () => {

beforeEach(() => {
signer = Signer.init(signerOptions);
signer.setOwner({owner});
});

afterEach(() => {
Expand Down Expand Up @@ -2619,4 +2629,74 @@ describe('Signer', () => {
);
});
});

describe('should return a NOT_INITIALIZED error when calling owner-dependent methods without an owner', () => {
const signerOptions = {host: 'http://localhost:4943'};
const testOrigin = 'https://hello.com';
const testId = crypto.randomUUID();

const requestAccountsData: IcrcAccountsRequest = {
id: testId,
jsonrpc: JSON_RPC_VERSION_2,
method: ICRC27_ACCOUNTS
};

const requestCallCanisterData: IcrcCallCanisterRequest = {
id: testId,
jsonrpc: JSON_RPC_VERSION_2,
method: ICRC49_CALL_CANISTER,
params: {
...mockCallCanisterParams
}
};

const testParams: Array<{
method: IcrcScopedMethod;
requestData: IcrcAccountsRequest | IcrcCallCanisterRequest | IcrcRequestAnyPermissionsRequest;
}> = [
{method: 'icrc27_accounts', requestData: requestAccountsData},
{method: 'icrc49_call_canister', requestData: requestCallCanisterData}
];

let signer: Signer;
let postMessageMock: MockInstance;

beforeEach(() => {
// Initialize the signer without setting an owner.
signer = Signer.init(signerOptions);
postMessageMock = vi.fn();
vi.stubGlobal('opener', {postMessage: postMessageMock});
});

afterEach(() => {
signer.disconnect();
vi.clearAllMocks();
vi.restoreAllMocks();
});

testParams.forEach(({method, requestData}) => {
it(`should trigger notifyError for ${method} when owner is not set`, async () => {
const messageEvent = new MessageEvent('message', {
data: requestData,
origin: testOrigin
});

window.dispatchEvent(messageEvent);

await vi.waitFor(() => {
expect(postMessageMock).toHaveBeenCalledWith(
{
jsonrpc: JSON_RPC_VERSION_2,
id: testId,
error: {
code: SignerErrorCode.NOT_INITIALIZED,
message: 'The signer does not have an owner set.'
}
},
testOrigin
);
});
});
});
});
});
Loading