@palliora.org/chainsdk 0.3.2 → 0.4.0

package/dist/index.d.cts

@@ -119,9 +119,16 @@ declare const API_TYPES: {
         active: string;
         maximum: string;
     };
+    CurrencyId: {
+        _enum: {
+            Native: string;
+            USDC: string;
+            ForeignAsset: string;
+        };
+    };
     GuardianNwParams: {
         kzg: string;
-        agg_key: string;
+        aggKey: string;
     };
     AppId: string;
     DataLookupItem: {
@@ -172,9 +179,9 @@ declare const API_TYPES: {
         verifier: string;
     };
     SilentThresholdParams: {
-        td_params: string;
-        pk_bytes: string;
-        tau_params: string;
+        tdParams: string;
+        pkBytes: string;
+        tauParams: string;
     };
     ThresholdParams: {
         _enum: {
@@ -200,16 +207,16 @@ declare const API_TYPES: {
         };
     };
     Secp256k1Params: {
-        recipient_public_key: string;
-        ephemeral_public_key: string;
+        recipientPublicKey: string;
+        ephemeralPublicKey: string;
         compressed: string;
         kdf: string;
         salt: string;
         info: string;
     };
     Ed25519Params: {
-        recipient_public_key: string;
-        ephemeral_public_key: string;
+        recipientPublicKey: string;
+        ephemeralPublicKey: string;
         kdf: string;
         salt: string;
         info: string;
@@ -221,12 +228,12 @@ declare const API_TYPES: {
         };
     };
     ThresholdHybridParams: {
-        threshold_params: string;
-        symmetric_params: string;
+        thresholdParams: string;
+        symmetricParams: string;
     };
     AsymmetricHybridParams: {
-        asymmetric_params: string;
-        symmetric_params: string;
+        asymmetricParams: string;
+        symmetricParams: string;
     };
     CipherSuite: {
         _enum: {
@@ -253,8 +260,11 @@ declare const API_TYPES: {
         data: string;
     };
     DAInputChainTransaction: {
-        block_number: string;
-        extrinsic_index: string;
+        blockNumber: string;
+        extrinsicIndex: string;
+    };
+    DAInputContractId: {
+        id: string;
     };
     DAInputIpfs: {
         cid: string;
@@ -270,6 +280,7 @@ declare const API_TYPES: {
             Null: string;
             Inline: string;
             ChainTransaction: string;
+            ContractId: string;
             Ipfs: string;
             Url: string;
             NativeExecute: string;
@@ -280,6 +291,7 @@ declare const API_TYPES: {
         _enum: {
             Dormant: string;
             Active: string;
+            Subscription: string;
         };
     };
     StoreType: {
@@ -293,28 +305,30 @@ declare const API_TYPES: {
     ComputeMetadata: {
         name: string;
         description: string;
-        store_type: string;
-        group_id: string;
+        storeType: string;
+        groupId: string;
     };
     ComputeInfo: {
         cipher: string;
-        computer_indices: string;
+        computerIndices: string;
         fees: string;
+        computeRate: string;
         deadline: string;
         confidentiality: string;
-        fee_function: string;
-        program_env: string;
+        feeFunction: string;
+        programEnv: string;
         input: string;
         program: string;
         metadata: string;
     };
     Contract: {
-        contract_type: string;
+        contractType: string;
         guardians: string;
-        pre_check: string;
+        preCheck: string;
         compute: string;
-        post_check: string;
-        result_cipher: string;
+        postCheck: string;
+        resultCipher: string;
+        currencyId: string;
     };
     AgreementInfo: {
         status: string;
@@ -322,7 +336,7 @@ declare const API_TYPES: {
         index: string;
     };
     ComputePayload: {
-        da_type: string;
+        daType: string;
         agreement: string;
         verification: string;
         compute: string;
@@ -399,17 +413,53 @@ declare const API_TYPES: {
     GProof: string;
     GRow: string;
     GDataProof: string;
+    AgreementStatus: {
+        _enum: string[];
+    };
+    AcceptedSubStatus: {
+        _enum: string[];
+    };
+    RejectedSubStatus: {
+        _enum: string[];
+    };
+    SettlementReason: {
+        _enum: string[];
+    };
+    ExecutionOutcome: {
+        _enum: string[];
+    };
+    ContractInfo: {
+        status: string;
+        owner: string;
+        originBlock: string;
+        invocationBlock: string;
+        index: string;
+        usagePrice: string;
+        contractType: string;
+    };
+    SettlementInfo: {
+        computeRate: string;
+        inputContractId: string;
+        guardians: string;
+    };
+    AppKeyInfo: {
+        owner: string;
+        id: string;
+    };
+    DataType: {
+        _enum: string[];
+    };
 };
 declare const DEFAULT_COMPUTE_PAYLOAD: {
     compute: {
-        da_type: number;
+        daType: number;
         verification: number;
         compute: number;
     };
 };
 declare const DEFAULT_EMPTY_PAYLOAD: {
     compute: {
-        da_type: number;
+        daType: number;
         verification: number;
         compute: number;
         agreement: never[];
@@ -428,6 +478,13 @@ declare const API_EXTENSIONS: {
         };
         payload: {};
     };
+    ChargeCurrencyTransactionPayment: {
+        extrinsic: {
+            tip: string;
+            currencyId: string;
+        };
+        payload: {};
+    };
 };
 
 declare const PALI_SYMBOL = "PALI";
@@ -473,7 +530,7 @@ type Hex = `0x${string}`;
  */
 interface ComputePayload {
     /** DA type: 0 = none, 1 = DA. */
-    da_type: number;
+    daType: number;
     /** Guardian agreement keys. Each element is a 32-byte Uint8Array or number[]. */
     agreement?: Uint8Array[] | number[][];
     /** Verification mode. */
@@ -488,11 +545,11 @@ interface OnChainRef {
 }
 interface SilentThresholdParams {
     /** Encoded threshold ciphertext bytes (from encodeCiphertext). */
-    td_params: number[];
+    tdParams: number[];
     /** Guardian group aggregate public key bytes. */
-    pk_bytes: number[];
+    pkBytes: number[];
     /** KZG powers-of-tau bytes. */
-    tau_params: number[];
+    tauParams: number[];
 }
 type ThresholdParams = {
     SilentThreshold: SilentThresholdParams;
@@ -508,16 +565,16 @@ type SymmetricParams = {
 };
 type KdfParams = "HkdfSha256" | "HkdfSha512";
 interface Secp256k1Params {
-    recipient_public_key: number[];
-    ephemeral_public_key?: number[] | null;
+    recipientPublicKey: number[];
+    ephemeralPublicKey?: number[] | null;
     compressed: boolean;
     kdf: KdfParams;
     salt?: number[] | null;
     info?: number[] | null;
 }
 interface Ed25519Params {
-    recipient_public_key: number[];
-    ephemeral_public_key?: number[] | null;
+    recipientPublicKey: number[];
+    ephemeralPublicKey?: number[] | null;
     kdf: KdfParams;
     salt?: number[] | null;
     info?: number[] | null;
@@ -528,12 +585,12 @@ type AsymmetricParams = {
     Ed25519: Ed25519Params;
 };
 interface ThresholdHybridParams {
-    threshold_params: ThresholdParams;
-    symmetric_params: SymmetricParams;
+    thresholdParams: ThresholdParams;
+    symmetricParams: SymmetricParams;
 }
 interface AsymmetricHybridParams {
-    asymmetric_params: AsymmetricParams;
-    symmetric_params: SymmetricParams;
+    asymmetricParams: AsymmetricParams;
+    symmetricParams: SymmetricParams;
 }
 /** Mirrors the on-chain CipherSuite enum from spec.ts. */
 type CipherSuite = "Plaintext" | {
@@ -561,7 +618,7 @@ interface UploadOptions {
     guardianGroupInfo: GuardianGroupInfo;
     ref?: string;
     filePath?: string;
-    /** Options forwarded to signAndSend. Defaults to dormant DA payload (da_type=1, compute=0). */
+    /** Options forwarded to signAndSend. Defaults to dormant DA payload (daType=1, compute=0). */
     opts?: {
         compute: ComputePayload;
     };
@@ -726,6 +783,17 @@ declare function getKeyring(): Promise<Keyring>;
  */
 declare function getEncKeyring(): Promise<Keyring>;
 
+/** Identifies the currency used for fee payment / contract settlement. Mirrors runtime `primitives::CurrencyId`. */
+type CurrencyId = "Native" | "USDC" | {
+    ForeignAsset: number;
+};
+/** Fee terms for a compute step: an absolute amount plus an optional dynamic compute rate. */
+interface Fee {
+    /** Absolute fee offered for the compute step, in PALI. Defaults to 0. */
+    amount?: PaliAmountInput;
+    /** Compute rate used for dynamic fee calculation, in PALI. Defaults to 0. */
+    computeRate?: PaliAmountInput;
+}
 /** On-chain proof that a result extrinsic was included in a block. */
 interface SubmissionReceipt {
     /** Hash of the result extrinsic (hex-encoded, "0x..."). */
@@ -818,15 +886,27 @@ declare function watchForSubmissionReceipt(requestId: string, timeoutMs?: number
  */
 declare function getAgreementCreatedRequestId(blockHeight: number, extrinsicIndex: number): Promise<string | null>;
 
+/**
+ * Converts a {@link Fee} into the on-chain `fees` / `computeRate` pair.
+ * `computeRate` only has meaning for `Active` contracts (it drives dynamic
+ * fee calculation during `compute.result`); omit `computeRate` for `Dormant`
+ * contracts.
+ */
+declare function buildFee(fee?: Fee): {
+    fees: bigint;
+    computeRate: bigint;
+};
 interface ComputeContract {
-    contract_type: "Active" | "Dormant";
+    contractType: "Active" | "Dormant";
     guardians: GuardianAddress[];
-    pre_check?: unknown;
+    preCheck?: unknown;
     compute: Record<string, unknown>;
-    post_check?: unknown;
-    result_cipher: unknown;
+    postCheck?: unknown;
+    resultCipher: unknown;
+    /** Currency the deposit is reserved in and settlement is paid out in. Defaults to "Native". */
+    currencyId?: CurrencyId;
 }
-declare function createAgreement(contract: ComputeContract, account: KeyringPair): Promise<{
+declare function createAgreement(contract: ComputeContract, account: KeyringPair, oracle_quore_id?: string | undefined): Promise<{
     blockNumber: number;
     index: number;
     hash: string;
@@ -844,8 +924,12 @@ interface DataContractParams {
     url: string;
     /** Guardian account IDs that participate in this contract. */
     guardians: string[];
-    /** Fee offered for the contract in PALI. Defaults to 0. */
-    fees?: PaliAmountInput;
+    /**
+     * Absolute fee offered for the contract. Defaults to 0.
+     * `computeRate` is omitted: this is a `Dormant` contract and the
+     * compute rate only applies to `Active` contracts.
+     */
+    fee: Fee;
     /** Block number deadline. Defaults to 0 (no deadline). */
     deadline?: number;
     /** Trusted guardian index in the guardians list. Defaults to 0. */
@@ -867,13 +951,91 @@ declare function dataContract(params: DataContractParams, account: KeyringPair):
     agreementId?: string;
 }>;
 
+interface EncryptedInferenceSubscriptionParams {
+    /** Guardian account addresses that participate in this compute. */
+    guardians: string[];
+    /** Fee offered for the compute step. Defaults to 0. */
+    fee?: Fee;
+    /** Block number deadline. Defaults to 0 (no deadline). */
+    deadline?: number;
+}
+interface EncryptedInferenceSubscriptionInvocationParams {
+    /** Hex-encoded agreement ID returned by encryptedInferenceSubscription. */
+    agreementId: string;
+    /** Input payload to encrypt and submit. String is UTF-8 encoded. */
+    input: Uint8Array | string;
+    /** Guardian addresses to route the compute request to. */
+    guardians: string[];
+    /** Guardian group cryptographic parameters for threshold encryption. */
+    guardianInfo: GuardianGroupInfo;
+}
+interface EncryptedInferenceComputeParams {
+    /** Input payload to encrypt and submit. String is UTF-8 encoded. */
+    input: Uint8Array | string;
+    /** Guardian account addresses that participate in this compute. */
+    guardians: string[];
+    /** Guardian group cryptographic parameters for threshold encryption. */
+    guardianInfo: GuardianGroupInfo;
+    /** Fee offered for the compute step. Defaults to 0. */
+    fee?: Fee;
+    /** Block number deadline. Defaults to 0 (no deadline). */
+    deadline?: number;
+}
+/**
+ * Creates a Dormant agreement that registers encrypted inference compute terms.
+ * The agreement ID returned here is passed to encryptedInferenceSubscriptionInvocation
+ * for each subsequent encrypted inference call.
+ */
+declare function encryptedInferenceSubscription(params: EncryptedInferenceSubscriptionParams, account: KeyringPair): Promise<{
+    blockNumber: number;
+    index: number;
+    hash: string;
+    agreementId?: string;
+}>;
+/**
+ * Invokes an existing encrypted inference subscription agreement with a
+ * threshold-encrypted input payload. The result is encrypted back to encAccount.
+ *
+ * @param params   - Agreement ID, input payload, guardians, and guardian group crypto params.
+ * @param encAccount - Ed25519 keypair whose public key is used to receive the encrypted result.
+ * @param account  - Keypair used to sign and submit the transaction.
+ */
+declare function encryptedInferenceSubscriptionInvocation(params: EncryptedInferenceSubscriptionInvocationParams, encAccount: KeyringPair, account: KeyringPair): Promise<{
+    blockNumber: number;
+    index: number;
+    hash: `0x${string}`;
+    tx_result: _polkadot_types_types.ISubmittableResult;
+}>;
+/**
+ * Convenience wrapper: creates an encrypted inference subscription then
+ * immediately invokes it with the given input. Returns both receipts.
+ *
+ * @param params     - Input payload, guardians, guardian group crypto params, and fee.
+ * @param encAccount - Ed25519 keypair whose public key is used to receive the encrypted result.
+ * @param account    - Keypair used to sign and submit both transactions.
+ */
+declare function encryptedInferenceCompute(params: EncryptedInferenceComputeParams, encAccount: KeyringPair, account: KeyringPair): Promise<{
+    subscription: {
+        blockNumber: number;
+        index: number;
+        hash: string;
+        agreementId?: string;
+    };
+    invocation: {
+        blockNumber: number;
+        index: number;
+        hash: `0x${string}`;
+        tx_result: _polkadot_types_types.ISubmittableResult;
+    };
+}>;
+
 interface InferenceComputeParams {
     /** Raw input data — string will be UTF-8 encoded, Uint8Array used as-is. */
     input: Uint8Array | string;
     /** Guardian account IDs that participate in this compute. */
     guardians: string[];
-    /** Fee offered for the compute step in PALI. Defaults to 0. */
-    fees?: PaliAmountInput;
+    /** Fee offered for the compute step. Defaults to 0 amount and 0 compute rate. */
+    fee: Fee;
     /** Block number deadline for the compute step. Defaults to 0 (no deadline). */
     deadline?: number;
 }
@@ -918,8 +1080,8 @@ interface SimpleComputeParams {
     inputExtrinsicIndex?: number;
     /** Program location as URL. */
     programUrl: string;
-    /** Fee offered for the compute step in PALI. Defaults to 0. */
-    fees?: PaliAmountInput;
+    /** Fee offered for the compute step. Defaults to 0 amount and 0 compute rate. */
+    fee?: Fee;
     /** Block number deadline for the compute step. Defaults to 0 (no deadline). */
     deadline?: number;
     /** Trusted guardian index in the guardians list. Defaults to 0. */
@@ -1091,8 +1253,11 @@ interface DataAgreementParams {
     ref: OnChainRef;
     /** Guardian account IDs that participate in this agreement. */
     guardians: string[];
-    /** Fee for the agreement in PALI atomic units. */
-    fees: bigint;
+    /**
+     * Absolute fee for the agreement. `computeRate` is omitted: this is a
+     * `Dormant` contract and the compute rate only applies to `Active` contracts.
+     */
+    fee: Pick<Fee, "amount">;
     /** If provided, populates ComputeInfo.metadata in the contract. */
     metadata?: DataAgreementMetadata;
     /** Block number deadline. Defaults to 0 (no deadline). */
@@ -1274,4 +1439,4 @@ declare function setIdentity(account: KeyringPair, { display }: IdentityFields):
 declare function rotateAndSetKeys(account: KeyringPair): Promise<void>;
 declare function setWorker(account: KeyringPair): Promise<void>;
 
-export { API_EXTENSIONS, API_RPC, API_TYPES, AccountSourceType, type AsymmetricHybridParams, type AsymmetricParams, type AtomicPaliAmount, type BlockScanFilter, type BlockScanResult, type CipherSuite, type ComputeContract, CryptoType, DEBUG, DEFAULT_COMPUTE_PAYLOAD, DEFAULT_EMPTY_PAYLOAD, type DataAgreementMetadata, type DataAgreementParams, type DataContractParams, type Ed25519Params, FileFromMetadataRef, type GuardianAddress, type GuardianGroupInfo, type GuardianJoinPrefs, type GuardianParticipants, type IdentityFields, type InferenceComputeParams, type KdfParams, MCryptFs, MCryptFsReader, MCryptFsWriter, type OnChainRef, PALI_DECIMALS, PALI_SYMBOL, PALLIORA_RPC_URL, PALLIORA_WS, type PaliAmountInput, type Secp256k1Params, type SilentThresholdParams, type SimpleComputeParams, type SubmissionReceipt, type SubmitTEDataResult, type SymmetricParams, TX_WAIT_FINALIZATION, type ThresholdHybridParams, type ThresholdParams, type UploadOptions, addStake, base64ToUint8Array, clearTokenCache, configure, createAccount, createAgreement, createGuardianGroup, createGuardianGroupAndWatch, createSimpleAgreement, dataContract, debugLog, decodeAggregateKey, decodeField, decodePowersOfTau, decrypt, encrypt as ecncryptTest, encodeCiphertext, encrypt$1 as encrypt, fetchAndDecodeExtrinsic, fetchTokenProperties, formatBalanceWithTokenProperties, formatPaliAmount, fromAtomicPaliAmount, fundAccount, gen_shared_key, gen_stretched_key, generateRandomBytes, getAgreementCreatedRequestId, getApi, getCachedTokenProperties, getEncKeyring, getFileMetadataCall, getGuardianAddress, getGuardianList, getGuardianNwParams, getGuardianParticipants, getKeyring, hexToUint8Array, inferenceCompute, joinGuardian, joinIdleStaker, joinValidator, newStake, pairFromPrivateKeyHex, payoutStake, provider, reduceStake, registerDataAgreement, removeStake, rotateAndSetKeys, runAgent, scanForBlockEvent, setIdentity, setWorker, signAndSend, simpleCompute, submitData, submitTEData, submitTEDataWithCipher, testCrypt, toAtomicPaliAmount, tokenToBigint, transfer, uint8ArrayToBase64, uploadData, uploadDataLegacy, watchForSubmissionReceipt, withdrawStake, writeMetadata };
+export { API_EXTENSIONS, API_RPC, API_TYPES, AccountSourceType, type AsymmetricHybridParams, type AsymmetricParams, type AtomicPaliAmount, type BlockScanFilter, type BlockScanResult, type CipherSuite, type ComputeContract, CryptoType, type CurrencyId, DEBUG, DEFAULT_COMPUTE_PAYLOAD, DEFAULT_EMPTY_PAYLOAD, type DataAgreementMetadata, type DataAgreementParams, type DataContractParams, type Ed25519Params, type EncryptedInferenceComputeParams, type EncryptedInferenceSubscriptionInvocationParams, type EncryptedInferenceSubscriptionParams, type Fee, FileFromMetadataRef, type GuardianAddress, type GuardianGroupInfo, type GuardianJoinPrefs, type GuardianParticipants, type IdentityFields, type InferenceComputeParams, type KdfParams, MCryptFs, MCryptFsReader, MCryptFsWriter, type OnChainRef, PALI_DECIMALS, PALI_SYMBOL, PALLIORA_RPC_URL, PALLIORA_WS, type PaliAmountInput, type Secp256k1Params, type SilentThresholdParams, type SimpleComputeParams, type SubmissionReceipt, type SubmitTEDataResult, type SymmetricParams, TX_WAIT_FINALIZATION, type ThresholdHybridParams, type ThresholdParams, type UploadOptions, addStake, base64ToUint8Array, buildFee, clearTokenCache, configure, createAccount, createAgreement, createGuardianGroup, createGuardianGroupAndWatch, createSimpleAgreement, dataContract, debugLog, decodeAggregateKey, decodeField, decodePowersOfTau, decrypt, encrypt as ecncryptTest, encodeCiphertext, encrypt$1 as encrypt, encryptedInferenceCompute, encryptedInferenceSubscription, encryptedInferenceSubscriptionInvocation, fetchAndDecodeExtrinsic, fetchTokenProperties, formatBalanceWithTokenProperties, formatPaliAmount, fromAtomicPaliAmount, fundAccount, gen_shared_key, gen_stretched_key, generateRandomBytes, getAgreementCreatedRequestId, getApi, getCachedTokenProperties, getEncKeyring, getFileMetadataCall, getGuardianAddress, getGuardianList, getGuardianNwParams, getGuardianParticipants, getKeyring, hexToUint8Array, inferenceCompute, joinGuardian, joinIdleStaker, joinValidator, newStake, pairFromPrivateKeyHex, payoutStake, provider, reduceStake, registerDataAgreement, removeStake, rotateAndSetKeys, runAgent, scanForBlockEvent, setIdentity, setWorker, signAndSend, simpleCompute, submitData, submitTEData, submitTEDataWithCipher, testCrypt, toAtomicPaliAmount, tokenToBigint, transfer, uint8ArrayToBase64, uploadData, uploadDataLegacy, watchForSubmissionReceipt, withdrawStake, writeMetadata };