@buildonspark/spark-sdk 0.0.13 → 0.0.15

package/dist/proto/spark.d.ts

@@ -12,6 +12,14 @@ export declare enum Network {
 }
 export declare function networkFromJSON(object: any): Network;
 export declare function networkToJSON(object: Network): string;
+export declare enum TokenTransactionStatus {
+    TOKEN_TRANSACTION_STARTED = 0,
+    TOKEN_TRANSACTION_SIGNED = 1,
+    TOKEN_TRANSACTION_FINALIZED = 2,
+    UNRECOGNIZED = -1
+}
+export declare function tokenTransactionStatusFromJSON(object: any): TokenTransactionStatus;
+export declare function tokenTransactionStatusToJSON(object: TokenTransactionStatus): string;
 export declare enum TransferStatus {
     TRANSFER_STATUS_SENDER_INITIATED = 0,
     TRANSFER_STATUS_SENDER_KEY_TWEAK_PENDING = 1,
@@ -20,6 +28,7 @@ export declare enum TransferStatus {
     TRANSFER_STATUSR_RECEIVER_REFUND_SIGNED = 4,
     TRANSFER_STATUS_COMPLETED = 5,
     TRANSFER_STATUS_EXPIRED = 6,
+    TRANSFER_STATUS_RETURNED = 7,
     UNRECOGNIZED = -1
 }
 export declare function transferStatusFromJSON(object: any): TransferStatus;
@@ -169,12 +178,16 @@ export interface TokenTransaction {
     outputLeaves: TokenLeafOutput[];
     sparkOperatorIdentityPublicKeys: Uint8Array[];
 }
+export interface TokenTransactionWithStatus {
+    tokenTransaction: TokenTransaction | undefined;
+    status: TokenTransactionStatus;
+}
 export interface TokenTransactionSignatures {
     /**
      * Filled by signing the partial token transaction hash with the owner/issuer private key.
      * For mint transactions this will be one signature for the input issuer_public_key
      * For transfer transactions this will be one for each leaf for the leaf owner_public_key
-     * This is a DER signature which can be between 68 and 73 bytes.
+     * This is a Schnorr or ECDSA DER signature which can be between 64 and 73 bytes.
      */
     ownerSignatures: Uint8Array[];
 }
@@ -206,7 +219,7 @@ export interface OperatorSpecificTokenTransactionSignablePayload {
  */
 export interface OperatorSpecificTokenTransactionSignature {
     ownerPublicKey: Uint8Array;
-    /** This is a DER signature which can be between 68 and 73 bytes. */
+    /** This is a Schnorr or ECDSA DER signature which can be between 64 and 73 bytes. */
     ownerSignature: Uint8Array;
     payload: OperatorSpecificTokenTransactionSignablePayload | undefined;
 }
@@ -238,7 +251,7 @@ export interface FreezeTokensPayload {
 }
 export interface FreezeTokensRequest {
     freezeTokensPayload: FreezeTokensPayload | undefined;
-    /** This is a DER signature which can be between 68 and 73 bytes. */
+    /** This is a Schnorr or ECDSA DER signature which can be between 64 and 73 bytes. */
     issuerSignature: Uint8Array;
 }
 export interface FreezeTokensResponse {
@@ -251,6 +264,23 @@ export interface GetOwnedTokenLeavesRequest {
     /** Optionally provide token public keys. If not set return leaves for all tokens. */
     tokenPublicKeys: Uint8Array[];
 }
+/** Request constraints are combined using an AND relation. */
+export interface QueryTokenTransactionsRequest {
+    /** Returns transactions that have one of these leaf ids in the input or output. */
+    leafIds: string[];
+    /** Returns transactions that have this owner public key as the sender or receiver in one or more of the input/output leaves. */
+    ownerPublicKeys: Uint8Array[];
+    /** Returns transactions that related to this token public key. */
+    tokenPublicKeys: Uint8Array[];
+    /** Returns transactions that match the provided transaction hashes. */
+    tokenTransactionHashes: Uint8Array[];
+    limit: number;
+    offset: number;
+}
+export interface QueryTokenTransactionsResponse {
+    tokenTransactionsWithStatus: TokenTransactionWithStatus[];
+    offset: number;
+}
 export interface LeafWithPreviousTransactionData {
     leaf: TokenLeafOutput | undefined;
     previousTransactionHash: Uint8Array;
@@ -259,6 +289,10 @@ export interface LeafWithPreviousTransactionData {
 export interface GetOwnedTokenLeavesResponse {
     leavesWithPreviousTransactionData: LeafWithPreviousTransactionData[];
 }
+export interface CancelSignedTokenTransactionRequest {
+    finalTokenTransaction: TokenTransaction | undefined;
+    senderIdentityPublicKey: Uint8Array;
+}
 export interface TreeNode {
     id: string;
     treeId: string;
@@ -284,6 +318,9 @@ export interface SecretShare {
     secretShare: Uint8Array;
     proofs: Uint8Array[];
 }
+export interface SecretProof {
+    proofs: Uint8Array[];
+}
 export interface LeafRefundTxSigningJob {
     leafId: string;
     refundTxSigningJob: SigningJob | undefined;
@@ -299,6 +336,13 @@ export interface StartSendTransferRequest {
     leavesToSend: LeafRefundTxSigningJob[];
     receiverIdentityPublicKey: Uint8Array;
     expiryTime: Date | undefined;
+    keyTweakProofs: {
+        [key: string]: SecretProof;
+    };
+}
+export interface StartSendTransferRequest_KeyTweakProofsEntry {
+    key: string;
+    value: SecretProof | undefined;
 }
 export interface StartSendTransferResponse {
     transfer: Transfer | undefined;
@@ -351,6 +395,7 @@ export interface QueryPendingTransfersRequest {
         senderIdentityPublicKey: Uint8Array;
     } | undefined;
     transferIds: string[];
+    network: Network;
 }
 export interface QueryPendingTransfersResponse {
     transfers: Transfer[];
@@ -375,6 +420,13 @@ export interface ClaimTransferSignRefundsRequest {
     transferId: string;
     ownerIdentityPublicKey: Uint8Array;
     signingJobs: LeafRefundTxSigningJob[];
+    keyTweakProofs: {
+        [key: string]: SecretProof;
+    };
+}
+export interface ClaimTransferSignRefundsRequest_KeyTweakProofsEntry {
+    key: string;
+    value: SecretProof | undefined;
 }
 export interface ClaimTransferSignRefundsResponse {
     signingResults: LeafRefundTxSigningResult[];
@@ -428,6 +480,7 @@ export interface UserSignedRefund {
     userSignature: Uint8Array;
     signingCommitments: SigningCommitments | undefined;
     userSignatureCommitment: SigningCommitment | undefined;
+    network: Network;
 }
 export interface InvoiceAmountProof {
     bolt11Invoice: string;
@@ -610,6 +663,7 @@ export interface QueryNodesRequest {
         nodeIds: TreeNodeIds;
     } | undefined;
     includeParents: boolean;
+    network: Network;
 }
 export interface QueryNodesResponse {
     nodes: {
@@ -647,6 +701,20 @@ export interface DepositAddressQueryResult {
 export interface QueryUnusedDepositAddressesResponse {
     depositAddresses: DepositAddressQueryResult[];
 }
+export interface QueryBalanceRequest {
+    identityPublicKey: Uint8Array;
+    network: Network;
+}
+export interface QueryBalanceResponse {
+    balance: number;
+    nodeBalances: {
+        [key: string]: number;
+    };
+}
+export interface QueryBalanceResponse_NodeBalancesEntry {
+    key: string;
+    value: number;
+}
 export declare const DepositAddressProof: MessageFns<DepositAddressProof>;
 export declare const DepositAddressProof_AddressSignaturesEntry: MessageFns<DepositAddressProof_AddressSignaturesEntry>;
 export declare const GenerateDepositAddressRequest: MessageFns<GenerateDepositAddressRequest>;
@@ -669,6 +737,7 @@ export declare const TransferInput: MessageFns<TransferInput>;
 export declare const MintInput: MessageFns<MintInput>;
 export declare const TokenLeafOutput: MessageFns<TokenLeafOutput>;
 export declare const TokenTransaction: MessageFns<TokenTransaction>;
+export declare const TokenTransactionWithStatus: MessageFns<TokenTransactionWithStatus>;
 export declare const TokenTransactionSignatures: MessageFns<TokenTransactionSignatures>;
 export declare const StartTokenTransactionRequest: MessageFns<StartTokenTransactionRequest>;
 export declare const StartTokenTransactionResponse: MessageFns<StartTokenTransactionResponse>;
@@ -681,15 +750,20 @@ export declare const FreezeTokensPayload: MessageFns<FreezeTokensPayload>;
 export declare const FreezeTokensRequest: MessageFns<FreezeTokensRequest>;
 export declare const FreezeTokensResponse: MessageFns<FreezeTokensResponse>;
 export declare const GetOwnedTokenLeavesRequest: MessageFns<GetOwnedTokenLeavesRequest>;
+export declare const QueryTokenTransactionsRequest: MessageFns<QueryTokenTransactionsRequest>;
+export declare const QueryTokenTransactionsResponse: MessageFns<QueryTokenTransactionsResponse>;
 export declare const LeafWithPreviousTransactionData: MessageFns<LeafWithPreviousTransactionData>;
 export declare const GetOwnedTokenLeavesResponse: MessageFns<GetOwnedTokenLeavesResponse>;
+export declare const CancelSignedTokenTransactionRequest: MessageFns<CancelSignedTokenTransactionRequest>;
 export declare const TreeNode: MessageFns<TreeNode>;
 export declare const FinalizeNodeSignaturesRequest: MessageFns<FinalizeNodeSignaturesRequest>;
 export declare const FinalizeNodeSignaturesResponse: MessageFns<FinalizeNodeSignaturesResponse>;
 export declare const SecretShare: MessageFns<SecretShare>;
+export declare const SecretProof: MessageFns<SecretProof>;
 export declare const LeafRefundTxSigningJob: MessageFns<LeafRefundTxSigningJob>;
 export declare const LeafRefundTxSigningResult: MessageFns<LeafRefundTxSigningResult>;
 export declare const StartSendTransferRequest: MessageFns<StartSendTransferRequest>;
+export declare const StartSendTransferRequest_KeyTweakProofsEntry: MessageFns<StartSendTransferRequest_KeyTweakProofsEntry>;
 export declare const StartSendTransferResponse: MessageFns<StartSendTransferResponse>;
 export declare const SendLeafKeyTweak: MessageFns<SendLeafKeyTweak>;
 export declare const SendLeafKeyTweak_PubkeySharesTweakEntry: MessageFns<SendLeafKeyTweak_PubkeySharesTweakEntry>;
@@ -703,6 +777,7 @@ export declare const ClaimLeafKeyTweak: MessageFns<ClaimLeafKeyTweak>;
 export declare const ClaimLeafKeyTweak_PubkeySharesTweakEntry: MessageFns<ClaimLeafKeyTweak_PubkeySharesTweakEntry>;
 export declare const ClaimTransferTweakKeysRequest: MessageFns<ClaimTransferTweakKeysRequest>;
 export declare const ClaimTransferSignRefundsRequest: MessageFns<ClaimTransferSignRefundsRequest>;
+export declare const ClaimTransferSignRefundsRequest_KeyTweakProofsEntry: MessageFns<ClaimTransferSignRefundsRequest_KeyTweakProofsEntry>;
 export declare const ClaimTransferSignRefundsResponse: MessageFns<ClaimTransferSignRefundsResponse>;
 export declare const AggregateNodesRequest: MessageFns<AggregateNodesRequest>;
 export declare const AggregateNodesResponse: MessageFns<AggregateNodesResponse>;
@@ -756,6 +831,9 @@ export declare const QueryAllTransfersResponse: MessageFns<QueryAllTransfersResp
 export declare const QueryUnusedDepositAddressesRequest: MessageFns<QueryUnusedDepositAddressesRequest>;
 export declare const DepositAddressQueryResult: MessageFns<DepositAddressQueryResult>;
 export declare const QueryUnusedDepositAddressesResponse: MessageFns<QueryUnusedDepositAddressesResponse>;
+export declare const QueryBalanceRequest: MessageFns<QueryBalanceRequest>;
+export declare const QueryBalanceResponse: MessageFns<QueryBalanceResponse>;
+export declare const QueryBalanceResponse_NodeBalancesEntry: MessageFns<QueryBalanceResponse_NodeBalancesEntry>;
 export type SparkServiceDefinition = typeof SparkServiceDefinition;
 export declare const SparkServiceDefinition: {
     readonly name: "SparkService";
@@ -937,6 +1015,14 @@ export declare const SparkServiceDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly query_balance: {
+            readonly name: "query_balance";
+            readonly requestType: MessageFns<QueryBalanceRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<QueryBalanceResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly query_user_signed_refunds: {
             readonly name: "query_user_signed_refunds";
             readonly requestType: MessageFns<QueryUserSignedRefundsRequest>;
@@ -986,6 +1072,22 @@ export declare const SparkServiceDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly query_token_transactions: {
+            readonly name: "query_token_transactions";
+            readonly requestType: MessageFns<QueryTokenTransactionsRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<QueryTokenTransactionsResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly cancel_signed_token_transaction: {
+            readonly name: "cancel_signed_token_transaction";
+            readonly requestType: MessageFns<CancelSignedTokenTransactionRequest>;
+            readonly requestStream: false;
+            readonly responseType: import("./google/protobuf/empty.js").MessageFns<Empty>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
         readonly return_lightning_payment: {
             readonly name: "return_lightning_payment";
             readonly requestType: MessageFns<ReturnLightningPaymentRequest>;
@@ -1035,6 +1137,7 @@ export interface SparkServiceImplementation<CallContextExt = {}> {
     create_tree(request: CreateTreeRequest, context: CallContext & CallContextExt): Promise<DeepPartial<CreateTreeResponse>>;
     get_signing_operator_list(request: Empty, context: CallContext & CallContextExt): Promise<DeepPartial<GetSigningOperatorListResponse>>;
     query_nodes(request: QueryNodesRequest, context: CallContext & CallContextExt): Promise<DeepPartial<QueryNodesResponse>>;
+    query_balance(request: QueryBalanceRequest, context: CallContext & CallContextExt): Promise<DeepPartial<QueryBalanceResponse>>;
     query_user_signed_refunds(request: QueryUserSignedRefundsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<QueryUserSignedRefundsResponse>>;
     /** Token RPCs */
     start_token_transaction(request: StartTokenTransactionRequest, context: CallContext & CallContextExt): Promise<DeepPartial<StartTokenTransactionResponse>>;
@@ -1042,6 +1145,8 @@ export interface SparkServiceImplementation<CallContextExt = {}> {
     finalize_token_transaction(request: FinalizeTokenTransactionRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Empty>>;
     freeze_tokens(request: FreezeTokensRequest, context: CallContext & CallContextExt): Promise<DeepPartial<FreezeTokensResponse>>;
     get_owned_token_leaves(request: GetOwnedTokenLeavesRequest, context: CallContext & CallContextExt): Promise<DeepPartial<GetOwnedTokenLeavesResponse>>;
+    query_token_transactions(request: QueryTokenTransactionsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<QueryTokenTransactionsResponse>>;
+    cancel_signed_token_transaction(request: CancelSignedTokenTransactionRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Empty>>;
     return_lightning_payment(request: ReturnLightningPaymentRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Empty>>;
     cancel_send_transfer(request: CancelSendTransferRequest, context: CallContext & CallContextExt): Promise<DeepPartial<CancelSendTransferResponse>>;
     query_unused_deposit_addresses(request: QueryUnusedDepositAddressesRequest, context: CallContext & CallContextExt): Promise<DeepPartial<QueryUnusedDepositAddressesResponse>>;
@@ -1069,6 +1174,7 @@ export interface SparkServiceClient<CallOptionsExt = {}> {
     create_tree(request: DeepPartial<CreateTreeRequest>, options?: CallOptions & CallOptionsExt): Promise<CreateTreeResponse>;
     get_signing_operator_list(request: DeepPartial<Empty>, options?: CallOptions & CallOptionsExt): Promise<GetSigningOperatorListResponse>;
     query_nodes(request: DeepPartial<QueryNodesRequest>, options?: CallOptions & CallOptionsExt): Promise<QueryNodesResponse>;
+    query_balance(request: DeepPartial<QueryBalanceRequest>, options?: CallOptions & CallOptionsExt): Promise<QueryBalanceResponse>;
     query_user_signed_refunds(request: DeepPartial<QueryUserSignedRefundsRequest>, options?: CallOptions & CallOptionsExt): Promise<QueryUserSignedRefundsResponse>;
     /** Token RPCs */
     start_token_transaction(request: DeepPartial<StartTokenTransactionRequest>, options?: CallOptions & CallOptionsExt): Promise<StartTokenTransactionResponse>;
@@ -1076,6 +1182,8 @@ export interface SparkServiceClient<CallOptionsExt = {}> {
     finalize_token_transaction(request: DeepPartial<FinalizeTokenTransactionRequest>, options?: CallOptions & CallOptionsExt): Promise<Empty>;
     freeze_tokens(request: DeepPartial<FreezeTokensRequest>, options?: CallOptions & CallOptionsExt): Promise<FreezeTokensResponse>;
     get_owned_token_leaves(request: DeepPartial<GetOwnedTokenLeavesRequest>, options?: CallOptions & CallOptionsExt): Promise<GetOwnedTokenLeavesResponse>;
+    query_token_transactions(request: DeepPartial<QueryTokenTransactionsRequest>, options?: CallOptions & CallOptionsExt): Promise<QueryTokenTransactionsResponse>;
+    cancel_signed_token_transaction(request: DeepPartial<CancelSignedTokenTransactionRequest>, options?: CallOptions & CallOptionsExt): Promise<Empty>;
     return_lightning_payment(request: DeepPartial<ReturnLightningPaymentRequest>, options?: CallOptions & CallOptionsExt): Promise<Empty>;
     cancel_send_transfer(request: DeepPartial<CancelSendTransferRequest>, options?: CallOptions & CallOptionsExt): Promise<CancelSendTransferResponse>;
     query_unused_deposit_addresses(request: DeepPartial<QueryUnusedDepositAddressesRequest>, options?: CallOptions & CallOptionsExt): Promise<QueryUnusedDepositAddressesResponse>;