Skip to content

Commit f313627

Browse files
quakeCopilot
andcommitted
fix(fiber-js): align pubkey wire typing
Use Pubkey type (no 0x prefix) for RPC pubkey fields and params instead of HexString. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent d434827 commit f313627

File tree

6 files changed

+23
-20
lines changed

6 files changed

+23
-20
lines changed

fiber-js/src/types/channel.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { HexString } from "./general";
1+
import { HexString, Pubkey } from "./general";
22

33
interface Script {
44
code_hash: HexString;
@@ -7,7 +7,7 @@ interface Script {
77
}
88

99
interface OpenChannelParams {
10-
pubkey: HexString;
10+
pubkey: Pubkey;
1111
funding_amount: HexString;
1212
public?: boolean;
1313
funding_udt_type_script?: Script;
@@ -41,7 +41,7 @@ interface AcceptChannelResult {
4141
channel_id: HexString;
4242
}
4343
interface ListChannelsParams {
44-
pubkey?: HexString;
44+
pubkey?: Pubkey;
4545
include_closed?: boolean;
4646
}
4747

@@ -53,7 +53,7 @@ interface Channel {
5353
channel_id: HexString;
5454
is_public: boolean;
5555
channel_outpoint: HexString;
56-
pubkey: HexString;
56+
pubkey: Pubkey;
5757
funding_udt_type_script?: Script;
5858
state: ChannelState;
5959
local_balance: HexString;

fiber-js/src/types/general.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ interface FiberInvokeRequest {
2121
type FiberInvokeResponse = { ok: true; data: any; } | { ok: false; error: string };
2222

2323
type HexString = `0x${string}`;
24+
/** Compressed secp256k1 public key hex string without `0x` prefix (66 chars). */
25+
type Pubkey = string;
2426

2527
type HashAlgorithm = "ckb_hash" | "sha256";
2628

@@ -30,5 +32,6 @@ export type {
3032
FiberInvokeRequest,
3133
FiberInvokeResponse,
3234
HexString,
35+
Pubkey,
3336
HashAlgorithm
3437
}

fiber-js/src/types/graph.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { Script } from "./channel";
2-
import { HexString } from "./general"
2+
import { HexString, Pubkey } from "./general"
33

44
interface GraphNodesParams {
55
limit?: HexString;
@@ -39,7 +39,7 @@ type UdtCfgInfos = UdtArgInfo[];
3939
interface NodeInfo {
4040
node_name: string;
4141
addresses: string[];
42-
pubkey: HexString;
42+
pubkey: Pubkey;
4343
timestamp: HexString;
4444
chain_hash: HexString;
4545
auto_accept_min_ckb_funding_amount: HexString;
@@ -66,8 +66,8 @@ interface ChannelUpdateInfo {
6666

6767
interface ChannelInfo {
6868
channel_outpoint: HexString;
69-
node1: HexString;
70-
node2: HexString;
69+
node1: Pubkey;
70+
node2: Pubkey;
7171
created_timestamp: HexString;
7272
update_info_of_node1?: ChannelUpdateInfo;
7373
update_info_of_node2?: ChannelUpdateInfo;

fiber-js/src/types/info.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import { Script } from "./channel";
2-
import { HexString } from "./general";
2+
import { HexString, Pubkey } from "./general";
33
import { UdtCfgInfos } from "./graph";
44

55
interface NodeInfoResult {
66
version: string;
77
commit_hash: string;
8-
pubkey: string;
8+
pubkey: Pubkey;
99
node_name?: string;
1010
addresses: string[];
1111
chain_hash: HexString;

fiber-js/src/types/payment.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import { Script } from "./channel";
2-
import { HexString } from "./general"
2+
import { HexString, Pubkey } from "./general"
33
type PaymentSessionStatus = "Created" | "Inflight" | "Success" | "Failed";
44

55
interface PaymentCustomRecords {
66
[k: HexString]: HexString;
77
}
88
interface SessionRouteNode {
9-
pubkey: string;
9+
pubkey: Pubkey;
1010
amount: HexString;
1111
channel_outpoint: HexString;
1212
}
@@ -22,17 +22,17 @@ interface GetPaymentCommandResult {
2222
router?: SessionRouteNode[];
2323
}
2424
interface HopHint {
25-
pubkey: string;
25+
pubkey: Pubkey;
2626
channel_outpoint: HexString;
2727
fee_rate: HexString;
2828
tlc_expiry_delta: HexString;
2929
}
3030
interface HopRequire {
31-
pubkey: string;
31+
pubkey: Pubkey;
3232
channel_outpoint: HexString;
3333
}
3434
interface RouterHop {
35-
target: HexString;
35+
target: Pubkey;
3636
channel_outpoint: HexString;
3737
amount_received: HexString;
3838
incoming_tlc_expiry: HexString;
@@ -41,7 +41,7 @@ interface GetPaymentCommandParams {
4141
payment_hash: HexString;
4242
}
4343
interface SendPaymentCommandParams {
44-
target_pubkey?: string;
44+
target_pubkey?: Pubkey;
4545
amount?: HexString;
4646
payment_hash?: HexString;
4747
final_tlc_expiry_delta?: HexString;
@@ -51,7 +51,7 @@ interface SendPaymentCommandParams {
5151
max_fee_amount?: HexString;
5252
max_fee_rate?: HexString;
5353
max_parts?: HexString;
54-
trampoline_hops?: string[];
54+
trampoline_hops?: Pubkey[];
5555
keysend?: boolean;
5656
udt_type_script?: Script;
5757
allow_self_payment?: boolean;

fiber-js/src/types/peer.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { HexString } from "./general"
1+
import { Pubkey } from "./general"
22

33
interface ConnectPeerParams {
44
address: string;
@@ -7,11 +7,11 @@ interface ConnectPeerParams {
77
}
88

99
interface DisconnectPeerParams {
10-
pubkey: HexString;
10+
pubkey: Pubkey;
1111
}
1212

1313
interface PeerInfo {
14-
pubkey: HexString;
14+
pubkey: Pubkey;
1515
address: string;
1616
}
1717

0 commit comments

Comments
 (0)