@avarok/citadel-protocol型号

Citadel 协议的 TypeScript 类型定义,由 Rust 类型自动生成.

安装

npm install @avarok/citadel-protocol-types

版本函数

从程序上获取协议和 SDK 版本 :

import { protocol_version, sdk_version } from '@avarok/citadel-protocol-types';

console.log(`Protocol version: ${protocol_version()}`);  // e.g., "0.9.0"
console.log(`SDK version: ${sdk_version()}`);            // e.g., "0.14.0"

使用量

import {
  ConnectMode,
  SecurityLevel,
  UserIdentifier,
  MutualPeer,
  CryptoParameters,
  ClientConnectionType,
  PeerConnectionType,
  VirtualConnectionType,
  Error as CitadelError
} from '@avarok/citadel-protocol-types';

// Use the types in your TypeScript code
const peer: MutualPeer = {
  parent_icid: 12345n,
  cid: 67890n,
  username: "alice"
};

const securityLevel: SecurityLevel = "High";

// Connection types for C2S and P2P connections
const c2sConnection: ClientConnectionType = {
  Server: { session_cid: 12345n }
};

const p2pConnection: PeerConnectionType = {
  LocalGroupPeer: { session_cid: 12345n, peer_cid: 67890n }
};

可用类型

版本函数

• protocol_version() - 返回Citadel协议版本
• sdk_version() - 返回Citadel SDK版本

用户类型

• MutualPeer
• PeerInfo
• UserIdentifier

连接类型

• ClientConnectionType - C2S连接变体(Server,扩展)
• PeerConnectionType - P2P 连接变体( LocalGroupPeer, 外部GroupPeer)
• VirtualConnectionType - 用于路由的统一连接类型

协议类型

• ConnectMode
• VirtualObjectMetadata
• ObjectId
• ObjectTransferOrientation
• ObjectTransferStatus
• SessionSecuritySettings
• UdpMode
• MemberState
• GroupMemberAlterMode
• MessageGroupOptions
• GroupType
• MessageGroupKey
• TransferType

加密类型

• CryptoParameters
• EncryptionAlgorithm
• SecrecyMode
• KemAlgorithm
• SigAlgorithm
• SecurityLevel
• HeaderObfuscatorSettings
• PreSharedKey

错误类型

• Error - Citadel 协议的主要出错类型

重生类型

要从 Rust 源头重生类型 :

cd ../citadel_types
cargo run --bin export_ts --features typescript

然后重建 TypeScript 库:

npm run build

链接

• Citadel 协议 GitHub
• 阿瓦罗克网络安全

许可证

麻省理工学院或阿帕奇2.0