-
Notifications
You must be signed in to change notification settings - Fork 0
/
walrus.go
339 lines (278 loc) · 9.7 KB
/
walrus.go
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
package walrus_go
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"strconv"
)
// Client is a client for interacting with the Walrus API
type Client struct {
AggregatorURL string
PublisherURL string
httpClient *http.Client
}
// NewClient creates a new Walrus client
func NewClient(aggregatorURL, publisherURL string) *Client {
return &Client{
AggregatorURL: aggregatorURL,
PublisherURL: publisherURL,
httpClient: &http.Client{},
}
}
// StoreOptions defines options for storing data
type StoreOptions struct {
Epochs int // Number of storage epochs
}
// BlobInfo represents the information returned after storing data
type BlobInfo struct {
BlobID string `json:"blobId"`
EndEpoch int `json:"endEpoch"`
}
// BlobObject represents the blob object information
type BlobObject struct {
ID string `json:"id"`
StoredEpoch int `json:"storedEpoch"`
BlobID string `json:"blobId"`
Size int64 `json:"size"`
ErasureCodeType string `json:"erasureCodeType"`
CertifiedEpoch int `json:"certifiedEpoch"`
Storage StorageInfo `json:"storage"`
}
// StoreResponse represents the unified response for store operations
type StoreResponse struct {
Blob BlobInfo `json:"blobInfo,omitempty"`
// For newly created blobs
NewlyCreated *struct {
BlobObject BlobObject `json:"blobObject"`
EncodedSize int `json:"encodedSize"`
Cost int `json:"cost"`
} `json:"newlyCreated,omitempty"`
// For already certified blobs
AlreadyCertified *struct {
BlobID string `json:"blobId"`
Event EventInfo `json:"event"`
EndEpoch int `json:"endEpoch"`
} `json:"alreadyCertified,omitempty"`
}
// NormalizeBlobResponse is a helper function to normalize the response from the blob service
func (resp *StoreResponse) NormalizeBlobResponse() {
if resp.AlreadyCertified != nil {
resp.Blob.BlobID = resp.AlreadyCertified.BlobID
resp.Blob.EndEpoch = resp.AlreadyCertified.EndEpoch
}
if resp.NewlyCreated != nil {
resp.Blob.BlobID = resp.NewlyCreated.BlobObject.BlobID
resp.Blob.EndEpoch = resp.NewlyCreated.BlobObject.Storage.EndEpoch
}
}
// EventInfo represents the certification event information
type EventInfo struct {
TxDigest string `json:"txDigest"`
EventSeq string `json:"eventSeq"`
}
// StorageInfo represents the storage information for a blob
type StorageInfo struct {
ID string `json:"id"`
StartEpoch int `json:"startEpoch"`
EndEpoch int `json:"endEpoch"`
StorageSize int `json:"storageSize"`
}
// BlobMetadata represents the metadata information returned by Head request
type BlobMetadata struct {
ContentLength int64 `json:"content-length"`
ContentType string `json:"content-type"`
LastModified string `json:"last-modified"`
ETag string `json:"etag"`
}
// Store stores data on the Walrus Publisher and returns the complete store response
func (c *Client) Store(data []byte, opts *StoreOptions) (*StoreResponse, error) {
urlStr := fmt.Sprintf("%s/v1/store", c.PublisherURL)
if opts != nil && opts.Epochs > 0 {
urlStr += "?epochs=" + strconv.Itoa(opts.Epochs)
}
req, err := http.NewRequest("PUT", urlStr, bytes.NewReader(data))
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/octet-stream")
resp, err := c.httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
respData, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("failed to store data: %s", string(respData))
}
var storeResp StoreResponse
if err := json.Unmarshal(respData, &storeResp); err != nil {
return nil, fmt.Errorf("failed to parse response: %w", err)
}
storeResp.NormalizeBlobResponse()
return &storeResp, nil
}
// StoreReader stores data from an io.Reader and returns the complete store response
func (c *Client) StoreReader(reader io.Reader, contentLength int64, opts *StoreOptions) (*StoreResponse, error) {
urlStr := fmt.Sprintf("%s/v1/store", c.PublisherURL)
if opts != nil && opts.Epochs > 0 {
urlStr += "?epochs=" + strconv.Itoa(opts.Epochs)
}
req, err := http.NewRequest("PUT", urlStr, reader)
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/octet-stream")
if contentLength >= 0 {
req.ContentLength = contentLength
}
resp, err := c.httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
respData, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("failed to store data: %s", string(respData))
}
var storeResp StoreResponse
if err := json.Unmarshal(respData, &storeResp); err != nil {
return nil, fmt.Errorf("failed to parse response: %w", err)
}
storeResp.NormalizeBlobResponse()
return &storeResp, nil
}
// StoreFromURL downloads and stores content from URL and returns the complete store response
func (c *Client) StoreFromURL(sourceURL string, opts *StoreOptions) (*StoreResponse, error) {
req, err := http.NewRequest("GET", sourceURL, nil)
if err != nil {
return nil, fmt.Errorf("failed to create request: %w", err)
}
resp, err := c.httpClient.Do(req)
if err != nil {
return nil, fmt.Errorf("failed to download from URL: %w", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("failed to download from URL, status code: %d", resp.StatusCode)
}
return c.StoreReader(resp.Body, resp.ContentLength, opts)
}
// StoreFile stores a file and returns the complete store response
func (c *Client) StoreFile(filePath string, opts *StoreOptions) (*StoreResponse, error) {
file, err := os.Open(filePath)
if err != nil {
return nil, err
}
defer file.Close()
stat, err := file.Stat()
if err != nil {
return nil, err
}
return c.StoreReader(file, stat.Size(), opts)
}
// Read retrieves a blob from the Walrus Aggregator
func (c *Client) Read(blobID string) ([]byte, error) {
urlStr := fmt.Sprintf("%s/v1/%s", c.AggregatorURL, url.PathEscape(blobID))
resp, err := c.httpClient.Get(urlStr)
if err != nil {
return nil, err
}
defer resp.Body.Close()
// Check for HTTP errors
if resp.StatusCode != http.StatusOK {
respData, _ := io.ReadAll(resp.Body)
return nil, fmt.Errorf("failed to read blob: %s", string(respData))
}
return io.ReadAll(resp.Body)
}
// ReadToFile retrieves a blob and writes it to a file
func (c *Client) ReadToFile(blobID, filePath string) error {
urlStr := fmt.Sprintf("%s/v1/%s", c.AggregatorURL, url.PathEscape(blobID))
resp, err := c.httpClient.Get(urlStr)
if err != nil {
return err
}
defer resp.Body.Close()
// Check for HTTP errors
if resp.StatusCode != http.StatusOK {
respData, _ := io.ReadAll(resp.Body)
return fmt.Errorf("failed to read blob: %s", string(respData))
}
// Create the file
outFile, err := os.Create(filePath)
if err != nil {
return err
}
defer outFile.Close()
// Write the response body to the file
_, err = io.Copy(outFile, resp.Body)
return err
}
// GetAPISpec retrieves the API specification from the aggregator or publisher
func (c *Client) GetAPISpec(isAggregator bool) ([]byte, error) {
var baseURL string
if isAggregator {
baseURL = c.AggregatorURL
} else {
baseURL = c.PublisherURL
}
urlStr := fmt.Sprintf("%s/v1/api", baseURL)
resp, err := c.httpClient.Get(urlStr)
if err != nil {
return nil, err
}
defer resp.Body.Close()
// Check for HTTP errors
if resp.StatusCode != http.StatusOK {
respData, _ := io.ReadAll(resp.Body)
return nil, fmt.Errorf("failed to get API spec: %s", string(respData))
}
return io.ReadAll(resp.Body)
}
// Head retrieves blob metadata from the Walrus Aggregator without downloading the content
func (c *Client) Head(blobID string) (*BlobMetadata, error) {
urlStr := fmt.Sprintf("%s/v1/%s", c.AggregatorURL, url.PathEscape(blobID))
req, err := http.NewRequest(http.MethodHead, urlStr, nil)
if err != nil {
return nil, fmt.Errorf("failed to create HEAD request: %w", err)
}
resp, err := c.httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, fmt.Errorf("failed to get blob metadata: status code %d", resp.StatusCode)
}
metadata := &BlobMetadata{
ContentLength: resp.ContentLength,
ContentType: resp.Header.Get("Content-Type"),
LastModified: resp.Header.Get("Last-Modified"),
ETag: resp.Header.Get("ETag"),
}
return metadata, nil
}
// ReadToReader retrieves a blob and writes it to the provided io.Writer
func (c *Client) ReadToReader(blobID string) (io.ReadCloser, error) {
urlStr := fmt.Sprintf("%s/v1/%s", c.AggregatorURL, url.PathEscape(blobID))
resp, err := c.httpClient.Get(urlStr)
if err != nil {
return nil, err
}
if resp.StatusCode != http.StatusOK {
resp.Body.Close()
respData, _ := io.ReadAll(resp.Body)
return nil, fmt.Errorf("failed to read blob: %s", string(respData))
}
return resp.Body, nil
}