Expose certain functions from @stellar/js-xdr so downstream don't need to mix dependencies.

.github/workflows/npm_publish.yml

@@ -33,5 +33,6 @@ jobs:
       - name: Deprecate the old package
         run: |
           npm deprecate stellar-base@"<= 11.0.0" "⚠️ This package has moved to @stellar/stellar-base! 🚚"
+          npm deprecate @stellar/stellar-base@"= 11.1.0" "⚠️ This version contains breaking changes, use v11.0.1 for compatibility or upgrade to v12."
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -3,11 +3,14 @@
 ## Unreleased
 
 
-## [`v11.1.0`](https://github.com/stellar/js-stellar-base/compare/v11.0.1...v11.1.0)
+## [`v12.0.0-rc.1`](https://github.com/stellar/js-stellar-base/compare/v11.0.1...v12.0.0-rc.1)
 
-### Added
+### Breaking Changes
 * The generated XDR has been upgraded to match the upcoming Protocol 21, namely [stellar/stellar-xdr@`1a04392`](https://github.com/stellar/stellar-xdr/commit/1a04392432dacc0092caaeae22a600ea1af3c6a5) ([#738](https://github.com/stellar/js-stellar-base/pull/738)).
 
+### Added
+* To facilitate serialization and deserialization for downstream systems, this package now exports `cereal.XdrWriter` and `cereal.XdrReader` which come directly from `@stellar/js-xdr` ([TODO]()).
+
 ### Fixed
 * Updated various dependencies ([#737](https://github.com/stellar/js-stellar-base/pull/737), [#739](https://github.com/stellar/js-stellar-base/pull/739)).
 

src/index.js

@@ -1,7 +1,9 @@
 /* eslint-disable import/no-import-module-exports */
 import xdr from './xdr';
+import cereal from './jsxdr';
 
 export { xdr };
+export { cereal };
 export { hash } from './hashing';
 export { sign, verify, FastSigning } from './signing';
 export {

src/jsxdr.js

@@ -0,0 +1,4 @@
+import { XdrWriter, XdrReader } from '@stellar/js-xdr';
+
+const cereal = { XdrWriter, XdrReader };
+export default cereal;

test/unit/soroban_test.js

@@ -1,4 +1,9 @@
 describe('Soroban', function () {
+  it('should have XDR serialization', function () {
+    expect(StellarBase.cereal).not.to.be.undefined;
+    console.log(StellarBase.cereal);
+  });
+
   describe('formatTokenAmount', function () {
     const SUCCESS_TEST_CASES = [
       { amount: '1000000001', decimals: 7, expected: '100.0000001' },

types/index.d.ts

@@ -1268,3 +1268,41 @@ export namespace Soroban {
   function formatTokenAmount(address: string, decimals: number): string;
   function parseTokenAmount(value: string, decimals: number): string;
 }
+
+export namespace cereal {
+  // These belong in @stellar/js-xdr but that would be a huge lift since we'd
+  // need types for the whole thing.
+  export class XdrWriter {
+    constructor(buffer?: Buffer|number);
+
+    alloc(size: number): number;
+    resize(minRequiredSize: number): void;
+    finalize(): Buffer;
+    toArray(): number[];
+
+    write(value: Buffer|string, size: number): XdrReader;
+    writeInt32BE(value: number): void;
+    writeUInt32BE(value: number): void;
+    writeBigInt64BE(value: BigInt): void;
+    writeBigUInt64BE(value: BigInt): void;
+    writeFloatBE(value: number): void;
+    writeDoubleBE(value: number): void;
+  }
+
+  export class XdrReader {
+    constructor(data: Buffer);
+
+    eof: boolean;
+    advance(size: number): number;
+    rewind(): void;
+    ensureInputConsumed(): void;
+
+    read(size: number): Buffer;
+    readInt32BE(): number;
+    readUInt32BE(): number;
+    readBigInt64BE(): BigInt;
+    readBigUInt64BE(): BigInt;
+    readFloatBE(): number;
+    readDoubleBE(): number;
+  }
+}