VeeFriends.Wallet.MagicLink 1.0.3

VeeFriends.Wallet.MagicLink

This package has nothing todo with VeeFriends.com or Gary Vaynerchuk or NFTs.

Table of Contents

• Getting Started
• Installation
• Configuration
• Usage
  • Adding Magic to your service collection
  • Working with IdTokens
  • User Client Operations

Getting Started

To get started with the VeeFriends.Wallet.MagicLink SDK, make sure you have a working environment with .NET and necessary tools installed to build and run C# applications.

Installation

To install the VeeFriends.Wallet.MagicLink SDK, you will need to reference it in your project. If the SDK is available as a NuGet package, you can install it using the NuGet Package Manager or the dotnet CLI:

$ dotnet add package VeeFriends.Wallet.MagicLink

Replace <version_number> with the actual version of the VeeFriends.Wallet.MagicLink SDK.

Configuration

Before you can use the SDK, you need to configure it with your specific settings. You will require an API secret and the base URL for the service.

Here's an example of how to configure the SDK in the Startup.cs of your application:

public void ConfigureServices(IServiceCollection services)
{
    services.AddMagic(options =>
    {
        options.BaseAddress = new Uri("https://api.example.com/");
        options.Secret = "your-api-secret";
        options.ApiSecretHeader = "X-Api-Secret";
    });

    // ... other services
}

Usage

Adding VeeFriends.Wallet.MagicLink to your service collection

To use VeeFriends.Wallet.MagicLink within your application, add it to your service collection during the configuration phase:

services.AddMagic(options =>
{
    options.BaseAddress = new Uri("https://api.example.com/");
    options.Secret = "your-api-secret";
    options.ApiSecretHeader = "X-Api-Secret";
});

This extension method will configure the necessary HTTP clients and services required by the SDK to function.

Working with IdTokens

IdToken is a critical component of the SDK. It represents a cryptographic proof of ownership of a claim.

// Parsing an IdToken from a string
var idToken = new IdToken("your-id-token-string");

// Retrieving the claim from the IdToken
var claim = idToken.GetClaim();

// Validating the token
bool isValid = idToken.Validate("your-client-id");

User Client Operations

The SDK provides an IUserClient interface to interact with user data. Here's how you can use it in your application:

public class UserService
{
    private readonly IUserClient _userClient;

    public UserService(IUserClient userClient)
    {
        _userClient = userClient;
    }

    public async Task<UserInfo> GetUserMetadataByIssuer(string issuer)
    {
        return await _userClient.GetMetadataByIssuer(issuer, CancellationToken.None);
    }

    // Other operations...
}

Make sure to implement error handling and proper asynchronous programming practices when using these asynchronous methods.