Mark error context and objects inside those contexts as read-only

Author: steveluscher

packages/errors/src/__tests__/error-test.ts

@@ -1,3 +1,5 @@
+import '@solana/test-matchers/toBeFrozenObject';
+
 import { isSolanaError, SolanaError } from '../error';
 import { getErrorMessage } from '../message-formatter';
 
@@ -25,6 +27,9 @@ describe('SolanaError', () => {
         it('calls the message formatter with the code and context', () => {
             expect(getErrorMessage).toHaveBeenCalledWith(123, expect.objectContaining({ foo: 'bar' }));
         });
+        it('freezes the context object', () => {
+            expect(errorWithContext.context).toBeFrozenObject();
+        });
     });
     describe('given an error with no context', () => {
         beforeEach(() => {

packages/errors/src/__typetests__/error-typetest.ts

@@ -39,11 +39,17 @@ if (unknownError.context.__code === SOLANA_ERROR__TRANSACTION__SIGNATURES_MISSIN
 const e = null as unknown;
 if (isSolanaError(e)) {
     e.context satisfies Readonly<{ __code: SolanaErrorCode }>;
+    // @ts-expect-error Code is read-only
+    e.context.__code = SOLANA_ERROR__TRANSACTION__FEE_PAYER_SIGNATURE_MISSING;
 }
 if (isSolanaError(e, SOLANA_ERROR__TRANSACTION__SIGNATURES_MISSING)) {
     e.context satisfies SolanaErrorContext[typeof SOLANA_ERROR__TRANSACTION__SIGNATURES_MISSING];
     // @ts-expect-error Context belongs to another error code
     e.context satisfies SolanaErrorContext[typeof SOLANA_ERROR__TRANSACTION__FEE_PAYER_SIGNATURE_MISSING];
+    // @ts-expect-error Context is read-only
+    e.context.addresses = [] as unknown as typeof e.context.addresses;
+    // @ts-expect-error Objects in context are read-only
+    e.context.addresses.push('abc' as unknown as (typeof e.context.addresses)[number]);
 }
 
 // `SolanaErrorContext` must not contain any keys reserved by `ErrorOptions` (eg. `cause`)