logos-storage/logos-storage-nim-cs-dist-tests
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-nim-cs-dist-tests.git synced 2026-05-27 11:40:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

updates codex api

Browse Source
This commit is contained in:
ThatBen 2025-04-03 09:15:39 +02:00
parent fbb8db2a03
commit 83e4cb2e04
No known key found for this signature in database
GPG Key ID: 62C543548433D43E
4 changed files with 166 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
ProjectPlugins/CodexClient/Mapper.cs
View File

@ -1,5 +1,4 @@
using CodexOpenApi;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Linq;
using System.Numerics;
using Utils;
@ -37,14 +36,14 @@ namespace CodexClient
};
}
public CodexOpenApi.SalesAvailabilityCREATE Map(StorageAvailability availability)
public CodexOpenApi.SalesAvailability Map(StorageAvailability availability)
{
return new CodexOpenApi.SalesAvailabilityCREATE
return new CodexOpenApi.SalesAvailability
{
Duration = ToDecInt(availability.MaxDuration.TotalSeconds),
Duration = ToLong(availability.MaxDuration.TotalSeconds),
MinPricePerBytePerSecond = ToDecInt(availability.MinPricePerBytePerSecond),
TotalCollateral = ToDecInt(availability.TotalCollateral),
TotalSize = ToDecInt(availability.TotalSpace.SizeInBytes)
TotalSize = availability.TotalSpace.SizeInBytes
};
}
@ -52,11 +51,11 @@ namespace CodexClient
{
return new CodexOpenApi.StorageRequestCreation
{
Duration = ToDecInt(purchase.Duration.TotalSeconds),
Duration = ToLong(purchase.Duration.TotalSeconds),
ProofProbability = ToDecInt(purchase.ProofProbability),
PricePerBytePerSecond = ToDecInt(purchase.PricePerBytePerSecond),
CollateralPerByte = ToDecInt(purchase.CollateralPerByte),
Expiry = ToDecInt(purchase.Expiry.TotalSeconds),
Expiry = ToLong(purchase.Expiry.TotalSeconds),
Nodes = Convert.ToInt32(purchase.MinRequiredNumberOfNodes),
Tolerance = Convert.ToInt32(purchase.NodeFailureTolerance)
};
@ -73,8 +72,8 @@ namespace CodexClient
(
ToByteSize(availability.TotalSize),
ToTimespan(availability.Duration),
new TestToken(ToBigIng(availability.MinPricePerBytePerSecond)),
new TestToken(ToBigIng(availability.TotalCollateral))
new TestToken(ToBigInt(availability.MinPricePerBytePerSecond)),
new TestToken(ToBigInt(availability.TotalCollateral))
)
{
Id = availability.Id,
@ -92,7 +91,7 @@ namespace CodexClient
};
}
public StoragePurchaseState Map(PurchaseState purchaseState)
public StoragePurchaseState Map(CodexOpenApi.PurchaseState purchaseState)
{
// TODO: to be re-enabled when marketplace api lines up with openapi.yaml.
@ -100,21 +99,21 @@ namespace CodexClient
// That's what we want.
switch (purchaseState)
{
case PurchaseState.Cancelled:
case CodexOpenApi.PurchaseState.Cancelled:
return StoragePurchaseState.Cancelled;
case PurchaseState.Error:
case CodexOpenApi.PurchaseState.Error:
return StoragePurchaseState.Error;
case PurchaseState.Failed:
case CodexOpenApi.PurchaseState.Failed:
return StoragePurchaseState.Failed;
case PurchaseState.Finished:
case CodexOpenApi.PurchaseState.Finished:
return StoragePurchaseState.Finished;
case PurchaseState.Pending:
case CodexOpenApi.PurchaseState.Pending:
return StoragePurchaseState.Pending;
case PurchaseState.Started:
case CodexOpenApi.PurchaseState.Started:
return StoragePurchaseState.Started;
case PurchaseState.Submitted:
case CodexOpenApi.PurchaseState.Submitted:
return StoragePurchaseState.Submitted;
case PurchaseState.Unknown:
case CodexOpenApi.PurchaseState.Unknown:
return StoragePurchaseState.Unknown;
}
@ -129,7 +128,7 @@ namespace CodexClient
Content = Map(request.Content),
Id = request.Id,
Client = request.Client,
Expiry = request.Expiry,
Expiry = TimeSpan.FromSeconds(request.Expiry),
Nonce = request.Nonce
};
}
@ -138,12 +137,12 @@ namespace CodexClient
{
return new StorageAsk
{
Duration = ask.Duration,
Duration = TimeSpan.FromSeconds(ask.Duration),
MaxSlotLoss = ask.MaxSlotLoss,
ProofProbability = ask.ProofProbability,
PricePerBytePerSecond = ask.PricePerBytePerSecond,
PricePerBytePerSecond = ToTestToken(ask.PricePerBytePerSecond),
Slots = ask.Slots,
SlotSize = ask.SlotSize
SlotSize = ToByteSize(ask.SlotSize)
};
}
@ -258,19 +257,29 @@ namespace CodexClient
return t.TstWei.ToString("D");
}
private BigInteger ToBigIng(string tokens)
private TestToken ToTestToken(string s)
{
return new TestToken(ToBigInt(s));
}
private long ToLong(double value)
{
return Convert.ToInt64(value);
}
private BigInteger ToBigInt(string tokens)
{
return BigInteger.Parse(tokens);
}
private TimeSpan ToTimespan(string duration)
private TimeSpan ToTimespan(long duration)
{
return TimeSpan.FromSeconds(Convert.ToInt32(duration));
return TimeSpan.FromSeconds(duration);
}
private ByteSize ToByteSize(string size)
private ByteSize ToByteSize(long size)
{
return new ByteSize(Convert.ToInt64(size));
return new ByteSize(size);
}
}
}

12
ProjectPlugins/CodexClient/MarketplaceTypes.cs
View File

@ -63,18 +63,18 @@ namespace CodexClient
public string Client { get; set; } = string.Empty;
public StorageAsk Ask { get; set; } = null!;
public StorageContent Content { get; set; } = null!;
public string Expiry { get; set; } = string.Empty;
public TimeSpan Expiry { get; set; }
public string Nonce { get; set; } = string.Empty;
}
public class StorageAsk
{
public int Slots { get; set; }
public string SlotSize { get; set; } = string.Empty;
public string Duration { get; set; } = string.Empty;
public long Slots { get; set; }
public ByteSize SlotSize { get; set; } = 0.Bytes();
public TimeSpan Duration { get; set; }
public string ProofProbability { get; set; } = string.Empty;
public string PricePerBytePerSecond { get; set; } = string.Empty;
public int MaxSlotLoss { get; set; }
public TestToken PricePerBytePerSecond { get; set; } = 0.Tst();
public long MaxSlotLoss { get; set; }
}
public class StorageContent

162
ProjectPlugins/CodexClient/openapi.yaml
View File

@ -27,10 +27,6 @@ components:
maxLength: 66
example: 0x...
BigInt:
type: string
description: Integer represented as decimal string
Cid:
type: string
description: Content Identifier as specified at https://github.com/multiformats/cid
@ -55,17 +51,18 @@ components:
description: The amount of tokens paid per byte per second per slot to hosts the client is willing to pay
Duration:
type: string
description: The duration of the request in seconds as decimal string
type: integer
format: int64
description: The duration of the request in seconds
ProofProbability:
type: string
description: How often storage proofs are required as decimal string
Expiry:
type: string
type: integer
format: int64
description: A timestamp as seconds since unix epoch at which this request expires if the Request does not find requested amount of nodes to host the data.
default: 10 minutes
SPR:
type: string
@ -73,6 +70,8 @@ components:
SPRRead:
type: object
required:
- spr
properties:
spr:
$ref: "#/components/schemas/SPR"
@ -85,6 +84,8 @@ components:
Content:
type: object
required:
- cid
description: Parameters specifying the content
properties:
cid:
@ -92,6 +93,12 @@ components:
Node:
type: object
required:
- nodeId
- peerId
- record
- address
- seen
properties:
nodeId:
type: string
@ -116,6 +123,9 @@ components:
PeersTable:
type: object
required:
- localNode
- nodes
properties:
localNode:
$ref: "#/components/schemas/Node"
@ -126,6 +136,14 @@ components:
DebugInfo:
type: object
required:
- id
- addrs
- repo
- spr
- announceAddresses
- table
- codex
properties:
id:
$ref: "#/components/schemas/PeerId"
@ -149,12 +167,16 @@ components:
SalesAvailability:
type: object
required:
- totalSize
- duration
- minPricePerBytePerSecond
- totalCollateral
properties:
id:
$ref: "#/components/schemas/Id"
totalSize:
type: string
description: Total size of availability's storage in bytes as decimal string
type: integer
format: int64
description: Total size of availability's storage in bytes
duration:
$ref: "#/components/schemas/Duration"
minPricePerBytePerSecond:
@ -173,42 +195,53 @@ components:
default: 0
SalesAvailabilityREAD:
required:
- id
- totalRemainingCollateral
allOf:
- $ref: "#/components/schemas/SalesAvailability"
- type: object
properties:
id:
$ref: "#/components/schemas/Id"
readonly: true
freeSize:
type: string
type: integer
format: int64
description: Unused size of availability's storage in bytes as decimal string
SalesAvailabilityCREATE:
allOf:
- $ref: "#/components/schemas/SalesAvailability"
- required:
- totalSize
- minPricePerBytePerSecond
- totalCollateral
- duration
readOnly: true
totalRemainingCollateral:
type: string
description: Total collateral effective (in amount of tokens) that can be used for matching requests
readOnly: true
Slot:
type: object
required:
- id
- request
- slotIndex
properties:
id:
$ref: "#/components/schemas/SlotId"
request:
$ref: "#/components/schemas/StorageRequest"
slotIndex:
type: string
description: Slot Index as decimal string
type: integer
format: int64
description: Slot Index number
SlotAgent:
type: object
required:
- state
- requestId
- slotIndex
properties:
id:
$ref: "#/components/schemas/SlotId"
slotIndex:
type: string
description: Slot Index as decimal string
type: integer
format: int64
description: Slot Index number
requestId:
$ref: "#/components/schemas/Id"
request:
@ -235,18 +268,28 @@ components:
Reservation:
type: object
required:
- id
- availabilityId
- size
- requestId
- slotIndex
- validUntil
properties:
id:
$ref: "#/components/schemas/Id"
availabilityId:
$ref: "#/components/schemas/Id"
size:
$ref: "#/components/schemas/BigInt"
type: integer
format: int64
description: Size of the slot in bytes
requestId:
$ref: "#/components/schemas/Id"
slotIndex:
type: string
description: Slot Index as decimal string
type: integer
format: int64
description: Slot Index number
validUntil:
type: integer
description: Timestamp after which the reservation will no longer be valid.
@ -269,28 +312,39 @@ components:
nodes:
description: Minimal number of nodes the content should be stored on
type: integer
default: 1
default: 3
minimum: 3
tolerance:
description: Additional number of nodes on top of the `nodes` property that can be lost before pronouncing the content lost
type: integer
default: 0
default: 1
minimum: 1
collateralPerByte:
type: string
description: Number as decimal string that represents how much collateral per byte is asked from hosts that wants to fill a slots
expiry:
type: string
description: Number as decimal string that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself.
type: integer
format: int64
description: Number that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself.
StorageAsk:
type: object
required:
- slots
- slotSize
- duration
- proofProbability
- pricePerBytePerSecond
- collateralPerByte
- maxSlotLoss
properties:
slots:
description: Number of slots (eq. hosts) that the Request want to have the content spread over
type: integer
format: int64
slotSize:
type: string
description: Amount of storage per slot (in bytes) as decimal string
type: integer
format: int64
description: Amount of storage per slot in bytes
duration:
$ref: "#/components/schemas/Duration"
proofProbability:
@ -299,10 +353,18 @@ components:
$ref: "#/components/schemas/PricePerBytePerSecond"
maxSlotLoss:
type: integer
format: int64
description: Max slots that can be lost without data considered to be lost
StorageRequest:
type: object
required:
- id
- client
- ask
- content
- expiry
- nonce
properties:
id:
type: string
@ -321,6 +383,9 @@ components:
Purchase:
type: object
required:
- state
- requestId
properties:
state:
type: string
@ -340,9 +405,13 @@ components:
description: If Request failed, then here is presented the error message
request:
$ref: "#/components/schemas/StorageRequest"
requestId:
$ref: "#/components/schemas/Id"
DataList:
type: object
required:
- content
properties:
content:
type: array
@ -351,6 +420,9 @@ components:
DataItem:
type: object
required:
- cid
- manifest
properties:
cid:
$ref: "#/components/schemas/Cid"
@ -359,6 +431,11 @@ components:
ManifestItem:
type: object
required:
- treeCid
- datasetSize
- blockSize
- protected
properties:
treeCid:
$ref: "#/components/schemas/Cid"
@ -386,6 +463,11 @@ components:
Space:
type: object
required:
- totalBlocks
- quotaMaxBytes
- quotaUsedBytes
- quotaReservedBytes
properties:
totalBlocks:
description: "Number of blocks stored by the node"
@ -704,7 +786,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/SalesAvailabilityCREATE"
$ref: "#/components/schemas/SalesAvailability"
responses:
"201":
description: Created storage availability
@ -870,7 +952,7 @@ paths:
"200":
description: Node's SPR
content:
plain/text:
text/plain:
schema:
$ref: "#/components/schemas/SPR"
application/json:
@ -888,7 +970,7 @@ paths:
"200":
description: Node's Peer ID
content:
plain/text:
text/plain:
schema:
$ref: "#/components/schemas/PeerId"
application/json:

2
ProjectPlugins/CodexPlugin/ApiChecker.cs
View File

@ -10,7 +10,7 @@ namespace CodexPlugin
public class ApiChecker
{
// <INSERT-OPENAPI-YAML-HASH>
private const string OpenApiYamlHash = "9D-AB-49-BC-50-D3-ED-3D-EE-F3-5B-CC-74-F2-26-CD-74-1B-19-FF-25-F0-3F-05-37-71-1C-D7-C2-EF-AD-0A";
private const string OpenApiYamlHash = "EE-A5-6C-F9-F2-81-21-63-AB-F0-8D-63-0C-30-E8-55-F0-CC-7A-B0-69-6E-7F-77-C1-88-B0-31-F3-64-40-1A";
private const string OpenApiFilePath = "/codex/openapi.yaml";
private const string DisableEnvironmentVariable = "CODEXPLUGIN_DISABLE_APICHECK";