EdjCase.ICP.Candid
4.0.0-pre.6
See the version list below for details.
dotnet add package EdjCase.ICP.Candid --version 4.0.0-pre.6
NuGet\Install-Package EdjCase.ICP.Candid -Version 4.0.0-pre.6
<PackageReference Include="EdjCase.ICP.Candid" Version="4.0.0-pre.6" />
paket add EdjCase.ICP.Candid --version 4.0.0-pre.6
#r "nuget: EdjCase.ICP.Candid, 4.0.0-pre.6"
// Install EdjCase.ICP.Candid as a Cake Addin #addin nuget:?package=EdjCase.ICP.Candid&version=4.0.0-pre.6&prerelease // Install EdjCase.ICP.Candid as a Cake Tool #tool nuget:?package=EdjCase.ICP.Candid&version=4.0.0-pre.6&prerelease
Candid - Library of Candid Encoding, Models and Helpers
- Nuget:
EdjCase.ICP.Candid
Using Native Candid Types
CandidArg
is the set of candid typed value parameters that is sent to a IC canister for a requestCandidTypedValue
is the combo of aCandidValue
and its correspondingCandidType
CandidValue
is a raw candid valueCandidType
is the type definition of a candid type
Create Type
Some Examples:
// Nat (positive integer)
CandidType natType = CandidType.Nat(); // shorthand for `new CandidPrimitiveType(PrimitiveType.Nat)`
// Text (string)
CandidType textType = CandidType.Text(); // shorthand for `new CandidPrimitiveType(PrimitiveType.Text)`
// Opt (optional/nullable) Principal (identifier)
CandidType optionalPrincipalType = CandidType.Opt(CandidType.Principal());
// Record (dictionary/object)
CandidType recordType = new CandidRecordType(new Dictionary<CandidTag, CandidType>
{
{ CandidTag.FromName("name"), CandidType.Text() },
{ CandidTag.FromName("age"), CandidType.Nat() }
});
// Variant (union)
CandidType variantType = new CandidVariantType(new Dictionary<CandidTag, CandidType>
{
{ CandidTag.FromName("option1"), CandidType.Bool() },
{ CandidTag.FromName("option2"), CandidType.Null() }
});
// Vec (list/array) of Float32
CandidType float32Vec = new CandidVectorType(CandidType.Float32());
Create Value
Some Examples:
// Nat (positive integer)
CandidValue natType = CandidValue.Nat(4);
// Text (string)
CandidValue textType = CandidValue.Text("SomeText");
// Opt (optional/nullable) Principal (identifier)
CandidValue optionalPrincipalType = new CandidOptional(CandidValue.Principal(Principal.Anonymous()));
// Record (dictionary/object)
CandidValue recordType = new CandidRecord(new Dictionary<CandidTag, CandidValue>
{
{ CandidTag.FromName("name"), CandidValue.Text("Name1") },
{ CandidTag.FromName("age"), CandidValue.Nat(21) }
});
// Variant (union)
CandidValue variantType = new CandidVariant("option1", CandidValue.Bool(true));
// Vec (list/array) of Float32
CandidValue float32Vec = new CandidVector(new CandidValue[]
{
CandidValue.Float32(1.1f),
CandidValue.Float32(2.2f),
CandidValue.Float32(3.3f)
});
Parse From bytes
When candid is encoded, its in the form of a CandidArg
. Individual values and types are not usually encoded
CandidArg arg = CandidByteParser.Parse(rawCandidBytes);
OR
CandidArg arg = CandidArg.FromBytes(rawCandidBytes);
Reading Values (without custom types)
// Assume arg is `(Nat, record { title : Text; length : Nat; })`
CandidArg arg = ...;
CandidTypedValue firstTypedValue = arg.Values[0];
UnboundedUInt natValue = firstTypedValue.Value.AsNat();
CandidTypedValue secondTypedValue = arg.Values[1];
CandidRecord recordValue = secondTypedValue.Value.AsRecord();
string title = recordValue["title"].AsText();
UnboundedUInt length = recordValue["length"].AsNat();
Using Self Defined Types
Self defined types are helpful for predefining classes to the candid schema of an endpoint. This can be done manually (as shown below) or done automattically with the ClientGenerator
From Candid To Self Defined Type
Single argument:
CandidArg arg = ...;
MyObj1 obj = arg.ToObjects<MyObj1>();
Multi arguments:
CandidArg arg = ...;
(MyObj1 obj, MyObj2 obj2) = arg.ToObjects<MyObj1, MyObj2>();
To Candid From Self Defined Type
// Serialze
MyObj obj = new MyObj
{
Title = "Title 1",
IsGoodTitle = false
};
CandidTypedValue value = CandidTypedValue.FromObject(obj);
Defining Variant Types
[Variant(typeof(MyVariantTag))] // Required to flag as variant and define options with enum
public class MyVariant
{
[VariantTagProperty] // Flag for tag/enum property, not required if name is `Tag`
public MyVariantTag Tag { get; set; }
[VariantValueProperty] // Flag for value property, not required if name is `Value`
public object? Value { get; set; }
}
public enum MyVariantTag
{
[CandidName("o1")] // Used to override name for candid
Option1,
[CandidName("o2")]
[VariantType(typeof(string))] // Used to specify if the option has a value associated
Option2
}
Or if variant options have no type, just an Enum can be used
public enum MyVariant
{
[CandidName("o1")]
Option1,
[CandidName("o2")]
Option2
}
Defining Record Types
public class MyRecord
{
[CandidName("title")] // Used to override name for candid
public string Title { get; set; }
[CandidName("is_good_title")]
public bool IsGoodTitle { get; set; }
}
NOTE: [CandidName(...)] is not needed if the property name is exactly the same as the candid name
// Equivalent to above
public class MyRecord
{
public string title { get; set; }
public bool is_good_title { get; set; }
}
Defining Other Types
(C# type) -> (Candid type)
UnboundedUInt -> Nat
byte -> Nat8
ushort -> Nat16
uint -> Nat32
ulong -> Nat64
UnboundedInt -> Int
sbyte -> Int8
short -> Int16
int -> Int32
long -> Int64
string -> Text
float -> Float32
double -> Float64
bool -> Bool
Principal -> Principal
List<T> -> Vec T
T[] -> Vec T
CandidFunc -> Func
OptionalValue<T> -> Opt T
EmptyValue -> Empty
ReservedValue -> Reserved
NullValue -> Null
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- Microsoft.Bcl.HashCode (>= 1.1.1)
- System.Formats.Asn1 (>= 7.0.0)
- System.Memory (>= 4.5.5)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on EdjCase.ICP.Candid:
Package | Downloads |
---|---|
EdjCase.ICP.Agent
Package Description |
|
EdjCase.ICP.InternetIdentity
Package Description |
|
Qwer.Chains.Dfinity.Clients
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
7.0.0-pre.1 | 130 | 10/27/2024 |
6.2.1 | 145 | 10/23/2024 |
6.2.0 | 136 | 10/21/2024 |
6.1.2 | 1,639 | 4/30/2024 |
6.1.1 | 195 | 4/17/2024 |
6.1.0 | 192 | 4/15/2024 |
6.0.0 | 208 | 3/21/2024 |
5.1.0 | 295 | 1/25/2024 |
5.0.0 | 1,226 | 1/12/2024 |
5.0.0-pre.2 | 126 | 12/13/2023 |
5.0.0-pre.1 | 78 | 12/11/2023 |
4.1.0 | 518 | 11/10/2023 |
4.0.1 | 296 | 11/1/2023 |
4.0.0 | 420 | 10/12/2023 |
4.0.0-pre.10 | 89 | 10/10/2023 |
4.0.0-pre.9 | 83 | 10/10/2023 |
4.0.0-pre.8 | 89 | 10/9/2023 |
4.0.0-pre.7 | 86 | 10/9/2023 |
4.0.0-pre.6 | 85 | 10/9/2023 |
4.0.0-pre.5 | 83 | 10/8/2023 |
4.0.0-pre.4 | 92 | 10/6/2023 |
4.0.0-pre.3 | 82 | 10/5/2023 |
4.0.0-pre.2 | 86 | 9/27/2023 |
4.0.0-pre.1 | 82 | 9/25/2023 |
3.2.2 | 539 | 9/22/2023 |
3.2.1 | 233 | 9/22/2023 |
3.2.0 | 831 | 8/2/2023 |
3.1.5 | 252 | 9/27/2023 |
3.1.4 | 396 | 7/20/2023 |
3.1.3 | 776 | 6/12/2023 |
3.1.2 | 1,265 | 5/11/2023 |
3.1.1 | 427 | 5/9/2023 |
3.1.0 | 342 | 5/9/2023 |
3.0.1 | 362 | 5/2/2023 |
3.0.0 | 348 | 5/1/2023 |
3.0.0-beta.1 | 118 | 4/17/2023 |
2.3.9 | 323 | 5/1/2023 |
2.3.8 | 361 | 4/28/2023 |
2.3.7 | 344 | 4/28/2023 |
2.3.6 | 353 | 4/28/2023 |
2.3.5 | 404 | 4/27/2023 |
2.3.4 | 374 | 4/27/2023 |
2.3.3 | 389 | 4/26/2023 |
2.3.2 | 371 | 4/26/2023 |
2.3.1 | 515 | 4/26/2023 |
2.3.0 | 404 | 4/25/2023 |
2.2.10 | 403 | 4/24/2023 |
2.2.9 | 361 | 4/24/2023 |
2.2.8 | 408 | 4/24/2023 |
2.2.7 | 620 | 4/17/2023 |
2.2.6 | 709 | 4/12/2023 |
2.2.5 | 407 | 4/12/2023 |
2.2.4 | 498 | 4/11/2023 |
2.2.3 | 416 | 4/11/2023 |
2.2.2 | 489 | 4/7/2023 |
2.2.1 | 431 | 4/7/2023 |
2.2.0 | 465 | 4/6/2023 |
2.1.1 | 604 | 3/30/2023 |
2.1.0 | 714 | 3/23/2023 |
2.0.8 | 545 | 3/20/2023 |
2.0.7 | 613 | 3/12/2023 |
2.0.6 | 297 | 3/12/2023 |
2.0.5 | 275 | 3/12/2023 |
2.0.4 | 305 | 3/12/2023 |
2.0.3 | 292 | 3/12/2023 |
2.0.2 | 523 | 3/10/2023 |
2.0.1 | 515 | 3/10/2023 |
2.0.0 | 551 | 3/8/2023 |
2.0.0-beta.26 | 123 | 3/8/2023 |
2.0.0-beta.25 | 121 | 3/8/2023 |
2.0.0-beta.24 | 129 | 3/7/2023 |
2.0.0-beta.23 | 127 | 3/6/2023 |
2.0.0-beta.22 | 123 | 3/1/2023 |
2.0.0-beta.21 | 123 | 2/28/2023 |
2.0.0-beta.20 | 139 | 2/20/2023 |
2.0.0-beta.19 | 129 | 2/14/2023 |
2.0.0-beta.18 | 127 | 2/14/2023 |
2.0.0-beta.17 | 131 | 2/14/2023 |
2.0.0-beta.16 | 130 | 2/11/2023 |
2.0.0-beta.15 | 135 | 2/10/2023 |
2.0.0-beta.14 | 139 | 2/6/2023 |
2.0.0-beta.13 | 139 | 2/3/2023 |
2.0.0-beta.12 | 147 | 2/2/2023 |
2.0.0-beta.11 | 153 | 1/30/2023 |
2.0.0-beta.10 | 145 | 1/23/2023 |
2.0.0-beta.9 | 154 | 1/19/2023 |
2.0.0-beta.8 | 141 | 1/19/2023 |
2.0.0-beta.7 | 153 | 1/12/2023 |
2.0.0-beta.6 | 147 | 12/31/2022 |
2.0.0-beta.5 | 136 | 12/30/2022 |
2.0.0-beta.4 | 142 | 12/21/2022 |
2.0.0-beta.3 | 140 | 12/19/2022 |
2.0.0-beta.2 | 141 | 12/10/2022 |
2.0.0-beta.1 | 143 | 12/2/2022 |
1.2.1 | 709 | 11/29/2022 |
1.2.0 | 647 | 11/28/2022 |
1.1.0 | 672 | 11/28/2022 |
1.0.3 | 660 | 11/25/2022 |
1.0.2 | 832 | 6/8/2022 |
1.0.1 | 868 | 6/7/2022 |
0.0.1-beta.20 | 176 | 6/1/2022 |
0.0.1-beta.19 | 174 | 5/20/2022 |
0.0.1-beta.18 | 168 | 5/20/2022 |
0.0.1-beta.14 | 182 | 5/19/2022 |
0.0.1-beta.13 | 176 | 5/18/2022 |
0.0.1-beta.2 | 206 | 5/16/2022 |
0.0.1-beta.1 | 188 | 5/11/2022 |