ICP.NET/src/ClientGenerator/ClientCodeGenerator.cs at main · edjCase/ICP.NET · GitHub

History

386 lines (360 loc) · 14.4 KB

Raw

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

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

using EdjCase.ICP.Agent.Agents;

using EdjCase.ICP.Candid.Models;

using EdjCase.ICP.Candid.Models.Types;

using EdjCase.ICP.Candid.Models.Values;

using Microsoft.CodeAnalysis;

using Microsoft.CodeAnalysis.CSharp.Syntax;

using Org.BouncyCastle.Crypto.Agreement;

using Org.BouncyCastle.Ocsp;

using System;

using System.Collections.Generic;

using System.Linq;

using System.Threading.Tasks;

namespace EdjCase.ICP.ClientGenerator

{

/// <summary>

/// Generator to create client source code based of candid definitions from `.did` files

/// or from a canister id

/// </summary>

public static class ClientCodeGenerator

{

/// <summary>

/// Creates client source code for a canister based on its id. This only works if

/// the canister has the `candid:service` meta data available in its public state

/// </summary>

/// <param name="canisterId">The canister to get the definition from</param>

/// <param name="options">The options for client generation</param>

public static async Task<ClientSyntax> GenerateClientFromCanisterAsync(

Principal canisterId,

ClientGenerationOptions options

)

{

var agent = new HttpAgent(identity: null, httpBoundryNodeUrl: options.BoundryNodeUrl);

var candidServicePath = StatePath.FromSegments("canister", canisterId.Raw, "metadata", "candid:service");

var paths = new List<StatePath>

{

candidServicePath

};

var response = await agent.ReadStateAsync(canisterId, paths);

string? fileText = response.Certificate.Tree.GetValueOrDefault(candidServicePath)?.AsLeaf().AsUtf8();

if (string.IsNullOrWhiteSpace(fileText))

{

throw new Exception("Canister does not have 'candid:service' exposed");

}

return GenerateClientFromFile(fileText, options);

}

/// <summary>

/// Generates client source code for a canister based on a `.did` file definition

/// </summary>

/// <param name="fileText">The text content of the `.did` definition file</param>

/// <param name="options">The options for client generation</param>

public static ClientSyntax GenerateClientFromFile(

string fileText,

ClientGenerationOptions options

)

{

CandidServiceDescription serviceFile = CandidServiceDescription.Parse(fileText);

return GenerateClient(serviceFile, options);

}

/// <summary>

/// Generates client source code for a canister based on a `.did` file definition

/// </summary>

/// <param name="service">The service definition to generate the client from</param>

/// <param name="options">The options for client generation</param>

public static ClientSyntax GenerateClient(

CandidServiceDescription service,

ClientGenerationOptions options

)

{

var nameHelper = new NameHelper(options.KeepCandidCase);

HashSet<string> aliasedTypeIds = new();

// Mapping of A => Type

// where candid is: type A = Type;

Dictionary<string, (string Name, SourceCodeType Type)> declaredTypes = service.DeclaredTypes

.Where(t => t.Value is not CandidServiceType) // avoid duplication service of type

.Select(t =>

{

NamedTypeOptions? typeOptions = options.Types.GetValueOrDefault(t.Key.ToString());

ResolvedName typeName = nameHelper.ResolveName(t.Key.ToString(), typeOptions?.NameOverride);

aliasedTypeIds.Add(t.Key.ToString());

SourceCodeType sourceCodeType = ResolveSourceCodeType(

t.Value,

nameHelper,

typeOptions?.TypeOptions,

aliasedTypeIds,

options.OverrideOptionalValue,

out bool _

);

if (!sourceCodeType.IsPredefinedType)

{

// If predefined (List<>, Dictionary<>, etc...) then use an alias vs a new type

aliasedTypeIds.Remove(t.Key.ToString());

}

return (Id: t.Key.ToString(), Name: typeName.Name, Type: sourceCodeType);

})

.ToDictionary(t => t.Id, t => (t.Name, t.Type));

string modelNamespace = options.NoFolders

? options.Namespace

: options.Namespace + ".Models";

var typeResolver = new RoslynTypeResolver(

modelNamespace,

aliasedTypeIds,

options.FeatureNullable,

options.VariantsUseProperties,

nameHelper,

declaredTypes

);

Dictionary<string, ResolvedType> resolvedTypes = declaredTypes

.ToDictionary(

t => t.Key,

t => typeResolver.ResolveTypeDeclaration(t.Key, t.Value.Name, t.Value.Type)

);

var typeFiles = new List<(string FileName, CompilationUnitSyntax Source)>();

Dictionary<string, string> aliasTypes = aliasedTypeIds

.ToDictionary(

t => declaredTypes[t].Name,

t => resolvedTypes[t].Name.BuildName(options.FeatureNullable, includeNamespace: true, resolveAliases: true)

);

foreach ((string id, ResolvedType typeInfo) in resolvedTypes)

{

CompilationUnitSyntax? sourceCode = RoslynSourceGenerator.GenerateTypeSourceCode(

typeInfo,

typeResolver.ModelNamespace,

aliasTypes

);

if (sourceCode != null)

{

typeFiles.Add((typeInfo.Name.BuildName(options.FeatureNullable, false), sourceCode));

}

string clientName = options.Name + "ApiClient";

TypeName clientTypeName = new SimpleTypeName(clientName, options.Namespace, isDefaultNullable: true);

ServiceSourceCodeType serviceSourceType = ResolveService(service.Service, nameHelper, aliasedTypeIds, options.OverrideOptionalValue);

CompilationUnitSyntax clientSource = RoslynSourceGenerator.GenerateClientSourceCode(

clientTypeName,

options.Namespace,

serviceSourceType,

typeResolver,

aliasTypes

);

// TODO? global using only supported in C# 10+

return new ClientSyntax(clientName, clientSource, typeFiles);

}

private static SourceCodeType ResolveSourceCodeType(

CandidType type,

NameHelper nameHelper,

TypeOptions? typeOptions,

HashSet<string> aliasedTypeIds,

bool overrideOptionalValue,

out bool hasAliasReference

)

{

switch (type)

{

case CandidFuncType f:

{

hasAliasReference = false;

return new RawCandidType(f);

}

case CandidPrimitiveType p:

{

hasAliasReference = false;

return p.PrimitiveType switch

{

PrimitiveType.Text => new NonGenericSourceCodeType(typeof(string)),

PrimitiveType.Nat => new NonGenericSourceCodeType(typeof(UnboundedUInt)),

PrimitiveType.Nat8 => new NonGenericSourceCodeType(typeof(byte)),

PrimitiveType.Nat16 => new NonGenericSourceCodeType(typeof(ushort)),

PrimitiveType.Nat32 => new NonGenericSourceCodeType(typeof(uint)),

PrimitiveType.Nat64 => new NonGenericSourceCodeType(typeof(ulong)),

PrimitiveType.Int => new NonGenericSourceCodeType(typeof(UnboundedInt)),

PrimitiveType.Int8 => new NonGenericSourceCodeType(typeof(sbyte)),

PrimitiveType.Int16 => new NonGenericSourceCodeType(typeof(short)),

PrimitiveType.Int32 => new NonGenericSourceCodeType(typeof(int)),

PrimitiveType.Int64 => new NonGenericSourceCodeType(typeof(long)),

PrimitiveType.Float32 => new NonGenericSourceCodeType(typeof(float)),

PrimitiveType.Float64 => new NonGenericSourceCodeType(typeof(double)),

PrimitiveType.Bool => new NonGenericSourceCodeType(typeof(bool)),

PrimitiveType.Principal => new NonGenericSourceCodeType(typeof(Principal)),

PrimitiveType.Reserved => new NonGenericSourceCodeType(typeof(ReservedValue)),

PrimitiveType.Empty => new NonGenericSourceCodeType(typeof(EmptyValue)),

PrimitiveType.Null => new NonGenericSourceCodeType(typeof(NullValue)),

_ => throw new NotImplementedException(),

};

}

case CandidReferenceType r:

{

hasAliasReference = aliasedTypeIds.Contains(r.Id.ToString());

return new ReferenceSourceCodeType(r.Id);

}

case CandidVectorType v:

{

TypeOptions? innerTypeOptions = typeOptions?.InnerType;

SourceCodeType innerType = ResolveSourceCodeType(

v.InnerType,

nameHelper,

innerTypeOptions,

aliasedTypeIds,

overrideOptionalValue,

out hasAliasReference

);

bool isDictionaryCompatible = innerType is TupleSourceCodeType t && t.Fields.Count == 2;

string defaultRepresentation = isDictionaryCompatible

? "dictionary"

: "list";

string rep = typeOptions?.Representation ?? defaultRepresentation;

bool usePredefined = !hasAliasReference; // If has alias reference, create own type due to alias reference limitations

switch (rep.ToLower())

{

case "array":

return new ArraySourceCodeType(innerType);

case "list":

return new ListSourceCodeType(innerType, usePredefined);

case "dictionary":

if (!isDictionaryCompatible)

{

throw new Exception("List to dictionary conversion is only compatible with `vec record { a; b }` candid types");

}

TupleSourceCodeType tuple = (TupleSourceCodeType)innerType;

SourceCodeType keyType = tuple.Fields[0];

SourceCodeType valueType = tuple.Fields[1];

return new DictionarySourceCodeType(keyType, valueType, usePredefined);

default:

throw new Exception($"Vec types do not support representation: '{rep}'");

}

case CandidOptionalType o:

{

SourceCodeType innerType = ResolveSourceCodeType(

o.Value,

nameHelper,

typeOptions: null,

aliasedTypeIds,

overrideOptionalValue,

out hasAliasReference

);

return new OptionalValueSourceCodeType(innerType, !hasAliasReference);

}

case CandidRecordType o:

{

List<(CandidTag Key, SourceCodeType Type, bool HasAliasReference, bool OptionalOverridden)> fields = o.Fields

.Select(f =>

{

NamedTypeOptions? fieldTypeOptions = typeOptions?.Fields.GetValueOrDefault(f.Key.ToString());

CandidType type;

bool optionalOverridden;

if (overrideOptionalValue && f.Value is CandidOptionalType o)

{

optionalOverridden = true;

type = o.Value;

}

else

{

optionalOverridden = false;

type = f.Value;

}

SourceCodeType sourceCodeType = ResolveSourceCodeType(

type,

nameHelper,

fieldTypeOptions?.TypeOptions,

aliasedTypeIds,

overrideOptionalValue,

out bool innerHasAliasReference

);

return (Id: f.Key, Type: sourceCodeType, HasAliasReference: innerHasAliasReference, OptionalOverridden: optionalOverridden);

})

.ToList();

hasAliasReference = fields.Any(f => f.HasAliasReference);

// Check if tuple (tag ids are 0...N)

bool isTuple = !hasAliasReference // If has any alias reference, make own object due to C# alias limitations

&& o.Fields.Any()

&& o.Fields

.Select(f => f.Key.Id)

.OrderBy(f => f)

.SequenceEqual(Enumerable.Range(0, o.Fields.Count).Select(i => (uint)i));

if (isTuple)

{

List<SourceCodeType> tupleFields = fields

.Select(f => f.Type)

.ToList()!;

return new TupleSourceCodeType(tupleFields);

}

return new RecordSourceCodeType(fields

.Select(f =>

{

NamedTypeOptions? fieldTypeOptions = f.Key.Name == null ? null : typeOptions?.Fields.GetValueOrDefault(f.Key.Name);

ResolvedName fieldName = nameHelper.ResolveName(f.Key, fieldTypeOptions?.NameOverride);

return new RecordSourceCodeType.RecordField(

tag: fieldName,

type: f.Type,

optionalOverridden: f.OptionalOverridden

);

})

.ToList()

);

}

case CandidVariantType va:

{

List<(ResolvedName Key, SourceCodeType? Type, bool HasAliasReference, bool OptionalOverridden)> fields = va.Options

.Select(f =>

{

NamedTypeOptions? innerTypeOptions = f.Key.Name == null ? null : typeOptions?.Fields.GetValueOrDefault(f.Key.Name);

// If type is null, then just be a typeless variant

bool innerHasAliasReference = false;

CandidType type;

bool optionalOverridden;

if (overrideOptionalValue && f.Value is CandidOptionalType o)

{

optionalOverridden = true;

type = o.Value;

}

else

{

optionalOverridden = false;

type = f.Value;

}

SourceCodeType? sourceCodeType = f.Value == CandidType.Null()

? null

: ResolveSourceCodeType(type, nameHelper, innerTypeOptions?.TypeOptions, aliasedTypeIds, overrideOptionalValue, out innerHasAliasReference);

ResolvedName optionName = nameHelper.ResolveName(f.Key, innerTypeOptions?.NameOverride);

return (optionName, sourceCodeType, innerHasAliasReference, optionalOverridden);

})

.ToList();

hasAliasReference = fields.Any(f => f.HasAliasReference);

return new VariantSourceCodeType(fields.Select(f => new VariantSourceCodeType.VariantOption(f.Key, f.Type, f.OptionalOverridden)).ToList());

}

default:

throw new NotImplementedException();

}

internal static ServiceSourceCodeType ResolveService(CandidServiceType s, NameHelper nameHelper, HashSet<string> aliasedTypeIds, bool overrideOptionalValue)

{

List<(string CsharpName, string CandidName, ServiceSourceCodeType.Func FuncInfo)> methods = s.Methods

.Select(m =>

{

ResolvedName valueName = nameHelper.ResolveName(m.Key.ToString());

return (valueName.Name, valueName.CandidTag.Name!, ResolveFunc(m.Value, nameHelper, aliasedTypeIds, overrideOptionalValue));

})

.ToList();

return new ServiceSourceCodeType(methods);

}

private static ServiceSourceCodeType.Func ResolveFunc(CandidFuncType value, NameHelper nameHelper, HashSet<string> aliasedTypeIds, bool overrideOptionalValue)

{

List<(ResolvedName Name, SourceCodeType Type)> argTypes = value.ArgTypes

.Select((t, i) => ResolveXType(t, i, "arg"))

.ToList();

List<(ResolvedName Name, SourceCodeType Type)> returnTypes = value.ReturnTypes

.Select((t, i) => ResolveXType(t, i, "returnArg"))

.ToList();

bool isOneway = value.Modes.Contains(FuncMode.Oneway);

bool isQuery = value.Modes.Contains(FuncMode.Query) || value.Modes.Contains(FuncMode.CompositeQuery);

return new ServiceSourceCodeType.Func(argTypes, returnTypes, isOneway, isQuery);

(ResolvedName Name, SourceCodeType Type) ResolveXType((CandidId? Name, CandidType Type) a, int i, string backupPrefix)

{

ResolvedName name = nameHelper.ResolveName(a.Name?.ToString() ?? backupPrefix + i);

SourceCodeType type = ResolveSourceCodeType(a.Type, nameHelper, null, aliasedTypeIds, overrideOptionalValue, out bool hasAliasReference);

return (name, type);

}

ICP.NET/src/ClientGenerator/ClientCodeGenerator.cs at main · edjCase/ICP.NET · GitHub

Uh oh!

Expand file tree

Breadcrumbs

ClientCodeGenerator.cs

Latest commit

History

Breadcrumbs

ClientCodeGenerator.cs

File metadata and controls