@xyo-network/sdk 2.102.4 → 7.0.3

package/README.md

@@ -1,13 +1,57 @@
 [![logo][]](https://xyo.network)
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
+# @xyo-network/sdk
+
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Self-contained all-in-one SDK for XYO Protocol 2.0 — foundation + modules runtime. The legacy `@xyo-network/sdk-js` package re-exports this package for backward compatibility.
+
+## Self-contained build
+
+Unlike a traditional barrel that declares every child package as a runtime dependency,
+`@xyo-network/sdk` is **self-contained**: its published `dist/` vendors the compiled output
+of each `@xyo-network/*` package in the closure (under `dist/_pkg/`), with cross-package
+imports rewritten to relative paths. At runtime it depends only on real externals (`ethers`,
+`@xylabs/sdk`, `zod`, etc.), declared as `peerDependencies`.
+
+Import the whole SDK:
+
+```ts
+import { MemoryArchivist } from '@xyo-network/sdk'
+```
+
+…or a group via subpath export:
+
+```ts
+import { Archivist } from '@xyo-network/sdk/archivist'
+import { ObjectHasher } from '@xyo-network/sdk/protocol'
+```
+
+The vendoring is performed by [`scripts/populate-dist.mjs`](scripts/populate-dist.mjs),
+wired into the toolchain via a local **`package-compile`** script in `package.json`.
+
+```sh
+pnpm xy build                           # compiles all packages, then vendors the barrel
+pnpm xy build @xyo-network/sdk          # vendors using already-compiled child dist
+```
+
+## Install
+
+```sh
+npm install @xyo-network/sdk
+```
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
 ## Credits
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
+[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
 
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/sdk.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/sdk
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/sdk.svg
+[license-link]: https://github.com/XYOracleNetwork/sdk-xyo-client-js/blob/main/LICENSE
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/_pkg/account/neutral/Account.d.ts

@@ -0,0 +1,37 @@
+import type { Hash } from '@xylabs/sdk';
+import type { AccountAlgorithm, AccountConfig, AccountInstance, JwtParts, SignJwtOptions, SignJwtResult, VerifyJwtOptions, VerifyJwtResult } from '../../account-model/neutral/index.ts';
+import type { XyoAddress } from '../../address/neutral/index.ts';
+import type { PrivateKeyInstance, PublicKeyInstance } from '../../key-model/neutral/index.ts';
+import type { PreviousHashStore } from '../../previous-hash-store-model/neutral/index.ts';
+import { HDNodeWallet } from 'ethers';
+import { EllipticKey } from './Key/index.ts';
+export declare class Account extends EllipticKey implements AccountInstance {
+    static previousHashStore: PreviousHashStore | undefined;
+    static readonly uniqueName: string;
+    protected static _addressMap: Record<string, WeakRef<AccountInstance>>;
+    protected static _protectedConstructorKey: symbol;
+    private readonly _privateKey;
+    private readonly _signingMutex;
+    protected _node: HDNodeWallet | undefined;
+    protected _previousHash?: ArrayBufferLike;
+    readonly algorithm: AccountAlgorithm;
+    protected constructor(key: unknown, privateKey: PrivateKeyInstance, node?: HDNodeWallet);
+    static create(opts?: AccountConfig): Promise<AccountInstance>;
+    static decodeJwt(token: string): JwtParts;
+    static fromPrivateKey(key: ArrayBufferLike | bigint | string): Promise<AccountInstance>;
+    static isAddress(address: XyoAddress): boolean;
+    static random(): Promise<AccountInstance>;
+    static verifyJwt(token: string, options?: VerifyJwtOptions): Promise<VerifyJwtResult>;
+    get address(): XyoAddress;
+    get addressBytes(): ArrayBufferLike;
+    get previousHash(): import("@xylabs/sdk").BrandedHash | undefined;
+    get previousHashBytes(): ArrayBufferLike | undefined;
+    get private(): PrivateKeyInstance;
+    get public(): PublicKeyInstance;
+    initialize(): Promise<this>;
+    loadPreviousHash(previousHash?: ArrayBufferLike | string): Promise<this>;
+    sign(hash: ArrayBufferLike, previousHash: ArrayBufferLike | undefined): Promise<[ArrayBufferLike, Hash?]>;
+    signJwt(options: SignJwtOptions): Promise<SignJwtResult>;
+    verify(msg: ArrayBufferLike, signature: ArrayBufferLike): Promise<boolean>;
+    verifyUniqueAddress(): AccountInstance | this;
+}

package/dist/_pkg/account/neutral/Jwt/base64url.d.ts

@@ -0,0 +1,4 @@
+export declare function base64urlEncode(bytes: Uint8Array): string;
+export declare function base64urlDecode(value: string): Uint8Array;
+export declare function base64urlEncodeJson(value: unknown): string;
+export declare function base64urlDecodeJson<T>(value: string): T;

package/dist/_pkg/account/neutral/Jwt/createJwt.d.ts

@@ -0,0 +1,2 @@
+import type { AccountInstance, SignJwtOptions, SignJwtResult } from '../../../account-model/neutral/index.ts';
+export declare function createJwt(account: AccountInstance, options: SignJwtOptions): Promise<SignJwtResult>;

package/dist/_pkg/account/neutral/Jwt/decodeJwt.d.ts

@@ -0,0 +1,2 @@
+import type { JwtParts } from '../../../account-model/neutral/index.ts';
+export declare function decodeJwt(token: string): JwtParts;

package/dist/_pkg/account/neutral/Jwt/digest.d.ts

@@ -0,0 +1,3 @@
+export declare function sha256Bytes(input: Uint8Array): Uint8Array;
+export declare function stripHexPrefix(value: string): string;
+export declare function normalizeAddress(value: string): string;

package/dist/_pkg/account/neutral/Jwt/index.d.ts

@@ -0,0 +1,5 @@
+export * from './base64url.ts';
+export * from './createJwt.ts';
+export * from './decodeJwt.ts';
+export * from './digest.ts';
+export * from './verifyJwt.ts';

package/dist/_pkg/account/neutral/Jwt/verifyJwt.d.ts

@@ -0,0 +1,2 @@
+import type { VerifyJwtOptions, VerifyJwtResult } from '../../../account-model/neutral/index.ts';
+export declare function verifyJwt(token: string, options?: VerifyJwtOptions): Promise<VerifyJwtResult>;

package/dist/_pkg/account/neutral/Key/AddressValue.d.ts

@@ -0,0 +1,10 @@
+import type { AddressValueInstance } from '../../../key-model/neutral/index.ts';
+import { EllipticKey } from './EllipticKey.ts';
+export declare class AddressValue extends EllipticKey implements AddressValueInstance {
+    private _isAddress;
+    constructor(address: ArrayBufferLike);
+    static addressFromAddressOrPublicKey(bytes: ArrayBufferLike): ArrayBufferLike;
+    static addressFromPublicKey(key: ArrayBufferLike): ArrayBufferLike;
+    static initialize(): Promise<boolean>;
+    static isAddress(value: unknown): boolean;
+}

package/dist/_pkg/account/neutral/Key/EllipticKey.d.ts

@@ -0,0 +1,3 @@
+import { Data } from '../../../data/neutral/index.ts';
+export declare class EllipticKey extends Data {
+}

package/dist/_pkg/account/neutral/Key/PrivateKey.d.ts

@@ -0,0 +1,13 @@
+import type { PrivateKeyInstance, PublicKeyInstance } from '../../../key-model/neutral/index.ts';
+import { EllipticKey } from './EllipticKey.ts';
+export declare class PrivateKey extends EllipticKey implements PrivateKeyInstance {
+    protected static privateConstructorKey: string;
+    protected _isPrivateKey: boolean;
+    protected _public: PublicKeyInstance;
+    protected constructor(privateConstructorKey: string, value: ArrayBufferLike, publicKey: PublicKeyInstance);
+    static create(value: ArrayBufferLike | bigint): Promise<PrivateKey>;
+    static isPrivateKey(value: unknown): boolean;
+    get public(): PublicKeyInstance;
+    sign(hash: ArrayBufferLike): Promise<ArrayBufferLike>;
+    verify(msg: ArrayBufferLike, signature: ArrayBufferLike): Promise<boolean>;
+}

package/dist/_pkg/account/neutral/Key/PublicKey.d.ts

@@ -0,0 +1,13 @@
+import type { AddressValueInstance, PublicKeyInstance } from '../../../key-model/neutral/index.ts';
+import { EllipticKey } from './EllipticKey.ts';
+export declare class PublicKey extends EllipticKey implements PublicKeyInstance {
+    protected static privateConstructorKey: string;
+    private _address;
+    private _isPublicKey;
+    protected constructor(privateConstructorKey: string, bytes: ArrayBufferLike);
+    static create(bytes: ArrayBufferLike): Promise<PublicKey>;
+    static fromPrivate(bytes: ArrayBufferLike | bigint): Promise<PublicKeyInstance>;
+    static isPublicKey(value: unknown): boolean;
+    get address(): AddressValueInstance;
+    verify(msg: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
+}

package/dist/_pkg/account/neutral/Key/index.d.ts

@@ -0,0 +1,4 @@
+export * from './AddressValue.ts';
+export * from './EllipticKey.ts';
+export * from './PrivateKey.ts';
+export * from './PublicKey.ts';

package/dist/_pkg/account/neutral/index.d.ts

@@ -0,0 +1,5 @@
+import './register.ts';
+export * from './Account.ts';
+export * from './Jwt/index.ts';
+export * from './Key/index.ts';
+export * from './lib/index.ts';