You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: market/mk20/info.md
+19-20Lines changed: 19 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -96,19 +96,19 @@ DataSource represents the source of piece data, including metadata and optional
96
96
97
97
| Field | Type | Tag | Description |
98
98
|-------|------|-----|-------------|
99
-
| PieceCID |[cid.Cid](https://pkg.go.dev/github.com/ipfs/go-cid#Cid)| json:"piececid" | PieceCID represents the unique identifier for a piece of data, stored as a CID object. |
99
+
| PieceCID |[cid.Cid](https://pkg.go.dev/github.com/ipfs/go-cid#Cid)| json:"piece_cid" | PieceCID represents the unique identifier for a piece of data, stored as a CID object. |
100
100
| Size |[abi.PaddedPieceSize](https://pkg.go.dev/github.com/filecoin-project/go-state-types/abi#PaddedPieceSize)| json:"size" | Size represents the size of the padded piece in the data source. |
101
101
| Format |[mk20.PieceDataFormat](#piecedataformat)| json:"format" | Format defines the format of the piece data, which can include CAR, Aggregate, or Raw formats. |
102
-
| SourceHTTP |[*mk20.DataSourceHTTP](#datasourcehttp)| json:"sourcehttp" | SourceHTTP represents the HTTP-based source of piece data within a deal, including raw size and URLs for retrieval. |
103
-
| SourceAggregate |[*mk20.DataSourceAggregate](#datasourceaggregate)| json:"sourceaggregate" | SourceAggregate represents an aggregated source, comprising multiple data sources as pieces. |
104
-
| SourceOffline |[*mk20.DataSourceOffline](#datasourceoffline)| json:"sourceoffline" | SourceOffline defines the data source for offline pieces, including raw size information. |
105
-
| SourceHttpPut |[*mk20.DataSourceHttpPut](#datasourcehttpput)| json:"sourcehttpput" | SourceHTTPPut // allow clients to push piece data after deal accepted, sort of like offline import |
102
+
| SourceHTTP |[*mk20.DataSourceHTTP](#datasourcehttp)| json:"source_http" | SourceHTTP represents the HTTP-based source of piece data within a deal, including raw size and URLs for retrieval. |
103
+
| SourceAggregate |[*mk20.DataSourceAggregate](#datasourceaggregate)| json:"source_aggregate" | SourceAggregate represents an aggregated source, comprising multiple data sources as pieces. |
104
+
| SourceOffline |[*mk20.DataSourceOffline](#datasourceoffline)| json:"source_offline" | SourceOffline defines the data source for offline pieces, including raw size information. |
105
+
| SourceHttpPut |[*mk20.DataSourceHttpPut](#datasourcehttpput)| json:"source_httpput" | SourceHTTPPut // allow clients to push piece data after deal accepted, sort of like offline import |
106
106
107
107
### Products
108
108
109
109
| Field | Type | Tag | Description |
110
110
|-------|------|-----|-------------|
111
-
| DDOV1 |[*mk20.DDOV1](#ddov1)| json:"ddov1" | DDOV1 represents a product v1 configuration for Direct Data Onboarding (DDO) |
111
+
| DDOV1 |[*mk20.DDOV1](#ddov1)| json:"ddo_v1" | DDOV1 represents a product v1 configuration for Direct Data Onboarding (DDO) |
112
112
113
113
### DDOV1
114
114
@@ -119,16 +119,16 @@ for a DDO deal handling.
119
119
|-------|------|-----|-------------|
120
120
| Provider |[address.Address](https://pkg.go.dev/github.com/filecoin-project/go-address#Address)| json:"provider" | Provider specifies the address of the provider |
121
121
| Client |[address.Address](https://pkg.go.dev/github.com/filecoin-project/go-address#Address)| json:"client" | Client represents the address of the deal client |
122
-
| PieceManager |[address.Address](https://pkg.go.dev/github.com/filecoin-project/go-address#Address)| json:"piecemanager" | Actor able to with AuthorizeMessage (like f1/f3 wallet) able to authorize actions such as managing ACLs |
122
+
| PieceManager |[address.Address](https://pkg.go.dev/github.com/filecoin-project/go-address#Address)| json:"piece_manager" | Actor providing AuthorizeMessage (like f1/f3 wallet) able to authorize actions such as managing ACLs |
123
123
| Duration |[abi.ChainEpoch](https://pkg.go.dev/github.com/filecoin-project/go-state-types/abi#ChainEpoch)| json:"duration" | Duration represents the deal duration in epochs. This value is ignored for the deal with allocationID. It must be at least 518400 |
124
-
| AllocationId |[*verifreg.AllocationId](https://pkg.go.dev/github.com/filecoin-project/go-state-types/builtin/v16/verifreg#AllocationId)| json:"aggregatedallocationid" | AllocationId represents an aggregated allocation identifier for the deal. |
125
-
| ContractAddress |[string](https://pkg.go.dev/builtin#string)| json:"contractaddress" | ContractAddress specifies the address of the contract governing the deal |
126
-
|ContractDealIDMethod|[string](https://pkg.go.dev/builtin#string)| json:"contractdealidmethod" | ContractDealIDMethod specifies the method name to retrieve the deal ID for a contract |
127
-
|ContractDealIDMethodParams|[[]byte](https://pkg.go.dev/builtin#byte)| json:"contractdealidmethodparams" | ContractDealIDMethodParams represents encoded parameters for the contract deal ID method if required by the contract |
128
-
| NotificationAddress |[string](https://pkg.go.dev/builtin#string)| json:"notificationaddress" | NotificationAddress specifies the address to which notifications will be relayed to when sector is activated |
129
-
| NotificationPayload |[[]byte](https://pkg.go.dev/builtin#byte)| json:"notificationpayload" | NotificationPayload holds the notification data typically in a serialized byte array format. |
124
+
| AllocationId |[*verifreg.AllocationId](https://pkg.go.dev/github.com/filecoin-project/go-state-types/builtin/v16/verifreg#AllocationId)| json:"allocation_id" | AllocationId represents an aggregated allocation identifier for the deal. |
125
+
| ContractAddress |[string](https://pkg.go.dev/builtin#string)| json:"contract_address" | ContractAddress specifies the address of the contract governing the deal |
126
+
|ContractVerifyMethod|[string](https://pkg.go.dev/builtin#string)| json:"contract_verify_method" | ContractDealIDMethod specifies the method name to verify the deal and retrieve the deal ID for a contract |
127
+
|ContractVerifyMethodParams|[[]byte](https://pkg.go.dev/builtin#byte)| json:"contract_verify_method_params" | ContractDealIDMethodParams represents encoded parameters for the contract verify method if required by the contract |
128
+
| NotificationAddress |[string](https://pkg.go.dev/builtin#string)| json:"notification_address" | NotificationAddress specifies the address to which notifications will be relayed to when sector is activated |
129
+
| NotificationPayload |[[]byte](https://pkg.go.dev/builtin#byte)| json:"notification_payload" | NotificationPayload holds the notification data typically in a serialized byte array format. |
130
130
| Indexing |[bool](https://pkg.go.dev/builtin#bool)| json:"indexing" | Indexing indicates if the deal is to be indexed in the provider's system to support CIDs based retrieval |
131
-
| AnnounceToIPNI |[bool](https://pkg.go.dev/builtin#bool)| json:"announcetoinpni" | AnnounceToIPNI indicates whether the deal should be announced to the Interplanetary Network Indexer (IPNI). |
131
+
| AnnounceToIPNI |[bool](https://pkg.go.dev/builtin#bool)| json:"announce_to_ipni" | AnnounceToIPNI indicates whether the deal should be announced to the Interplanetary Network Indexer (IPNI). |
132
132
133
133
### DataSourceAggregate
134
134
@@ -153,15 +153,15 @@ DataSourceHttpPut represents a data source allowing clients to push piece data a
153
153
154
154
| Field | Type | Tag | Description |
155
155
|-------|------|-----|-------------|
156
-
| RawSize |[uint64](https://pkg.go.dev/builtin#uint64)| json:"rawsize" | RawSize specifies the raw size of the data in bytes. |
156
+
| RawSize |[uint64](https://pkg.go.dev/builtin#uint64)| json:"raw_size" | RawSize specifies the raw size of the data in bytes. |
157
157
158
158
### DataSourceOffline
159
159
160
160
DataSourceOffline represents the data source for offline pieces, including metadata such as the raw size of the piece.
161
161
162
162
| Field | Type | Tag | Description |
163
163
|-------|------|-----|-------------|
164
-
| RawSize |[uint64](https://pkg.go.dev/builtin#uint64)| json:"rawsize" | RawSize specifies the raw size of the data in bytes. |
164
+
| RawSize |[uint64](https://pkg.go.dev/builtin#uint64)| json:"raw_size" | RawSize specifies the raw size of the data in bytes. |
165
165
166
166
### DealStatusResponse
167
167
@@ -170,7 +170,7 @@ DealStatusResponse represents the response of a deal's status, including its cur
170
170
| Field | Type | Tag | Description |
171
171
|-------|------|-----|-------------|
172
172
| State |[mk20.DealState](#constants-for-dealstate)| json:"status" | State indicates the current processing state of the deal as a DealState value. |
173
-
| ErrorMsg |[string](https://pkg.go.dev/builtin#string)| json:"errormsg" | ErrorMsg is an optional field containing error details associated with the deal's current state if an error occurred. |
173
+
| ErrorMsg |[string](https://pkg.go.dev/builtin#string)| json:"error_msg" | ErrorMsg is an optional field containing error details associated with the deal's current state if an error occurred. |
174
174
175
175
### FormatAggregate
176
176
@@ -190,11 +190,10 @@ FormatBytes defines the raw byte representation of data as a format.
190
190
191
191
### FormatCar
192
192
193
-
FormatCar represents the CAR (Content Addressable aRchive) format with version metadata for piece data serialization.
193
+
FormatCar represents the CAR (Content Addressable archive) format for piece data serialization.
194
194
195
195
| Field | Type | Tag | Description |
196
196
|-------|------|-----|-------------|
197
-
| Version |[uint64](https://pkg.go.dev/builtin#uint64)| json:"version" | Version specifies the version of the CAR format used for piece data serialization. |
198
197
199
198
### HttpUrl
200
199
@@ -203,7 +202,7 @@ HttpUrl represents an HTTP endpoint configuration for fetching piece data.
203
202
| Field | Type | Tag | Description |
204
203
|-------|------|-----|-------------|
205
204
| URL |[string](https://pkg.go.dev/builtin#string)| json:"url" | URL specifies the HTTP endpoint where the piece data can be fetched. |
206
-
|HTTPHeaders|[http.Header](https://pkg.go.dev/net/http#Header)| json:"httpheaders" | HTTPHeaders represents the HTTP headers associated with the URL. |
205
+
|Headers|[http.Header](https://pkg.go.dev/net/http#Header)| json:"headers" | HTTPHeaders represents the HTTP headers associated with the URL. |
207
206
| Priority |[uint64](https://pkg.go.dev/builtin#uint64)| json:"priority" | Priority indicates the order preference for using the URL in requests, with lower values having higher priority. |
208
207
| Fallback |[bool](https://pkg.go.dev/builtin#bool)| json:"fallback" | Fallback indicates whether this URL serves as a fallback option when other URLs fail. |
0 commit comments