@buildonspark/spark-sdk 0.1.39 → 0.1.41

package/dist/proto/spark_token.d.cts

@@ -0,0 +1,209 @@
+import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
+import { CallOptions, CallContext } from 'nice-grpc-common';
+import { N as Network, S as SigningKeyshare } from '../spark-DjR1b3TC.cjs';
+
+declare const protobufPackage = "spark_token";
+/**
+ * This proto is constructed by the wallet to specify leaves it wants to spend
+ * as part of the token transaction.
+ */
+interface TokenOutputToSpend {
+    prevTokenTransactionHash: Uint8Array;
+    prevTokenTransactionVout: number;
+}
+declare const TokenOutputToSpend: MessageFns<TokenOutputToSpend>;
+interface TokenTransferInput {
+    outputsToSpend: TokenOutputToSpend[];
+}
+declare const TokenTransferInput: MessageFns<TokenTransferInput>;
+interface TokenMintInput {
+    issuerPublicKey: Uint8Array;
+    /**
+     * Issuer provided timestamp of when the transaction was signed/constructed.
+     * Helps provide idempotency and ensures that each mint input signature is
+     * unique as long as multiple mint signatures are not happening at the same
+     * time. Also gives a potentially useful data point for when the issuer
+     * authorized from their perspective.  Note that we have no way of proving
+     * this is accurate.
+     * TODO: Consider whether implementing generic idempotency controls and/or a
+     * random nonce would be favorable to populating this field.
+     */
+    issuerProvidedTimestamp: number;
+}
+declare const TokenMintInput: MessageFns<TokenMintInput>;
+/**
+ * This proto is constructed by the wallet to specify outputs it wants to create
+ * as part of a token transaction. Output id and revocation public key should
+ * remain unfilled so that the SE can fill them as part of the
+ * StartTokenTransaction() call.
+ */
+interface TokenOutput {
+    id?: string | undefined;
+    ownerPublicKey: Uint8Array;
+    revocationCommitment?: Uint8Array | undefined;
+    withdrawBondSats?: number | undefined;
+    withdrawRelativeBlockLocktime?: number | undefined;
+    tokenPublicKey: Uint8Array;
+    /** Decoded uint128 */
+    tokenAmount: Uint8Array;
+}
+declare const TokenOutput: MessageFns<TokenOutput>;
+/**
+ * This proto is constructed by the wallet and is the core transaction data
+ * structure. This proto is deterministically hashed to generate the
+ * token_transaction_hash that is cooperatively signed by the SO group to
+ * confirm a token transaction.
+ */
+interface TokenTransaction {
+    /**
+     * For mint transactions issuer_public_key will be specified without any
+     * outputs_to_spend. For transfer transactions the token amount in the input
+     * leaves must match the token amount in the output leaves.
+     */
+    version: number;
+    tokenInputs?: {
+        $case: "mintInput";
+        mintInput: TokenMintInput;
+    } | {
+        $case: "transferInput";
+        transferInput: TokenTransferInput;
+    } | undefined;
+    tokenOutputs: TokenOutput[];
+    sparkOperatorIdentityPublicKeys: Uint8Array[];
+    /**
+     * Server-set expiry time. The server calculates this by adding the client's
+     * requested validity_duration_seconds to the server's current time when
+     * creating the final transaction.
+     */
+    expiryTime: Date | undefined;
+    network: Network;
+}
+declare const TokenTransaction: MessageFns<TokenTransaction>;
+interface SignatureWithIndex {
+    /**
+     * This is a Schnorr or ECDSA DER signature which can be between 64 and 73
+     * bytes.
+     */
+    signature: Uint8Array;
+    /** The index of the TTXO associated with this signature. */
+    inputIndex: number;
+}
+declare const SignatureWithIndex: MessageFns<SignatureWithIndex>;
+/**
+ * A group of signatures for the input TTXOs binding them to the final token
+ * transaction hash. This bundle of signatures is specific to a given operator.
+ */
+interface InputTtxoSignaturesPerOperator {
+    ttxoSignatures: SignatureWithIndex[];
+    operatorIdentityPublicKey: Uint8Array;
+}
+declare const InputTtxoSignaturesPerOperator: MessageFns<InputTtxoSignaturesPerOperator>;
+/** === Start Transaction === */
+interface StartTransactionRequest {
+    identityPublicKey: Uint8Array;
+    partialTokenTransaction: TokenTransaction | undefined;
+    /**
+     * 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 output for the output owner_public_key
+     */
+    partialTokenTransactionOwnerSignatures: SignatureWithIndex[];
+    /**
+     * How long the transaction should be valid for, in seconds.
+     * The server will set the actual expiry_time in the final transaction based
+     * on this duration. Must be between 1 and 300 seconds.
+     */
+    validityDurationSeconds: number;
+}
+declare const StartTransactionRequest: MessageFns<StartTransactionRequest>;
+interface StartTransactionResponse {
+    finalTokenTransaction: TokenTransaction | undefined;
+    keyshareInfo: SigningKeyshare | undefined;
+}
+declare const StartTransactionResponse: MessageFns<StartTransactionResponse>;
+interface CommitTransactionRequest {
+    finalTokenTransaction: TokenTransaction | undefined;
+    finalTokenTransactionHash: Uint8Array;
+    inputTtxoSignaturesPerOperator: InputTtxoSignaturesPerOperator[];
+    ownerIdentityPublicKey: Uint8Array;
+}
+declare const CommitTransactionRequest: MessageFns<CommitTransactionRequest>;
+interface CommitTransactionResponse {
+}
+declare const CommitTransactionResponse: MessageFns<CommitTransactionResponse>;
+type SparkTokenServiceDefinition = typeof SparkTokenServiceDefinition;
+declare const SparkTokenServiceDefinition: {
+    readonly name: "SparkTokenService";
+    readonly fullName: "spark_token.SparkTokenService";
+    readonly methods: {
+        /**
+         * Start process to create final token transaction with all inputs required
+         * from user and SOs (including revocation secret commitment)
+         */
+        readonly start_transaction: {
+            readonly name: "start_transaction";
+            readonly requestType: MessageFns<StartTransactionRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<StartTransactionResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /**
+         * Complete the transaction and commit it with all SOs. This will be
+         * coordinated by one SO.
+         */
+        readonly commit_transaction: {
+            readonly name: "commit_transaction";
+            readonly requestType: MessageFns<CommitTransactionRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<CommitTransactionResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+    };
+};
+interface SparkTokenServiceImplementation<CallContextExt = {}> {
+    /**
+     * Start process to create final token transaction with all inputs required
+     * from user and SOs (including revocation secret commitment)
+     */
+    start_transaction(request: StartTransactionRequest, context: CallContext & CallContextExt): Promise<DeepPartial<StartTransactionResponse>>;
+    /**
+     * Complete the transaction and commit it with all SOs. This will be
+     * coordinated by one SO.
+     */
+    commit_transaction(request: CommitTransactionRequest, context: CallContext & CallContextExt): Promise<DeepPartial<CommitTransactionResponse>>;
+}
+interface SparkTokenServiceClient<CallOptionsExt = {}> {
+    /**
+     * Start process to create final token transaction with all inputs required
+     * from user and SOs (including revocation secret commitment)
+     */
+    start_transaction(request: DeepPartial<StartTransactionRequest>, options?: CallOptions & CallOptionsExt): Promise<StartTransactionResponse>;
+    /**
+     * Complete the transaction and commit it with all SOs. This will be
+     * coordinated by one SO.
+     */
+    commit_transaction(request: DeepPartial<CommitTransactionRequest>, options?: CallOptions & CallOptionsExt): Promise<CommitTransactionResponse>;
+}
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
+    $case: string;
+} ? {
+    [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
+} & {
+    $case: T["$case"];
+} : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
+}
+
+export { CommitTransactionRequest, CommitTransactionResponse, type DeepPartial, InputTtxoSignaturesPerOperator, type MessageFns, SignatureWithIndex, type SparkTokenServiceClient, SparkTokenServiceDefinition, type SparkTokenServiceImplementation, StartTransactionRequest, StartTransactionResponse, TokenMintInput, TokenOutput, TokenOutputToSpend, TokenTransaction, TokenTransferInput, protobufPackage };

package/dist/proto/spark_token.d.ts

@@ -0,0 +1,209 @@
+import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
+import { CallOptions, CallContext } from 'nice-grpc-common';
+import { N as Network, S as SigningKeyshare } from '../spark-DjR1b3TC.js';
+
+declare const protobufPackage = "spark_token";
+/**
+ * This proto is constructed by the wallet to specify leaves it wants to spend
+ * as part of the token transaction.
+ */
+interface TokenOutputToSpend {
+    prevTokenTransactionHash: Uint8Array;
+    prevTokenTransactionVout: number;
+}
+declare const TokenOutputToSpend: MessageFns<TokenOutputToSpend>;
+interface TokenTransferInput {
+    outputsToSpend: TokenOutputToSpend[];
+}
+declare const TokenTransferInput: MessageFns<TokenTransferInput>;
+interface TokenMintInput {
+    issuerPublicKey: Uint8Array;
+    /**
+     * Issuer provided timestamp of when the transaction was signed/constructed.
+     * Helps provide idempotency and ensures that each mint input signature is
+     * unique as long as multiple mint signatures are not happening at the same
+     * time. Also gives a potentially useful data point for when the issuer
+     * authorized from their perspective.  Note that we have no way of proving
+     * this is accurate.
+     * TODO: Consider whether implementing generic idempotency controls and/or a
+     * random nonce would be favorable to populating this field.
+     */
+    issuerProvidedTimestamp: number;
+}
+declare const TokenMintInput: MessageFns<TokenMintInput>;
+/**
+ * This proto is constructed by the wallet to specify outputs it wants to create
+ * as part of a token transaction. Output id and revocation public key should
+ * remain unfilled so that the SE can fill them as part of the
+ * StartTokenTransaction() call.
+ */
+interface TokenOutput {
+    id?: string | undefined;
+    ownerPublicKey: Uint8Array;
+    revocationCommitment?: Uint8Array | undefined;
+    withdrawBondSats?: number | undefined;
+    withdrawRelativeBlockLocktime?: number | undefined;
+    tokenPublicKey: Uint8Array;
+    /** Decoded uint128 */
+    tokenAmount: Uint8Array;
+}
+declare const TokenOutput: MessageFns<TokenOutput>;
+/**
+ * This proto is constructed by the wallet and is the core transaction data
+ * structure. This proto is deterministically hashed to generate the
+ * token_transaction_hash that is cooperatively signed by the SO group to
+ * confirm a token transaction.
+ */
+interface TokenTransaction {
+    /**
+     * For mint transactions issuer_public_key will be specified without any
+     * outputs_to_spend. For transfer transactions the token amount in the input
+     * leaves must match the token amount in the output leaves.
+     */
+    version: number;
+    tokenInputs?: {
+        $case: "mintInput";
+        mintInput: TokenMintInput;
+    } | {
+        $case: "transferInput";
+        transferInput: TokenTransferInput;
+    } | undefined;
+    tokenOutputs: TokenOutput[];
+    sparkOperatorIdentityPublicKeys: Uint8Array[];
+    /**
+     * Server-set expiry time. The server calculates this by adding the client's
+     * requested validity_duration_seconds to the server's current time when
+     * creating the final transaction.
+     */
+    expiryTime: Date | undefined;
+    network: Network;
+}
+declare const TokenTransaction: MessageFns<TokenTransaction>;
+interface SignatureWithIndex {
+    /**
+     * This is a Schnorr or ECDSA DER signature which can be between 64 and 73
+     * bytes.
+     */
+    signature: Uint8Array;
+    /** The index of the TTXO associated with this signature. */
+    inputIndex: number;
+}
+declare const SignatureWithIndex: MessageFns<SignatureWithIndex>;
+/**
+ * A group of signatures for the input TTXOs binding them to the final token
+ * transaction hash. This bundle of signatures is specific to a given operator.
+ */
+interface InputTtxoSignaturesPerOperator {
+    ttxoSignatures: SignatureWithIndex[];
+    operatorIdentityPublicKey: Uint8Array;
+}
+declare const InputTtxoSignaturesPerOperator: MessageFns<InputTtxoSignaturesPerOperator>;
+/** === Start Transaction === */
+interface StartTransactionRequest {
+    identityPublicKey: Uint8Array;
+    partialTokenTransaction: TokenTransaction | undefined;
+    /**
+     * 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 output for the output owner_public_key
+     */
+    partialTokenTransactionOwnerSignatures: SignatureWithIndex[];
+    /**
+     * How long the transaction should be valid for, in seconds.
+     * The server will set the actual expiry_time in the final transaction based
+     * on this duration. Must be between 1 and 300 seconds.
+     */
+    validityDurationSeconds: number;
+}
+declare const StartTransactionRequest: MessageFns<StartTransactionRequest>;
+interface StartTransactionResponse {
+    finalTokenTransaction: TokenTransaction | undefined;
+    keyshareInfo: SigningKeyshare | undefined;
+}
+declare const StartTransactionResponse: MessageFns<StartTransactionResponse>;
+interface CommitTransactionRequest {
+    finalTokenTransaction: TokenTransaction | undefined;
+    finalTokenTransactionHash: Uint8Array;
+    inputTtxoSignaturesPerOperator: InputTtxoSignaturesPerOperator[];
+    ownerIdentityPublicKey: Uint8Array;
+}
+declare const CommitTransactionRequest: MessageFns<CommitTransactionRequest>;
+interface CommitTransactionResponse {
+}
+declare const CommitTransactionResponse: MessageFns<CommitTransactionResponse>;
+type SparkTokenServiceDefinition = typeof SparkTokenServiceDefinition;
+declare const SparkTokenServiceDefinition: {
+    readonly name: "SparkTokenService";
+    readonly fullName: "spark_token.SparkTokenService";
+    readonly methods: {
+        /**
+         * Start process to create final token transaction with all inputs required
+         * from user and SOs (including revocation secret commitment)
+         */
+        readonly start_transaction: {
+            readonly name: "start_transaction";
+            readonly requestType: MessageFns<StartTransactionRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<StartTransactionResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /**
+         * Complete the transaction and commit it with all SOs. This will be
+         * coordinated by one SO.
+         */
+        readonly commit_transaction: {
+            readonly name: "commit_transaction";
+            readonly requestType: MessageFns<CommitTransactionRequest>;
+            readonly requestStream: false;
+            readonly responseType: MessageFns<CommitTransactionResponse>;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+    };
+};
+interface SparkTokenServiceImplementation<CallContextExt = {}> {
+    /**
+     * Start process to create final token transaction with all inputs required
+     * from user and SOs (including revocation secret commitment)
+     */
+    start_transaction(request: StartTransactionRequest, context: CallContext & CallContextExt): Promise<DeepPartial<StartTransactionResponse>>;
+    /**
+     * Complete the transaction and commit it with all SOs. This will be
+     * coordinated by one SO.
+     */
+    commit_transaction(request: CommitTransactionRequest, context: CallContext & CallContextExt): Promise<DeepPartial<CommitTransactionResponse>>;
+}
+interface SparkTokenServiceClient<CallOptionsExt = {}> {
+    /**
+     * Start process to create final token transaction with all inputs required
+     * from user and SOs (including revocation secret commitment)
+     */
+    start_transaction(request: DeepPartial<StartTransactionRequest>, options?: CallOptions & CallOptionsExt): Promise<StartTransactionResponse>;
+    /**
+     * Complete the transaction and commit it with all SOs. This will be
+     * coordinated by one SO.
+     */
+    commit_transaction(request: DeepPartial<CommitTransactionRequest>, options?: CallOptions & CallOptionsExt): Promise<CommitTransactionResponse>;
+}
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
+    $case: string;
+} ? {
+    [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
+} & {
+    $case: T["$case"];
+} : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
+}
+
+export { CommitTransactionRequest, CommitTransactionResponse, type DeepPartial, InputTtxoSignaturesPerOperator, type MessageFns, SignatureWithIndex, type SparkTokenServiceClient, SparkTokenServiceDefinition, type SparkTokenServiceImplementation, StartTransactionRequest, StartTransactionResponse, TokenMintInput, TokenOutput, TokenOutputToSpend, TokenTransaction, TokenTransferInput, protobufPackage };

package/dist/proto/spark_token.js

@@ -0,0 +1,32 @@
+import {
+  CommitTransactionRequest,
+  CommitTransactionResponse,
+  InputTtxoSignaturesPerOperator,
+  SignatureWithIndex,
+  SparkTokenServiceDefinition,
+  StartTransactionRequest,
+  StartTransactionResponse,
+  TokenMintInput,
+  TokenOutput,
+  TokenOutputToSpend,
+  TokenTransaction,
+  TokenTransferInput,
+  protobufPackage
+} from "../chunk-VA7MV4MZ.js";
+import "../chunk-M6A4KFIG.js";
+import "../chunk-MVRQ5US7.js";
+export {
+  CommitTransactionRequest,
+  CommitTransactionResponse,
+  InputTtxoSignaturesPerOperator,
+  SignatureWithIndex,
+  SparkTokenServiceDefinition,
+  StartTransactionRequest,
+  StartTransactionResponse,
+  TokenMintInput,
+  TokenOutput,
+  TokenOutputToSpend,
+  TokenTransaction,
+  TokenTransferInput,
+  protobufPackage
+};

package/dist/{sdk-types-BuVMn2rX.d.cts → sdk-types-CfhdFnsA.d.cts}

@@ -1,4 +1,4 @@
-import { a as TransferStatus, S as SigningKeyshare, N as Network, b as TransferType, d as TreeNode, e as TransferLeaf, f as Transfer } from './spark-DXYE9gMM.cjs';
+import { T as TransferStatus, S as SigningKeyshare, N as Network, a as TransferType, b as TreeNode, d as TransferLeaf, e as Transfer } from './spark-DjR1b3TC.cjs';
 
 interface WalletLeaf {
     id: string;

package/dist/{sdk-types-BeI6DM_M.d.ts → sdk-types-MnQrHolg.d.ts}

@@ -1,4 +1,4 @@
-import { a as TransferStatus, S as SigningKeyshare, N as Network, b as TransferType, d as TreeNode, e as TransferLeaf, f as Transfer } from './spark-DXYE9gMM.js';
+import { T as TransferStatus, S as SigningKeyshare, N as Network, a as TransferType, b as TreeNode, d as TransferLeaf, e as Transfer } from './spark-DjR1b3TC.js';
 
 interface WalletLeaf {
     id: string;