@xyo-network/sdk-protocol

@xyo-network/sdk-protocol

Foundation SDK thin facade for XYO Protocol 2.0 — protocol, core payload plugins, manifest, and sdk-utils.

Thin facade

@xyo-network/sdk-protocol is a thin compatibility facade over @xyo-network/sdk-protocol-core. Its dist/ contains pure package re-exports; the two hash worker bundles are copied byte-for-byte from the core package. Shared externals (ethers, @ariestools/sdk, zod, etc.) remain peerDependencies.

Import the whole SDK:

import { ObjectHasher } from '@xyo-network/sdk-protocol'

...or a foundation package via subpath export:

import { PayloadPlugins } from '@xyo-network/sdk-protocol/core-payload-plugins'
import { Api } from '@xyo-network/sdk-protocol/sdk-utils'
import { PayloadSchema } from '@xyo-network/sdk-protocol/payload-model'

Compilation is handled by the @ariestools/toolchain monolith facade mode configured in xy.config.ts. The facade modules mirror the core package's public module manifest, with export-parity tests preventing drift. Workspace dependency ordering builds the core package before the facade copies its worker outputs:

pnpm xy build                           # builds the core package and facade
pnpm xy build @xyo-network/sdk-protocol # builds the facade from current core dist

Consumers can import from @xyo-network/sdk-protocol, one of its subpaths, or the individual @xyo-network/* foundation packages directly.

Payload schema contracts

The core SDK contract defines schema identifier grammar, $version encoding and compatibility, object closure, typed validation, and the root-hash default for application identities. This facade exports the core helpers; see that document before introducing or revising a payload type. Existing protocol-specific data-hash contracts remain unchanged unless explicitly migrated.

Install

Using npm:

npm install @xyo-network/sdk-protocol

Using yarn:

yarn add @xyo-network/sdk-protocol

Using pnpm:

pnpm add @xyo-network/sdk-protocol

Using bun:

bun add @xyo-network/sdk-protocol

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Credits

Made with 🔥 and ❄️ by XYO Foundation