[![logo][]](https://xyo.network)

# @xyo-network/sdk-protocol

[![npm][npm-badge]][npm-link]
[![license][license-badge]][license-link]

> 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:

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

...or a foundation package via subpath export:

```ts
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`](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:

```sh
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.

## Install

Using npm:

```sh
npm install @xyo-network/sdk-protocol
```

Using yarn:

```sh
yarn add @xyo-network/sdk-protocol
```

Using pnpm:

```sh
pnpm add @xyo-network/sdk-protocol
```

Using bun:

```sh
bun add @xyo-network/sdk-protocol
```


## License

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

## Credits

[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)

[npm-badge]: https://img.shields.io/npm/v/@xyo-network/sdk-protocol.svg
[npm-link]: https://www.npmjs.com/package/@xyo-network/sdk-protocol
[license-badge]: https://img.shields.io/npm/l/@xyo-network/sdk-protocol.svg
[license-link]: https://github.com/XYOracleNetwork/sdk-protocol-js/blob/main/LICENSE
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png