This repository was archived by the owner on Dec 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathhttp-server.ts
More file actions
232 lines (200 loc) · 6.72 KB
/
http-server.ts
File metadata and controls
232 lines (200 loc) · 6.72 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
import type {
OfferingsApi,
ExchangesApi,
CreateExchangeCallback,
SubmitOrderCallback,
SubmitCloseCallback,
GetExchangesCallback,
GetOfferingsCallback,
GetBalancesCallback,
GetExchangeCallback,
BalancesApi,
} from './types.js'
import type { Express, Request, Response } from 'express'
import express from 'express'
import cors from 'cors'
import { getExchanges, getOfferings, createExchange } from './request-handlers/index.js'
import { jsonBodyParser } from './middleware/index.js'
import { InMemoryOfferingsApi } from './in-memory-offerings-api.js'
import { InMemoryExchangesApi } from './in-memory-exchanges-api.js'
import { submitMessage } from './request-handlers/submit-message.js'
import { getExchange } from './request-handlers/get-exchange.js'
import { getBalances } from './request-handlers/get-balances.js'
/**
* Maps the requests to their respective callbacks handlers
* @beta
*/
type CallbackMap = {
getExchange?: GetExchangeCallback
getExchanges?: GetExchangesCallback
getOfferings?: GetOfferingsCallback
getBalances?: GetBalancesCallback
createExchange?: CreateExchangeCallback
submitOrder?: SubmitOrderCallback
submitClose?: SubmitCloseCallback
}
/**
* Options for creating a new HttpServer
* @param opts.offeringsApi Optionally accepts an {@link OfferingsApi}. Defaults an in-memory implementation.
* @param opts.exchangesApi Optionally accepts an {@link ExchangesApi}. Defaults an in-memory implementation.
* @param opts.balancesApi Optionally accepts a {@link BalancesApi}. Else, leave `undefined` if not supporting the balances endpoint.
* @param opts.pfiDid Required if instantiating the HttpServer with options. Else, defaults to an arbitrary string for example purposes only.
* @beta
*/
type NewHttpServerOptions = {
offeringsApi?: OfferingsApi
exchangesApi?: ExchangesApi,
balancesApi?: BalancesApi,
pfiDid: string
}
/**
* TBDex HTTP Server powered by Express
* @beta
*/
export class TbdexHttpServer {
/**
* Map of callbacks handlers for the available requests
*/
callbacks: CallbackMap
/**
* Express server instance
*/
api: Express
/**
* PFI Exchanges API
*/
exchangesApi: ExchangesApi
/**
* PFI Offerings API
*/
offeringsApi: OfferingsApi
/**
* PFI Balances API
*/
balancesApi?: BalancesApi
/**
* PFI DID
*/
pfiDid: string
constructor(opts?: NewHttpServerOptions) {
this.callbacks = {}
this.exchangesApi = opts?.exchangesApi ?? new InMemoryExchangesApi()
this.offeringsApi = opts?.offeringsApi ?? new InMemoryOfferingsApi()
this.balancesApi = opts?.balancesApi
this.pfiDid = opts?.pfiDid ?? 'did:ex:pfi'
// initialize api here so that consumers can attach custom endpoints
const api = express()
api.use(cors())
api.use(jsonBodyParser())
this.api = api
}
/**
* Set up a callback or overwrite the existing callback for the SubmitRfq endpoint
* @param callback - A callback to be invoked when a valid Rfq is sent to the
* CreateExchange endpoint.
*/
onCreateExchange(callback: CreateExchangeCallback): void {
this.callbacks.createExchange = callback
}
/**
* Set up a callback or overwrite the existing callback for the for the SubmitMessage endpoint
* @param callback - A callback to be invoked when a valid Order is sent to the
* SubmitMessage endpoint.
*/
onSubmitOrder(callback: SubmitOrderCallback): void {
this.callbacks.submitOrder = callback
}
/**
* Set up a callback or overwrite the existing callback for the for the SubmitMessage endpoint
* @param callback - A callback to be invoked when a valid Close is sent to the
* SubmitMessage endpoint.
*/
onSubmitClose(callback: SubmitCloseCallback): void {
this.callbacks.submitClose = callback
}
/**
* Set up a callback or overwrite the existing callback for the GetExchange endpoint
* @param callback - A callback to be invoked when a valid request is sent to the
* GetExchange endpoint.
*/
onGetExchange(callback: GetExchangeCallback): void {
this.callbacks.getExchange = callback
}
/**
* Set up a callback or overwrite the existing callback for the GetExchanges endpoint
* @param callback - A callback to be invoked when a valid request is sent to the
* GetExchanges endpoint.
*/
onGetExchanges(callback: GetExchangesCallback): void {
this.callbacks.getExchanges = callback
}
/**
* Set up a callback or overwrite the existing callback for the GetOfferings endpoint
* @param callback - A callback to be invoked when a valid request is sent to the
* GetOfferings endpoint.
*/
onGetOfferings(callback: GetOfferingsCallback): void {
this.callbacks.getOfferings = callback
}
/**
* Set up a callback or overwrite the existing callback for the GetBalances endpoint
* @param callback - A callback to be invoked when a valid request is sent to the
* GetBalances endpoint.
*/
onGetBalances(callback: GetBalancesCallback): void {
this.callbacks.getBalances = callback
}
/**
* Setup the PFI routes and start a express server to listen for incoming requests
* @param port - server port number
* @param callback - to be called when the server is ready
*/
listen(port: number | string, callback?: () => void) {
const { offeringsApi, exchangesApi, balancesApi, pfiDid } = this
this.api.post('/exchanges', (req: Request, res: Response) =>
createExchange(req, res, {
callback: this.callbacks['createExchange'],
offeringsApi,
exchangesApi,
})
)
this.api.put('/exchanges/:exchangeId', (req: Request, res: Response) =>
submitMessage(req, res, {
submitOrderCallback : this.callbacks.submitOrder,
submitCloseCallback : this.callbacks.submitClose,
exchangesApi,
})
)
this.api.get('/exchanges/:exchangeId', (req: Request, res: Response) =>
getExchange(req, res, {
callback: this.callbacks.getExchange,
exchangesApi,
pfiDid,
})
)
this.api.get('/exchanges', (req: Request, res: Response) =>
getExchanges(req, res, {
callback: this.callbacks.getExchanges,
exchangesApi,
pfiDid,
})
)
this.api.get('/offerings', (req, res) =>
getOfferings(req, res, {
callback: this.callbacks['getOfferings'],
offeringsApi
})
)
if (balancesApi) {
this.api.get('/balances', (req, res) =>
getBalances(req, res, {
callback: this.callbacks['getBalances'],
balancesApi,
pfiDid,
})
)
}
// TODO: support hostname and backlog arguments
return this.api.listen(port, callback)
}
}