@ghostspeak/sdk 2.0.0 → 2.0.1

package/dist/ipfs-types-KJcvy9Qk.d.ts

@@ -0,0 +1,553 @@
+import { Address, Option, ReadonlyUint8Array } from '@solana/kit';
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Types of execution conditions */
+declare enum ConditionType {
+    TimeDelay = 0,
+    TokenBalance = 1,
+    PriceThreshold = 2,
+    VoteCount = 3,
+    ExternalOracle = 4,
+    CustomLogic = 5
+}
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Vote delegation information */
+type DelegationInfo = {
+    /** Original delegator */
+    delegator: Address;
+    /** Delegation timestamp */
+    delegatedAt: bigint;
+    /** Delegation scope */
+    scope: DelegationScope;
+    /** Delegation expiry */
+    expiresAt: Option<bigint>;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Scope of vote delegation */
+type DelegationScope = {
+    __kind: 'All';
+} | {
+    __kind: 'ProposalType';
+    fields: readonly [ProposalType];
+} | {
+    __kind: 'SingleProposal';
+} | {
+    __kind: 'Limited';
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Execution conditions for transactions */
+type ExecutionCondition = {
+    /** Condition type */
+    conditionType: ConditionType;
+    /** Target value/threshold */
+    targetValue: bigint;
+    /** Current value */
+    currentValue: bigint;
+    /** Condition met */
+    met: boolean;
+    /** Condition description */
+    description: string;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Execution parameters for proposals */
+type ExecutionParams = {
+    /** Instructions to execute if passed */
+    instructions: Array<ProposalInstruction>;
+    /** Time delay before execution */
+    executionDelay: bigint;
+    /** Execution conditions */
+    executionConditions: Array<ExecutionCondition>;
+    /** Can be cancelled after approval */
+    cancellable: boolean;
+    /** Automatic execution enabled */
+    autoExecute: boolean;
+    /** Required execution authority */
+    executionAuthority: Address;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Account specification for proposal instruction */
+type ProposalAccount = {
+    /** Account public key */
+    pubkey: Address;
+    /** Is signer required */
+    isSigner: boolean;
+    /** Is writable */
+    isWritable: boolean;
+    /** Account description */
+    description: string;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Individual instruction in proposal */
+type ProposalInstruction = {
+    /** Target program */
+    programId: Address;
+    /** Accounts required */
+    accounts: Array<ProposalAccount>;
+    /** Instruction data */
+    data: ReadonlyUint8Array;
+    /** Instruction description */
+    description: string;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Proposal metadata */
+type ProposalMetadata = {
+    /** IPFS hash for detailed proposal */
+    ipfsHash: Option<string>;
+    /** External references */
+    externalReferences: Array<string>;
+    /** Proposal tags */
+    tags: Array<string>;
+    /** Risk assessment */
+    riskAssessment: Option<string>;
+    /** Impact analysis */
+    impactAnalysis: Option<string>;
+    /** Implementation timeline */
+    implementationTimeline: Option<string>;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Proposal execution status */
+declare enum ProposalStatus {
+    Draft = 0,
+    Active = 1,
+    Passed = 2,
+    Failed = 3,
+    Executed = 4,
+    Cancelled = 5,
+    Expired = 6,
+    Queued = 7
+}
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Types of governance proposals */
+declare enum ProposalType {
+    ParameterUpdate = 0,
+    ProtocolUpgrade = 1,
+    TreasuryOperation = 2,
+    FeeUpdate = 3,
+    SecurityUpdate = 4,
+    GovernanceUpdate = 5,
+    EmergencyAction = 6,
+    Custom = 7
+}
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Methods for calculating quorum */
+declare enum QuorumMethod {
+    Absolute = 0,
+    Relative = 1,
+    Weighted = 2,
+    Dynamic = 3
+}
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Quorum requirements for proposals */
+type QuorumRequirements = {
+    /** Minimum participation rate (0-100) */
+    minimumParticipation: number;
+    /** Approval threshold (0-100) */
+    approvalThreshold: number;
+    /** Super majority required */
+    superMajorityRequired: boolean;
+    /** Minimum total voting power */
+    minimumVotingPower: bigint;
+    /** Quorum calculation method */
+    quorumMethod: QuorumMethod;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Individual vote record */
+type Vote = {
+    /** Voter public key */
+    voter: Address;
+    /** Vote choice */
+    choice: VoteChoice;
+    /** Voting power used */
+    votingPower: bigint;
+    /** Vote timestamp */
+    votedAt: bigint;
+    /** Vote reasoning (optional) */
+    reasoning: Option<string>;
+    /** Delegation info (if delegated vote) */
+    delegationInfo: Option<DelegationInfo>;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Vote choices */
+declare enum VoteChoice {
+    For = 0,
+    Against = 1,
+    Abstain = 2
+}
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+/** Voting results for proposal */
+type VotingResults = {
+    /** Total votes for */
+    votesFor: bigint;
+    /** Total votes against */
+    votesAgainst: bigint;
+    /** Total votes abstain */
+    votesAbstain: bigint;
+    /** Total voting power */
+    totalVotingPower: bigint;
+    /** Participation rate */
+    participationRate: number;
+    /** Individual votes */
+    individualVotes: Array<Vote>;
+    /** Weighted voting enabled */
+    weightedVoting: boolean;
+    /** Quorum reached */
+    quorumReached: boolean;
+    /** Approval threshold met */
+    approvalThresholdMet: boolean;
+};
+
+/**
+ * This code was AUTOGENERATED using the codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+type GovernanceProposal = {
+    discriminator: ReadonlyUint8Array;
+    /** Proposal ID */
+    proposalId: bigint;
+    /** Proposer */
+    proposer: Address;
+    /** Proposal title */
+    title: string;
+    /** Proposal description */
+    description: string;
+    /** Proposal type */
+    proposalType: ProposalType;
+    /** Creation timestamp */
+    createdAt: bigint;
+    /** Voting start timestamp */
+    votingStartsAt: bigint;
+    /** Voting end timestamp */
+    votingEndsAt: bigint;
+    /** Execution timestamp (if approved) */
+    executionTimestamp: Option<bigint>;
+    /** Proposal status */
+    status: ProposalStatus;
+    /** Voting results */
+    votingResults: VotingResults;
+    /** Execution parameters */
+    executionParams: ExecutionParams;
+    /** Quorum requirements */
+    quorumRequirements: QuorumRequirements;
+    /** Proposal metadata */
+    metadata: ProposalMetadata;
+    /** Reserved space */
+    reserved: ReadonlyUint8Array;
+};
+
+/**
+ * IPFS configuration and types for GhostSpeak SDK
+ */
+/**
+ * IPFS provider configuration
+ */
+interface IPFSProviderConfig {
+    /** Provider name */
+    name: 'pinata' | 'infura' | 'ipfs-http-client' | 'web3-storage' | 'custom' | 'test';
+    /** API endpoint URL */
+    endpoint?: string;
+    /** API key for authentication */
+    apiKey?: string;
+    /** API secret for authentication */
+    apiSecret?: string;
+    /** JWT token for authentication */
+    jwt?: string;
+    /** Custom headers */
+    headers?: Record<string, string>;
+    /** Request timeout in milliseconds */
+    timeout?: number;
+}
+/**
+ * IPFS client configuration
+ */
+interface IPFSConfig {
+    /** Primary provider */
+    provider: IPFSProviderConfig;
+    /** Fallback providers */
+    fallbackProviders?: IPFSProviderConfig[];
+    /** Default IPFS gateway for retrieving content */
+    gateway?: string;
+    /** Additional gateways for redundancy */
+    gateways?: string[];
+    /** Whether to automatically pin uploaded content */
+    autoPinning?: boolean;
+    /** Content size threshold for IPFS (bytes) - content above this will use IPFS */
+    sizeThreshold?: number;
+    /** Maximum retry attempts for failed operations */
+    maxRetries?: number;
+    /** Retry delay in milliseconds */
+    retryDelay?: number;
+    /** Enable caching of IPFS content */
+    enableCache?: boolean;
+    /** Cache TTL in milliseconds */
+    cacheTTL?: number;
+}
+/**
+ * IPFS upload options
+ */
+interface IPFSUploadOptions {
+    /** Pin the content after upload */
+    pin?: boolean;
+    /** Custom filename for the content */
+    filename?: string;
+    /** Metadata to associate with the upload */
+    metadata?: Record<string, unknown>;
+    /** Content type/MIME type */
+    contentType?: string;
+    /** Whether to wrap in directory */
+    wrapWithDirectory?: boolean;
+    /** Progress callback for large uploads */
+    onProgress?: (uploaded: number, total: number) => void;
+}
+/**
+ * IPFS upload result
+ */
+interface IPFSUploadResult {
+    /** IPFS hash/CID of the uploaded content */
+    hash: string;
+    /** Full IPFS URI (ipfs://<hash>) */
+    uri: string;
+    /** Size of uploaded content in bytes */
+    size: number;
+    /** Upload timestamp */
+    timestamp: number;
+    /** Whether content was pinned */
+    pinned: boolean;
+    /** Gateway URLs for accessing the content */
+    gateways: string[];
+}
+/**
+ * IPFS retrieval options
+ */
+interface IPFSRetrievalOptions {
+    /** Preferred gateway to use */
+    gateway?: string;
+    /** Timeout for retrieval in milliseconds */
+    timeout?: number;
+    /** Whether to cache retrieved content */
+    cache?: boolean;
+    /** Content type to expect */
+    expectedType?: string;
+}
+/**
+ * IPFS retrieval result
+ */
+interface IPFSRetrievalResult {
+    /** Retrieved content */
+    content: string | Uint8Array;
+    /** Content type */
+    contentType?: string;
+    /** Content size in bytes */
+    size: number;
+    /** IPFS hash */
+    hash: string;
+    /** Gateway used for retrieval */
+    gateway: string;
+    /** Whether content was served from cache */
+    fromCache: boolean;
+}
+/**
+ * IPFS pin operation result
+ */
+interface IPFSPinResult {
+    /** IPFS hash that was pinned */
+    hash: string;
+    /** Whether pin was successful */
+    success: boolean;
+    /** Pin status */
+    status: 'pinned' | 'pinning' | 'failed';
+    /** Error message if failed */
+    error?: string;
+}
+/**
+ * IPFS content metadata for large content storage
+ */
+interface IPFSContentMetadata {
+    /** Type of content stored */
+    type: 'agent-metadata' | 'channel-message' | 'file-attachment' | 'custom';
+    /** Original content size before IPFS storage */
+    originalSize: number;
+    /** IPFS hash of the content */
+    ipfsHash: string;
+    /** Content encoding used */
+    encoding?: 'utf8' | 'base64' | 'binary';
+    /** Compression algorithm used */
+    compression?: 'gzip' | 'brotli' | 'none';
+    /** Content MIME type */
+    mimeType?: string;
+    /** Upload timestamp */
+    uploadedAt: number;
+    /** Whether content is pinned */
+    pinned: boolean;
+    /** Checksum for integrity verification */
+    checksum?: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Error types for IPFS operations
+ */
+type IPFSError = 'UPLOAD_FAILED' | 'RETRIEVAL_FAILED' | 'PIN_FAILED' | 'UNPIN_FAILED' | 'PROVIDER_ERROR' | 'NETWORK_ERROR' | 'TIMEOUT_ERROR' | 'INVALID_HASH' | 'INVALID_CONFIG' | 'CONTENT_TOO_LARGE' | 'QUOTA_EXCEEDED' | 'AUTHENTICATION_FAILED';
+/**
+ * IPFS operation result with error handling
+ */
+interface IPFSOperationResult<T> {
+    /** Whether operation was successful */
+    success: boolean;
+    /** Result data if successful */
+    data?: T;
+    /** Error type if failed */
+    error?: IPFSError;
+    /** Human-readable error message */
+    message?: string;
+    /** Operation duration in milliseconds */
+    duration?: number;
+    /** Provider used for the operation */
+    provider?: string;
+}
+/**
+ * Utility type for content that can be stored on IPFS or inline
+ */
+interface FlexibleContent {
+    /** Content stored inline (for small content) */
+    inline?: string;
+    /** IPFS reference (for large content) */
+    ipfs?: IPFSContentMetadata;
+}
+/**
+ * Helper type for converting content to IPFS when size threshold is exceeded
+ */
+interface ContentStorageResult {
+    /** Final content URI (either data: or ipfs:) */
+    uri: string;
+    /** Whether content was stored on IPFS */
+    useIpfs: boolean;
+    /** IPFS metadata if stored on IPFS */
+    ipfsMetadata?: IPFSContentMetadata;
+    /** Content size in bytes */
+    size: number;
+}
+
+export { type ContentStorageResult as C, type ExecutionCondition as E, type FlexibleContent as F, type GovernanceProposal as G, type IPFSConfig as I, ProposalStatus as P, type QuorumRequirements as Q, VoteChoice as V, type IPFSUploadOptions as a, type IPFSContentMetadata as b, type IPFSOperationResult as c, type IPFSError as d, type IPFSProviderConfig as e, type IPFSUploadResult as f, type IPFSRetrievalOptions as g, type IPFSRetrievalResult as h, type IPFSPinResult as i, type VotingResults as j };