@palliora.org/chainsdk 0.3.1 → 0.3.3

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import * as _polkadot_util_crypto_types from '@polkadot/util-crypto/types';
 import { KeyringPair } from '@polkadot/keyring/types';
+export { KeyringPair } from '@polkadot/keyring/types';
 import * as _polkadot_types_types from '@polkadot/types/types';
 import { ISubmittableResult } from '@polkadot/types/types';
 import { ApiPromise, Keyring, WsProvider } from '@polkadot/api';
@@ -15,6 +16,7 @@ import * as utilCrypto from '@polkadot/util-crypto';
 export { utilCrypto };
 import * as wasmCrypto from '@polkadot/wasm-crypto';
 export { wasmCrypto };
+export { Keyring } from '@polkadot/keyring';
 
 declare enum CryptoType {
     SR25519 = "sr25519",
@@ -36,7 +38,7 @@ declare enum AccountSourceType {
  * @param cryptoType - The crypto type: 'sr25519' | 'ed25519' | 'ecdsa' (default: 'sr25519').
  * @returns The keypair object.
  */
-declare function createAccount(input: string, type: AccountSourceType, name?: string, cryptoType?: CryptoType): Promise<KeyringPair>;
+declare function createAccount(input: string, type: AccountSourceType, name?: string, cryptoType?: CryptoType, signedMsg?: string): Promise<KeyringPair>;
 declare function pairFromPrivateKeyHex(privateKeyHex: string, cryptoType: CryptoType): _polkadot_util_crypto_types.Keypair;
 
 declare const API_RPC: {
@@ -119,7 +121,7 @@ declare const API_TYPES: {
     };
     GuardianNwParams: {
         kzg: string;
-        agg_key: string;
+        aggKey: string;
     };
     AppId: string;
     DataLookupItem: {
@@ -170,9 +172,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: {
@@ -198,16 +200,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;
@@ -219,12 +221,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: {
@@ -251,8 +253,11 @@ declare const API_TYPES: {
         data: string;
     };
     DAInputChainTransaction: {
-        block_number: string;
-        extrinsic_index: string;
+        blockNumber: string;
+        extrinsicIndex: string;
+    };
+    DAInputContractId: {
+        id: string;
     };
     DAInputIpfs: {
         cid: string;
@@ -268,6 +273,7 @@ declare const API_TYPES: {
             Null: string;
             Inline: string;
             ChainTransaction: string;
+            ContractId: string;
             Ipfs: string;
             Url: string;
             NativeExecute: string;
@@ -278,6 +284,7 @@ declare const API_TYPES: {
         _enum: {
             Dormant: string;
             Active: string;
+            Subscription: string;
         };
     };
     StoreType: {
@@ -291,28 +298,29 @@ 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;
     };
     AgreementInfo: {
         status: string;
@@ -320,7 +328,7 @@ declare const API_TYPES: {
         index: string;
     };
     ComputePayload: {
-        da_type: string;
+        daType: string;
         agreement: string;
         verification: string;
         compute: string;
@@ -397,17 +405,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[];
@@ -471,7 +515,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. */
@@ -486,11 +530,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;
@@ -506,16 +550,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;
@@ -526,12 +570,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" | {
@@ -559,7 +603,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;
     };
@@ -724,6 +768,13 @@ declare function getKeyring(): Promise<Keyring>;
  */
 declare function getEncKeyring(): Promise<Keyring>;
 
+/** 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..."). */
@@ -816,15 +867,25 @@ 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;
 }
-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;
@@ -842,8 +903,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. */
@@ -870,8 +935,8 @@ interface InferenceComputeParams {
     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;
 }
@@ -916,8 +981,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. */
@@ -1089,8 +1154,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). */
@@ -1272,4 +1340,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, DEBUG, DEFAULT_COMPUTE_PAYLOAD, DEFAULT_EMPTY_PAYLOAD, type DataAgreementMetadata, type DataAgreementParams, type DataContractParams, type Ed25519Params, 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, 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 };