forked from x402-foundation/x402
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathserver.go
More file actions
1154 lines (1032 loc) · 40.2 KB
/
server.go
File metadata and controls
1154 lines (1032 loc) · 40.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package x402
import (
"context"
"encoding/json"
"fmt"
"math/big"
"regexp"
"strconv"
"strings"
"sync"
"time"
"github.com/x402-foundation/x402/go/types"
)
var (
percentRegex = regexp.MustCompile(`^(\d+(?:\.\d{0,2})?)%$`)
dollarRegex = regexp.MustCompile(`^\$(\d+(?:\.\d+)?)$`)
)
// ResolveSettlementOverrideAmount resolves a settlement override amount string
// to a final atomic-unit string. Supports three formats:
// - Raw atomic units: "1000"
// - Percent of requirements.Amount: "50%" (up to 2 decimal places, floored)
// - Dollar price: "$0.05" (converted using the provided decimals)
func ResolveSettlementOverrideAmount(rawAmount string, requirements types.PaymentRequirements, decimals int) (string, error) {
if m := percentRegex.FindStringSubmatch(rawAmount); m != nil {
parts := strings.SplitN(m[1], ".", 2)
intPart, _ := strconv.ParseInt(parts[0], 10, 64)
decPart := int64(0)
if len(parts) == 2 {
padded := (parts[1] + "00")[:2]
decPart, _ = strconv.ParseInt(padded, 10, 64)
}
scaledPercent := big.NewInt(intPart*100 + decPart)
base, ok := new(big.Int).SetString(requirements.Amount, 10)
if !ok {
return "", fmt.Errorf("invalid requirements amount: %s", requirements.Amount)
}
result := new(big.Int).Mul(base, scaledPercent)
result.Div(result, big.NewInt(10000))
return result.String(), nil
}
if m := dollarRegex.FindStringSubmatch(rawAmount); m != nil {
dollarFloat, ok := new(big.Float).SetPrec(256).SetString(m[1])
if !ok {
return "", fmt.Errorf("invalid dollar amount: %s", rawAmount)
}
multiplier := new(big.Float).SetPrec(256).SetInt(
new(big.Int).Exp(big.NewInt(10), big.NewInt(int64(decimals)), nil),
)
atomicFloat := new(big.Float).SetPrec(256).Mul(dollarFloat, multiplier)
atomicInt, _ := atomicFloat.Int(nil) // truncates toward zero (floor for positive values)
return atomicInt.String(), nil
}
return rawAmount, nil
}
// x402ResourceServer manages payment requirements and verification for protected resources
// V2 ONLY - This server only produces and accepts V2 payments
type x402ResourceServer struct {
mu sync.RWMutex
// V2 only - server only produces/accepts V2 (default, no suffix)
schemes map[Network]map[string]SchemeNetworkServer
// Facilitator clients by network/scheme (can handle both V1 and V2)
facilitatorClients map[Network]map[string]FacilitatorClient
tempFacilitatorClients []FacilitatorClient // Temp storage until Initialize
registeredExtensions map[string]types.ResourceServerExtension
supportedCache *SupportedCache
// Manual lifecycle hooks registered via OnBeforeVerify / OnAfterVerify / etc.
// These fire for every request regardless of scheme/network. Mirrors TS
// `beforeVerifyHooks: BeforeVerifyHook[]` arrays.
beforeVerifyHooks []BeforeVerifyHook
afterVerifyHooks []AfterVerifyHook
onVerifyFailureHooks []OnVerifyFailureHook
beforeSettleHooks []BeforeSettleHook
afterSettleHooks []AfterSettleHook
onSettleFailureHooks []OnSettleFailureHook
onVerifiedPaymentCanceledHooks []OnVerifiedPaymentCanceledHook
// Per-scheme hook adapters: only the matched (network, scheme) entry
// fires for a given request. Mirrors TS `schemeHookAdapters: Map<Network,
// Map<scheme, SchemeAdapterHandles>>`. Replaces the previous behavior of
// appending scheme hooks into the global lists, which leaked hooks across
// unrelated schemes registered on the same server.
schemeHookAdapters map[Network]map[string]*hookAdapterHandles
// Per-extension hook adapters: only fire when the extension key is
// declared on the route via `declaredExtensions`. Mirrors TS
// `extensionHookAdapters: Map<string, ExtensionAdapterHandles>`.
extensionHookAdapters map[string]*hookAdapterHandles
}
// hookAdapterHandles bundles the optional per-phase hook funcs contributed
// by a scheme or extension. Phases left nil are skipped at invocation time.
// Mirrors TS `HookAdapterHandles`.
type hookAdapterHandles struct {
BeforeVerify BeforeVerifyHook
AfterVerify AfterVerifyHook
OnVerifyFailure OnVerifyFailureHook
BeforeSettle BeforeSettleHook
AfterSettle AfterSettleHook
OnSettleFailure OnSettleFailureHook
OnVerifiedPaymentCanceled OnVerifiedPaymentCanceledHook
}
// labeledHook tags a hook function with its source for diagnostics. The
// source string is one of "manual #N", `scheme "X"`, or `extension "Y"`.
type labeledHook[F any] struct {
Label string
Hook F
}
// SupportedCache caches facilitator capabilities
type SupportedCache struct {
mu sync.RWMutex
data map[string]SupportedResponse // key is facilitator identifier
expiry map[string]time.Time
ttl time.Duration
}
// Set stores a supported response in the cache
func (c *SupportedCache) Set(key string, response SupportedResponse) {
c.mu.Lock()
defer c.mu.Unlock()
c.data[key] = response
c.expiry[key] = time.Now().Add(c.ttl)
}
// Get retrieves a supported response from the cache
func (c *SupportedCache) Get(key string) (SupportedResponse, bool) {
c.mu.RLock()
defer c.mu.RUnlock()
response, exists := c.data[key]
if !exists {
return SupportedResponse{}, false
}
// Check if expired
if time.Now().After(c.expiry[key]) {
return SupportedResponse{}, false
}
return response, true
}
// Clear removes all cached supported responses and expiry entries
func (c *SupportedCache) Clear() {
c.mu.Lock()
defer c.mu.Unlock()
clear(c.data)
clear(c.expiry)
}
// ResourceServerOption configures the server
type ResourceServerOption func(*x402ResourceServer)
// WithFacilitatorClient adds a facilitator client
func WithFacilitatorClient(client FacilitatorClient) ResourceServerOption {
return func(s *x402ResourceServer) {
// Store temporarily - will populate map in Initialize
if s.tempFacilitatorClients == nil {
s.tempFacilitatorClients = []FacilitatorClient{}
}
s.tempFacilitatorClients = append(s.tempFacilitatorClients, client)
}
}
// WithSchemeServer registers a scheme server implementation (V2, default)
func WithSchemeServer(network Network, schemeServer SchemeNetworkServer) ResourceServerOption {
return func(s *x402ResourceServer) {
s.Register(network, schemeServer)
}
}
// WithCacheTTL sets the cache TTL for supported kinds
func WithCacheTTL(ttl time.Duration) ResourceServerOption {
return func(s *x402ResourceServer) {
s.supportedCache.ttl = ttl
}
}
func Newx402ResourceServer(opts ...ResourceServerOption) *x402ResourceServer {
s := &x402ResourceServer{
schemes: make(map[Network]map[string]SchemeNetworkServer),
facilitatorClients: make(map[Network]map[string]FacilitatorClient),
registeredExtensions: make(map[string]types.ResourceServerExtension),
schemeHookAdapters: make(map[Network]map[string]*hookAdapterHandles),
extensionHookAdapters: make(map[string]*hookAdapterHandles),
supportedCache: &SupportedCache{
data: make(map[string]SupportedResponse),
expiry: make(map[string]time.Time),
ttl: 5 * time.Minute,
},
}
for _, opt := range opts {
opt(s)
}
return s
}
// Initialize populates facilitator clients by querying GetSupported
func (s *x402ResourceServer) Initialize(ctx context.Context) error {
s.mu.Lock()
defer s.mu.Unlock()
for _, client := range s.tempFacilitatorClients {
// Get supported kinds
supported, err := client.GetSupported(ctx)
if err != nil {
return fmt.Errorf("failed to get supported from facilitator: %w", err)
}
// Populate facilitatorClients map from kinds (now flat array with version in each element)
for _, kind := range supported.Kinds {
network := Network(kind.Network)
scheme := kind.Scheme
if s.facilitatorClients[network] == nil {
s.facilitatorClients[network] = make(map[string]FacilitatorClient)
}
// Only set if not already present (precedence to earlier clients)
if s.facilitatorClients[network][scheme] == nil {
s.facilitatorClients[network][scheme] = client
}
}
// Cache the supported response
s.supportedCache.Set(fmt.Sprintf("facilitator_%p", client), supported)
}
return nil
}
// HasRegisteredScheme checks if a scheme is registered for a given network
func (s *x402ResourceServer) HasRegisteredScheme(network Network, scheme string) bool {
s.mu.RLock()
defer s.mu.RUnlock()
networkSchemes, ok := s.schemes[network]
if !ok {
return false
}
_, exists := networkSchemes[scheme]
return exists
}
// HasFacilitatorSupport checks if a facilitator client supports a given network/scheme combination
func (s *x402ResourceServer) HasFacilitatorSupport(network Network, scheme string) bool {
s.mu.RLock()
defer s.mu.RUnlock()
networkClients, ok := s.facilitatorClients[network]
if !ok {
return false
}
_, exists := networkClients[scheme]
return exists
}
// Register registers a payment mechanism (V2, default).
//
// Auto-wires lifecycle hooks contributed by the scheme via the optional
// BeforeVerifyHookProvider / AfterVerifyHookProvider / BeforeSettleHookProvider
// / AfterSettleHookProvider / OnVerifyFailureHookProvider / OnSettleFailureHookProvider
// / OnVerifiedPaymentCanceledHookProvider interfaces (mirrors the TS schemeHooks field).
//
// Scheme hooks are stored per (network, scheme) and fire ONLY when the
// matched requirements use that scheme/network — they do NOT leak across
// other registered schemes. Manual hooks registered via OnBeforeVerify etc.
// run for every request and execute BEFORE the matched scheme's hooks
// (mirrors TS hook ordering: manual → matched scheme → declared extensions).
func (s *x402ResourceServer) Register(network Network, schemeServer SchemeNetworkServer) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
if s.schemes[network] == nil {
s.schemes[network] = make(map[string]SchemeNetworkServer)
}
s.schemes[network][schemeServer.Scheme()] = schemeServer
handles := &hookAdapterHandles{}
if h, ok := schemeServer.(BeforeVerifyHookProvider); ok {
if hook := h.BeforeVerifyHook(); hook != nil {
handles.BeforeVerify = hook
}
}
if h, ok := schemeServer.(AfterVerifyHookProvider); ok {
if hook := h.AfterVerifyHook(); hook != nil {
handles.AfterVerify = hook
}
}
if h, ok := schemeServer.(OnVerifyFailureHookProvider); ok {
if hook := h.OnVerifyFailureHook(); hook != nil {
handles.OnVerifyFailure = hook
}
}
if h, ok := schemeServer.(BeforeSettleHookProvider); ok {
if hook := h.BeforeSettleHook(); hook != nil {
handles.BeforeSettle = hook
}
}
if h, ok := schemeServer.(AfterSettleHookProvider); ok {
if hook := h.AfterSettleHook(); hook != nil {
handles.AfterSettle = hook
}
}
if h, ok := schemeServer.(OnSettleFailureHookProvider); ok {
if hook := h.OnSettleFailureHook(); hook != nil {
handles.OnSettleFailure = hook
}
}
if h, ok := schemeServer.(OnVerifiedPaymentCanceledHookProvider); ok {
if hook := h.OnVerifiedPaymentCanceledHook(); hook != nil {
handles.OnVerifiedPaymentCanceled = hook
}
}
if handles.isEmpty() {
// No scheme hooks; clear any prior registration for this slot so
// re-registering a scheme without hooks doesn't keep stale entries.
if byScheme, ok := s.schemeHookAdapters[network]; ok {
delete(byScheme, schemeServer.Scheme())
if len(byScheme) == 0 {
delete(s.schemeHookAdapters, network)
}
}
} else {
if s.schemeHookAdapters[network] == nil {
s.schemeHookAdapters[network] = make(map[string]*hookAdapterHandles)
}
s.schemeHookAdapters[network][schemeServer.Scheme()] = handles
}
return s
}
// isEmpty reports whether no hook phases are populated.
func (h *hookAdapterHandles) isEmpty() bool {
return h.BeforeVerify == nil && h.AfterVerify == nil && h.OnVerifyFailure == nil &&
h.BeforeSettle == nil && h.AfterSettle == nil && h.OnSettleFailure == nil &&
h.OnVerifiedPaymentCanceled == nil
}
func (s *x402ResourceServer) RegisterExtension(extension types.ResourceServerExtension) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
key := extension.Key()
s.registeredExtensions[key] = extension
hp, ok := extension.(ResourceServerExtensionHookProvider)
if !ok {
delete(s.extensionHookAdapters, key)
return s
}
// Wire optional per-extension lifecycle hooks. Each phase is wrapped so it
// only fires when `ctx.DeclaredExtensions[key]` is set — mirrors TS
// `bindExtensionHookAdapter`.
hooks := hp.ResourceServerExtensionHooks()
handles := &hookAdapterHandles{
BeforeVerify: gateExtensionHook(key, hooks.OnBeforeVerify, func(c VerifyContext) map[string]interface{} { return c.DeclaredExtensions }),
AfterVerify: gateExtensionHook(key, hooks.OnAfterVerify, func(c VerifyResultContext) map[string]interface{} { return c.DeclaredExtensions }),
OnVerifyFailure: gateExtensionHook(key, hooks.OnVerifyFailure, func(c VerifyFailureContext) map[string]interface{} { return c.DeclaredExtensions }),
BeforeSettle: gateExtensionHook(key, hooks.OnBeforeSettle, func(c SettleContext) map[string]interface{} { return c.DeclaredExtensions }),
AfterSettle: gateExtensionVoidHook(key, hooks.OnAfterSettle, func(c SettleResultContext) map[string]interface{} { return c.DeclaredExtensions }),
OnSettleFailure: gateExtensionHook(key, hooks.OnSettleFailure, func(c SettleFailureContext) map[string]interface{} { return c.DeclaredExtensions }),
OnVerifiedPaymentCanceled: gateExtensionVoidHook(key, hooks.OnVerifiedPaymentCanceled, func(c VerifiedPaymentCanceledContext) map[string]interface{} { return c.DeclaredExtensions }),
}
if handles.isEmpty() {
delete(s.extensionHookAdapters, key)
} else {
s.extensionHookAdapters[key] = handles
}
return s
}
// gateExtensionHook returns a wrapper that invokes `impl` only when the
// declared-extension map carries `key`. Mirrors TS `bindExtensionHookAdapter`'s
// `if (ctx.declaredExtensions[extensionKey] === undefined) return;` guard.
// Returns nil when `impl` is nil so RegisterExtension can drop the phase.
func gateExtensionHook[Ctx any, Result any](
key string,
impl func(Ctx) (*Result, error),
declared func(Ctx) map[string]interface{},
) func(Ctx) (*Result, error) {
if impl == nil {
return nil
}
return func(ctx Ctx) (*Result, error) {
ext := declared(ctx)
if ext == nil {
return nil, nil
}
if _, ok := ext[key]; !ok {
return nil, nil
}
return impl(ctx)
}
}
// gateExtensionVoidHook is the error-only variant of gateExtensionHook for
// hooks that don't return a result struct (AfterSettle, OnVerifiedPaymentCanceled).
func gateExtensionVoidHook[Ctx any](
key string,
impl func(Ctx) error,
declared func(Ctx) map[string]interface{},
) func(Ctx) error {
if impl == nil {
return nil
}
return func(ctx Ctx) error {
ext := declared(ctx)
if ext == nil {
return nil
}
if _, ok := ext[key]; !ok {
return nil
}
return impl(ctx)
}
}
// ============================================================================
// Hook Registration Methods (Chainable)
// ============================================================================
func (s *x402ResourceServer) OnBeforeVerify(hook BeforeVerifyHook) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
s.beforeVerifyHooks = append(s.beforeVerifyHooks, hook)
return s
}
func (s *x402ResourceServer) OnAfterVerify(hook AfterVerifyHook) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
s.afterVerifyHooks = append(s.afterVerifyHooks, hook)
return s
}
func (s *x402ResourceServer) OnVerifyFailure(hook OnVerifyFailureHook) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
s.onVerifyFailureHooks = append(s.onVerifyFailureHooks, hook)
return s
}
func (s *x402ResourceServer) OnBeforeSettle(hook BeforeSettleHook) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
s.beforeSettleHooks = append(s.beforeSettleHooks, hook)
return s
}
func (s *x402ResourceServer) OnAfterSettle(hook AfterSettleHook) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
s.afterSettleHooks = append(s.afterSettleHooks, hook)
return s
}
func (s *x402ResourceServer) OnSettleFailure(hook OnSettleFailureHook) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
s.onSettleFailureHooks = append(s.onSettleFailureHooks, hook)
return s
}
func (s *x402ResourceServer) OnVerifiedPaymentCanceled(hook OnVerifiedPaymentCanceledHook) *x402ResourceServer {
s.mu.Lock()
defer s.mu.Unlock()
s.onVerifiedPaymentCanceledHooks = append(s.onVerifiedPaymentCanceledHooks, hook)
return s
}
// matchedSchemeHooks returns the per-(network, scheme) hook handles for the
// scheme that matched the current request, or nil when no scheme is registered
// for that pair. Caller must hold s.mu (read).
func (s *x402ResourceServer) matchedSchemeHooks(network Network, scheme string) *hookAdapterHandles {
if byScheme, ok := s.schemeHookAdapters[network]; ok {
if h, ok := byScheme[scheme]; ok {
return h
}
}
return nil
}
// orderedHooks returns the hooks for `phase` in the canonical execution order:
// manual → matched scheme → declared extensions. Mirrors TS `getLabeledHooks`.
//
// `pickPhase` extracts the per-phase hook from a `*hookAdapterHandles` (passing
// nil-safe). Caller must hold s.mu (read).
func orderedHooks[F any](
s *x402ResourceServer,
phase string,
manual []F,
scheme *hookAdapterHandles,
declaredExtensions map[string]interface{},
pickPhase func(*hookAdapterHandles) F,
isNil func(F) bool,
) []labeledHook[F] {
out := make([]labeledHook[F], 0, len(manual)+1+len(declaredExtensions))
for i, h := range manual {
out = append(out, labeledHook[F]{Label: fmt.Sprintf("manual %s hook #%d", phase, i), Hook: h})
}
if scheme != nil {
if h := pickPhase(scheme); !isNil(h) {
out = append(out, labeledHook[F]{Label: fmt.Sprintf("scheme %s", phase), Hook: h})
}
}
for key := range declaredExtensions {
if handles, ok := s.extensionHookAdapters[key]; ok {
if h := pickPhase(handles); !isNil(h) {
out = append(out, labeledHook[F]{Label: fmt.Sprintf("extension %q %s", key, phase), Hook: h})
}
}
}
return out
}
// CreatePaymentCancellationDispatcher returns a dispatcher with no declared
// extensions. Equivalent to CreatePaymentCancellationDispatcherWithExtensions(...,
// nil). Kept for callers that don't track route extension declarations.
func (s *x402ResourceServer) CreatePaymentCancellationDispatcher(
ctx context.Context,
payload types.PaymentPayload,
requirements types.PaymentRequirements,
) *PaymentCancellationDispatcher {
return s.CreatePaymentCancellationDispatcherWithExtensions(ctx, payload, requirements, nil)
}
// CreatePaymentCancellationDispatcherWithExtensions returns a dispatcher
// that, when Cancel'd, invokes onVerifiedPaymentCanceled hooks exactly once.
// The HTTP transport calls this after a successful Verify but before/instead
// of Settle when the resource handler errors or returns a non-2xx response.
//
// Hook execution order (mirrors verify/settle): manual → matched scheme →
// declared extensions. Extension hooks gate on `declaredExtensions[key]`
// being set on the route.
func (s *x402ResourceServer) CreatePaymentCancellationDispatcherWithExtensions(
ctx context.Context,
payload types.PaymentPayload,
requirements types.PaymentRequirements,
declaredExtensions map[string]interface{},
) *PaymentCancellationDispatcher {
payloadBytes, _ := json.Marshal(payload)
requirementsBytes, _ := json.Marshal(requirements)
settleCtx := SettleContext{
Ctx: ctx,
Payload: payload,
Requirements: requirements,
DeclaredExtensions: declaredExtensions,
PayloadBytes: payloadBytes,
RequirementsBytes: requirementsBytes,
}
return &PaymentCancellationDispatcher{
fire: func(opts VerifiedPaymentCancelOptions) {
cancelCtx := VerifiedPaymentCanceledContext{
SettleContext: settleCtx,
Reason: opts.Reason,
Err: opts.Err,
ResponseStatus: opts.ResponseStatus,
}
s.mu.RLock()
matchedScheme := s.matchedSchemeHooks(Network(requirements.Network), requirements.Scheme)
hooks := orderedHooks(s, "onVerifiedPaymentCanceled", s.onVerifiedPaymentCanceledHooks, matchedScheme,
declaredExtensions, func(h *hookAdapterHandles) OnVerifiedPaymentCanceledHook { return h.OnVerifiedPaymentCanceled },
func(f OnVerifiedPaymentCanceledHook) bool { return f == nil })
s.mu.RUnlock()
for _, lh := range hooks {
_ = lh.Hook(cancelCtx)
}
},
}
}
// ============================================================================
// Core Payment Methods (V2 Only)
// ============================================================================
func mergeExtraFields(parsedExtra map[string]interface{}, configExtra map[string]interface{}) map[string]interface{} {
if len(parsedExtra) == 0 && len(configExtra) == 0 {
return nil
}
merged := make(map[string]interface{}, len(parsedExtra)+len(configExtra))
for key, value := range parsedExtra {
merged[key] = value
}
for key, value := range configExtra {
merged[key] = value
}
return merged
}
// BuildPaymentRequirements creates payment requirements for a resource
func (s *x402ResourceServer) BuildPaymentRequirements(
ctx context.Context,
config ResourceConfig,
supportedKind types.SupportedKind,
extensions []string,
) (types.PaymentRequirements, error) {
s.mu.RLock()
defer s.mu.RUnlock()
// Find the scheme server
scheme := config.Scheme
network := config.Network
schemeServer := s.schemes[network][scheme]
if schemeServer == nil {
return types.PaymentRequirements{}, &PaymentError{
Code: ErrCodeUnsupportedScheme,
Message: fmt.Sprintf("no scheme server for %s on %s", scheme, network),
}
}
// Parse price to get asset/amount
assetAmount, err := schemeServer.ParsePrice(config.Price, network)
if err != nil {
return types.PaymentRequirements{}, err
}
// Apply default timeout if not specified
maxTimeout := config.MaxTimeoutSeconds
if maxTimeout == 0 {
maxTimeout = 60 // Default to 60 seconds
}
// Build base requirements
requirements := types.PaymentRequirements{
Scheme: scheme,
Network: string(network),
Asset: assetAmount.Asset,
Amount: assetAmount.Amount,
PayTo: config.PayTo,
MaxTimeoutSeconds: maxTimeout,
Extra: mergeExtraFields(assetAmount.Extra, config.Extra),
}
// Enhance with scheme-specific details
enhanced, err := schemeServer.EnhancePaymentRequirements(ctx, requirements, supportedKind, extensions)
if err != nil {
return types.PaymentRequirements{}, err
}
return enhanced, nil
}
// FindMatchingRequirements finds requirements that match a payment payload
func (s *x402ResourceServer) FindMatchingRequirements(available []types.PaymentRequirements, payload types.PaymentPayload) *types.PaymentRequirements {
for _, req := range available {
if payload.Accepted.Scheme == req.Scheme &&
payload.Accepted.Network == req.Network &&
payload.Accepted.Amount == req.Amount &&
payload.Accepted.Asset == req.Asset &&
payload.Accepted.PayTo == req.PayTo {
return &req
}
}
return nil
}
// VerifyPayment verifies a V2 payment with no declared extensions.
// Equivalent to VerifyPaymentWithExtensions(ctx, payload, requirements, nil).
func (s *x402ResourceServer) VerifyPayment(ctx context.Context, payload types.PaymentPayload, requirements types.PaymentRequirements) (*VerifyResponse, error) {
return s.VerifyPaymentWithExtensions(ctx, payload, requirements, nil)
}
// VerifyPaymentWithExtensions verifies a V2 payment, gating extension hooks
// on the supplied `declaredExtensions` map (keys must be present for the
// extension's hook to fire). Hook execution order: manual → matched scheme →
// declared extensions.
func (s *x402ResourceServer) VerifyPaymentWithExtensions(
ctx context.Context,
payload types.PaymentPayload,
requirements types.PaymentRequirements,
declaredExtensions map[string]interface{},
) (*VerifyResponse, error) {
// Marshal to bytes early for hooks (escape hatch for extensions)
payloadBytes, err := json.Marshal(payload)
if err != nil {
return nil, NewVerifyError(ErrFailedToMarshalPayload, "", err.Error())
}
requirementsBytes, err := json.Marshal(requirements)
if err != nil {
return nil, NewVerifyError(ErrFailedToMarshalRequirements, "", err.Error())
}
hookCtx := VerifyContext{
Ctx: ctx,
Payload: payload,
Requirements: requirements,
DeclaredExtensions: declaredExtensions,
PayloadBytes: payloadBytes,
RequirementsBytes: requirementsBytes,
}
s.mu.RLock()
scheme := requirements.Scheme
network := Network(requirements.Network)
matchedScheme := s.matchedSchemeHooks(network, scheme)
beforeVerifyHooks := orderedHooks(s, "beforeVerify", s.beforeVerifyHooks, matchedScheme,
declaredExtensions, func(h *hookAdapterHandles) BeforeVerifyHook { return h.BeforeVerify },
func(f BeforeVerifyHook) bool { return f == nil })
afterVerifyHooks := orderedHooks(s, "afterVerify", s.afterVerifyHooks, matchedScheme,
declaredExtensions, func(h *hookAdapterHandles) AfterVerifyHook { return h.AfterVerify },
func(f AfterVerifyHook) bool { return f == nil })
verifyFailureHooks := orderedHooks(s, "onVerifyFailure", s.onVerifyFailureHooks, matchedScheme,
declaredExtensions, func(h *hookAdapterHandles) OnVerifyFailureHook { return h.OnVerifyFailure },
func(f OnVerifyFailureHook) bool { return f == nil })
facilitator := s.facilitatorClients[network][scheme]
s.mu.RUnlock()
var skipVerifyResult *VerifyResponse
for _, lh := range beforeVerifyHooks {
result, err := lh.Hook(hookCtx)
if err != nil {
return nil, err
}
if result == nil {
continue
}
if result.Abort {
return nil, NewVerifyError(result.Reason, "", result.Message)
}
if result.Skip && result.SkipVerifyResult != nil {
// Last skip wins, like SettleResponse for after-hooks
skipVerifyResult = result.SkipVerifyResult
}
}
// Short-circuit: a BeforeVerify hook produced a local verify result. Still run
// AfterVerify hooks so cooperative-refund SkipHandler signaling works.
if skipVerifyResult != nil {
resultCtx := VerifyResultContext{VerifyContext: hookCtx, Result: skipVerifyResult}
for _, lh := range afterVerifyHooks {
directive, _ := lh.Hook(resultCtx)
if directive != nil && directive.SkipHandler {
resp := directive.Response
if resp == nil {
resp = &SkipHandlerDirective{}
}
skipVerifyResult.SkipHandler = resp
}
}
return skipVerifyResult, nil
}
if facilitator == nil {
return nil, NewVerifyError(ErrNoFacilitatorForNetwork, "", fmt.Sprintf("no facilitator for scheme=%q network=%q", scheme, network))
}
// Use already marshaled bytes for network call
verifyResult, verifyErr := facilitator.Verify(ctx, payloadBytes, requirementsBytes)
// Handle failure (network/protocol error from facilitator)
if verifyErr != nil {
failureCtx := VerifyFailureContext{VerifyContext: hookCtx, Error: verifyErr}
for _, lh := range verifyFailureHooks {
result, _ := lh.Hook(failureCtx)
if result != nil && result.Recovered {
return result.Result, nil
}
}
return verifyResult, verifyErr
}
// Handle IsValid: false — facilitator reachable but explicitly rejected the payment.
// Conflating "no network error" with "payment valid" is a security bug: an HTTP-200
// response carrying {"isValid":false} must be treated as a hard gate failure.
if verifyResult == nil || !verifyResult.IsValid {
reason := ErrCodeInvalidPayment
var payer, message string
if verifyResult != nil {
if verifyResult.InvalidReason != "" {
reason = verifyResult.InvalidReason
}
payer = verifyResult.Payer
message = verifyResult.InvalidMessage
}
ve := NewVerifyError(reason, payer, message)
failureCtx := VerifyFailureContext{VerifyContext: hookCtx, Error: ve}
for _, lh := range verifyFailureHooks {
result, _ := lh.Hook(failureCtx)
if result != nil && result.Recovered {
return result.Result, nil
}
}
return verifyResult, ve
}
// Execute afterVerify hooks. The last hook to return a SkipHandler directive
// wins; this lets schemes signal that a self-contained operation (e.g.
// cooperative refund) should bypass the resource handler and settle inline.
resultCtx := VerifyResultContext{VerifyContext: hookCtx, Result: verifyResult}
for _, lh := range afterVerifyHooks {
directive, _ := lh.Hook(resultCtx) // Log errors but don't fail
if directive != nil && directive.SkipHandler {
resp := directive.Response
if resp == nil {
resp = &SkipHandlerDirective{}
}
verifyResult.SkipHandler = resp
}
}
return verifyResult, nil
}
// SettlePayment settles a V2 payment with no declared extensions.
// Equivalent to SettlePaymentWithExtensions(ctx, payload, requirements, overrides, nil).
func (s *x402ResourceServer) SettlePayment(ctx context.Context, payload types.PaymentPayload, requirements types.PaymentRequirements, overrides *SettlementOverrides) (*SettleResponse, error) {
return s.SettlePaymentWithExtensions(ctx, payload, requirements, overrides, nil)
}
// SettlePaymentWithExtensions settles a V2 payment, gating extension hooks on
// the supplied `declaredExtensions` map (keys must be present for the
// extension's hook to fire). Hook execution order: manual → matched scheme →
// declared extensions. Mirrors TS `settlePayment(payload, requirements,
// overrides, declaredExtensions)`.
//
// If overrides is non-nil and overrides.Amount is set, the effective
// requirements amount is replaced before settlement (partial settlement for
// upto scheme).
func (s *x402ResourceServer) SettlePaymentWithExtensions(
ctx context.Context,
payload types.PaymentPayload,
requirements types.PaymentRequirements,
overrides *SettlementOverrides,
declaredExtensions map[string]interface{},
) (*SettleResponse, error) {
effectiveRequirements := requirements
if overrides != nil && overrides.Amount != "" {
decimals := 6
s.mu.RLock()
network := Network(requirements.Network)
if networkSchemes, ok := s.schemes[network]; ok {
if scheme, ok := networkSchemes[requirements.Scheme]; ok {
if dp, ok := scheme.(AssetDecimalsProvider); ok {
decimals = dp.GetAssetDecimals(requirements.Asset, network)
}
}
}
s.mu.RUnlock()
resolved, err := ResolveSettlementOverrideAmount(overrides.Amount, requirements, decimals)
if err != nil {
return nil, NewSettleError("invalid_settlement_override", "", Network(requirements.Network), "", err.Error())
}
effectiveRequirements.Amount = resolved
}
// Marshal to bytes early for hooks (escape hatch for extensions)
payloadBytes, err := json.Marshal(payload)
if err != nil {
return nil, NewSettleError("failed_to_marshal_payload", "", Network(effectiveRequirements.Network), "", err.Error())
}
requirementsBytes, err := json.Marshal(effectiveRequirements)
if err != nil {
return nil, NewSettleError("failed_to_marshal_requirements", "", Network(effectiveRequirements.Network), "", err.Error())
}
hookCtx := SettleContext{
Ctx: ctx,
Payload: payload,
Requirements: effectiveRequirements,
DeclaredExtensions: declaredExtensions,
PayloadBytes: payloadBytes,
RequirementsBytes: requirementsBytes,
}
s.mu.RLock()
scheme := effectiveRequirements.Scheme
network := Network(effectiveRequirements.Network)
matchedScheme := s.matchedSchemeHooks(network, scheme)
beforeSettleHooks := orderedHooks(s, "beforeSettle", s.beforeSettleHooks, matchedScheme,
declaredExtensions, func(h *hookAdapterHandles) BeforeSettleHook { return h.BeforeSettle },
func(f BeforeSettleHook) bool { return f == nil })
afterSettleHooks := orderedHooks(s, "afterSettle", s.afterSettleHooks, matchedScheme,
declaredExtensions, func(h *hookAdapterHandles) AfterSettleHook { return h.AfterSettle },
func(f AfterSettleHook) bool { return f == nil })
settleFailureHooks := orderedHooks(s, "onSettleFailure", s.onSettleFailureHooks, matchedScheme,
declaredExtensions, func(h *hookAdapterHandles) OnSettleFailureHook { return h.OnSettleFailure },
func(f OnSettleFailureHook) bool { return f == nil })
facilitator := s.facilitatorClients[network][scheme]
s.mu.RUnlock()
for _, lh := range beforeSettleHooks {
result, err := lh.Hook(hookCtx)
if err != nil {
return nil, err
}
if result != nil {
if result.Abort {
return nil, NewSettleError(result.Reason, "", Network(effectiveRequirements.Network), "", result.Message)
}
if result.Skip && result.SkipResult != nil {
// Execute afterSettle hooks even when skipping
skipResultCtx := SettleResultContext{SettleContext: hookCtx, Result: result.SkipResult}
for _, ah := range afterSettleHooks {
_ = ah.Hook(skipResultCtx)
}
return result.SkipResult, nil
}
}
}
// Scheme-level settlement-payload enrichment. Mirrors TS
// `enrichSettlementPayload`: schemes return additive fields that the
// framework merges into payload.Payload after the additive policy has
// rejected any attempt to overwrite existing keys.
s.mu.RLock()
matchedSchemeServer := s.schemes[network][scheme]
s.mu.RUnlock()
if enricher, ok := matchedSchemeServer.(EnrichSettlementPayloadProvider); ok {
enrichment, err := enricher.EnrichSettlementPayload(hookCtx)
if err != nil {
return nil, NewSettleError("scheme_enrich_settlement_payload_failed", "", network, "", err.Error())
}
if len(enrichment) > 0 {
rawPayload := payload.GetPayload()
if err := AssertAdditivePayloadEnrichment(rawPayload, enrichment, fmt.Sprintf(`scheme %q`, scheme)); err != nil {
return nil, NewSettleError("scheme_enrich_settlement_payload_policy_violation", "", network, "", err.Error())
}
for k, v := range enrichment {
rawPayload[k] = v
}
}
}
if facilitator == nil {
return nil, NewSettleError("no_facilitator", "", network, "", fmt.Sprintf("no facilitator for scheme=%q network=%q", scheme, network))
}
// Re-marshal payload after hooks: BeforeSettle hooks AND scheme enrichment
// may have mutated payload.Payload (e.g., the batch-settlement refund
// enrich path adds the refund authorizer signatures). The pre-hook bytes
// would carry the original shape and the facilitator would reject it.
payloadBytes, err = json.Marshal(payload)
if err != nil {
return nil, NewSettleError("failed_to_marshal_payload", "", Network(effectiveRequirements.Network), "", err.Error())
}
settleResult, settleErr := facilitator.Settle(ctx, payloadBytes, requirementsBytes)
// Handle failure
if settleErr != nil {
failureCtx := SettleFailureContext{SettleContext: hookCtx, Error: settleErr}
for _, lh := range settleFailureHooks {
result, _ := lh.Hook(failureCtx)
if result != nil && result.Recovered {
return result.Result, nil
}
}
return settleResult, settleErr
}
// Execute afterSettle hooks
resultCtx := SettleResultContext{SettleContext: hookCtx, Result: settleResult}
for _, lh := range afterSettleHooks {
_ = lh.Hook(resultCtx) // Log errors but don't fail
}
// Scheme-level settlement-response enrichment. Mirrors TS
// `enrichSettlementResponse`: returned fields are deep-merged into
// settleResult.Extra after the additive policy has rejected any attempt
// to overwrite existing extras (recursively for nested maps).
if enricher, ok := matchedSchemeServer.(EnrichSettlementResponseProvider); ok {
enrichment, err := enricher.EnrichSettlementResponse(resultCtx)
if err != nil {
return settleResult, NewSettleError("scheme_enrich_settlement_response_failed", "", network, "", err.Error())
}
if len(enrichment) > 0 {
extra := settleResult.Extra
if extra == nil {
extra = map[string]interface{}{}
}
if err := AssertAdditiveSettlementExtra(extra, enrichment, fmt.Sprintf(`scheme %q`, scheme)); err != nil {
return settleResult, NewSettleError("scheme_enrich_settlement_response_policy_violation", "", network, "", err.Error())
}
settleResult.Extra = MergeAdditiveSettlementExtra(extra, enrichment)
}
}