npm.io
7.3.3 • Published 22h ago

@xyo-network/sdk-protocol

Licence
LGPL-3.0-only
Version
7.3.3
Deps
1
Size
399 kB
Vulns
0
Weekly
0

logo

@xyo-network/sdk-protocol

npm license

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.

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