@sats-connect/core 0.4.0-e8e6a66 → 0.4.0-f42fc9a
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +525 -216
- package/dist/index.d.ts +525 -216
- package/dist/index.js +653 -254
- package/dist/index.mjs +611 -244
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -42,15 +42,15 @@ type SignMessageOptions = RequestOptions<SignMessagePayload, SignMessageResponse
|
|
|
42
42
|
|
|
43
43
|
declare const signMessage: (options: SignMessageOptions) => Promise<void>;
|
|
44
44
|
|
|
45
|
-
interface Recipient
|
|
45
|
+
interface Recipient {
|
|
46
46
|
address: string;
|
|
47
47
|
amountSats: bigint;
|
|
48
48
|
}
|
|
49
|
-
type SerializedRecipient = Omit<Recipient
|
|
49
|
+
type SerializedRecipient = Omit<Recipient, 'amountSats'> & {
|
|
50
50
|
amountSats: string;
|
|
51
51
|
};
|
|
52
52
|
interface SendBtcTransactionPayload extends RequestPayload {
|
|
53
|
-
recipients: Recipient
|
|
53
|
+
recipients: Recipient[];
|
|
54
54
|
senderAddress: string;
|
|
55
55
|
message?: string;
|
|
56
56
|
}
|
|
@@ -313,9 +313,9 @@ declare const addressSchema: v.ObjectSchema<{
|
|
|
313
313
|
readonly purpose: v.EnumSchema<typeof AddressPurpose, undefined>;
|
|
314
314
|
readonly addressType: v.EnumSchema<typeof AddressType, undefined>;
|
|
315
315
|
}, undefined>;
|
|
316
|
-
type Address
|
|
316
|
+
type Address = v.InferOutput<typeof addressSchema>;
|
|
317
317
|
interface GetAddressResponse {
|
|
318
|
-
addresses: Address
|
|
318
|
+
addresses: Address[];
|
|
319
319
|
}
|
|
320
320
|
type GetAddressOptions = RequestOptions<GetAddressPayload, GetAddressResponse>;
|
|
321
321
|
|
|
@@ -502,6 +502,7 @@ declare const signPsbtParamsSchema: v.ObjectSchema<{
|
|
|
502
502
|
* The key is the address and the value is an array of indexes of the inputs to sign.
|
|
503
503
|
*/
|
|
504
504
|
readonly signInputs: v.RecordSchema<v.StringSchema<undefined>, v.ArraySchema<v.NumberSchema<undefined>, undefined>, undefined>;
|
|
505
|
+
readonly allowedSignHash: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
505
506
|
/**
|
|
506
507
|
* Whether to broadcast the transaction after signing.
|
|
507
508
|
**/
|
|
@@ -532,6 +533,7 @@ declare const signPsbtRequestMessageSchema: v.ObjectSchema<{
|
|
|
532
533
|
* The key is the address and the value is an array of indexes of the inputs to sign.
|
|
533
534
|
*/
|
|
534
535
|
readonly signInputs: v.RecordSchema<v.StringSchema<undefined>, v.ArraySchema<v.NumberSchema<undefined>, undefined>, undefined>;
|
|
536
|
+
readonly allowedSignHash: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
535
537
|
/**
|
|
536
538
|
* Whether to broadcast the transaction after signing.
|
|
537
539
|
**/
|
|
@@ -621,6 +623,7 @@ declare const getInscriptionsParamsSchema: v.ObjectSchema<{
|
|
|
621
623
|
readonly offset: v.NumberSchema<undefined>;
|
|
622
624
|
readonly limit: v.NumberSchema<undefined>;
|
|
623
625
|
}, undefined>;
|
|
626
|
+
type GetInscriptionsParams = v.InferOutput<typeof getInscriptionsParamsSchema>;
|
|
624
627
|
declare const getInscriptionsResultSchema: v.ObjectSchema<{
|
|
625
628
|
readonly total: v.NumberSchema<undefined>;
|
|
626
629
|
readonly limit: v.NumberSchema<undefined>;
|
|
@@ -639,7 +642,8 @@ declare const getInscriptionsResultSchema: v.ObjectSchema<{
|
|
|
639
642
|
readonly output: v.StringSchema<undefined>;
|
|
640
643
|
}, undefined>, undefined>;
|
|
641
644
|
}, undefined>;
|
|
642
|
-
|
|
645
|
+
type GetInscriptionsResult = v.InferOutput<typeof getInscriptionsResultSchema>;
|
|
646
|
+
declare const getInscriptionsRequestMessageSchema: v.ObjectSchema<{
|
|
643
647
|
readonly method: v.LiteralSchema<"ord_getInscriptions", undefined>;
|
|
644
648
|
readonly params: v.ObjectSchema<{
|
|
645
649
|
readonly offset: v.NumberSchema<undefined>;
|
|
@@ -648,7 +652,8 @@ declare const getInscriptionsSchema: v.ObjectSchema<{
|
|
|
648
652
|
readonly id: v.StringSchema<undefined>;
|
|
649
653
|
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
650
654
|
}, undefined>;
|
|
651
|
-
type
|
|
655
|
+
type GetInscriptionsRequestMessage = v.InferOutput<typeof getInscriptionsRequestMessageSchema>;
|
|
656
|
+
type GetInscriptions = MethodParamsAndResult<GetInscriptionsParams, GetInscriptionsResult>;
|
|
652
657
|
declare const sendInscriptionsMethodName = "ord_sendInscriptions";
|
|
653
658
|
declare const sendInscriptionsParamsSchema: v.ObjectSchema<{
|
|
654
659
|
readonly transfers: v.ArraySchema<v.ObjectSchema<{
|
|
@@ -656,10 +661,12 @@ declare const sendInscriptionsParamsSchema: v.ObjectSchema<{
|
|
|
656
661
|
readonly inscriptionId: v.StringSchema<undefined>;
|
|
657
662
|
}, undefined>, undefined>;
|
|
658
663
|
}, undefined>;
|
|
664
|
+
type SendInscriptionsParams = v.InferOutput<typeof sendInscriptionsParamsSchema>;
|
|
659
665
|
declare const sendInscriptionsResultSchema: v.ObjectSchema<{
|
|
660
666
|
readonly txid: v.StringSchema<undefined>;
|
|
661
667
|
}, undefined>;
|
|
662
|
-
|
|
668
|
+
type SendInscriptionsResult = v.InferOutput<typeof sendInscriptionsResultSchema>;
|
|
669
|
+
declare const sendInscriptionsRequestMessageSchema: v.ObjectSchema<{
|
|
663
670
|
readonly method: v.LiteralSchema<"ord_sendInscriptions", undefined>;
|
|
664
671
|
readonly params: v.ObjectSchema<{
|
|
665
672
|
readonly transfers: v.ArraySchema<v.ObjectSchema<{
|
|
@@ -670,7 +677,8 @@ declare const sendInscriptionsSchema: v.ObjectSchema<{
|
|
|
670
677
|
readonly id: v.StringSchema<undefined>;
|
|
671
678
|
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
672
679
|
}, undefined>;
|
|
673
|
-
type
|
|
680
|
+
type SendInscriptionsRequestMessage = v.InferOutput<typeof sendInscriptionsRequestMessageSchema>;
|
|
681
|
+
type SendInscriptions = MethodParamsAndResult<SendInscriptionsParams, SendInscriptionsResult>;
|
|
674
682
|
|
|
675
683
|
type CreateMintOrderRequest = {
|
|
676
684
|
runeName: string;
|
|
@@ -738,55 +746,95 @@ type RBFOrderResponse = {
|
|
|
738
746
|
fundingAddress: string;
|
|
739
747
|
};
|
|
740
748
|
|
|
741
|
-
interface
|
|
742
|
-
network?: BitcoinNetworkType;
|
|
743
|
-
}
|
|
744
|
-
type EstimateRunesMintResult = EstimateOrderResponse;
|
|
745
|
-
type EstimateRunesMint = MethodParamsAndResult<EstimateRunesMintParams, EstimateRunesMintResult>;
|
|
746
|
-
interface MintRunesParams extends CreateMintOrderRequest {
|
|
747
|
-
network?: BitcoinNetworkType;
|
|
748
|
-
}
|
|
749
|
-
type MintRunesResult = {
|
|
750
|
-
orderId: string;
|
|
751
|
-
fundTransactionId: string;
|
|
752
|
-
fundingAddress: string;
|
|
753
|
-
};
|
|
754
|
-
type MintRunes = MethodParamsAndResult<MintRunesParams, MintRunesResult>;
|
|
755
|
-
interface EstimateRunesEtchParams extends EstimateEtchOrderRequest {
|
|
756
|
-
network?: BitcoinNetworkType;
|
|
757
|
-
}
|
|
758
|
-
type EstimateRunesEtchResult = EstimateOrderResponse;
|
|
759
|
-
type EstimateRunesEtch = MethodParamsAndResult<EstimateRunesEtchParams, EstimateRunesEtchResult>;
|
|
760
|
-
interface EtchRunesParams extends CreateEtchOrderRequest {
|
|
761
|
-
network?: BitcoinNetworkType;
|
|
762
|
-
}
|
|
763
|
-
type EtchRunesResult = {
|
|
764
|
-
orderId: string;
|
|
765
|
-
fundTransactionId: string;
|
|
766
|
-
fundingAddress: string;
|
|
767
|
-
};
|
|
768
|
-
type EtchRunes = MethodParamsAndResult<EtchRunesParams, EtchRunesResult>;
|
|
769
|
-
interface GetOrderParams extends GetOrderRequest {
|
|
749
|
+
interface RunesEstimateEtchParams extends EstimateEtchOrderRequest {
|
|
770
750
|
network?: BitcoinNetworkType;
|
|
771
751
|
}
|
|
772
|
-
type
|
|
773
|
-
|
|
752
|
+
type RunesEstimateEtchResult = EstimateOrderResponse;
|
|
753
|
+
type RunesEstimateEtch = MethodParamsAndResult<RunesEstimateEtchParams, RunesEstimateEtchResult>;
|
|
754
|
+
|
|
755
|
+
interface runesEstimateMintParams extends EstimateMintOrderRequest {
|
|
774
756
|
network?: BitcoinNetworkType;
|
|
775
757
|
}
|
|
776
|
-
type
|
|
777
|
-
|
|
758
|
+
type runesEstimateMintResult = EstimateOrderResponse;
|
|
759
|
+
type RunesEstimateMint = MethodParamsAndResult<runesEstimateMintParams, runesEstimateMintResult>;
|
|
760
|
+
|
|
761
|
+
interface RunesEstimateRbfOrderParams extends RBFOrderRequest {
|
|
778
762
|
network?: BitcoinNetworkType;
|
|
779
763
|
}
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
764
|
+
type RunesEstimateRbfOrder = MethodParamsAndResult<RunesEstimateRbfOrderParams, RBFOrderResponse>;
|
|
765
|
+
|
|
766
|
+
declare const runesEtchMethodName = "runes_etch";
|
|
767
|
+
declare const runesEtchParamsSchema: v.ObjectSchema<{
|
|
768
|
+
readonly runeName: v.StringSchema<undefined>;
|
|
769
|
+
readonly divisibility: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
770
|
+
readonly symbol: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
771
|
+
readonly premine: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
772
|
+
readonly isMintable: v.BooleanSchema<undefined>;
|
|
773
|
+
readonly delegateInscriptionId: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
774
|
+
readonly destinationAddress: v.StringSchema<undefined>;
|
|
775
|
+
readonly refundAddress: v.StringSchema<undefined>;
|
|
776
|
+
readonly feeRate: v.NumberSchema<undefined>;
|
|
777
|
+
readonly appServiceFee: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
778
|
+
readonly appServiceFeeAddress: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
779
|
+
readonly terms: v.OptionalSchema<v.ObjectSchema<{
|
|
780
|
+
readonly amount: v.StringSchema<undefined>;
|
|
781
|
+
readonly cap: v.StringSchema<undefined>;
|
|
782
|
+
readonly heightStart: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
783
|
+
readonly heightEnd: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
784
|
+
readonly offsetStart: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
785
|
+
readonly offsetEnd: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
786
|
+
}, undefined>, never>;
|
|
787
|
+
readonly inscriptionDetails: v.OptionalSchema<v.ObjectSchema<{
|
|
788
|
+
readonly contentType: v.StringSchema<undefined>;
|
|
789
|
+
readonly contentBase64: v.StringSchema<undefined>;
|
|
790
|
+
}, undefined>, never>;
|
|
791
|
+
readonly network: v.OptionalSchema<v.EnumSchema<typeof BitcoinNetworkType, undefined>, never>;
|
|
792
|
+
}, undefined>;
|
|
793
|
+
type RunesEtchParams = v.InferOutput<typeof runesEtchParamsSchema>;
|
|
794
|
+
declare const runesEtchResultSchema: v.ObjectSchema<{
|
|
795
|
+
readonly orderId: v.StringSchema<undefined>;
|
|
796
|
+
readonly fundTransactionId: v.StringSchema<undefined>;
|
|
797
|
+
readonly fundingAddress: v.StringSchema<undefined>;
|
|
798
|
+
}, undefined>;
|
|
799
|
+
type RunesEtchResult = v.InferOutput<typeof runesEtchResultSchema>;
|
|
800
|
+
declare const runesEtchRequestMessageSchema: v.ObjectSchema<{
|
|
801
|
+
readonly method: v.LiteralSchema<"runes_etch", undefined>;
|
|
802
|
+
readonly params: v.ObjectSchema<{
|
|
803
|
+
readonly runeName: v.StringSchema<undefined>;
|
|
804
|
+
readonly divisibility: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
805
|
+
readonly symbol: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
806
|
+
readonly premine: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
807
|
+
readonly isMintable: v.BooleanSchema<undefined>;
|
|
808
|
+
readonly delegateInscriptionId: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
809
|
+
readonly destinationAddress: v.StringSchema<undefined>;
|
|
810
|
+
readonly refundAddress: v.StringSchema<undefined>;
|
|
811
|
+
readonly feeRate: v.NumberSchema<undefined>;
|
|
812
|
+
readonly appServiceFee: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
813
|
+
readonly appServiceFeeAddress: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
814
|
+
readonly terms: v.OptionalSchema<v.ObjectSchema<{
|
|
815
|
+
readonly amount: v.StringSchema<undefined>;
|
|
816
|
+
readonly cap: v.StringSchema<undefined>;
|
|
817
|
+
readonly heightStart: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
818
|
+
readonly heightEnd: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
819
|
+
readonly offsetStart: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
820
|
+
readonly offsetEnd: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
821
|
+
}, undefined>, never>;
|
|
822
|
+
readonly inscriptionDetails: v.OptionalSchema<v.ObjectSchema<{
|
|
823
|
+
readonly contentType: v.StringSchema<undefined>;
|
|
824
|
+
readonly contentBase64: v.StringSchema<undefined>;
|
|
825
|
+
}, undefined>, never>;
|
|
826
|
+
readonly network: v.OptionalSchema<v.EnumSchema<typeof BitcoinNetworkType, undefined>, never>;
|
|
827
|
+
}, undefined>;
|
|
828
|
+
readonly id: v.StringSchema<undefined>;
|
|
829
|
+
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
830
|
+
}, undefined>;
|
|
831
|
+
type RunesEtchRequestMessage = v.InferOutput<typeof runesEtchRequestMessageSchema>;
|
|
832
|
+
type RunesEtch = MethodParamsAndResult<v.InferOutput<typeof runesEtchParamsSchema>, v.InferOutput<typeof runesEtchResultSchema>>;
|
|
833
|
+
|
|
834
|
+
declare const runesGetBalanceMethodName = "runes_getBalance";
|
|
835
|
+
declare const runesGetBalanceParamsSchema: v.NullishSchema<v.NullSchema<undefined>, never>;
|
|
836
|
+
type RunesGetBalanceParams = v.InferOutput<typeof runesGetBalanceParamsSchema>;
|
|
837
|
+
declare const runesGetBalanceResultSchema: v.ObjectSchema<{
|
|
790
838
|
readonly balances: v.ArraySchema<v.ObjectSchema<{
|
|
791
839
|
readonly runeName: v.StringSchema<undefined>;
|
|
792
840
|
readonly amount: v.StringSchema<undefined>;
|
|
@@ -795,25 +843,81 @@ declare const getRunesBalanceResultSchema: v.ObjectSchema<{
|
|
|
795
843
|
readonly inscriptionId: v.NullishSchema<v.StringSchema<undefined>, never>;
|
|
796
844
|
}, undefined>, undefined>;
|
|
797
845
|
}, undefined>;
|
|
798
|
-
type
|
|
799
|
-
declare const
|
|
846
|
+
type RunesGetBalanceResult = v.InferOutput<typeof runesGetBalanceResultSchema>;
|
|
847
|
+
declare const runesGetBalanceRequestMessageSchema: v.ObjectSchema<{
|
|
800
848
|
readonly method: v.LiteralSchema<"runes_getBalance", undefined>;
|
|
801
849
|
readonly params: v.NullishSchema<v.NullSchema<undefined>, never>;
|
|
802
850
|
readonly id: v.StringSchema<undefined>;
|
|
803
851
|
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
804
852
|
}, undefined>;
|
|
805
|
-
type
|
|
806
|
-
type
|
|
807
|
-
|
|
808
|
-
|
|
853
|
+
type runesGetBalanceRequestMessage = v.InferOutput<typeof runesGetBalanceRequestMessageSchema>;
|
|
854
|
+
type RunesGetBalance = MethodParamsAndResult<RunesGetBalanceParams, RunesGetBalanceResult>;
|
|
855
|
+
|
|
856
|
+
interface RunesGetOrderParams extends GetOrderRequest {
|
|
857
|
+
network?: BitcoinNetworkType;
|
|
858
|
+
}
|
|
859
|
+
type RunesGetOrder = MethodParamsAndResult<RunesGetOrderParams, GetOrderResponse>;
|
|
860
|
+
|
|
861
|
+
declare const runesMintMethodName = "runes_mint";
|
|
862
|
+
declare const runesMintParamsSchema: v.ObjectSchema<{
|
|
863
|
+
readonly appServiceFee: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
864
|
+
readonly appServiceFeeAddress: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
865
|
+
readonly destinationAddress: v.StringSchema<undefined>;
|
|
866
|
+
readonly feeRate: v.NumberSchema<undefined>;
|
|
867
|
+
readonly refundAddress: v.StringSchema<undefined>;
|
|
868
|
+
readonly repeats: v.NumberSchema<undefined>;
|
|
869
|
+
readonly runeName: v.StringSchema<undefined>;
|
|
870
|
+
readonly network: v.OptionalSchema<v.EnumSchema<typeof BitcoinNetworkType, undefined>, never>;
|
|
871
|
+
}, undefined>;
|
|
872
|
+
type RunesMintParams = v.InferOutput<typeof runesMintParamsSchema>;
|
|
873
|
+
declare const runesMintResultSchema: v.ObjectSchema<{
|
|
874
|
+
readonly orderId: v.StringSchema<undefined>;
|
|
875
|
+
readonly fundTransactionId: v.StringSchema<undefined>;
|
|
876
|
+
readonly fundingAddress: v.StringSchema<undefined>;
|
|
877
|
+
}, undefined>;
|
|
878
|
+
type RunesMintResult = v.InferOutput<typeof runesMintResultSchema>;
|
|
879
|
+
declare const runesMintRequestMessageSchema: v.ObjectSchema<{
|
|
880
|
+
readonly method: v.LiteralSchema<"runes_mint", undefined>;
|
|
881
|
+
readonly params: v.ObjectSchema<{
|
|
882
|
+
readonly appServiceFee: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
883
|
+
readonly appServiceFeeAddress: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
884
|
+
readonly destinationAddress: v.StringSchema<undefined>;
|
|
885
|
+
readonly feeRate: v.NumberSchema<undefined>;
|
|
886
|
+
readonly refundAddress: v.StringSchema<undefined>;
|
|
887
|
+
readonly repeats: v.NumberSchema<undefined>;
|
|
888
|
+
readonly runeName: v.StringSchema<undefined>;
|
|
889
|
+
readonly network: v.OptionalSchema<v.EnumSchema<typeof BitcoinNetworkType, undefined>, never>;
|
|
890
|
+
}, undefined>;
|
|
891
|
+
readonly id: v.StringSchema<undefined>;
|
|
892
|
+
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
893
|
+
}, undefined>;
|
|
894
|
+
type RunesMintRequestMessage = v.InferOutput<typeof runesMintRequestMessageSchema>;
|
|
895
|
+
type RunesMint = MethodParamsAndResult<v.InferOutput<typeof runesMintParamsSchema>, v.InferOutput<typeof runesMintResultSchema>>;
|
|
896
|
+
|
|
897
|
+
interface RunesRbfOrderParams extends RBFOrderRequest {
|
|
898
|
+
network?: BitcoinNetworkType;
|
|
899
|
+
}
|
|
900
|
+
interface RunesRbfOrderResult {
|
|
901
|
+
orderId: string;
|
|
902
|
+
fundRBFTransactionId: string;
|
|
903
|
+
fundingAddress: string;
|
|
904
|
+
}
|
|
905
|
+
type RunesRbfOrder = MethodParamsAndResult<RunesRbfOrderParams, RunesRbfOrderResult>;
|
|
906
|
+
|
|
907
|
+
declare const runesTransferMethodName = "runes_transfer";
|
|
908
|
+
declare const runesTransferParamsSchema: v.ObjectSchema<{
|
|
809
909
|
readonly recipients: v.ArraySchema<v.ObjectSchema<{
|
|
810
910
|
readonly runeName: v.StringSchema<undefined>;
|
|
811
911
|
readonly amount: v.StringSchema<undefined>;
|
|
812
912
|
readonly address: v.StringSchema<undefined>;
|
|
813
913
|
}, undefined>, undefined>;
|
|
814
914
|
}, undefined>;
|
|
815
|
-
type TransferRunesParams = v.InferOutput<typeof
|
|
816
|
-
declare const
|
|
915
|
+
type TransferRunesParams = v.InferOutput<typeof runesTransferParamsSchema>;
|
|
916
|
+
declare const runesTransferResultSchema: v.ObjectSchema<{
|
|
917
|
+
readonly txid: v.StringSchema<undefined>;
|
|
918
|
+
}, undefined>;
|
|
919
|
+
type RunesTransferResult = v.InferOutput<typeof runesTransferResultSchema>;
|
|
920
|
+
declare const runesTransferRequestMessageSchema: v.ObjectSchema<{
|
|
817
921
|
readonly method: v.LiteralSchema<"runes_transfer", undefined>;
|
|
818
922
|
readonly params: v.ObjectSchema<{
|
|
819
923
|
readonly recipients: v.ArraySchema<v.ObjectSchema<{
|
|
@@ -825,134 +929,24 @@ declare const transferRunesRequestSchema: v.ObjectSchema<{
|
|
|
825
929
|
readonly id: v.StringSchema<undefined>;
|
|
826
930
|
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
827
931
|
}, undefined>;
|
|
828
|
-
type
|
|
829
|
-
|
|
830
|
-
readonly txid: v.StringSchema<undefined>;
|
|
831
|
-
}, undefined>;
|
|
832
|
-
type TransferRunesResult = v.InferOutput<typeof TransferRunesResultSchema>;
|
|
833
|
-
type TransferRunes = MethodParamsAndResult<TransferRunesParams, TransferRunesResult>;
|
|
932
|
+
type RunesTransferRequestMessage = v.InferOutput<typeof runesTransferRequestMessageSchema>;
|
|
933
|
+
type RunesTransfer = MethodParamsAndResult<TransferRunesParams, RunesTransferResult>;
|
|
834
934
|
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
* When sending a transfer STX request to a wallet, users can generally
|
|
838
|
-
* choose from which accout they want to send the STX tokens from. In
|
|
839
|
-
* cases where applications want the transfer to be made from a specific
|
|
840
|
-
* account, they can provide the `pubkey` of the address they'd like the
|
|
841
|
-
* transfer to be made from. It is up to wallet providers to handle this
|
|
842
|
-
* field as they see fit.
|
|
843
|
-
*/
|
|
844
|
-
pubkey: string;
|
|
845
|
-
}
|
|
846
|
-
interface Address {
|
|
847
|
-
/**
|
|
848
|
-
* A Crockford base-32 encoded Stacks address.
|
|
849
|
-
*/
|
|
850
|
-
address: string;
|
|
851
|
-
}
|
|
852
|
-
interface PostConditions {
|
|
935
|
+
declare const stxCallContractMethodName = "stx_callContract";
|
|
936
|
+
declare const stxCallContractParamsSchema: v.ObjectSchema<{
|
|
853
937
|
/**
|
|
854
|
-
*
|
|
855
|
-
*
|
|
856
|
-
* A post condition may be converted to it's hex representation using the `serializePostCondition` helper from the `@stacks/transactions` package,
|
|
857
|
-
*
|
|
858
|
-
* ```js
|
|
859
|
-
* import { serializePostCondition } from '@stacks/transactions';
|
|
860
|
-
*
|
|
861
|
-
* const postCondition = somePostCondition;
|
|
862
|
-
* const hexPostCondition = serializePostCondition(postCondition).toString('hex');
|
|
863
|
-
* ```
|
|
864
|
-
*/
|
|
865
|
-
postConditions: Array<string>;
|
|
866
|
-
}
|
|
867
|
-
interface PostConditionMode {
|
|
868
|
-
/**
|
|
869
|
-
* The mode of the post conditions.
|
|
870
|
-
*/
|
|
871
|
-
postConditionMode: number;
|
|
872
|
-
}
|
|
873
|
-
interface ParameterFormatVersion {
|
|
874
|
-
/**
|
|
875
|
-
* Version of parameter format.
|
|
876
|
-
*/
|
|
877
|
-
version: string;
|
|
878
|
-
}
|
|
879
|
-
interface Recipient {
|
|
880
|
-
/**
|
|
881
|
-
* The recipeint's Crockford base-32 encoded Stacks address.
|
|
882
|
-
*/
|
|
883
|
-
recipient: string;
|
|
884
|
-
}
|
|
885
|
-
interface Amount {
|
|
886
|
-
/**
|
|
887
|
-
* Amount of STX tokens to transfer in microstacks as a string. Anything
|
|
888
|
-
* parseable by `BigInt` is acceptable.
|
|
889
|
-
*
|
|
890
|
-
* Example,
|
|
891
|
-
*
|
|
892
|
-
* ```js
|
|
893
|
-
* const amount1 = 1234;
|
|
894
|
-
* const amount2 = 1234n;
|
|
895
|
-
* const amount3 = '1234';
|
|
896
|
-
* ```
|
|
897
|
-
*/
|
|
898
|
-
amount: number | string;
|
|
899
|
-
}
|
|
900
|
-
interface Memo {
|
|
901
|
-
/**
|
|
902
|
-
* A string representing the memo.
|
|
903
|
-
*/
|
|
904
|
-
memo: string;
|
|
905
|
-
}
|
|
906
|
-
interface TxId {
|
|
907
|
-
/**
|
|
908
|
-
* The ID of the transaction.
|
|
909
|
-
*/
|
|
910
|
-
txid: string;
|
|
911
|
-
}
|
|
912
|
-
interface Transaction {
|
|
913
|
-
/**
|
|
914
|
-
* A Stacks transaction as a hex-encoded string.
|
|
915
|
-
*/
|
|
916
|
-
transaction: string;
|
|
917
|
-
}
|
|
918
|
-
interface Message {
|
|
919
|
-
/**
|
|
920
|
-
* Message payload to be signed.
|
|
921
|
-
*/
|
|
922
|
-
message: string;
|
|
923
|
-
}
|
|
924
|
-
interface Signature {
|
|
925
|
-
/**
|
|
926
|
-
* Signature of the message.
|
|
927
|
-
*/
|
|
928
|
-
signature: string;
|
|
929
|
-
}
|
|
930
|
-
interface PublicKey {
|
|
931
|
-
/**
|
|
932
|
-
* Public key as hex-encoded string.
|
|
933
|
-
*/
|
|
934
|
-
publicKey: string;
|
|
935
|
-
}
|
|
936
|
-
interface Domain {
|
|
937
|
-
/**
|
|
938
|
-
* The domain to be signed.
|
|
939
|
-
*/
|
|
940
|
-
domain: string;
|
|
941
|
-
}
|
|
942
|
-
interface CallContractParams {
|
|
943
|
-
/**
|
|
944
|
-
* The contract's Crockford base-32 encoded Stacks address and name.
|
|
938
|
+
* The contract principal.
|
|
945
939
|
*
|
|
946
940
|
* E.g. `"SPKE...GD5C.my-contract"`
|
|
947
941
|
*/
|
|
948
|
-
contract:
|
|
942
|
+
readonly contract: v.StringSchema<undefined>;
|
|
949
943
|
/**
|
|
950
944
|
* The name of the function to call.
|
|
951
945
|
*
|
|
952
946
|
* Note: spec changes ongoing,
|
|
953
947
|
* https://github.com/stacksgov/sips/pull/166#pullrequestreview-1914236999
|
|
954
948
|
*/
|
|
955
|
-
functionName:
|
|
949
|
+
readonly functionName: v.StringSchema<undefined>;
|
|
956
950
|
/**
|
|
957
951
|
* The function's arguments. The arguments are expected to be hex-encoded
|
|
958
952
|
* strings of Clarity values.
|
|
@@ -967,42 +961,131 @@ interface CallContractParams {
|
|
|
967
961
|
* const hexArgs = functionArgs.map(cvToString);
|
|
968
962
|
* ```
|
|
969
963
|
*/
|
|
970
|
-
arguments
|
|
971
|
-
}
|
|
972
|
-
type
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
964
|
+
readonly arguments: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, never>;
|
|
965
|
+
}, undefined>;
|
|
966
|
+
type StxCallContractParams = v.InferOutput<typeof stxCallContractParamsSchema>;
|
|
967
|
+
declare const stxCallContractResultSchema: v.ObjectSchema<{
|
|
968
|
+
/**
|
|
969
|
+
* The ID of the transaction.
|
|
970
|
+
*/
|
|
971
|
+
readonly txid: v.StringSchema<undefined>;
|
|
972
|
+
/**
|
|
973
|
+
* A Stacks transaction as a hex-encoded string.
|
|
974
|
+
*/
|
|
975
|
+
readonly transaction: v.StringSchema<undefined>;
|
|
976
|
+
}, undefined>;
|
|
977
|
+
type StxCallContractResult = v.InferOutput<typeof stxCallContractResultSchema>;
|
|
978
|
+
declare const stxCallContractRequestMessageSchema: v.ObjectSchema<{
|
|
979
|
+
readonly method: v.LiteralSchema<"stx_callContract", undefined>;
|
|
980
|
+
readonly params: v.ObjectSchema<{
|
|
981
|
+
/**
|
|
982
|
+
* The contract principal.
|
|
983
|
+
*
|
|
984
|
+
* E.g. `"SPKE...GD5C.my-contract"`
|
|
985
|
+
*/
|
|
986
|
+
readonly contract: v.StringSchema<undefined>;
|
|
987
|
+
/**
|
|
988
|
+
* The name of the function to call.
|
|
989
|
+
*
|
|
990
|
+
* Note: spec changes ongoing,
|
|
991
|
+
* https://github.com/stacksgov/sips/pull/166#pullrequestreview-1914236999
|
|
992
|
+
*/
|
|
993
|
+
readonly functionName: v.StringSchema<undefined>;
|
|
994
|
+
/**
|
|
995
|
+
* The function's arguments. The arguments are expected to be hex-encoded
|
|
996
|
+
* strings of Clarity values.
|
|
997
|
+
*
|
|
998
|
+
* To convert Clarity values to their hex representation, the `cvToString`
|
|
999
|
+
* helper from the `@stacks/transactions` package may be helpful.
|
|
1000
|
+
*
|
|
1001
|
+
* ```js
|
|
1002
|
+
* import { cvToString } from '@stacks/transactions';
|
|
1003
|
+
*
|
|
1004
|
+
* const functionArgs = [someClarityValue1, someClarityValue2];
|
|
1005
|
+
* const hexArgs = functionArgs.map(cvToString);
|
|
1006
|
+
* ```
|
|
1007
|
+
*/
|
|
1008
|
+
readonly arguments: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, never>;
|
|
1009
|
+
}, undefined>;
|
|
1010
|
+
readonly id: v.StringSchema<undefined>;
|
|
1011
|
+
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
1012
|
+
}, undefined>;
|
|
1013
|
+
type StxCallContractRequestMessage = v.InferOutput<typeof stxCallContractRequestMessageSchema>;
|
|
1014
|
+
type StxCallContract = MethodParamsAndResult<StxCallContractParams, StxCallContractResult>;
|
|
1015
|
+
|
|
1016
|
+
declare const stxDeployContractMethodName = "stx_deployContract";
|
|
1017
|
+
declare const stxDeployContractParamsSchema: v.ObjectSchema<{
|
|
984
1018
|
/**
|
|
985
1019
|
* Name of the contract.
|
|
986
1020
|
*/
|
|
987
|
-
name:
|
|
1021
|
+
readonly name: v.StringSchema<undefined>;
|
|
988
1022
|
/**
|
|
989
|
-
* The code of the Clarity contract.
|
|
1023
|
+
* The source code of the Clarity contract.
|
|
990
1024
|
*/
|
|
991
|
-
clarityCode:
|
|
1025
|
+
readonly clarityCode: v.StringSchema<undefined>;
|
|
992
1026
|
/**
|
|
993
1027
|
* The version of the Clarity contract.
|
|
994
1028
|
*/
|
|
995
|
-
clarityVersion
|
|
996
|
-
}
|
|
997
|
-
type
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1029
|
+
readonly clarityVersion: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1030
|
+
}, undefined>;
|
|
1031
|
+
type StxDeployContractParams = v.InferOutput<typeof stxDeployContractParamsSchema>;
|
|
1032
|
+
declare const stxDeployContractResultSchema: v.ObjectSchema<{
|
|
1033
|
+
/**
|
|
1034
|
+
* The ID of the transaction.
|
|
1035
|
+
*/
|
|
1036
|
+
readonly txid: v.StringSchema<undefined>;
|
|
1037
|
+
/**
|
|
1038
|
+
* A Stacks transaction as a hex-encoded string.
|
|
1039
|
+
*/
|
|
1040
|
+
readonly transaction: v.StringSchema<undefined>;
|
|
1041
|
+
}, undefined>;
|
|
1042
|
+
type StxDeployContractResult = v.InferOutput<typeof stxDeployContractResultSchema>;
|
|
1043
|
+
declare const stxDeployContractRequestMessageSchema: v.ObjectSchema<{
|
|
1044
|
+
readonly method: v.LiteralSchema<"stx_deployContract", undefined>;
|
|
1045
|
+
readonly params: v.ObjectSchema<{
|
|
1046
|
+
/**
|
|
1047
|
+
* Name of the contract.
|
|
1048
|
+
*/
|
|
1049
|
+
readonly name: v.StringSchema<undefined>;
|
|
1050
|
+
/**
|
|
1051
|
+
* The source code of the Clarity contract.
|
|
1052
|
+
*/
|
|
1053
|
+
readonly clarityCode: v.StringSchema<undefined>;
|
|
1054
|
+
/**
|
|
1055
|
+
* The version of the Clarity contract.
|
|
1056
|
+
*/
|
|
1057
|
+
readonly clarityVersion: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1058
|
+
}, undefined>;
|
|
1059
|
+
readonly id: v.StringSchema<undefined>;
|
|
1060
|
+
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
1061
|
+
}, undefined>;
|
|
1062
|
+
type StxDeployContractRequestMessage = v.InferOutput<typeof stxDeployContractRequestMessageSchema>;
|
|
1063
|
+
type StxDeployContract = MethodParamsAndResult<StxDeployContractParams, StxDeployContractResult>;
|
|
1064
|
+
|
|
1065
|
+
declare const stxGetAccountsMethodName = "stx_getAccounts";
|
|
1066
|
+
declare const stxGetAccountsParamsSchema: v.NullishSchema<v.NullSchema<undefined>, never>;
|
|
1067
|
+
type StxGetAccountsParams = v.InferOutput<typeof stxGetAccountsParamsSchema>;
|
|
1068
|
+
declare const stxGetAccountsResultSchema: v.ObjectSchema<{
|
|
1069
|
+
/**
|
|
1070
|
+
* The addresses generated for the given purposes.
|
|
1071
|
+
*/
|
|
1072
|
+
readonly addresses: v.ArraySchema<v.ObjectSchema<{
|
|
1073
|
+
readonly address: v.StringSchema<undefined>;
|
|
1074
|
+
readonly publicKey: v.StringSchema<undefined>;
|
|
1075
|
+
readonly gaiaHubUrl: v.StringSchema<undefined>;
|
|
1076
|
+
readonly gaiaAppKey: v.StringSchema<undefined>;
|
|
1077
|
+
}, undefined>, undefined>;
|
|
1078
|
+
}, undefined>;
|
|
1079
|
+
type StxGetAccountsResult = v.InferOutput<typeof stxGetAccountsResultSchema>;
|
|
1080
|
+
declare const stxGetAccountsRequestMessageSchema: v.ObjectSchema<{
|
|
1081
|
+
readonly method: v.LiteralSchema<"stx_getAccounts", undefined>;
|
|
1082
|
+
readonly params: v.NullishSchema<v.NullSchema<undefined>, never>;
|
|
1083
|
+
readonly id: v.StringSchema<undefined>;
|
|
1084
|
+
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
1085
|
+
}, undefined>;
|
|
1086
|
+
type StxGetAccountsRequestMessage = v.InferOutput<typeof stxGetAccountsRequestMessageSchema>;
|
|
1087
|
+
type StxGetAccounts = MethodParamsAndResult<StxGetAccountsParams, StxGetAccountsResult>;
|
|
1088
|
+
|
|
1006
1089
|
declare const stxGetAddressesMethodName = "stx_getAddresses";
|
|
1007
1090
|
declare const stxGetAddressesParamsSchema: v.NullishSchema<v.ObjectSchema<{
|
|
1008
1091
|
/**
|
|
@@ -1036,6 +1119,113 @@ declare const stxGetAddressesRequestMessageSchema: v.ObjectSchema<{
|
|
|
1036
1119
|
}, undefined>;
|
|
1037
1120
|
type StxGetAddressesRequestMessage = v.InferOutput<typeof stxGetAddressesRequestMessageSchema>;
|
|
1038
1121
|
type StxGetAddresses = MethodParamsAndResult<v.InferOutput<typeof stxGetAddressesParamsSchema>, v.InferOutput<typeof stxGetAddressesResultSchema>>;
|
|
1122
|
+
|
|
1123
|
+
declare const stxSignMessageMethodName = "stx_signMessage";
|
|
1124
|
+
declare const stxSignMessageParamsSchema: v.ObjectSchema<{
|
|
1125
|
+
/**
|
|
1126
|
+
* The message to sign.
|
|
1127
|
+
*/
|
|
1128
|
+
readonly message: v.StringSchema<undefined>;
|
|
1129
|
+
/**
|
|
1130
|
+
* The public key to sign the message with.
|
|
1131
|
+
*/
|
|
1132
|
+
readonly publicKey: v.StringSchema<undefined>;
|
|
1133
|
+
/**
|
|
1134
|
+
* The format version of the parameter.
|
|
1135
|
+
*/
|
|
1136
|
+
readonly parameterFormatVersion: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
1137
|
+
}, undefined>;
|
|
1138
|
+
type StxSignMessageParams = v.InferOutput<typeof stxSignMessageParamsSchema>;
|
|
1139
|
+
declare const stxSignMessageResultSchema: v.ObjectSchema<{
|
|
1140
|
+
/**
|
|
1141
|
+
* The signature of the message.
|
|
1142
|
+
*/
|
|
1143
|
+
readonly signature: v.StringSchema<undefined>;
|
|
1144
|
+
/**
|
|
1145
|
+
* The public key used to sign the message.
|
|
1146
|
+
*/
|
|
1147
|
+
readonly publicKey: v.StringSchema<undefined>;
|
|
1148
|
+
}, undefined>;
|
|
1149
|
+
type StxSignMessageResult = v.InferOutput<typeof stxSignMessageResultSchema>;
|
|
1150
|
+
declare const stxSignMessageRequestMessageSchema: v.ObjectSchema<{
|
|
1151
|
+
readonly method: v.LiteralSchema<"stx_signMessage", undefined>;
|
|
1152
|
+
readonly params: v.ObjectSchema<{
|
|
1153
|
+
/**
|
|
1154
|
+
* The message to sign.
|
|
1155
|
+
*/
|
|
1156
|
+
readonly message: v.StringSchema<undefined>;
|
|
1157
|
+
/**
|
|
1158
|
+
* The public key to sign the message with.
|
|
1159
|
+
*/
|
|
1160
|
+
readonly publicKey: v.StringSchema<undefined>;
|
|
1161
|
+
/**
|
|
1162
|
+
* The format version of the parameter.
|
|
1163
|
+
*/
|
|
1164
|
+
readonly parameterFormatVersion: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
1165
|
+
}, undefined>;
|
|
1166
|
+
readonly id: v.StringSchema<undefined>;
|
|
1167
|
+
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
1168
|
+
}, undefined>;
|
|
1169
|
+
type StxSignMessageRequestMessage = v.InferOutput<typeof stxSignMessageRequestMessageSchema>;
|
|
1170
|
+
type StxSignMessage = MethodParamsAndResult<StxSignMessageParams, StxSignMessageResult>;
|
|
1171
|
+
|
|
1172
|
+
declare const stxSignStructuredMessageMethodName = "stx_signStructuredMessage";
|
|
1173
|
+
declare const stxSignStructuredMessageParamsSchema: v.ObjectSchema<{
|
|
1174
|
+
/**
|
|
1175
|
+
* The domain to be signed.
|
|
1176
|
+
*/
|
|
1177
|
+
readonly domain: v.StringSchema<undefined>;
|
|
1178
|
+
/**
|
|
1179
|
+
* Message payload to be signed.
|
|
1180
|
+
*/
|
|
1181
|
+
readonly message: v.StringSchema<undefined>;
|
|
1182
|
+
/**
|
|
1183
|
+
* The format version of the parameter.
|
|
1184
|
+
*/
|
|
1185
|
+
readonly parameterFormatVersion: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
1186
|
+
/**
|
|
1187
|
+
* The public key to sign the message with.
|
|
1188
|
+
*/
|
|
1189
|
+
readonly publicKey: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1190
|
+
}, undefined>;
|
|
1191
|
+
type StxSignStructuredMessageParams = v.InferOutput<typeof stxSignStructuredMessageParamsSchema>;
|
|
1192
|
+
declare const stxSignStructuredMessageResultSchema: v.ObjectSchema<{
|
|
1193
|
+
/**
|
|
1194
|
+
* Signature of the message.
|
|
1195
|
+
*/
|
|
1196
|
+
readonly signature: v.StringSchema<undefined>;
|
|
1197
|
+
/**
|
|
1198
|
+
* Public key as hex-encoded string.
|
|
1199
|
+
*/
|
|
1200
|
+
readonly publicKey: v.StringSchema<undefined>;
|
|
1201
|
+
}, undefined>;
|
|
1202
|
+
type StxSignStructuredMessageResult = v.InferOutput<typeof stxSignStructuredMessageResultSchema>;
|
|
1203
|
+
declare const stxSignStructuredMessageRequestMessageSchema: v.ObjectSchema<{
|
|
1204
|
+
readonly method: v.LiteralSchema<"stx_signStructuredMessage", undefined>;
|
|
1205
|
+
readonly params: v.ObjectSchema<{
|
|
1206
|
+
/**
|
|
1207
|
+
* The domain to be signed.
|
|
1208
|
+
*/
|
|
1209
|
+
readonly domain: v.StringSchema<undefined>;
|
|
1210
|
+
/**
|
|
1211
|
+
* Message payload to be signed.
|
|
1212
|
+
*/
|
|
1213
|
+
readonly message: v.StringSchema<undefined>;
|
|
1214
|
+
/**
|
|
1215
|
+
* The format version of the parameter.
|
|
1216
|
+
*/
|
|
1217
|
+
readonly parameterFormatVersion: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
1218
|
+
/**
|
|
1219
|
+
* The public key to sign the message with.
|
|
1220
|
+
*/
|
|
1221
|
+
readonly publicKey: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1222
|
+
}, undefined>;
|
|
1223
|
+
readonly id: v.StringSchema<undefined>;
|
|
1224
|
+
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
1225
|
+
}, undefined>;
|
|
1226
|
+
type StxSignStructuredMessageRequestMessage = v.InferOutput<typeof stxSignStructuredMessageRequestMessageSchema>;
|
|
1227
|
+
type StxSignStructuredMessage = MethodParamsAndResult<StxSignStructuredMessageParams, StxSignStructuredMessageResult>;
|
|
1228
|
+
|
|
1039
1229
|
declare const stxSignTransactionMethodName = "stx_signTransaction";
|
|
1040
1230
|
declare const stxSignTransactionParamsSchema: v.ObjectSchema<{
|
|
1041
1231
|
/**
|
|
@@ -1083,6 +1273,125 @@ declare const stxSignTransactionRequestMessageSchema: v.ObjectSchema<{
|
|
|
1083
1273
|
type StxSignTransactionRequestMessage = v.InferOutput<typeof stxSignTransactionRequestMessageSchema>;
|
|
1084
1274
|
type StxSignTransaction = MethodParamsAndResult<StxSignTransactionParams, StxSignTransactionResult>;
|
|
1085
1275
|
|
|
1276
|
+
declare const stxTransferStxMethodName = "stx_transferStx";
|
|
1277
|
+
declare const stxTransferStxParamsSchema: v.ObjectSchema<{
|
|
1278
|
+
/**
|
|
1279
|
+
* Amount of STX tokens to transfer in microstacks as a string. Anything
|
|
1280
|
+
* parseable by `BigInt` is acceptable.
|
|
1281
|
+
*
|
|
1282
|
+
* Example,
|
|
1283
|
+
*
|
|
1284
|
+
* ```js
|
|
1285
|
+
* const amount1 = 1234;
|
|
1286
|
+
* const amount2 = 1234n;
|
|
1287
|
+
* const amount3 = '1234';
|
|
1288
|
+
* ```
|
|
1289
|
+
*/
|
|
1290
|
+
readonly amount: v.UnionSchema<[v.NumberSchema<undefined>, v.StringSchema<undefined>], undefined>;
|
|
1291
|
+
/**
|
|
1292
|
+
* The recipeint's principal.
|
|
1293
|
+
*/
|
|
1294
|
+
readonly recipient: v.StringSchema<undefined>;
|
|
1295
|
+
/**
|
|
1296
|
+
* A string representing the memo.
|
|
1297
|
+
*/
|
|
1298
|
+
readonly memo: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1299
|
+
/**
|
|
1300
|
+
* Version of parameter format.
|
|
1301
|
+
*/
|
|
1302
|
+
readonly version: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1303
|
+
/**
|
|
1304
|
+
* The mode of the post conditions.
|
|
1305
|
+
*/
|
|
1306
|
+
readonly postConditionMode: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
1307
|
+
/**
|
|
1308
|
+
* A hex-encoded string representing the post conditions.
|
|
1309
|
+
*
|
|
1310
|
+
* A post condition may be converted to it's hex representation using the `serializePostCondition` helper from the `@stacks/transactions` package,
|
|
1311
|
+
*
|
|
1312
|
+
* ```js
|
|
1313
|
+
* import { serializePostCondition } from '@stacks/transactions';
|
|
1314
|
+
*
|
|
1315
|
+
* const postCondition = somePostCondition;
|
|
1316
|
+
* const hexPostCondition = serializePostCondition(postCondition).toString('hex');
|
|
1317
|
+
* ```
|
|
1318
|
+
*/
|
|
1319
|
+
readonly postConditions: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, never>;
|
|
1320
|
+
/**
|
|
1321
|
+
* The public key to sign the transaction with. The wallet may use any key
|
|
1322
|
+
* when not provided.
|
|
1323
|
+
*/
|
|
1324
|
+
readonly pubkey: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1325
|
+
}, undefined>;
|
|
1326
|
+
type StxTransferStxParams = v.InferOutput<typeof stxTransferStxParamsSchema>;
|
|
1327
|
+
declare const stxTransferStxResultSchema: v.ObjectSchema<{
|
|
1328
|
+
/**
|
|
1329
|
+
* The ID of the transaction.
|
|
1330
|
+
*/
|
|
1331
|
+
readonly txid: v.StringSchema<undefined>;
|
|
1332
|
+
/**
|
|
1333
|
+
* A Stacks transaction as a hex-encoded string.
|
|
1334
|
+
*/
|
|
1335
|
+
readonly transaction: v.StringSchema<undefined>;
|
|
1336
|
+
}, undefined>;
|
|
1337
|
+
type StxTransferStxResult = v.InferOutput<typeof stxTransferStxResultSchema>;
|
|
1338
|
+
declare const stxTransferStxRequestMessageSchema: v.ObjectSchema<{
|
|
1339
|
+
readonly method: v.LiteralSchema<"stx_transferStx", undefined>;
|
|
1340
|
+
readonly params: v.ObjectSchema<{
|
|
1341
|
+
/**
|
|
1342
|
+
* Amount of STX tokens to transfer in microstacks as a string. Anything
|
|
1343
|
+
* parseable by `BigInt` is acceptable.
|
|
1344
|
+
*
|
|
1345
|
+
* Example,
|
|
1346
|
+
*
|
|
1347
|
+
* ```js
|
|
1348
|
+
* const amount1 = 1234;
|
|
1349
|
+
* const amount2 = 1234n;
|
|
1350
|
+
* const amount3 = '1234';
|
|
1351
|
+
* ```
|
|
1352
|
+
*/
|
|
1353
|
+
readonly amount: v.UnionSchema<[v.NumberSchema<undefined>, v.StringSchema<undefined>], undefined>;
|
|
1354
|
+
/**
|
|
1355
|
+
* The recipeint's principal.
|
|
1356
|
+
*/
|
|
1357
|
+
readonly recipient: v.StringSchema<undefined>;
|
|
1358
|
+
/**
|
|
1359
|
+
* A string representing the memo.
|
|
1360
|
+
*/
|
|
1361
|
+
readonly memo: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1362
|
+
/**
|
|
1363
|
+
* Version of parameter format.
|
|
1364
|
+
*/
|
|
1365
|
+
readonly version: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1366
|
+
/**
|
|
1367
|
+
* The mode of the post conditions.
|
|
1368
|
+
*/
|
|
1369
|
+
readonly postConditionMode: v.OptionalSchema<v.NumberSchema<undefined>, never>;
|
|
1370
|
+
/**
|
|
1371
|
+
* A hex-encoded string representing the post conditions.
|
|
1372
|
+
*
|
|
1373
|
+
* A post condition may be converted to it's hex representation using the `serializePostCondition` helper from the `@stacks/transactions` package,
|
|
1374
|
+
*
|
|
1375
|
+
* ```js
|
|
1376
|
+
* import { serializePostCondition } from '@stacks/transactions';
|
|
1377
|
+
*
|
|
1378
|
+
* const postCondition = somePostCondition;
|
|
1379
|
+
* const hexPostCondition = serializePostCondition(postCondition).toString('hex');
|
|
1380
|
+
* ```
|
|
1381
|
+
*/
|
|
1382
|
+
readonly postConditions: v.OptionalSchema<v.ArraySchema<v.StringSchema<undefined>, undefined>, never>;
|
|
1383
|
+
/**
|
|
1384
|
+
* The public key to sign the transaction with. The wallet may use any key
|
|
1385
|
+
* when not provided.
|
|
1386
|
+
*/
|
|
1387
|
+
readonly pubkey: v.OptionalSchema<v.StringSchema<undefined>, never>;
|
|
1388
|
+
}, undefined>;
|
|
1389
|
+
readonly id: v.StringSchema<undefined>;
|
|
1390
|
+
readonly jsonrpc: v.LiteralSchema<"2.0", undefined>;
|
|
1391
|
+
}, undefined>;
|
|
1392
|
+
type StxTransferStxRequestMessage = v.InferOutput<typeof stxTransferStxRequestMessageSchema>;
|
|
1393
|
+
type StxTransferStx = MethodParamsAndResult<StxTransferStxParams, StxTransferStxResult>;
|
|
1394
|
+
|
|
1086
1395
|
/**
|
|
1087
1396
|
* Permissions with the clientId field omitted and optional actions. Used for
|
|
1088
1397
|
* permission requests, since the wallet performs authentication based on the
|
|
@@ -1578,7 +1887,7 @@ interface StxRequests {
|
|
|
1578
1887
|
stx_deployContract: StxDeployContract;
|
|
1579
1888
|
stx_getAccounts: StxGetAccounts;
|
|
1580
1889
|
stx_getAddresses: StxGetAddresses;
|
|
1581
|
-
stx_signMessage:
|
|
1890
|
+
stx_signMessage: StxSignMessage;
|
|
1582
1891
|
stx_signStructuredMessage: StxSignStructuredMessage;
|
|
1583
1892
|
stx_signTransaction: StxSignTransaction;
|
|
1584
1893
|
stx_transferStx: StxTransferStx;
|
|
@@ -1595,15 +1904,15 @@ interface BtcRequests {
|
|
|
1595
1904
|
}
|
|
1596
1905
|
type BtcRequestMethod = keyof BtcRequests;
|
|
1597
1906
|
interface RunesRequests {
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
runes_etch:
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
runes_transfer:
|
|
1907
|
+
runes_estimateEtch: RunesEstimateEtch;
|
|
1908
|
+
runes_estimateMint: RunesEstimateMint;
|
|
1909
|
+
runes_estimateRbfOrder: RunesEstimateRbfOrder;
|
|
1910
|
+
runes_etch: RunesEtch;
|
|
1911
|
+
runes_getBalance: RunesGetBalance;
|
|
1912
|
+
runes_getOrder: RunesGetOrder;
|
|
1913
|
+
runes_mint: RunesMint;
|
|
1914
|
+
runes_rbfOrder: RunesRbfOrder;
|
|
1915
|
+
runes_transfer: RunesTransfer;
|
|
1607
1916
|
}
|
|
1608
1917
|
type RunesRequestMethod = keyof RunesRequests;
|
|
1609
1918
|
interface OrdinalsRequests {
|
|
@@ -1648,4 +1957,4 @@ declare class BaseAdapter extends SatsConnectAdapter {
|
|
|
1648
1957
|
declare const DefaultAdaptersInfo: Record<string, Provider>;
|
|
1649
1958
|
declare const defaultAdapters: Record<string, new () => SatsConnectAdapter>;
|
|
1650
1959
|
|
|
1651
|
-
export { type AccountChangeEvent, type AddListener, type Address
|
|
1960
|
+
export { type AccountChangeEvent, type AddListener, type Address, AddressPurpose, AddressType, BaseAdapter, type BitcoinNetwork, BitcoinNetworkType, type BitcoinProvider, type BtcRequestMethod, type BtcRequests, type Capability, type Connect, type ConnectParams, type ConnectRequestMessage, type ConnectResult, type CreateInscriptionOptions, type CreateInscriptionPayload, type CreateInscriptionResponse, type CreateRepeatInscriptionsOptions, type CreateRepeatInscriptionsPayload, type CreateRepeatInscriptionsResponse, DefaultAdaptersInfo, type Disconnect, type DisconnectEvent, type DisconnectParams, type DisconnectRequestMessage, type DisconnectResult, type GetAccount, type GetAccountParams, type GetAccountRequestMessage, type GetAccountResult, type GetAccounts, type GetAccountsParams, type GetAccountsRequestMessage, type GetAccountsResult, type GetAddressOptions, type GetAddressPayload, type GetAddressResponse, type GetAddresses, type GetAddressesParams, type GetAddressesRequestMessage, type GetAddressesResult, type GetBalance, type GetBalanceParams, type GetBalanceRequestMessage, type GetBalanceResult, type GetCapabilitiesOptions, type GetCapabilitiesPayload, type GetCapabilitiesResponse, type GetCurrentPermissions, type GetCurrentPermissionsParams, type GetCurrentPermissionsRequestMessage, type GetCurrentPermissionsResult, type GetInfo, type GetInfoParams, type GetInfoRequestMessage, type GetInfoResult, type GetInscriptions, type GetInscriptionsParams, type GetInscriptionsRequestMessage, type GetInscriptionsResult, type GetWalletType, type GetWalletTypeParams, type GetWalletTypeRequestMessage, type GetWalletTypeResult, type InputToSign, MessageSigningProtocols, type MethodParamsAndResult, type NetworkChangeEvent, type OrdinalsRequestMethod, type OrdinalsRequests, type Params, type PermissionWithoutClientId, type Provider, type PsbtPayload, type Recipient, type RenouncePermissions, type RenouncePermissionsParams, type RenouncePermissionsRequestMessage, type RenouncePermissionsResult, type RequestOptions, type RequestPayload, type RequestPermissions, type RequestPermissionsParams, type RequestPermissionsRequestMessage, type RequestPermissionsResult, type Requests, type Return, type RpcBase, type RpcError, RpcErrorCode, type RpcErrorResponse, type RpcErrorResponseMessage, type RpcId, RpcIdSchema, type RpcRequest, type RpcRequestMessage, type RpcResponse, type RpcResponseMessage, type RpcResult, type RpcSuccessResponse, type RpcSuccessResponseMessage, type RunesEstimateEtch, type RunesEstimateEtchParams, type RunesEstimateEtchResult, type RunesEstimateMint, type RunesEstimateRbfOrder, type RunesEtch, type RunesEtchParams, type RunesEtchRequestMessage, type RunesEtchResult, type RunesGetBalance, type RunesGetBalanceParams, type RunesGetBalanceResult, type RunesGetOrder, type RunesMint, type RunesMintParams, type RunesMintRequestMessage, type RunesMintResult, type RunesRbfOrder, type RunesRequestMethod, type RunesRequests, type RunesTransfer, type RunesTransferRequestMessage, type RunesTransferResult, SatsConnectAdapter, type SendBtcTransactionOptions, type SendBtcTransactionPayload, type SendBtcTransactionResponse, type SendInscriptions, type SendInscriptionsParams, type SendInscriptionsRequestMessage, type SendInscriptionsResult, type SendTransfer, type SendTransferParams, type SendTransferRequestMessage, type SendTransferResult, type SerializedRecipient, type SerializedSendBtcTransactionPayload, type SignMessage, type SignMessageOptions, type SignMessageParams, type SignMessagePayload, type SignMessageRequestMessage, type SignMessageResponse, type SignMessageResult, type SignMultiplePsbtPayload, type SignMultipleTransactionOptions, type SignMultipleTransactionsPayload, type SignMultipleTransactionsResponse, type SignPsbt, type SignPsbtParams, type SignPsbtRequestMessage, type SignPsbtResult, type SignTransactionOptions, type SignTransactionPayload, type SignTransactionResponse, type StxCallContract, type StxCallContractParams, type StxCallContractRequestMessage, type StxCallContractResult, type StxDeployContract, type StxDeployContractParams, type StxDeployContractRequestMessage, type StxDeployContractResult, type StxGetAccounts, type StxGetAccountsParams, type StxGetAccountsRequestMessage, type StxGetAccountsResult, type StxGetAddresses, type StxGetAddressesParams, type StxGetAddressesRequestMessage, type StxGetAddressesResult, type StxRequestMethod, type StxRequests, type StxSignMessage, type StxSignMessageParams, type StxSignMessageRequestMessage, type StxSignMessageResult, type StxSignStructuredMessage, type StxSignStructuredMessageParams, type StxSignStructuredMessageRequestMessage, type StxSignStructuredMessageResult, type StxSignTransaction, type StxSignTransactionParams, type StxSignTransactionRequestMessage, type StxSignTransactionResult, type StxTransferStx, type StxTransferStxParams, type StxTransferStxRequestMessage, type StxTransferStxResult, type SupportedWallet, type TransferRunesParams, type WalletEvent, type WalletRequests, type WalletType, accountChangeEventName, accountChangeSchema, addListener, addressSchema, connectMethodName, connectParamsSchema, connectRequestMessageSchema, connectResultSchema, createInscription, createRepeatInscriptions, defaultAdapters, disconnectEventName, disconnectMethodName, disconnectParamsSchema, disconnectRequestMessageSchema, disconnectResultSchema, disconnectSchema, getAccountMethodName, getAccountParamsSchema, getAccountRequestMessageSchema, getAccountResultSchema, getAccountsMethodName, getAccountsParamsSchema, getAccountsRequestMessageSchema, getAccountsResultSchema, getAddress, getAddressesMethodName, getAddressesParamsSchema, getAddressesRequestMessageSchema, getAddressesResultSchema, getBalanceMethodName, getBalanceParamsSchema, getBalanceRequestMessageSchema, getBalanceResultSchema, getCapabilities, getCurrentPermissionsMethodName, getCurrentPermissionsParamsSchema, getCurrentPermissionsRequestMessageSchema, getCurrentPermissionsResultSchema, getDefaultProvider, getInfoMethodName, getInfoParamsSchema, getInfoRequestMessageSchema, getInfoResultSchema, getInscriptionsMethodName, getInscriptionsParamsSchema, getInscriptionsRequestMessageSchema, getInscriptionsResultSchema, getProviderById, getProviderOrThrow, getProviders, getSupportedWallets, getWalletTypeMethodName, getWalletTypeParamsSchema, getWalletTypeRequestMessageSchema, getWalletTypeResultSchema, isProviderInstalled, networkChangeEventName, networkChangeSchema, permissionTemplate, removeDefaultProvider, renouncePermissionsMethodName, renouncePermissionsParamsSchema, renouncePermissionsRequestMessageSchema, renouncePermissionsResultSchema, request, requestPermissionsMethodName, requestPermissionsParamsSchema, requestPermissionsRequestMessageSchema, requestPermissionsResultSchema, rpcErrorResponseMessageSchema, rpcRequestMessageSchema, rpcResponseMessageSchema, rpcSuccessResponseMessageSchema, type runesEstimateMintParams, type runesEstimateMintResult, runesEtchMethodName, runesEtchParamsSchema, runesEtchRequestMessageSchema, runesEtchResultSchema, runesGetBalanceMethodName, runesGetBalanceParamsSchema, type runesGetBalanceRequestMessage, runesGetBalanceRequestMessageSchema, runesGetBalanceResultSchema, runesMintMethodName, runesMintParamsSchema, runesMintRequestMessageSchema, runesMintResultSchema, runesTransferMethodName, runesTransferParamsSchema, runesTransferRequestMessageSchema, runesTransferResultSchema, sendBtcTransaction, sendInscriptionsMethodName, sendInscriptionsParamsSchema, sendInscriptionsRequestMessageSchema, sendInscriptionsResultSchema, sendTransferMethodName, sendTransferParamsSchema, sendTransferRequestMessageSchema, sendTransferResultSchema, setDefaultProvider, signMessage, signMessageMethodName, signMessageParamsSchema, signMessageRequestMessageSchema, signMessageResultSchema, signMultipleTransactions, signPsbtMethodName, signPsbtParamsSchema, signPsbtRequestMessageSchema, signPsbtResultSchema, signTransaction, stxCallContractMethodName, stxCallContractParamsSchema, stxCallContractRequestMessageSchema, stxCallContractResultSchema, stxDeployContractMethodName, stxDeployContractParamsSchema, stxDeployContractRequestMessageSchema, stxDeployContractResultSchema, stxGetAccountsMethodName, stxGetAccountsParamsSchema, stxGetAccountsRequestMessageSchema, stxGetAccountsResultSchema, stxGetAddressesMethodName, stxGetAddressesParamsSchema, stxGetAddressesRequestMessageSchema, stxGetAddressesResultSchema, stxSignMessageMethodName, stxSignMessageParamsSchema, stxSignMessageRequestMessageSchema, stxSignMessageResultSchema, stxSignStructuredMessageMethodName, stxSignStructuredMessageParamsSchema, stxSignStructuredMessageRequestMessageSchema, stxSignStructuredMessageResultSchema, stxSignTransactionMethodName, stxSignTransactionParamsSchema, stxSignTransactionRequestMessageSchema, stxSignTransactionResultSchema, stxTransferStxMethodName, stxTransferStxParamsSchema, stxTransferStxRequestMessageSchema, stxTransferStxResultSchema, walletEventSchema, walletTypeSchema, walletTypes };
|