From cb5ab92b261c36f3b3c8e10bc2f9ec1141220f28 Mon Sep 17 00:00:00 2001 From: 0xFirekeeper <0xFirekeeper@gmail.com> Date: Fri, 7 Nov 2025 17:34:38 +0700 Subject: [PATCH] Add llms.txt generation from XML docs and update build Introduces a new Makefile target 'generate-llms' to generate llms.txt from XML documentation using the generator project. Updates the build process to include llms.txt generation. Adds implementation in Thirdweb.Generator/Program.cs for parsing XML docs and outputting a formatted llms.txt file. Adds the initial generated llms.txt to the repository. --- Makefile | 15 + Thirdweb.Generator/Program.cs | 279 + llms.txt | 17706 ++++++++++++++++++++++++++++++++ 3 files changed, 18000 insertions(+) create mode 100644 llms.txt diff --git a/Makefile b/Makefile index 1d242d6c..af81f6d5 100644 --- a/Makefile +++ b/Makefile @@ -65,6 +65,7 @@ help: @printf ' $(C_CYN)%-12s$(C_RST) - %s\n' 'publish' 'Publish the Thirdweb project (dotnet publish)' @printf ' $(C_CYN)%-12s$(C_RST) - %s\n' 'run' 'Run the console application' @printf ' $(C_CYN)%-12s$(C_RST) - %s\n' 'generate' 'Generate API client from OpenAPI spec' + @printf ' $(C_CYN)%-12s$(C_RST) - %s\n' 'generate-llms' 'Generate llms.txt from XML documentation' @printf ' $(C_CYN)%-12s$(C_RST) - %s\n' 'lint' 'Check code formatting (dry run)' @printf ' $(C_CYN)%-12s$(C_RST) - %s\n' 'fix' 'Fix code formatting issues' @printf ' $(C_CYN)%-12s$(C_RST) - %s\n' 'help' 'Show this help message' @@ -105,6 +106,19 @@ generate: ) @$(call msg,$(C_GRN),$(IC_OK),API client generation complete) +.PHONY: generate-llms +# Generate llms.txt from XML documentation +generate-llms: + @$(call msg,$(C_BLU),$(IC_INFO),$(IC_BUILD) Building Thirdweb in Release mode) + @$(DOTNET) build '$(LIB_PROJ)' -c Release >/dev/null 2>&1 || { \ + $(call msg,$(C_MAG),>> ,Building Thirdweb project) ; \ + $(DOTNET) build '$(LIB_PROJ)' -c Release ; \ + } + @$(call msg,$(C_BLU),$(IC_INFO),$(IC_GEN) Generating llms.txt from XML documentation) + @$(DOTNET) run --project '$(GENERATOR_PROJ)' -- --llms && \ + $(call msg,$(C_GRN),$(IC_OK),llms.txt generation complete) || \ + $(call msg,$(C_RED),$(IC_ERR),llms.txt generation failed) + .PHONY: build build: @$(MAKE) --no-print-directory generate @@ -112,6 +126,7 @@ build: @$(DOTNET) build && \ $(call msg,$(C_GRN),$(IC_OK),Build succeeded) || \ $(call msg,$(C_RED),$(IC_ERR),Build failed) + @$(MAKE) --no-print-directory generate-llms .PHONY: clean clean: diff --git a/Thirdweb.Generator/Program.cs b/Thirdweb.Generator/Program.cs index 795508cc..41e29e0c 100644 --- a/Thirdweb.Generator/Program.cs +++ b/Thirdweb.Generator/Program.cs @@ -1,4 +1,6 @@ using System.Globalization; +using System.Text; +using System.Xml.Linq; using NJsonSchema; using NSwag; using NSwag.CodeGeneration.CSharp; @@ -18,6 +20,270 @@ static string FindRepoRoot() return Directory.GetCurrentDirectory(); } +static void GenerateLlmsTxt(string repoRoot) +{ + var xmlPath = Path.Combine(repoRoot, "Thirdweb", "bin", "Release", "netstandard2.1", "Thirdweb.xml"); + var outputPath = Path.Combine(repoRoot, "llms.txt"); + + if (!File.Exists(xmlPath)) + { + Console.WriteLine($"XML documentation not found at {xmlPath}"); + Console.WriteLine("Please build the project in Release mode first."); + Environment.Exit(1); + } + + Console.WriteLine($"Reading XML documentation from {xmlPath}..."); + var doc = XDocument.Load(xmlPath); + var sb = new StringBuilder(); + + _ = sb.AppendLine("THIRDWEB .NET SDK - API DOCUMENTATION"); + _ = sb.AppendLine("====================================="); + _ = sb.AppendLine(); + + var assembly = doc.Root?.Element("assembly")?.Element("name")?.Value; + if (assembly != null) + { + _ = sb.AppendLine($"Assembly: {assembly}"); + _ = sb.AppendLine(); + } + + var members = doc.Root?.Element("members")?.Elements("member"); + if (members != null) + { + foreach (var member in members) + { + var name = member.Attribute("name")?.Value; + if (string.IsNullOrEmpty(name)) + { + continue; + } + + _ = sb.AppendLine(new string('-', 80)); + _ = sb.AppendLine(name); + _ = sb.AppendLine(new string('-', 80)); + + // Parse signature for better display + var signature = ParseMemberSignature(name); + if (signature != null) + { + _ = sb.AppendLine(); + _ = sb.AppendLine($"KIND: {signature.Kind}"); + if (!string.IsNullOrEmpty(signature.ReturnType)) + { + _ = sb.AppendLine($"RETURN TYPE: {signature.ReturnType}"); + } + } + + // Group param elements by name attribute + var paramDocs = member.Elements("param").Select(p => new { Name = p.Attribute("name")?.Value, Description = p.Value.Trim() }).Where(p => !string.IsNullOrEmpty(p.Name)).ToList(); + + // Display parameters with their names and types + if (signature?.Parameters != null && signature.Parameters.Count > 0) + { + _ = sb.AppendLine(); + _ = sb.AppendLine("PARAMETERS:"); + for (var i = 0; i < signature.Parameters.Count; i++) + { + var param = signature.Parameters[i]; + // Try to get the actual parameter name from documentation + var paramDoc = i < paramDocs.Count ? paramDocs[i] : null; + var paramName = paramDoc?.Name ?? param.Name; + + _ = sb.AppendLine($" - {paramName} ({param.Type})"); + if (paramDoc != null && !string.IsNullOrEmpty(paramDoc.Description)) + { + _ = sb.AppendLine($" {NormalizeXmlText(paramDoc.Description).Replace("\n", "\n ")}"); + } + } + } + + // Display other elements (summary, remarks, returns, exception, etc.) + foreach (var element in member.Elements()) + { + if (element.Name.LocalName == "param") + { + continue; // Already handled above + } + + var content = element.Value.Trim(); + if (string.IsNullOrEmpty(content)) + { + continue; + } + + _ = sb.AppendLine(); + var elementName = element.Name.LocalName.ToUpper(); + + // Add attribute info for exceptions and type params + var nameAttr = element.Attribute("name")?.Value; + var crefAttr = element.Attribute("cref")?.Value; + if (!string.IsNullOrEmpty(nameAttr)) + { + elementName += $" ({nameAttr})"; + } + else if (!string.IsNullOrEmpty(crefAttr)) + { + elementName += $" ({crefAttr})"; + } + + _ = sb.AppendLine($"{elementName}:"); + _ = sb.AppendLine(NormalizeXmlText(content)); + } + + _ = sb.AppendLine(); + } + } + + File.WriteAllText(outputPath, sb.ToString()); + Console.WriteLine($"Generated llms.txt at {outputPath}"); +} + +static MemberSignature? ParseMemberSignature(string memberName) +{ + if (string.IsNullOrEmpty(memberName) || memberName.Length < 2) + { + return null; + } + + var kind = memberName[0] switch + { + 'M' => "Method", + 'P' => "Property", + 'T' => "Type", + 'F' => "Field", + 'E' => "Event", + _ => "Unknown", + }; + + var fullSignature = memberName[2..]; // Remove "M:", "P:", etc. + + // For methods, parse parameters and return type + if (memberName[0] == 'M') + { + var parameters = new List(); + var methodName = fullSignature; + var returnType = "System.Threading.Tasks.Task"; // Default for async methods + + // Extract parameters from signature + var paramStart = fullSignature.IndexOf('('); + if (paramStart >= 0) + { + methodName = fullSignature[..paramStart]; + var paramEnd = fullSignature.LastIndexOf(')'); + if (paramEnd > paramStart) + { + var paramString = fullSignature[(paramStart + 1)..paramEnd]; + if (!string.IsNullOrEmpty(paramString)) + { + var paramParts = SplitParameters(paramString); + for (var i = 0; i < paramParts.Count; i++) + { + var paramType = SimplifyTypeName(paramParts[i]); + parameters.Add(new ParameterInfo { Name = $"param{i + 1}", Type = paramType }); + } + } + } + + // Check if there's a return type after the parameters + if (paramEnd + 1 < fullSignature.Length && fullSignature[paramEnd + 1] == '~') + { + returnType = SimplifyTypeName(fullSignature[(paramEnd + 2)..]); + } + } + + return new MemberSignature + { + Kind = kind, + Parameters = parameters, + ReturnType = parameters.Count > 0 || fullSignature.Contains("Async") ? returnType : null, + }; + } + + return new MemberSignature { Kind = kind }; +} + +static List SplitParameters(string paramString) +{ + var parameters = new List(); + var current = new StringBuilder(); + var depth = 0; + + foreach (var c in paramString) + { + if (c is '{' or '<') + { + depth++; + } + else if (c is '}' or '>') + { + depth--; + } + else if (c == ',' && depth == 0) + { + parameters.Add(current.ToString()); + _ = current.Clear(); + continue; + } + + _ = current.Append(c); + } + + if (current.Length > 0) + { + parameters.Add(current.ToString()); + } + + return parameters; +} + +static string SimplifyTypeName(string fullTypeName) +{ + // Remove assembly information + var typeName = fullTypeName.Split(',')[0]; + + // Simplify common generic types + typeName = typeName + .Replace("System.Threading.Tasks.Task{", "Task<") + .Replace("System.Collections.Generic.List{", "List<") + .Replace("System.Collections.Generic.Dictionary{", "Dictionary<") + .Replace("System.Nullable{", "Nullable<") + .Replace("System.String", "string") + .Replace("System.Int32", "int") + .Replace("System.Int64", "long") + .Replace("System.Boolean", "bool") + .Replace("System.Byte", "byte") + .Replace("System.Object", "object") + .Replace('{', '<') + .Replace('}', '>'); + + return typeName; +} + +static string NormalizeXmlText(string text) +{ + var lines = text.Split('\n'); + var normalized = new StringBuilder(); + + foreach (var line in lines) + { + var trimmed = line.Trim(); + if (!string.IsNullOrEmpty(trimmed)) + { + _ = normalized.AppendLine(trimmed); + } + } + + return normalized.ToString().TrimEnd(); +} + +var cmdArgs = Environment.GetCommandLineArgs(); +if (cmdArgs.Length > 1 && cmdArgs[1] == "--llms") +{ + var root = FindRepoRoot(); + GenerateLlmsTxt(root); + return; +} + var specUrl = "https://api.thirdweb.com/openapi.json"; var repoRoot = FindRepoRoot(); var outputPath = Path.Combine(repoRoot, "Thirdweb", "Thirdweb.Api", "ThirdwebApi.cs"); @@ -177,3 +443,16 @@ void DedupeEnumOnSchema(JsonSchema schema, string? debugPath) Directory.CreateDirectory(Path.GetDirectoryName(outputPath)!); await File.WriteAllTextAsync(outputPath, code); Console.WriteLine($"Wrote generated client to {outputPath}"); + +internal class MemberSignature +{ + public string Kind { get; set; } = ""; + public List? Parameters { get; set; } + public string? ReturnType { get; set; } +} + +internal class ParameterInfo +{ + public string Name { get; set; } = ""; + public string Type { get; set; } = ""; +} diff --git a/llms.txt b/llms.txt new file mode 100644 index 00000000..11ad2352 --- /dev/null +++ b/llms.txt @@ -0,0 +1,17706 @@ +THIRDWEB .NET SDK - API DOCUMENTATION +===================================== + +Assembly: Thirdweb + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.InitiateAuthenticationAsync(Thirdweb.Api.Body) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body) + +SUMMARY: +Initiate Auth + +REMARKS: +Start any authentication flow in one unified endpoint. This endpoint supports all authentication methods including SMS, email, OAuth, passkey, and SIWE (Sign-In with Ethereum). +**Supported Methods:** +- **SMS** - Send verification code to phone number +- **Email** - Send verification code to email address +- **Passkey** - Generate WebAuthn challenge for biometric authentication +- **SIWE** - Generate Sign-In with Ethereum payload +**Flow:** +1. Choose your authentication method +2. Provide method-specific parameters +3. Receive challenge data to complete authentication +4. Use the /complete endpoint to finish the process +**OAuth:** +The OAuth method uses a dedicated `/auth/social` endpoint instead of this one: +`GET /auth/social?provider=google&redirectUrl=...` +**Custom (JWT, auth-payload) and Guest:** +For custom authentication (JWT, auth-payload) and for guest authentication, you can skip this step and use the `/auth/complete` endpoint directly. +**Authentication:** Requires `x-client-id` header for frontend usage or `x-secret-key` for backend usage. + +RETURNS: +Authentication initiated successfully. Use the returned challenge data to complete authentication. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.InitiateAuthenticationAsync(Thirdweb.Api.Body,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Initiate Auth + +REMARKS: +Start any authentication flow in one unified endpoint. This endpoint supports all authentication methods including SMS, email, OAuth, passkey, and SIWE (Sign-In with Ethereum). +**Supported Methods:** +- **SMS** - Send verification code to phone number +- **Email** - Send verification code to email address +- **Passkey** - Generate WebAuthn challenge for biometric authentication +- **SIWE** - Generate Sign-In with Ethereum payload +**Flow:** +1. Choose your authentication method +2. Provide method-specific parameters +3. Receive challenge data to complete authentication +4. Use the /complete endpoint to finish the process +**OAuth:** +The OAuth method uses a dedicated `/auth/social` endpoint instead of this one: +`GET /auth/social?provider=google&redirectUrl=...` +**Custom (JWT, auth-payload) and Guest:** +For custom authentication (JWT, auth-payload) and for guest authentication, you can skip this step and use the `/auth/complete` endpoint directly. +**Authentication:** Requires `x-client-id` header for frontend usage or `x-secret-key` for backend usage. + +RETURNS: +Authentication initiated successfully. Use the returned challenge data to complete authentication. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CompleteAuthenticationAsync(Thirdweb.Api.Body2) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body2) + +SUMMARY: +Complete Auth + +REMARKS: +Complete the authentication flow and receive your wallet credentials. After initiating authentication, use this endpoint to submit the required verification data. +**Completion Methods:** +- **SMS/Email** - Submit the verification code you received +- **Passkey** - Provide the WebAuthn signature response +- **SIWE** - Submit your signed Ethereum message +- **Guest** - Create an ephemeral guest wallet +- **Custom (JWT, auth-payload)** - Send your JWT token or custom payload +**Response:** +- `isNewUser` - Whether this is a new wallet creation +- `token` - JWT token for authenticated API requests +- `type` - The authentication method used +- `userId` - Unique identifier for the authenticated user +- `walletAddress` - Your new or existing wallet address +**Next step - Verify your token:** +```javascript +// Verify the token and get complete wallet details (server-side) +fetch('/v1/wallets/me', { +headers: { +'Authorization': 'Bearer ' + token, +'x-secret-key': 'your-secret-key' +} +}) +.then(response => response.json()) +.then(data => { +console.log('Wallet verified:', data.result.address); +console.log('Auth profiles:', data.result.profiles); +}); +``` +**Authentication:** Requires `x-client-id` header for frontend usage or `x-secret-key` for backend usage. + +RETURNS: +Authentication completed successfully. You now have wallet access. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CompleteAuthenticationAsync(Thirdweb.Api.Body2,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body2) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Complete Auth + +REMARKS: +Complete the authentication flow and receive your wallet credentials. After initiating authentication, use this endpoint to submit the required verification data. +**Completion Methods:** +- **SMS/Email** - Submit the verification code you received +- **Passkey** - Provide the WebAuthn signature response +- **SIWE** - Submit your signed Ethereum message +- **Guest** - Create an ephemeral guest wallet +- **Custom (JWT, auth-payload)** - Send your JWT token or custom payload +**Response:** +- `isNewUser` - Whether this is a new wallet creation +- `token` - JWT token for authenticated API requests +- `type` - The authentication method used +- `userId` - Unique identifier for the authenticated user +- `walletAddress` - Your new or existing wallet address +**Next step - Verify your token:** +```javascript +// Verify the token and get complete wallet details (server-side) +fetch('/v1/wallets/me', { +headers: { +'Authorization': 'Bearer ' + token, +'x-secret-key': 'your-secret-key' +} +}) +.then(response => response.json()) +.then(data => { +console.log('Wallet verified:', data.result.address); +console.log('Auth profiles:', data.result.profiles); +}); +``` +**Authentication:** Requires `x-client-id` header for frontend usage or `x-secret-key` for backend usage. + +RETURNS: +Authentication completed successfully. You now have wallet access. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.LinkAuthenticationAsync(Thirdweb.Api.Body3) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body3) + +SUMMARY: +Link Auth + +REMARKS: +Link an additional authentication method or external wallet to the currently authenticated user. Provide the authentication token from another completed login (for example, a SIWE wallet or OAuth account) and this endpoint will associate it with the user's existing wallet. +**Usage:** +1. Complete an authentication flow using `/auth/complete` to obtain the new authentication token +2. Call this endpoint with the token you want to link +3. Receive the full list of linked authentication profiles for the wallet +**Authentication:** Requires both client authentication (`x-client-id` or `x-secret-key`) and a wallet access token via `Authorization: Bearer `. + +RETURNS: +Authentication method linked successfully. The response contains the updated list of linked authentication profiles. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.LinkAuthenticationAsync(Thirdweb.Api.Body3,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body3) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Link Auth + +REMARKS: +Link an additional authentication method or external wallet to the currently authenticated user. Provide the authentication token from another completed login (for example, a SIWE wallet or OAuth account) and this endpoint will associate it with the user's existing wallet. +**Usage:** +1. Complete an authentication flow using `/auth/complete` to obtain the new authentication token +2. Call this endpoint with the token you want to link +3. Receive the full list of linked authentication profiles for the wallet +**Authentication:** Requires both client authentication (`x-client-id` or `x-secret-key`) and a wallet access token via `Authorization: Bearer `. + +RETURNS: +Authentication method linked successfully. The response contains the updated list of linked authentication profiles. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.UnlinkAuthenticationAsync(Thirdweb.Api.Body4) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body4) + +SUMMARY: +Unlink Auth + +REMARKS: +Disconnect an authentication method or external wallet from the currently authenticated user. Provide the identifiers for the provider you want to remove (for example, an email address or wallet address) and this endpoint will detach it from the user's account. +**Usage:** +1. Choose the provider type you want to disconnect (email, phone, siwe, oauth, etc.) +2. Supply the provider-specific identifiers in the request body +3. Receive the updated list of linked authentication profiles +**Authentication:** Requires both client authentication (`x-client-id` or `x-secret-key`) and a wallet access token via `Authorization: Bearer `. + +RETURNS: +Authentication method unlinked successfully. The response contains the updated list of linked authentication profiles. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.UnlinkAuthenticationAsync(Thirdweb.Api.Body4,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body4) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Unlink Auth + +REMARKS: +Disconnect an authentication method or external wallet from the currently authenticated user. Provide the identifiers for the provider you want to remove (for example, an email address or wallet address) and this endpoint will detach it from the user's account. +**Usage:** +1. Choose the provider type you want to disconnect (email, phone, siwe, oauth, etc.) +2. Supply the provider-specific identifiers in the request body +3. Receive the updated list of linked authentication profiles +**Authentication:** Requires both client authentication (`x-client-id` or `x-secret-key`) and a wallet access token via `Authorization: Bearer `. + +RETURNS: +Authentication method unlinked successfully. The response contains the updated list of linked authentication profiles. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SocialAuthenticationAsync(Thirdweb.Api.Provider,System.Uri,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - provider (Thirdweb.Api.Provider) + The OAuth provider to use + - redirectUrl (System.Uri) + URL to redirect the user to after OAuth completion + - clientId (string) + Client ID (alternative to x-client-id header for standard OAuth flows) + +SUMMARY: +Social Auth + +REMARKS: +Complete OAuth authentication with social providers in a single step. Unlike other auth methods that require separate initiate/complete calls, OAuth is handled entirely through redirects. +**OAuth Flow (Self-Contained):** +1. Redirect your user to this endpoint with provider and redirectUrl +2. User completes OAuth flow with the provider +3. User is redirected back to your redirectUrl with wallet credentials +**Why OAuth is different:** OAuth providers handle the challenge/response flow externally, so no separate `/complete` step is needed. +**Example:** +Redirect user to: `GET /v1/auth/social?provider=google&redirectUrl=https://myapp.com/auth/callback` +**Callback Handling:** +After OAuth completion, user arrives at your redirectUrl with an `authResult` query parameter: +``` +https://myapp.com/auth/callback?authResult=%7B%22storedToken%22%3A%7B%22authDetails%22%3A%7B...%7D%2C%22cookieString%22%3A%22eyJ...%22%7D%7D +``` +**Extract JWT token in your callback:** +```javascript +// Parse the authResult from URL +const urlParams = new URLSearchParams(window.location.search); +const authResultString = urlParams.get('authResult'); +const authResult = JSON.parse(authResultString!); +// Extract the JWT token +const token = authResult.storedToken.cookieString; +``` +**Verify and use the JWT token:** +```javascript +// Use the JWT token for authenticated requests +fetch('/v1/wallets/me', { +headers: { +'Authorization': 'Bearer ' + token, +'x-secret-key': 'your-secret-key' +} +}) +.then(response => response.json()) +.then(data => { +console.log('Wallet verified:', data.result.address); +console.log('Auth profiles:', data.result.profiles); +}); +``` +**Authentication Options:** +Choose one of two ways to provide your client credentials: +**Option 1: Query Parameter (Recommended for OAuth flows)** +``` +GET /v1/auth/social?provider=google&redirectUrl=https://myapp.com/callback&clientId=your_client_id +``` +**Option 2: Header (Alternative)** +``` +GET /v1/auth/social?provider=google&redirectUrl=https://myapp.com/callback +Headers: x-client-id: your_client_id +``` + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SocialAuthenticationAsync(Thirdweb.Api.Provider,System.Uri,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Provider) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - provider (System.Uri) + The OAuth provider to use + - redirectUrl (string) + URL to redirect the user to after OAuth completion + - clientId (System.Threading.CancellationToken) + Client ID (alternative to x-client-id header for standard OAuth flows) + +SUMMARY: +Social Auth + +REMARKS: +Complete OAuth authentication with social providers in a single step. Unlike other auth methods that require separate initiate/complete calls, OAuth is handled entirely through redirects. +**OAuth Flow (Self-Contained):** +1. Redirect your user to this endpoint with provider and redirectUrl +2. User completes OAuth flow with the provider +3. User is redirected back to your redirectUrl with wallet credentials +**Why OAuth is different:** OAuth providers handle the challenge/response flow externally, so no separate `/complete` step is needed. +**Example:** +Redirect user to: `GET /v1/auth/social?provider=google&redirectUrl=https://myapp.com/auth/callback` +**Callback Handling:** +After OAuth completion, user arrives at your redirectUrl with an `authResult` query parameter: +``` +https://myapp.com/auth/callback?authResult=%7B%22storedToken%22%3A%7B%22authDetails%22%3A%7B...%7D%2C%22cookieString%22%3A%22eyJ...%22%7D%7D +``` +**Extract JWT token in your callback:** +```javascript +// Parse the authResult from URL +const urlParams = new URLSearchParams(window.location.search); +const authResultString = urlParams.get('authResult'); +const authResult = JSON.parse(authResultString!); +// Extract the JWT token +const token = authResult.storedToken.cookieString; +``` +**Verify and use the JWT token:** +```javascript +// Use the JWT token for authenticated requests +fetch('/v1/wallets/me', { +headers: { +'Authorization': 'Bearer ' + token, +'x-secret-key': 'your-secret-key' +} +}) +.then(response => response.json()) +.then(data => { +console.log('Wallet verified:', data.result.address); +console.log('Auth profiles:', data.result.profiles); +}); +``` +**Authentication Options:** +Choose one of two ways to provide your client credentials: +**Option 1: Query Parameter (Recommended for OAuth flows)** +``` +GET /v1/auth/social?provider=google&redirectUrl=https://myapp.com/callback&clientId=your_client_id +``` +**Option 2: Header (Alternative)** +``` +GET /v1/auth/social?provider=google&redirectUrl=https://myapp.com/callback +Headers: x-client-id: your_client_id +``` + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetMyWalletAsync +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +SUMMARY: +Get My Wallet + +REMARKS: +Retrieve the authenticated user's wallet information including wallet addresses and linked authentication wallets. This endpoint provides comprehensive user data for the currently authenticated session. +**Returns:** +- userId - Unique identifier for this wallet in thirdweb auth +- Primary wallet address +- Smart wallet address (if available) +- Wallet creation timestamp +- Public key in hexadecimal format (if available) +- All linked authentication profiles (email, phone, OAuth providers) +**Authentication:** Requires `Authorization: Bearer ` header with a valid user authentication token. + +RETURNS: +Wallet retrieved successfully. Returns comprehensive user information including wallet addresses, public key, and linked wallets. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetMyWalletAsync(System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (System.Threading.CancellationToken) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + +SUMMARY: +Get My Wallet + +REMARKS: +Retrieve the authenticated user's wallet information including wallet addresses and linked authentication wallets. This endpoint provides comprehensive user data for the currently authenticated session. +**Returns:** +- userId - Unique identifier for this wallet in thirdweb auth +- Primary wallet address +- Smart wallet address (if available) +- Wallet creation timestamp +- Public key in hexadecimal format (if available) +- All linked authentication profiles (email, phone, OAuth providers) +**Authentication:** Requires `Authorization: Bearer ` header with a valid user authentication token. + +RETURNS: +Wallet retrieved successfully. Returns comprehensive user information including wallet addresses, public key, and linked wallets. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListUserWalletsAsync(System.Nullable{System.Double},System.Nullable{System.Double},System.String,System.String,System.String,System.String,System.String,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - userId (Nullable) + Filter results by the unique user identifier returned by auth flows. + - param2 (Nullable) + - param3 (string) + - param4 (string) + - param5 (string) + - param6 (string) + - param7 (string) + - param8 (string) + +SUMMARY: +List User Wallets + +REMARKS: +Get all user wallet details with filtering and pagination for your project. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Returns a list of user wallet addresses, smart wallet addresses, and auth details. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListUserWalletsAsync(System.Nullable{System.Double},System.Nullable{System.Double},System.String,System.String,System.String,System.String,System.String,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Nullable) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - userId (Nullable) + Filter results by the unique user identifier returned by auth flows. + - param3 (string) + - param4 (string) + - param5 (string) + - param6 (string) + - param7 (string) + - param8 (string) + - param9 (System.Threading.CancellationToken) + +SUMMARY: +List User Wallets + +REMARKS: +Get all user wallet details with filtering and pagination for your project. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Returns a list of user wallet addresses, smart wallet addresses, and auth details. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreateUserWalletAsync(Thirdweb.Api.Body5) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body5) + +SUMMARY: +Create User Wallet + +REMARKS: +Create a user wallet with a wallet based on their authentication strategy. This endpoint creates a wallet in advance that can be claimed later when the user authenticates. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Successfully created a user wallet with wallet. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreateUserWalletAsync(Thirdweb.Api.Body5,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body5) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Create User Wallet + +REMARKS: +Create a user wallet with a wallet based on their authentication strategy. This endpoint creates a wallet in advance that can be claimed later when the user authenticates. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Successfully created a user wallet with wallet. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListServerWalletsAsync(System.Nullable{System.Double},System.Nullable{System.Double}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Nullable) + - param2 (Nullable) + +SUMMARY: +List Server Wallets + +REMARKS: +Get all server wallet details with pagination for your project. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Returns a list of server wallet addresses, smart wallet addresses, and auth details. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListServerWalletsAsync(System.Nullable{System.Double},System.Nullable{System.Double},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Nullable) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (Nullable) + - param3 (System.Threading.CancellationToken) + +SUMMARY: +List Server Wallets + +REMARKS: +Get all server wallet details with pagination for your project. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Returns a list of server wallet addresses, smart wallet addresses, and auth details. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreateServerWalletAsync(Thirdweb.Api.Body6) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body6) + +SUMMARY: +Create Server Wallet + +REMARKS: +Creates a server wallet from a unique identifier. If the wallet already exists, it will return the existing wallet. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Server wallet created or connected successfully. Returns wallet addresses for subsequent operations. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreateServerWalletAsync(Thirdweb.Api.Body6,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body6) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Create Server Wallet + +REMARKS: +Creates a server wallet from a unique identifier. If the wallet already exists, it will return the existing wallet. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Server wallet created or connected successfully. Returns wallet addresses for subsequent operations. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetWalletBalanceAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - address (string) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (System.Collections.Generic.IEnumerable) + Chain ID(s) to request balance data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137 + - tokenAddress (string) + The token contract address. Omit for native token (ETH, MATIC, etc.). + +SUMMARY: +Get Balance + +REMARKS: +Get native or ERC20 token balance for a wallet address. Can retrieve live balances for any ERC20 token on a signle chain, or native token balances across multiple chains. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet native balances retrieved successfully. Returns detailed native token balance information for each chain including token metadata and formatted values. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetWalletBalanceAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - address (System.Collections.Generic.IEnumerable) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (string) + Chain ID(s) to request balance data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137 + - tokenAddress (System.Threading.CancellationToken) + The token contract address. Omit for native token (ETH, MATIC, etc.). + +SUMMARY: +Get Balance + +REMARKS: +Get native or ERC20 token balance for a wallet address. Can retrieve live balances for any ERC20 token on a signle chain, or native token balances across multiple chains. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet native balances retrieved successfully. Returns detailed native token balance information for each chain including token metadata and formatted values. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetWalletTransactionsAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{Thirdweb.Api.SortOrder}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - address (string) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (System.Collections.Generic.IEnumerable) + Chain ID(s) to request transaction data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137 + - filterBlockTimestampGte (Nullable) + Filter by block timestamp (Unix timestamp) greater than or equal to this value + - filterBlockTimestampLte (Nullable) + Filter by block timestamp (Unix timestamp) less than or equal to this value + - filterBlockNumberGte (Nullable) + Filter by block number greater than or equal to this value + - filterBlockNumberLte (Nullable) + Filter by block number less than or equal to this value + - filterValueGt (string) + Filter by transaction value (in wei) greater than this value + - filterFunctionSelector (string) + Filter by function selector (4-byte method ID), e.g., '0xa9059cbb' for ERC-20 transfer + - page (Nullable) + Current page number + - limit (Nullable) + Number of items per page + - sortOrder (Nullable) + Sort order: 'asc' for ascending, 'desc' for descending + +SUMMARY: +Get Transactions + +REMARKS: +Retrieves transactions for a specific wallet address across one or more blockchain networks. This endpoint provides comprehensive transaction data including both incoming and outgoing transactions, with block information, gas details, transaction status, and function calls. Results can be filtered, paginated, and sorted to meet specific requirements. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet transactions retrieved successfully. Returns transaction data with metadata including pagination information and chain details. Includes decoded function calls when ABI is available. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetWalletTransactionsAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{Thirdweb.Api.SortOrder},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - address (System.Collections.Generic.IEnumerable) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (Nullable) + Chain ID(s) to request transaction data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137 + - filterBlockTimestampGte (Nullable) + Filter by block timestamp (Unix timestamp) greater than or equal to this value + - filterBlockTimestampLte (Nullable) + Filter by block timestamp (Unix timestamp) less than or equal to this value + - filterBlockNumberGte (Nullable) + Filter by block number greater than or equal to this value + - filterBlockNumberLte (string) + Filter by block number less than or equal to this value + - filterValueGt (string) + Filter by transaction value (in wei) greater than this value + - filterFunctionSelector (Nullable) + Filter by function selector (4-byte method ID), e.g., '0xa9059cbb' for ERC-20 transfer + - page (Nullable) + Current page number + - limit (Nullable) + Number of items per page + - sortOrder (System.Threading.CancellationToken) + Sort order: 'asc' for ascending, 'desc' for descending + +SUMMARY: +Get Transactions + +REMARKS: +Retrieves transactions for a specific wallet address across one or more blockchain networks. This endpoint provides comprehensive transaction data including both incoming and outgoing transactions, with block information, gas details, transaction status, and function calls. Results can be filtered, paginated, and sorted to meet specific requirements. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet transactions retrieved successfully. Returns transaction data with metadata including pagination information and chain details. Includes decoded function calls when ABI is available. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetWalletTokensAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Thirdweb.Api.Metadata},System.Nullable{Thirdweb.Api.ResolveMetadataLinks},System.Nullable{Thirdweb.Api.IncludeSpam},System.Nullable{Thirdweb.Api.IncludeNative},System.Nullable{Thirdweb.Api.SortBy},System.Nullable{Thirdweb.Api.SortOrder2},System.Nullable{Thirdweb.Api.IncludeWithoutPrice}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - address (string) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (System.Collections.Generic.IEnumerable) + Chain ID(s) to request token data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137 + - tokenAddresses (System.Collections.Generic.IEnumerable) + Token addresses to filter by. If provided, only tokens with these addresses will be returned. + - limit (Nullable) + The number of tokens to return per chain (default: 20, max: 500). + - page (Nullable) + The page number for pagination (default: 1, max: 20). + - metadata (Nullable) + Whether to include token metadata (default: true). + - resolveMetadataLinks (Nullable) + Whether to resolve metadata links to fetch additional token information (default: true). + - includeSpam (Nullable) + Whether to include tokens marked as spam (default: false). + - includeNative (Nullable) + Whether to include native tokens (e.g., ETH, MATIC) in the results (default: true). + - sortBy (Nullable) + Field to sort tokens by: 'balance' for token balance, 'token_address' for token address, 'token_price' for token price, 'usd_value' for USD value (default: usd_value). + - sortOrder (Nullable) + Sort order: 'asc' for ascending, 'desc' for descending (default: desc). + - includeWithoutPrice (Nullable) + Whether to include tokens without price data (default: true). + +SUMMARY: +Get Tokens + +REMARKS: +Retrieves token balances for a specific wallet address across one or more blockchain networks. This endpoint provides comprehensive token data including ERC-20 tokens with their balances, metadata, and price information. Results can be filtered by chain, sorted by balance or USD value, and customized to include/exclude spam tokens, native tokens, and tokens without price data. Supports pagination and metadata resolution options. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet tokens retrieved successfully. Returns token data with metadata including pagination information and chain details. Includes token balances, metadata, and price information when available. Results are sorted by the specified criteria (default: USD value descending) and filtered according to the provided parameters. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetWalletTokensAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Thirdweb.Api.Metadata},System.Nullable{Thirdweb.Api.ResolveMetadataLinks},System.Nullable{Thirdweb.Api.IncludeSpam},System.Nullable{Thirdweb.Api.IncludeNative},System.Nullable{Thirdweb.Api.SortBy},System.Nullable{Thirdweb.Api.SortOrder2},System.Nullable{Thirdweb.Api.IncludeWithoutPrice},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - address (System.Collections.Generic.IEnumerable) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (System.Collections.Generic.IEnumerable) + Chain ID(s) to request token data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137 + - tokenAddresses (Nullable) + Token addresses to filter by. If provided, only tokens with these addresses will be returned. + - limit (Nullable) + The number of tokens to return per chain (default: 20, max: 500). + - page (Nullable) + The page number for pagination (default: 1, max: 20). + - metadata (Nullable) + Whether to include token metadata (default: true). + - resolveMetadataLinks (Nullable) + Whether to resolve metadata links to fetch additional token information (default: true). + - includeSpam (Nullable) + Whether to include tokens marked as spam (default: false). + - includeNative (Nullable) + Whether to include native tokens (e.g., ETH, MATIC) in the results (default: true). + - sortBy (Nullable) + Field to sort tokens by: 'balance' for token balance, 'token_address' for token address, 'token_price' for token price, 'usd_value' for USD value (default: usd_value). + - sortOrder (Nullable) + Sort order: 'asc' for ascending, 'desc' for descending (default: desc). + - includeWithoutPrice (System.Threading.CancellationToken) + Whether to include tokens without price data (default: true). + +SUMMARY: +Get Tokens + +REMARKS: +Retrieves token balances for a specific wallet address across one or more blockchain networks. This endpoint provides comprehensive token data including ERC-20 tokens with their balances, metadata, and price information. Results can be filtered by chain, sorted by balance or USD value, and customized to include/exclude spam tokens, native tokens, and tokens without price data. Supports pagination and metadata resolution options. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet tokens retrieved successfully. Returns token data with metadata including pagination information and chain details. Includes token balances, metadata, and price information when available. Results are sorted by the specified criteria (default: USD value descending) and filtered according to the provided parameters. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetWalletNFTsAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - address (string) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (System.Collections.Generic.IEnumerable) + Chain ID(s) to request NFT data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137 + - contractAddresses (System.Collections.Generic.IEnumerable) + NFT contract addresses to filter by. If provided, only NFTs with these addresses will be returned. + - limit (Nullable) + The number of NFTs to return per chain (default: 20, max: 500). + - page (Nullable) + The page number for pagination (default: 1, max: 20). + +SUMMARY: +Get NFTs + +REMARKS: +Retrieves NFTs for a specific wallet address across one or more blockchain networks. This endpoint provides comprehensive NFT data including metadata, attributes, and collection information. Results can be filtered by chain and paginated to meet specific requirements. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet NFTs retrieved successfully. Returns NFT data with metadata including pagination information and chain details. Includes NFT metadata, attributes, and collection information when available. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetWalletNFTsAsync(System.String,System.Collections.Generic.IEnumerable{System.Int32},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - address (System.Collections.Generic.IEnumerable) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (System.Collections.Generic.IEnumerable) + Chain ID(s) to request NFT data for. You can specify multiple chain IDs by repeating the parameter, up to a maximum of 50. Example: ?chainId=1&chainId=137 + - contractAddresses (Nullable) + NFT contract addresses to filter by. If provided, only NFTs with these addresses will be returned. + - limit (Nullable) + The number of NFTs to return per chain (default: 20, max: 500). + - page (System.Threading.CancellationToken) + The page number for pagination (default: 1, max: 20). + +SUMMARY: +Get NFTs + +REMARKS: +Retrieves NFTs for a specific wallet address across one or more blockchain networks. This endpoint provides comprehensive NFT data including metadata, attributes, and collection information. Results can be filtered by chain and paginated to meet specific requirements. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet NFTs retrieved successfully. Returns NFT data with metadata including pagination information and chain details. Includes NFT metadata, attributes, and collection information when available. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SignMessageAsync(Thirdweb.Api.Body7) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body7) + +SUMMARY: +Sign Message + +REMARKS: +Signs an arbitrary message using the specified wallet. This endpoint supports both text and hexadecimal message formats. The signing is performed using thirdweb Engine with smart wallet support for gasless transactions. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Message signed successfully. Returns the cryptographic signature that can be used for verification. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SignMessageAsync(Thirdweb.Api.Body7,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body7) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Sign Message + +REMARKS: +Signs an arbitrary message using the specified wallet. This endpoint supports both text and hexadecimal message formats. The signing is performed using thirdweb Engine with smart wallet support for gasless transactions. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Message signed successfully. Returns the cryptographic signature that can be used for verification. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SignTypedDataAsync(Thirdweb.Api.Body8) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body8) + +SUMMARY: +Sign Typed Data + +REMARKS: +Signs structured data according to the EIP-712 standard using the specified wallet. This is commonly used for secure message signing in DeFi protocols, NFT marketplaces, and other dApps that require structured data verification. The typed data includes domain separation and type definitions for enhanced security. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Typed data signed successfully. Returns the EIP-712 compliant signature that can be used for on-chain verification. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SignTypedDataAsync(Thirdweb.Api.Body8,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body8) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Sign Typed Data + +REMARKS: +Signs structured data according to the EIP-712 standard using the specified wallet. This is commonly used for secure message signing in DeFi protocols, NFT marketplaces, and other dApps that require structured data verification. The typed data includes domain separation and type definitions for enhanced security. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Typed data signed successfully. Returns the EIP-712 compliant signature that can be used for on-chain verification. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SendTokensAsync(Thirdweb.Api.Body9) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body9) + +SUMMARY: +Send Tokens + +REMARKS: +Send tokens to multiple recipients in a single transaction batch. Supports native tokens (ETH, MATIC, etc.), ERC20 tokens, ERC721 NFTs, and ERC1155 tokens. The token type is automatically determined based on the provided parameters and ERC165 interface detection: +- **Native Token**: No `tokenAddress` provided +- **ERC20**: `tokenAddress` provided, no `tokenId` +- **ERC721/ERC1155**: `tokenAddress` and `tokenId` provided. Auto detects contract type: +- ERC721: quantity must be '1' +- ERC1155: any quantity allowed (including '1') +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Tokens sent successfully. Returns transaction IDs for tracking and monitoring. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SendTokensAsync(Thirdweb.Api.Body9,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body9) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Send Tokens + +REMARKS: +Send tokens to multiple recipients in a single transaction batch. Supports native tokens (ETH, MATIC, etc.), ERC20 tokens, ERC721 NFTs, and ERC1155 tokens. The token type is automatically determined based on the provided parameters and ERC165 interface detection: +- **Native Token**: No `tokenAddress` provided +- **ERC20**: `tokenAddress` provided, no `tokenId` +- **ERC721/ERC1155**: `tokenAddress` and `tokenId` provided. Auto detects contract type: +- ERC721: quantity must be '1' +- ERC1155: any quantity allowed (including '1') +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Tokens sent successfully. Returns transaction IDs for tracking and monitoring. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListContractsAsync(System.Nullable{System.Int32},System.Nullable{System.Int32}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - limit (Nullable) + The number of contracts to return (default: 20, max: 100). + - page (Nullable) + The page number for pagination (default: 1). + +SUMMARY: +List Contracts + +REMARKS: +Retrieves a list of all smart contracts imported by the authenticated client on the thirdweb dashboard. This endpoint provides access to contracts that have been added to your dashboard for management and interaction. Results include contract metadata, deployment information, and import timestamps. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. +**Note**: For detailed contract metadata including compilation information, ABI, and source code, use the dedicated metadata endpoint: `GET /v1/contracts/{chainId}/{address}/metadata`. + +RETURNS: +Successfully retrieved list of contracts + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListContractsAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Nullable) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - limit (Nullable) + The number of contracts to return (default: 20, max: 100). + - page (System.Threading.CancellationToken) + The page number for pagination (default: 1). + +SUMMARY: +List Contracts + +REMARKS: +Retrieves a list of all smart contracts imported by the authenticated client on the thirdweb dashboard. This endpoint provides access to contracts that have been added to your dashboard for management and interaction. Results include contract metadata, deployment information, and import timestamps. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. +**Note**: For detailed contract metadata including compilation information, ABI, and source code, use the dedicated metadata endpoint: `GET /v1/contracts/{chainId}/{address}/metadata`. + +RETURNS: +Successfully retrieved list of contracts + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.DeployContractAsync(Thirdweb.Api.Body10) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body10) + +SUMMARY: +Deploy Contract + +REMARKS: +Deploy a new smart contract to a blockchain network using raw bytecode. This endpoint allows you to deploy contracts by providing the contract bytecode, ABI, constructor parameters, and optional salt for deterministic deployment. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Contract deployed successfully + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.DeployContractAsync(Thirdweb.Api.Body10,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body10) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Deploy Contract + +REMARKS: +Deploy a new smart contract to a blockchain network using raw bytecode. This endpoint allows you to deploy contracts by providing the contract bytecode, ABI, constructor parameters, and optional salt for deterministic deployment. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. + +RETURNS: +Contract deployed successfully + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ReadContractAsync(Thirdweb.Api.Body11) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body11) + +SUMMARY: +Read Contract + +REMARKS: +Executes multiple read-only contract method calls in a single batch request. This endpoint allows efficient batch reading from multiple contracts on the same chain, significantly reducing the number of HTTP requests needed. Each call specifies the contract address, method signature, and optional parameters. Results are returned in the same order as the input calls, with individual success/failure status for each operation. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Contract read operations completed successfully. Returns an array of results corresponding to each input call, including both successful and failed operations. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ReadContractAsync(Thirdweb.Api.Body11,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body11) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Read Contract + +REMARKS: +Executes multiple read-only contract method calls in a single batch request. This endpoint allows efficient batch reading from multiple contracts on the same chain, significantly reducing the number of HTTP requests needed. Each call specifies the contract address, method signature, and optional parameters. Results are returned in the same order as the input calls, with individual success/failure status for each operation. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Contract read operations completed successfully. Returns an array of results corresponding to each input call, including both successful and failed operations. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.WriteContractAsync(Thirdweb.Api.Body12) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body12) + +SUMMARY: +Write Contract + +REMARKS: +Executes write operations (transactions) on smart contracts. This is a convenience endpoint that simplifies contract interaction by accepting method signatures and parameters directly, without requiring manual transaction encoding. All calls are executed against the same contract address and chain, making it ideal for batch operations. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Contract write operations submitted successfully. Returns transaction IDs for tracking and monitoring. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.WriteContractAsync(Thirdweb.Api.Body12,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body12) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Write Contract + +REMARKS: +Executes write operations (transactions) on smart contracts. This is a convenience endpoint that simplifies contract interaction by accepting method signatures and parameters directly, without requiring manual transaction encoding. All calls are executed against the same contract address and chain, making it ideal for batch operations. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Contract write operations submitted successfully. Returns transaction IDs for tracking and monitoring. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetContractTransactionsAsync(System.Int32,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{Thirdweb.Api.SortOrder3}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (int) + The blockchain network identifier where the contract is deployed. + - address (string) + The smart contract address or ENS name. + - filterFromAddress (string) + Filter by transaction sender address + - filterToAddress (string) + Filter by transaction recipient address + - filterBlockTimestampGte (Nullable) + Filter by block timestamp (Unix timestamp) greater than or equal to this value + - filterBlockTimestampLte (Nullable) + Filter by block timestamp (Unix timestamp) less than or equal to this value + - filterBlockNumberGte (Nullable) + Filter by block number greater than or equal to this value + - filterBlockNumberLte (Nullable) + Filter by block number less than or equal to this value + - filterValueGt (string) + Filter by transaction value (in wei) greater than this value + - filterFunctionSelector (string) + Filter by function selector (4-byte method ID), e.g., '0xa9059cbb' for ERC-20 transfer + - page (Nullable) + Current page number + - limit (Nullable) + Number of items per page + - sortOrder (Nullable) + Sort order: 'asc' for ascending, 'desc' for descending + +SUMMARY: +Get Transactions + +REMARKS: +Retrieves transactions for a specific smart contract address on a specific blockchain network. This endpoint provides comprehensive transaction data including block information, gas details, transaction status, and function calls. Results can be filtered, paginated, and sorted to meet specific requirements. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Contract transactions retrieved successfully. Returns transaction data with metadata including pagination information. Includes decoded function calls when ABI is available. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetContractTransactionsAsync(System.Int32,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{Thirdweb.Api.SortOrder3},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (int) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - chainId (string) + The blockchain network identifier where the contract is deployed. + - address (string) + The smart contract address or ENS name. + - filterFromAddress (string) + Filter by transaction sender address + - filterToAddress (Nullable) + Filter by transaction recipient address + - filterBlockTimestampGte (Nullable) + Filter by block timestamp (Unix timestamp) greater than or equal to this value + - filterBlockTimestampLte (Nullable) + Filter by block timestamp (Unix timestamp) less than or equal to this value + - filterBlockNumberGte (Nullable) + Filter by block number greater than or equal to this value + - filterBlockNumberLte (string) + Filter by block number less than or equal to this value + - filterValueGt (string) + Filter by transaction value (in wei) greater than this value + - filterFunctionSelector (Nullable) + Filter by function selector (4-byte method ID), e.g., '0xa9059cbb' for ERC-20 transfer + - page (Nullable) + Current page number + - limit (Nullable) + Number of items per page + - sortOrder (System.Threading.CancellationToken) + Sort order: 'asc' for ascending, 'desc' for descending + +SUMMARY: +Get Transactions + +REMARKS: +Retrieves transactions for a specific smart contract address on a specific blockchain network. This endpoint provides comprehensive transaction data including block information, gas details, transaction status, and function calls. Results can be filtered, paginated, and sorted to meet specific requirements. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Contract transactions retrieved successfully. Returns transaction data with metadata including pagination information. Includes decoded function calls when ABI is available. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetContractEventsAsync(System.Int32,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{Thirdweb.Api.SortOrder4}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (int) + The blockchain network identifier where the contract is deployed. + - address (string) + The smart contract address or ENS name. + - signature (string) + Filter by event signature hash, e.g., '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef' for Transfer event + - filterTopic0 (string) + Filter by event topic 0 (event signature hash) + - filterTopic1 (string) + Filter by event topic 1 + - filterTopic2 (string) + Filter by event topic 2 + - filterTopic3 (string) + Filter by event topic 3 + - filterBlockTimestampGte (Nullable) + Filter by block timestamp (Unix timestamp) greater than or equal to this value + - filterBlockTimestampLte (Nullable) + Filter by block timestamp (Unix timestamp) less than or equal to this value + - filterBlockNumberGte (Nullable) + Filter by block number greater than or equal to this value + - filterBlockNumberLte (Nullable) + Filter by block number less than or equal to this value + - page (Nullable) + Current page number + - limit (Nullable) + Number of items per page + - sortOrder (Nullable) + Sort order: 'asc' for ascending, 'desc' for descending + +SUMMARY: +Get Events + +REMARKS: +Retrieves events emitted by a specific smart contract address on a specific blockchain network. This endpoint provides comprehensive event data including block information, transaction details, event topics, and optional ABI decoding. Results can be filtered, paginated, and sorted to meet specific requirements. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Contract events retrieved successfully. Returns event data with metadata including pagination information. Includes decoded event parameters when ABI is available. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetContractEventsAsync(System.Int32,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{Thirdweb.Api.SortOrder4},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (int) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - chainId (string) + The blockchain network identifier where the contract is deployed. + - address (string) + The smart contract address or ENS name. + - signature (string) + Filter by event signature hash, e.g., '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef' for Transfer event + - filterTopic0 (string) + Filter by event topic 0 (event signature hash) + - filterTopic1 (string) + Filter by event topic 1 + - filterTopic2 (string) + Filter by event topic 2 + - filterTopic3 (Nullable) + Filter by event topic 3 + - filterBlockTimestampGte (Nullable) + Filter by block timestamp (Unix timestamp) greater than or equal to this value + - filterBlockTimestampLte (Nullable) + Filter by block timestamp (Unix timestamp) less than or equal to this value + - filterBlockNumberGte (Nullable) + Filter by block number greater than or equal to this value + - filterBlockNumberLte (Nullable) + Filter by block number less than or equal to this value + - page (Nullable) + Current page number + - limit (Nullable) + Number of items per page + - sortOrder (System.Threading.CancellationToken) + Sort order: 'asc' for ascending, 'desc' for descending + +SUMMARY: +Get Events + +REMARKS: +Retrieves events emitted by a specific smart contract address on a specific blockchain network. This endpoint provides comprehensive event data including block information, transaction details, event topics, and optional ABI decoding. Results can be filtered, paginated, and sorted to meet specific requirements. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Contract events retrieved successfully. Returns event data with metadata including pagination information. Includes decoded event parameters when ABI is available. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetContractMetadataAsync(System.Int32,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (int) + The blockchain network identifier where the contract is deployed. + - address (string) + The smart contract address or ENS name. + +SUMMARY: +Get Metadata + +REMARKS: +Retrieves detailed metadata for a specific smart contract from the thirdweb contract metadata service. This includes compilation information, ABI, documentation, and other contract-related metadata. Note: Source code is excluded from the response to keep it lightweight and suitable for programmatic access. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. +**Metadata Source**: The metadata is fetched from the thirdweb contract metadata service and includes detailed Solidity compilation information, contract ABI, and developer documentation. + +RETURNS: +Successfully retrieved contract metadata + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetContractMetadataAsync(System.Int32,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (int) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - chainId (string) + The blockchain network identifier where the contract is deployed. + - address (System.Threading.CancellationToken) + The smart contract address or ENS name. + +SUMMARY: +Get Metadata + +REMARKS: +Retrieves detailed metadata for a specific smart contract from the thirdweb contract metadata service. This includes compilation information, ABI, documentation, and other contract-related metadata. Note: Source code is excluded from the response to keep it lightweight and suitable for programmatic access. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. +**Metadata Source**: The metadata is fetched from the thirdweb contract metadata service and includes detailed Solidity compilation information, contract ABI, and developer documentation. + +RETURNS: +Successfully retrieved contract metadata + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetContractSignaturesAsync(System.Int32,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (int) + The blockchain network identifier where the contract is deployed. + - address (string) + The smart contract address or ENS name. + +SUMMARY: +Get Signatures + +REMARKS: +Retrieves human-readable ABI signatures for a specific smart contract. This endpoint fetches the contract metadata from the thirdweb service, extracts the ABI, and converts it into an array of human-readable function and event signatures that can be used directly with contract interaction methods. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. +**Usage**: The returned signatures can be used directly in contract read/write operations or event filtering. Each signature follows the standard Solidity format and includes function parameters, return types, state mutability, and event indexing information. + +RETURNS: +Successfully retrieved contract signatures + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetContractSignaturesAsync(System.Int32,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (int) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - chainId (string) + The blockchain network identifier where the contract is deployed. + - address (System.Threading.CancellationToken) + The smart contract address or ENS name. + +SUMMARY: +Get Signatures + +REMARKS: +Retrieves human-readable ABI signatures for a specific smart contract. This endpoint fetches the contract metadata from the thirdweb service, extracts the ABI, and converts it into an array of human-readable function and event signatures that can be used directly with contract interaction methods. +**Authentication**: This endpoint requires backend authentication using the `x-secret-key` header. The secret key should never be exposed publicly. +**Usage**: The returned signatures can be used directly in contract read/write operations or event filtering. Each signature follows the standard Solidity format and includes function parameters, return types, state mutability, and event indexing information. + +RETURNS: +Successfully retrieved contract signatures + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetTransactionByIdAsync(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transactionId (string) + Unique identifier of the transaction to retrieve. + +SUMMARY: +Get Transaction + +REMARKS: +Retrieves detailed information about a specific transaction using its unique identifier. Returns comprehensive transaction data including execution status, blockchain details, and any associated metadata. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Transaction details retrieved successfully. Returns comprehensive transaction information including status, blockchain details, and execution metadata. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetTransactionByIdAsync(System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - transactionId (System.Threading.CancellationToken) + Unique identifier of the transaction to retrieve. + +SUMMARY: +Get Transaction + +REMARKS: +Retrieves detailed information about a specific transaction using its unique identifier. Returns comprehensive transaction data including execution status, blockchain details, and any associated metadata. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Transaction details retrieved successfully. Returns comprehensive transaction information including status, blockchain details, and execution metadata. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListTransactionsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - from (string) + Filter transactions by sender wallet address or ENS name. + - limit (Nullable) + Number of transactions to return per page (1-100). + - page (Nullable) + Page number for pagination, starting from 1. + +SUMMARY: +List Transactions + +REMARKS: +Retrieves a paginated list of transactions associated with the authenticated client. Results are sorted by creation date in descending order (most recent first). Supports filtering by wallet address and pagination controls. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Transactions retrieved successfully. Returns a paginated list of transactions with metadata including creation and confirmation timestamps. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListTransactionsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - from (Nullable) + Filter transactions by sender wallet address or ENS name. + - limit (Nullable) + Number of transactions to return per page (1-100). + - page (System.Threading.CancellationToken) + Page number for pagination, starting from 1. + +SUMMARY: +List Transactions + +REMARKS: +Retrieves a paginated list of transactions associated with the authenticated client. Results are sorted by creation date in descending order (most recent first). Supports filtering by wallet address and pagination controls. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Transactions retrieved successfully. Returns a paginated list of transactions with metadata including creation and confirmation timestamps. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SendTransactionsAsync(Thirdweb.Api.Body13) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body13) + +SUMMARY: +Send Transactions + +REMARKS: +Submits pre-encoded blockchain transactions with custom data payloads. This endpoint is for low-level transaction submission where you have already encoded the transaction data. For smart contract method calls, use /v1/contracts/write. For native token transfers, use /v1/wallets/send. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Encoded transactions submitted successfully. Returns the transaction IDs for tracking and monitoring. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SendTransactionsAsync(Thirdweb.Api.Body13,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body13) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Send Transactions + +REMARKS: +Submits pre-encoded blockchain transactions with custom data payloads. This endpoint is for low-level transaction submission where you have already encoded the transaction data. For smart contract method calls, use /v1/contracts/write. For native token transfers, use /v1/wallets/send. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Encoded transactions submitted successfully. Returns the transaction IDs for tracking and monitoring. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreatePaymentAsync(Thirdweb.Api.Body14) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body14) + +SUMMARY: +Create Payment + +REMARKS: +Create a payment to be executed. Users can complete the payment via hosted UI (link is returned), a transaction execution referencing the product ID, or embedded widgets with the product ID. +**Authentication**: This endpoint requires project authentication. + +RETURNS: +Payment created successfully. Returns the ID and link to complete the payment. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreatePaymentAsync(Thirdweb.Api.Body14,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body14) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Create Payment + +REMARKS: +Create a payment to be executed. Users can complete the payment via hosted UI (link is returned), a transaction execution referencing the product ID, or embedded widgets with the product ID. +**Authentication**: This endpoint requires project authentication. + +RETURNS: +Payment created successfully. Returns the ID and link to complete the payment. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.PaymentsPurchaseAsync(System.String,Thirdweb.Api.Body15) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (string) + - param2 (Thirdweb.Api.Body15) + +SUMMARY: +Complete Payment + +REMARKS: +Completes a payment using its default token and amount. If the user does not have sufficient funds in the product's default payment token a 402 status will be returned containing a link and raw quote for purchase fulfillment. +**Authentication**: This endpoint requires project authentication. + +RETURNS: +Product purchased successfully. Returns the transaction used for the purchase. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.PaymentsPurchaseAsync(System.String,Thirdweb.Api.Body15,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (Thirdweb.Api.Body15) + - param3 (System.Threading.CancellationToken) + +SUMMARY: +Complete Payment + +REMARKS: +Completes a payment using its default token and amount. If the user does not have sufficient funds in the product's default payment token a 402 status will be returned containing a link and raw quote for purchase fulfillment. +**Authentication**: This endpoint requires project authentication. + +RETURNS: +Product purchased successfully. Returns the transaction used for the purchase. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetPaymentHistoryAsync(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (string) + +SUMMARY: +Get Payment History + +REMARKS: +Get payment history for a specific payment link + +RETURNS: +Payment history retrieved successfully + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetPaymentHistoryAsync(System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Get Payment History + +REMARKS: +Get payment history for a specific payment link + +RETURNS: +Payment history retrieved successfully + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.VerifyX402PaymentAsync(Thirdweb.Api.Body16) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body16) + +SUMMARY: +x402 - Verify payment + +REMARKS: +Verify an x402 payment payload against the provided payment requirements. Compatible with any standard x402 middleware. + +RETURNS: +Verification successful + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.VerifyX402PaymentAsync(Thirdweb.Api.Body16,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body16) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +x402 - Verify payment + +REMARKS: +Verify an x402 payment payload against the provided payment requirements. Compatible with any standard x402 middleware. + +RETURNS: +Verification successful + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SettleX402PaymentAsync(Thirdweb.Api.Body17) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body17) + +SUMMARY: +x402 - Settle payment + +REMARKS: +Settle an x402 payment. Compatible with any standard x402 middleware. + +RETURNS: +Settlement successful + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SettleX402PaymentAsync(Thirdweb.Api.Body17,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body17) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +x402 - Settle payment + +REMARKS: +Settle an x402 payment. Compatible with any standard x402 middleware. + +RETURNS: +Settlement successful + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SupportedX402PaymentsAsync(System.String,Thirdweb.Api.ChainId) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - tokenAddress (string) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (Thirdweb.Api.ChainId) + Chain ID in CAIP-2 format (e.g., 'eip155:1' for Ethereum, 'solana:mainnet' for Solana). Also accepts legacy numeric IDs for EVM chains. + +SUMMARY: +x402 - Supported payment methods + +REMARKS: +List supported x402 payment methods, optionally filtered by token address and chainId. Compatible with any standard x402 middleware. + +RETURNS: +Supported payment kinds + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SupportedX402PaymentsAsync(System.String,Thirdweb.Api.ChainId,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - tokenAddress (Thirdweb.Api.ChainId) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - chainId (System.Threading.CancellationToken) + Chain ID in CAIP-2 format (e.g., 'eip155:1' for Ethereum, 'solana:mainnet' for Solana). Also accepts legacy numeric IDs for EVM chains. + +SUMMARY: +x402 - Supported payment methods + +REMARKS: +List supported x402 payment methods, optionally filtered by token address and chainId. Compatible with any standard x402 middleware. + +RETURNS: +Supported payment kinds + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.FetchWithPaymentAsync(System.String,System.Uri,Thirdweb.Api.Method,System.String,System.String,Thirdweb.Api.ChainId2,System.Object) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (string) + - param2 (System.Uri) + - param3 (Thirdweb.Api.Method) + - param4 (string) + - param5 (string) + - param6 (Thirdweb.Api.ChainId2) + - param7 (object) + +SUMMARY: +x402 - Fetch with payment + +REMARKS: +Fetch any given url. If the url returns HTTP 402 payment required, this endpoint handles payment with the authenticated wallet. +Optionally pass a 'from' query parameter with the authenticated wallet address (server or user wallet) to complete the payment. +If no 'from' parameter is passed, the default project wallet address will be used. +- Works with any x402 compatible endpoint. +- Automatically selects a compatible payment method. +- Signs the appropriate payment payload. +- Sends the payment to the url. +- Returns the final result from the url called. +Request body and headers are always passed through to the url called. +**Authentication**: This endpoint requires wallet authentication for the payment. For frontend usage, include `x-client-id` and `Authorization: Bearer ` headers. For backend usage, include `x-secret-key` header. + +RETURNS: +Returns the final result from the API call + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.FetchWithPaymentAsync(System.String,System.Uri,Thirdweb.Api.Method,System.String,System.String,Thirdweb.Api.ChainId2,System.Object,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Uri) + - param3 (Thirdweb.Api.Method) + - param4 (string) + - param5 (string) + - param6 (Thirdweb.Api.ChainId2) + - param7 (object) + - param8 (System.Threading.CancellationToken) + +SUMMARY: +x402 - Fetch with payment + +REMARKS: +Fetch any given url. If the url returns HTTP 402 payment required, this endpoint handles payment with the authenticated wallet. +Optionally pass a 'from' query parameter with the authenticated wallet address (server or user wallet) to complete the payment. +If no 'from' parameter is passed, the default project wallet address will be used. +- Works with any x402 compatible endpoint. +- Automatically selects a compatible payment method. +- Signs the appropriate payment payload. +- Sends the payment to the url. +- Returns the final result from the url called. +Request body and headers are always passed through to the url called. +**Authentication**: This endpoint requires wallet authentication for the payment. For frontend usage, include `x-client-id` and `Authorization: Bearer ` headers. For backend usage, include `x-secret-key` header. + +RETURNS: +Returns the final result from the API call + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListPayableServicesAsync(System.Nullable{System.Double},System.Nullable{System.Double},System.String,System.Nullable{Thirdweb.Api.SortBy2},System.Nullable{Thirdweb.Api.SortOrder5}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Nullable) + - param2 (Nullable) + - param3 (string) + - param4 (Nullable) + - param5 (Nullable) + +SUMMARY: +x402 - Discover resources + +REMARKS: +Discover payable x402 compatible services and HTTP endpoints that can be paid for using the fetchWithPayment tool. Use this tool to browse services, APIs and endpoints to find what you need for your tasks. Each item has a resource url that you can call with the fetchWithPayment tool.Price is in the base units of the asset. For example, if the price is 1000000 and the asset is USDC (which is the default and has 6 decimals), the price is 1 USDC.Examples: if network is eip155:8453, asset is 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913, max amount required is 10000, resource is https://api.example.com/paid-api, then you should interpret that as "the api.example.com/paid-api service costs 0.01 USDC per call". + +RETURNS: +List of discovered x402 resources + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListPayableServicesAsync(System.Nullable{System.Double},System.Nullable{System.Double},System.String,System.Nullable{Thirdweb.Api.SortBy2},System.Nullable{Thirdweb.Api.SortOrder5},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Nullable) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (Nullable) + - param3 (string) + - param4 (Nullable) + - param5 (Nullable) + - param6 (System.Threading.CancellationToken) + +SUMMARY: +x402 - Discover resources + +REMARKS: +Discover payable x402 compatible services and HTTP endpoints that can be paid for using the fetchWithPayment tool. Use this tool to browse services, APIs and endpoints to find what you need for your tasks. Each item has a resource url that you can call with the fetchWithPayment tool.Price is in the base units of the asset. For example, if the price is 1000000 and the asset is USDC (which is the default and has 6 decimals), the price is 1 USDC.Examples: if network is eip155:8453, asset is 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913, max amount required is 10000, resource is https://api.example.com/paid-api, then you should interpret that as "the api.example.com/paid-api service costs 0.01 USDC per call". + +RETURNS: +List of discovered x402 resources + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetX402AcceptsAsync(Thirdweb.Api.Body18) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body18) + +SUMMARY: +x402 - Get payment accepts + +REMARKS: +Transform payment configuration into x402 payment requirements. This endpoint converts high-level payment parameters (like USD amounts or ERC20 token specifications) into the standardized x402 payment requirements format used by x402-compatible middleware. + +RETURNS: +Returns x402 payment requirements + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetX402AcceptsAsync(Thirdweb.Api.Body18,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body18) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +x402 - Get payment accepts + +REMARKS: +Transform payment configuration into x402 payment requirements. This endpoint converts high-level payment parameters (like USD amounts or ERC20 token specifications) into the standardized x402 payment requirements format used by x402-compatible middleware. + +RETURNS: +Returns x402 payment requirements + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreateTokenAsync(Thirdweb.Api.Body19) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body19) + +SUMMARY: +Create Token + +REMARKS: +Create a new ERC20 token with the provided metadata and starting price. The token is immediately available for purchase using thirdweb Payments. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +The token is being deployed. Returns the predicted token address. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreateTokenAsync(Thirdweb.Api.Body19,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body19) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Create Token + +REMARKS: +Create a new ERC20 token with the provided metadata and starting price. The token is immediately available for purchase using thirdweb Payments. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +The token is being deployed. Returns the predicted token address. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListTokensAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - limit (Nullable) + Number of tokens to return per page (1-100). + - page (Nullable) + Page number for pagination, starting from 1. + - chainId (Nullable) + Limit tokens to a specific chain. + - tokenAddress (string) + Get a specific token by contract address + - symbol (string) + Limit tokens to a specific symbol. + - name (string) + Limit tokens to a specific name. + +SUMMARY: +List Tokens + +REMARKS: +Lists or search existing tokens based on the provided filters. Supports querying by chain ID, token address, symbol, and/or name. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Tokens returned successfully. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListTokensAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Nullable) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - limit (Nullable) + Number of tokens to return per page (1-100). + - page (Nullable) + Page number for pagination, starting from 1. + - chainId (string) + Limit tokens to a specific chain. + - tokenAddress (string) + Get a specific token by contract address + - symbol (string) + Limit tokens to a specific symbol. + - name (System.Threading.CancellationToken) + Limit tokens to a specific name. + +SUMMARY: +List Tokens + +REMARKS: +Lists or search existing tokens based on the provided filters. Supports querying by chain ID, token address, symbol, and/or name. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Tokens returned successfully. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetTokenOwnersAsync(System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (int) + The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + - address (string) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - tokenId (string) + Optional token ID for NFT owners. If provided, returns owners of the specific NFT token. + - limit (Nullable) + Number of owners to return per page (1-100). + - page (Nullable) + Page number for pagination, starting from 1. + +SUMMARY: +Get Owners + +REMARKS: +Retrieves a paginated list of owners for a given token contract on a specific chain. Supports ERC-20 tokens, ERC-721 NFTs, and ERC-1155 tokens: +- **ERC-20**: No `tokenId` provided - returns token holders with balances +- **NFT Collection**: No `tokenId` provided - returns all owners of any token in the collection +- **Specific NFT**: `tokenId` provided - returns owner(s) of that specific token ID +The token standard is automatically detected using ERC165 interface detection when needed. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Token owners retrieved successfully. Returns owners with pagination information. For ERC-20 tokens, `amount` represents token balance. For NFTs, `amount` represents quantity owned (usually '1' for ERC-721, can be >1 for ERC-1155). + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetTokenOwnersAsync(System.Int32,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (int) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - chainId (string) + The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + - address (string) + A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + - tokenId (Nullable) + Optional token ID for NFT owners. If provided, returns owners of the specific NFT token. + - limit (Nullable) + Number of owners to return per page (1-100). + - page (System.Threading.CancellationToken) + Page number for pagination, starting from 1. + +SUMMARY: +Get Owners + +REMARKS: +Retrieves a paginated list of owners for a given token contract on a specific chain. Supports ERC-20 tokens, ERC-721 NFTs, and ERC-1155 tokens: +- **ERC-20**: No `tokenId` provided - returns token holders with balances +- **NFT Collection**: No `tokenId` provided - returns all owners of any token in the collection +- **Specific NFT**: `tokenId` provided - returns owner(s) of that specific token ID +The token standard is automatically detected using ERC165 interface detection when needed. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Token owners retrieved successfully. Returns owners with pagination information. For ERC-20 tokens, `amount` represents token balance. For NFTs, `amount` represents quantity owned (usually '1' for ERC-721, can be >1 for ERC-1155). + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetBridgeChainsAsync +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +SUMMARY: +List Supported Chains + +REMARKS: +List all blockchain networks available for cross-chain bridging. Each chain includes metadata and native currency details. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Successfully retrieved supported bridge chains. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetBridgeChainsAsync(System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (System.Threading.CancellationToken) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + +SUMMARY: +List Supported Chains + +REMARKS: +List all blockchain networks available for cross-chain bridging. Each chain includes metadata and native currency details. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Successfully retrieved supported bridge chains. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetBridgeSupportedRoutesAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Int32}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - limit (Nullable) + Maximum number of routes to return (1-100). + - page (Nullable) + Page number for pagination, starting at 1. + - originChainId (Nullable) + Filter routes by the origin chain ID. + - destinationChainId (Nullable) + Filter routes by the destination chain ID. + - originTokenAddress (string) + Filter routes by origin token address. + - destinationTokenAddress (string) + Filter routes by destination token address. + - maxSteps (Nullable) + Maximum number of bridge steps allowed in the route. + +SUMMARY: +List Supported Routes + +REMARKS: +List supported bridge routes with simple pagination and optional chain or token filters. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Successfully retrieved supported bridge routes. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetBridgeSupportedRoutesAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Int32},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Nullable) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - limit (Nullable) + Maximum number of routes to return (1-100). + - page (Nullable) + Page number for pagination, starting at 1. + - originChainId (Nullable) + Filter routes by the origin chain ID. + - destinationChainId (string) + Filter routes by the destination chain ID. + - originTokenAddress (string) + Filter routes by origin token address. + - destinationTokenAddress (Nullable) + Filter routes by destination token address. + - maxSteps (System.Threading.CancellationToken) + Maximum number of bridge steps allowed in the route. + +SUMMARY: +List Supported Routes + +REMARKS: +List supported bridge routes with simple pagination and optional chain or token filters. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Successfully retrieved supported bridge routes. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ConvertFiatToCryptoAsync(Thirdweb.Api.From,System.String,System.Int32,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - from (Thirdweb.Api.From) + The fiat currency symbol + - fromAmount (string) + The amount of fiat currency to convert + - chainId (int) + The blockchain network identifier + - to (string) + The token address on the specified chain to convert to + +SUMMARY: +Convert Fiat to Crypto + +REMARKS: +Convert fiat currency amount to cryptocurrency token amount. Supports multiple fiat currencies based on available price data for the specific token. Returns the equivalent amount of crypto tokens for the specified fiat amount based on current market prices. If price data is not available for the requested currency, the API will return a 404 error. +**Native Tokens**: To get the price of native tokens (like ETH on Ethereum), use the address `0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE`. For example, to get the price of ETH on Ethereum Mainnet (chainId: 1), pass `to=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE`. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Conversion completed successfully. Returns the amount of crypto tokens equivalent to the specified fiat amount. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ConvertFiatToCryptoAsync(Thirdweb.Api.From,System.String,System.Int32,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.From) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - from (string) + The fiat currency symbol + - fromAmount (int) + The amount of fiat currency to convert + - chainId (string) + The blockchain network identifier + - to (System.Threading.CancellationToken) + The token address on the specified chain to convert to + +SUMMARY: +Convert Fiat to Crypto + +REMARKS: +Convert fiat currency amount to cryptocurrency token amount. Supports multiple fiat currencies based on available price data for the specific token. Returns the equivalent amount of crypto tokens for the specified fiat amount based on current market prices. If price data is not available for the requested currency, the API will return a 404 error. +**Native Tokens**: To get the price of native tokens (like ETH on Ethereum), use the address `0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE`. For example, to get the price of ETH on Ethereum Mainnet (chainId: 1), pass `to=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE`. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Conversion completed successfully. Returns the amount of crypto tokens equivalent to the specified fiat amount. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.BridgeSwapAsync(Thirdweb.Api.Body20) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body20) + +SUMMARY: +Swap or Bridge Tokens + +REMARKS: +Swap one token for another using the optimal route available. You can specify a tokenIn amount (if exact='input') or tokenOut amount (if exact='output'), but not both. The corresponding output or input amount will be returned as the quote. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Swap completed successfully. Returns the transaction used for the swap. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.BridgeSwapAsync(Thirdweb.Api.Body20,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body20) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Swap or Bridge Tokens + +REMARKS: +Swap one token for another using the optimal route available. You can specify a tokenIn amount (if exact='input') or tokenOut amount (if exact='output'), but not both. The corresponding output or input amount will be returned as the quote. +**Authentication**: This endpoint requires project authentication and wallet authentication. For backend usage, use `x-secret-key` header. For frontend usage, use `x-client-id` + `Authorization: Bearer ` headers. + +RETURNS: +Swap completed successfully. Returns the transaction used for the swap. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListSolanaWalletsAsync(System.Nullable{System.Int32},System.Nullable{System.Int32}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - page (Nullable) + Page number for paginated results. Starts at 1. + - limit (Nullable) + Maximum number of wallets to return per page. + +SUMMARY: +List Solana Wallets + +REMARKS: +List all Solana wallets created for your project. Supports pagination with page and limit parameters. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Successfully retrieved Solana wallets with pagination metadata. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ListSolanaWalletsAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Nullable) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - page (Nullable) + Page number for paginated results. Starts at 1. + - limit (System.Threading.CancellationToken) + Maximum number of wallets to return per page. + +SUMMARY: +List Solana Wallets + +REMARKS: +List all Solana wallets created for your project. Supports pagination with page and limit parameters. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Successfully retrieved Solana wallets with pagination metadata. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreateSolanaWalletAsync(Thirdweb.Api.Body21) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body21) + +SUMMARY: +Create Solana Wallet + +REMARKS: +Create a new Solana wallet or return the existing wallet for a given label. Labels must be unique within your project. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Solana wallet retrieved for the provided label. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.CreateSolanaWalletAsync(Thirdweb.Api.Body21,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body21) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Create Solana Wallet + +REMARKS: +Create a new Solana wallet or return the existing wallet for a given label. Labels must be unique within your project. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Solana wallet retrieved for the provided label. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetSolanaWalletBalanceAsync(System.String,Thirdweb.Api.ChainId3,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - address (string) + Public key of the Solana wallet. + - chainId (Thirdweb.Api.ChainId3) + Solana network to query. Choose either solana:mainnet or solana:devnet. + - tokenAddress (string) + SPL token mint address. Omit to retrieve native SOL balance. + +SUMMARY: +Get Solana Wallet Balance + +REMARKS: +Get the SOL or SPL token balance for a Solana wallet on a specific Solana network. +**Authentication**: Pass `x-client-id` for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet balance retrieved successfully for the requested Solana network. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetSolanaWalletBalanceAsync(System.String,Thirdweb.Api.ChainId3,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - address (Thirdweb.Api.ChainId3) + Public key of the Solana wallet. + - chainId (string) + Solana network to query. Choose either solana:mainnet or solana:devnet. + - tokenAddress (System.Threading.CancellationToken) + SPL token mint address. Omit to retrieve native SOL balance. + +SUMMARY: +Get Solana Wallet Balance + +REMARKS: +Get the SOL or SPL token balance for a Solana wallet on a specific Solana network. +**Authentication**: Pass `x-client-id` for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +Wallet balance retrieved successfully for the requested Solana network. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SignSolanaMessageAsync(Thirdweb.Api.Body22) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body22) + +SUMMARY: +Sign Solana Message + +REMARKS: +Sign an arbitrary message with a Solana wallet. Supports both text and hexadecimal message formats with automatic format detection. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Message signed successfully. Returns the base58 signature. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SignSolanaMessageAsync(Thirdweb.Api.Body22,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body22) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Sign Solana Message + +REMARKS: +Sign an arbitrary message with a Solana wallet. Supports both text and hexadecimal message formats with automatic format detection. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Message signed successfully. Returns the base58 signature. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SignSolanaTransactionAsync(Thirdweb.Api.Body23) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body23) + +SUMMARY: +Sign Solana Transaction + +REMARKS: +Sign a Solana transaction using a server wallet without broadcasting it. Provide either a serialized transaction or the instructions to assemble one, along with execution options. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. Optionally, include x-vault-access-token if your wallet is managed via Vault. + +RETURNS: +Transaction signed successfully. Returns the signature and the fully signed transaction payload. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SignSolanaTransactionAsync(Thirdweb.Api.Body23,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body23) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Sign Solana Transaction + +REMARKS: +Sign a Solana transaction using a server wallet without broadcasting it. Provide either a serialized transaction or the instructions to assemble one, along with execution options. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. Optionally, include x-vault-access-token if your wallet is managed via Vault. + +RETURNS: +Transaction signed successfully. Returns the signature and the fully signed transaction payload. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.BroadcastSolanaTransactionAsync(Thirdweb.Api.Body24) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body24) + +SUMMARY: +Broadcast Signed Solana Transaction + +REMARKS: +Broadcast a signed Solana transaction to the network and wait for confirmation. This endpoint accepts a base64 encoded signed transaction (such as the output from /v1/solana/sign-transaction), submits it to the Solana blockchain, and polls until the transaction is confirmed (up to 30 seconds). +The endpoint waits for the transaction to reach 'confirmed' or 'finalized' status before returning. If the transaction fails on-chain, detailed error information is returned including instruction index, error type, and the transaction signature for debugging. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. + +RETURNS: +Transaction broadcast and confirmed successfully. Returns the transaction signature (equivalent to EVM transaction hash). + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.BroadcastSolanaTransactionAsync(Thirdweb.Api.Body24,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body24) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Broadcast Signed Solana Transaction + +REMARKS: +Broadcast a signed Solana transaction to the network and wait for confirmation. This endpoint accepts a base64 encoded signed transaction (such as the output from /v1/solana/sign-transaction), submits it to the Solana blockchain, and polls until the transaction is confirmed (up to 30 seconds). +The endpoint waits for the transaction to reach 'confirmed' or 'finalized' status before returning. If the transaction fails on-chain, detailed error information is returned including instruction index, error type, and the transaction signature for debugging. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. + +RETURNS: +Transaction broadcast and confirmed successfully. Returns the transaction signature (equivalent to EVM transaction hash). + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SendSolanaTokensAsync(Thirdweb.Api.Body25) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body25) + +SUMMARY: +Send Solana Tokens + +REMARKS: +Transfer native SOL or SPL tokens on Solana. Automatically handles token account creation for SPL tokens if needed. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Transfer queued successfully. Returns the transaction identifier for status polling. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SendSolanaTokensAsync(Thirdweb.Api.Body25,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body25) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Send Solana Tokens + +REMARKS: +Transfer native SOL or SPL tokens on Solana. Automatically handles token account creation for SPL tokens if needed. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Transfer queued successfully. Returns the transaction identifier for status polling. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SendSolanaTransactionAsync(Thirdweb.Api.Body26) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body26) + +SUMMARY: +Send Solana Transaction + +REMARKS: +Submit a Solana transaction composed of one or more instructions. Transactions are queued and processed asynchronously. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Transaction queued successfully. Returns the transaction identifier for status polling. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.SendSolanaTransactionAsync(Thirdweb.Api.Body26,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body26) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Send Solana Transaction + +REMARKS: +Submit a Solana transaction composed of one or more instructions. Transactions are queued and processed asynchronously. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Transaction queued successfully. Returns the transaction identifier for status polling. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetSolanaTransactionAsync(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transactionId (string) + Identifier returned when the transaction was queued. + +SUMMARY: +Get Solana Transaction + +REMARKS: +Retrieve the status and details of a queued Solana transaction using the identifier returned when the transaction was submitted. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Transaction status retrieved successfully. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.GetSolanaTransactionAsync(System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (string) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - transactionId (System.Threading.CancellationToken) + Identifier returned when the transaction was queued. + +SUMMARY: +Get Solana Transaction + +REMARKS: +Retrieve the status and details of a queued Solana transaction using the identifier returned when the transaction was submitted. +**Authentication**: This endpoint requires backend authentication using the x-secret-key header. The secret key should never be exposed publicly. + +RETURNS: +Transaction status retrieved successfully. + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ChatAsync(Thirdweb.Api.Body27) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (Thirdweb.Api.Body27) + +SUMMARY: +Chat + +REMARKS: +Thirdweb AI chat completion API (BETA). +Send natural language queries to interact with any EVM chain, read data, prepare transactions, swap tokens, deploy contracts, payments and more. +Compatible with standard OpenAI API chat completion format, can be used raw or with any popular AI library. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +AI assistant response or SSE stream when stream=true + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +M:Thirdweb.Api.ThirdwebApiClient.ChatAsync(Thirdweb.Api.Body27,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - cancellationToken (Thirdweb.Api.Body27) + A cancellation token that can be used by other objects or threads to receive notice of cancellation. + - param2 (System.Threading.CancellationToken) + +SUMMARY: +Chat + +REMARKS: +Thirdweb AI chat completion API (BETA). +Send natural language queries to interact with any EVM chain, read data, prepare transactions, swap tokens, deploy contracts, payments and more. +Compatible with standard OpenAI API chat completion format, can be used raw or with any popular AI library. +**Authentication**: Pass `x-client-id` header for frontend usage from allowlisted origins or `x-secret-key` for backend usage. + +RETURNS: +AI assistant response or SSE stream when stream=true + +EXCEPTION (T:Thirdweb.Api.ApiException): +A server side error occurred. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body.Method +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Authentication method: SMS + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body.Phone +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Phone number in E.164 format (e.g., +1234567890) + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body2.Method +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Authentication method: SMS + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body2.Phone +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Phone number that received the code + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body2.Code +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Verification code received via SMS + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body3 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for linking an additional authentication method or external wallet to the currently authenticated user. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body3.AccountAuthTokenToConnect +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Authentication token for the account that should be linked to the currently authenticated wallet. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body4 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for unlinking an authentication provider or wallet from the currently authenticated user. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body4.Type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Authentication provider type to disconnect + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body4.Details +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Identifiers for the provider profile that should be disconnected + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body4.AllowAccountDeletion +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +If true, allows the account to be deleted when unlinking removes the last authentication method. Defaults to false when omitted. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Provider +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +The OAuth provider to use + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body5 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for pre-generating a wallet + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body5.WalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body6 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for creating a wallet + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body6.Identifier +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique identifier for wallet creation or retrieval. Can be user ID, email, or any unique string. The same identifier will always return the same wallet. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.SortOrder +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Sort order: 'asc' for ascending, 'desc' for descending + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Metadata +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Whether to include token metadata (default: true). + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.ResolveMetadataLinks +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Whether to resolve metadata links to fetch additional token information (default: true). + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.IncludeSpam +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Whether to include tokens marked as spam (default: false). + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.IncludeNative +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Whether to include native tokens (e.g., ETH, MATIC) in the results (default: true). + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.SortBy +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Field to sort tokens by: 'balance' for token balance, 'token_address' for token address, 'token_price' for token price, 'usd_value' for USD value (default: usd_value). + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.SortOrder2 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Sort order: 'asc' for ascending, 'desc' for descending (default: desc). + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.IncludeWithoutPrice +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Whether to include tokens without price data (default: true). + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body7 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for signing a message + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body7.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will sign the message. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body7.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier where the signing will occur. Common values include: 1 (Ethereum), 137 (Polygon), 56 (BSC). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body7.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The message to be signed. Can be plain text or hexadecimal format (starting with 0x). The format is automatically detected. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body8 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for signing typed data + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body8.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will sign the typed data. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body8.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier for EIP-712 domain separation. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body8.Domain +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +EIP-712 domain separator containing contract and chain information for signature verification. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body8.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The structured data to be signed, matching the defined types schema. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body8.PrimaryType +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The primary type name from the types object that defines the main structure being signed. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body8.Types +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Type definitions for the structured data, following EIP-712 specifications. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body9 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for sending tokens to multiple recipients. Supports native tokens, ERC20, ERC721, and ERC1155 transfers based on the provided parameters. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body9.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will send the tokens. If omitted, the project wallet will be used if available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body9.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier where the transfer will be executed. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body9.Recipients +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of recipients and quantities. Maximum 100 recipients per request. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body9.TokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token contract address. Omit for native token (ETH, MATIC, etc.) transfers. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body9.TokenId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token ID for NFT transfers (ERC721/ERC1155). Required for NFT transfers. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body10 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Contract deployment specification for raw bytecode deployment. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body10.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body10.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will deploy the contract. If omitted, the project wallet will be used if available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body10.Bytecode +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract bytecode as a hex string. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body10.Abi +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract ABI array. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body10.ConstructorParams +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Object containing constructor parameters for the contract deployment (e.g., { param1: 'value1', param2: 123 }). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body10.Salt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional salt value for deterministic contract deployment. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body11.Calls +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of contract method calls to execute. Each call specifies a contract address, method signature, and optional parameters. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body11.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body12.Calls +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of contract method calls to execute. Each call specifies a contract address, method signature, and optional parameters. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body12.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body12.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will send the transaction. If omitted, the project wallet will be used if available. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.SortOrder3 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Sort order: 'asc' for ascending, 'desc' for descending + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.SortOrder4 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Sort order: 'asc' for ascending, 'desc' for descending + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body13 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request object containing an array of encoded blockchain transactions to execute. All transactions must use the same from address and chainId. For contract calls, use /v1/contracts/write. For native token transfers, use /v1/wallets/send. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body13.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier where all transactions will be executed. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body13.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will send the transaction. If omitted, the project wallet will be used if available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body13.Transactions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of encoded blockchain transactions to execute. All transactions will use the same from address and chainId. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body14 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request to create a product to be purchased. Users can purchase the product via hosted UI (link is returned), a transaction execution referencing the product ID, or embedded widgets with the product ID. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body14.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The name of the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body14.Description +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The description of the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body14.ImageUrl +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The URL of the product image + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body14.Token +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token to purchase + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body14.Recipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will receive the payment for the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body14.PurchaseData +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +App specific purchase data for this payment + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body15 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request to purchase a product. The system will automatically use your wallet balance to purchase the specified product. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body15.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will purchase the product. If omitted, the project wallet will be used if available. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body16 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for x402 facilitator 'verify' + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body17 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request body for x402 facilitator 'settle' + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body17.WaitUntil +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The event to wait for to determina a transaction confirmation. 'simulated' will only simulate the transaction (fastest), 'submitted' will wait till the transaction is submitted, and 'confirmed' will wait for the transaction to be fully confirmed on chain (slowest). Defaults to 'confirmed'. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.ChainId +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Chain ID in CAIP-2 format (e.g., 'eip155:1' for Ethereum, 'solana:mainnet' for Solana). Also accepts legacy numeric IDs for EVM chains. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Method +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +The method to use, defaults to GET + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.ChainId2 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +The chain ID to use for the payment in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1', 1) and Solana chains (e.g., 'solana:mainnet'). If not provided, the chain ID from the url's payment requirements will be used. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body18.ResourceUrl +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The URL of the resource being protected by the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body18.Method +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The HTTP method used to access the resource + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body18.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network where the payment should be processed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body18.Price +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The price for accessing the resource - either a USD amount (e.g., '$0.10') or a specific token amount + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body18.RouteConfig +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional configuration for the payment middleware route + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body18.ServerWalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Your server wallet address, defaults to the project server wallet address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body18.RecipientAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional recipient address to receive the payment if different from your facilitator server wallet address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body18.ExtraMetadata +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional extra data to be passed to in the payment requirements. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body19 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request schema for creating a new ERC20 token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token name + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.Symbol +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token symbol + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.Description +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token description + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.ImageUrl +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token image URL + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Wallet address or ENS that will deploy the token. If omitted, the project wallet will be used if available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.Owner +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token owner address, if different from `from`. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.Salt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A salt to deterministically generate the token address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.MaxSupply +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The maximum token supply. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body19.Sale +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Setup this token for a sale. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.From +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +The fiat currency symbol + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body20 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request to swap tokens using the optimal route available. You can specify a tokenIn amount (if exact='input') or tokenOut amount (if exact='output'), but not both. The corresponding output or input amount will be returned as the quote. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body20.Exact +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether to swap the exact input or output amount + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body20.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address or ENS name that will execute the swap. If omitted, the project wallet will be used if available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body20.SlippageToleranceBps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The slippage tolerance in basis points. Will be automatically calculated by default. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body21 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request payload for creating or fetching a Solana wallet by label. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body21.Label +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique label to identify the wallet. Used for retrieval and management. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.ChainId3 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Solana network to query. Choose either solana:mainnet or solana:devnet. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body22 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request payload for signing an arbitrary Solana message. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body22.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The Solana wallet address used for signing. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body22.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Message to sign. Can be plain text or hexadecimal format (starting with 0x). The format is automatically detected. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body23 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request payload for signing a Solana transaction. Provide a serialized transaction or a set of instructions to be assembled server-side. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body23.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The Solana wallet address that will sign the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body23.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Solana network the transaction targets. Use solana:mainnet or solana:devnet. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body23.Transaction +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Base64 encoded Solana transaction to sign. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body23.Instructions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Instructions that will be assembled into a transaction before signing. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body23.PriorityFee +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Priority fee configuration applied via the compute budget program. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body23.ComputeUnitLimit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Override the compute unit limit for the transaction via the compute budget program. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body24 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request payload for broadcasting a signed Solana transaction. Use the signedTransaction output from /v1/solana/sign-transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body24.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Solana network the signed transaction targets. Use solana:mainnet or solana:devnet. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body24.SignedTransaction +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Base64 encoded signed transaction to broadcast to the Solana network. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body25 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Request payload for transferring SOL or SPL tokens on Solana. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body25.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Solana wallet address that will sign and submit the transfer. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body25.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination Solana address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body25.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Amount to transfer expressed in base units (lamports for SOL or token decimals). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body25.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Solana network identifier in CAIP-2 format. Use "solana:mainnet" or "solana:devnet" for convenience, or full CAIP-2 format. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body25.TokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional SPL token mint address. When omitted a native SOL transfer is performed. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body26 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Submit a Solana transaction made up of one or more instructions. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body26.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Solana wallet address that will sign and submit the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body26.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Solana network identifier in CAIP-2 format. Use "solana:mainnet" or "solana:devnet" for convenience, or full CAIP-2 format. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body26.Instructions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Set of instructions executed sequentially in a single transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body26.PriorityFee +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Priority fee configuration applied via the compute budget program. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body26.ComputeUnitLimit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Override the compute unit limit via the compute budget program. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Body27 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Chat request + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body27.Messages +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Natural language query for the AI assistant + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body27.Context +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Context for the AI assistant + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Body27.Stream +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Enable server streaming of the AI response + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response.Method +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Authentication method: SMS + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response.Success +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether the SMS code was sent successfully + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response2 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Successful authentication response. Returns wallet address plus authentication tokens. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response2.IsNewUser +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether this is a newly created user/wallet + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response2.Token +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +JWT authentication token for API access + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response2.Type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Type of authentication completed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response2.UserId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique identifier for the authenticated user + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response2.WalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet address + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response3 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Response returned after successfully linking an additional authentication provider. The response includes all linked profiles for the user. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response3.LinkedAccounts +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Updated list of authentication profiles linked to the wallet after the new account has been connected. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response4 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Response returned after successfully linking an additional authentication provider. The response includes all linked profiles for the user. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response4.LinkedAccounts +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Updated list of authentication profiles linked to the wallet after the new account has been connected. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response19.Result +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of results corresponding to each contract read call. Results are returned in the same order as the input calls. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response21 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Payment required response when user has insufficient funds. Contains a quote for completing the purchase. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response24 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Contract metadata from the thirdweb contract metadata service. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response25 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Contract ABI signatures in human-readable format. These signatures can be used directly with contract interaction methods. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response25.Result +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of human-readable ABI signatures including functions and events. Each signature is formatted as a string that can be used directly in contract read/write operations or event filtering. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response29 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Payment required response when user has insufficient funds. Contains a quote for completing the purchase. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response30 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Successful payment creation response containing the payment ID and link to purchase the product + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response32 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Payment required response when user has insufficient funds. Contains a quote for completing the purchase. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response33.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +List of payments for the client + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response36 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Response returned by x402 facilitator 'verify' + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response37 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Response returned by x402 facilitator 'settle' + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response38 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Supported payment kinds for this facilitator + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response39 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Payment required response when user has insufficient funds. Contains a quote for completing the purchase. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response43.TransactionId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The in-progress deployment transaction ID. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response43.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The address the token was deployed at + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response46.Result +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Blockchain networks that support cross-chain bridging + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response48.Result +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The conversion result - amount of crypto tokens for the fiat amount + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response49 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Successful token swap response containing executed transaction ID + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response50 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Payment required response when user has insufficient funds. Contains a quote for completing the purchase. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response52.Result +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Details for a Solana wallet in your project. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response53.Result +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Details for a Solana wallet in your project. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response54.Result +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Balance data for the requested Solana network. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response62.Result +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction metadata and status information. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Response63 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Chat response + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Response63.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The AI assistant's response + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Details.WalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Domain.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Chain ID as string for domain separation + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Domain.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The domain name (e.g., token name) + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Domain.Salt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional salt for additional entropy + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Domain.VerifyingContract +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract address that will verify this signature + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Domain.Version +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Domain version for signature compatibility + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Anonymous.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The field name + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Anonymous.Type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The Solidity type (e.g., 'address', 'uint256') + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Recipients.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The recipient wallet address or ENS name + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Recipients.Quantity +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount to send. For native tokens and ERC20: amount in wei/smallest unit. For ERC721: should be '1'. For ERC1155: the number of tokens to transfer. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Calls.ContractAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The smart contract address or ENS name. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Calls.Method +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract function signature to call (e.g., 'function approve(address spender, uint256 amount)' or `function balanceOf(address)`). Must start with 'function' followed by the function name and parameters as defined in the contract ABI. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Calls.Params +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of parameters to pass to the contract method, in the correct order and format. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Calls.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Amount of native token to send with the transaction in wei. Required for payable methods. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.calls.ContractAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The smart contract address or ENS name. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.calls.Method +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract function signature to call (e.g., 'function approve(address spender, uint256 amount)' or `function balanceOf(address)`). Must start with 'function' followed by the function name and parameters as defined in the contract ABI. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.calls.Params +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of parameters to pass to the contract method, in the correct order and format. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.calls.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Amount of native token to send with the transaction in wei. Required for payable methods. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Transactions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +A blockchain transaction with pre-encoded data payload. For contract calls, use /v1/contracts/write. For native token transfers, use /v1/wallets/send. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction data in hexadecimal format for contract interactions or custom payloads. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The target address or ENS name for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Amount of native token to send in wei (smallest unit). Use '0' or omit for non-value transactions. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Token.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token address to purchase (use 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for native token) + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Token.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network where the token is located + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Token.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount of the token to purchase in wei. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.PaymentPayload.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Network identifier in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1') and Solana chains (e.g., 'solana:mainnet'). Also accepts legacy numeric chain IDs for EVM (e.g., 1 for Ethereum). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.PaymentRequirements.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Network identifier in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1') and Solana chains (e.g., 'solana:mainnet'). Also accepts legacy numeric chain IDs for EVM (e.g., 1 for Ethereum). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.PaymentPayload2.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Network identifier in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1') and Solana chains (e.g., 'solana:mainnet'). Also accepts legacy numeric chain IDs for EVM (e.g., 1 for Ethereum). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.PaymentRequirements2.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Network identifier in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1') and Solana chains (e.g., 'solana:mainnet'). Also accepts legacy numeric chain IDs for EVM (e.g., 1 for Ethereum). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Sale.StartingPrice +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The initial token price in wei. This price is in the currency specified by `currency` (or the native token if not specified). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Sale.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The number of tokens to allocate to the sale. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Sale.DeveloperFeeBps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The bps fee on the token pool. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Sale.DeveloperFeeRecipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The address to send the developer fee to. Defaults to the token owner. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Sale.Currency +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The currency to price this token sale in. Defaults to the native token. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.TokenIn.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The input token address to swap (use 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for native token) + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.TokenIn.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network where the token is located + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.TokenIn.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount of the input token to swap in wei. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.TokenIn.MaxAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The maximum amount of the input token to swap in wei. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.TokenOut.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The output token address to swap (use 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE for native token) + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.TokenOut.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network where the token is located + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.TokenOut.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount of the output token to receive in wei. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.TokenOut.MinAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The minimum amount of the output token to receive in wei. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Instructions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Single Solana instruction that will be included in a transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Instructions.ProgramId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Program address to invoke for this instruction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Instructions.Accounts +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Ordered list of accounts consumed by the instruction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Instructions.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Instruction data encoded using the provided encoding. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Instructions.Encoding +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Encoding used for the instruction data payload. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.instructions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Single Solana instruction that will be included in a transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.instructions.ProgramId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Program address to invoke for this instruction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.instructions.Accounts +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Ordered list of accounts consumed by the instruction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.instructions.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Instruction data encoded using the provided encoding. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.instructions.Encoding +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Encoding used for the instruction data payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Context.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional wallet address that will execute transactions + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Context.Chain_ids +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional chain IDs for context + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Context.Session_id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional session ID for conversation continuity. If not provided, a new session will be created + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Context.Auto_execute_transactions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether to automatically execute transactions. If not provided, the default is false + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.LinkedAccounts +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Authentication provider details with type-based discrimination + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.linkedAccounts +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Authentication provider details with type-based discrimination + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result.UserId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique identifier for the user wallet within the thirdweb auth system. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The EOA (Externally Owned Wallet) address of the wallet. This is the traditional wallet address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The date and time the wallet was created + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result.Profiles +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The profiles linked to the wallet, can be email, phone, google etc, or backend for developer created wallets + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result.SmartWalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The smart wallet address with EIP-4337 support. This address enables gasless transactions and advanced wallet features. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result.PublicKey +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet's public key in hexadecimal format. Useful for peer-to-peer encryption and cryptographic operations. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result2.Pagination +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Pagination information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result2.Wallets +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of user wallets + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result3.UserId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique identifier for the user wallet within the thirdweb auth system. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result3.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The EOA (Externally Owned Wallet) address of the wallet. This is the traditional wallet address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result3.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The date and time the wallet was created + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result3.Profiles +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The profiles linked to the wallet, can be email, phone, google etc, or backend for developer created wallets + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result3.SmartWalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The smart wallet address with EIP-4337 support. This address enables gasless transactions and advanced wallet features. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result3.PublicKey +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet's public key in hexadecimal format. Useful for peer-to-peer encryption and cryptographic operations. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result4.Pagination +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Pagination information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result4.Wallets +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of server wallets + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result5.UserId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique identifier for the user wallet within the thirdweb auth system. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result5.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The EOA (Externally Owned Wallet) address of the wallet. This is the traditional wallet address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result5.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The date and time the wallet was created + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result5.Profiles +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The profiles linked to the wallet, can be email, phone, google etc, or backend for developer created wallets + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result5.SmartWalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The smart wallet address with EIP-4337 support. This address enables gasless transactions and advanced wallet features. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result5.PublicKey +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet's public key in hexadecimal format. Useful for peer-to-peer encryption and cryptographic operations. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.result.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.result.Decimals +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of decimal places for the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.result.DisplayValue +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Human-readable balance formatted with appropriate decimal places + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.result.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token name (e.g., 'Ether', 'USD Coin') + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.result.Symbol +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token symbol (e.g., 'ETH', 'USDC') + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.result.TokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token contract address. Returns zero address (0x0...0) for native tokens. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.result.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Raw balance value as string in smallest unit (wei for ETH, etc.) + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result6.Transactions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of wallet transactions. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result7.Tokens +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of wallet tokens. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result8.Nfts +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of wallet NFTs. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result9.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The cryptographic signature in hexadecimal format. This can be used for verification and authentication purposes. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result10.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The cryptographic signature in hexadecimal format. This can be used for verification and authentication purposes. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result11.TransactionIds +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of transaction IDs for the submitted transfers. One ID per recipient. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result12.Contracts +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of contracts imported by the client. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result13.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The deployed contract address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result13.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The chain ID where the contract was deployed. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result13.TransactionId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The unique identifier for the transaction that deployed the contract. Will not be returned if the contract was already deployed at the predicted address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result14.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The result of the contract read operation. The type and format depend on the method's return value as defined in the contract ABI. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result14.Error +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Error message if the contract read operation failed. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result14.Success +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Indicates whether the contract read operation was successful. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result15.TransactionIds +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of unique identifiers for the submitted transactions. Use these to track transaction status. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result16.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Message to display to the user + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result16.Link +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Link to purchase the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result16.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Payment ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result16.Quote +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Bridge quote for completing the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result17.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of contract transactions. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result18.Events +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of contract events. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result19.Compiler +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Compiler information including version. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result19.Language +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Programming language of the contract (e.g., 'Solidity'). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result19.Output +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Compilation output including ABI and documentation. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result19.Settings +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Compilation settings including optimization and target configuration. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result19.Version +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Metadata format version. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.BatchIndex +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Index within transaction batch + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.CancelledAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO timestamp when transaction was cancelled, if applicable + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Blockchain network identifier as string + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.ClientId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Client identifier that initiated the transaction + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.ConfirmedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO timestamp when transaction was confirmed on-chain + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.ConfirmedAtBlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Block number where transaction was confirmed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO timestamp when transaction was created + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.EnrichedData +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Additional metadata and enriched transaction information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.ErrorMessage +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Error message if transaction failed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.ExecutionParams +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Parameters used for transaction execution + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.ExecutionResult +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Result data from transaction execution + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Sender wallet address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique transaction identifier + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.TransactionHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +On-chain transaction hash once confirmed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.TransactionParams +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Original transaction parameters and data + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result20.Status +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction status + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result22.TransactionIds +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of unique identifiers for the submitted transactions. Use these to track transaction status. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result23.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Message to display to the user + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result23.Link +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Link to purchase the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result23.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Payment ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result23.Quote +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Bridge quote for completing the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result24.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The payment ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result24.Link +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The link to purchase the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result25.TransactionId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction ID that was executed for your product purchase + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result26.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Message to display to the user + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result26.Link +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Link to purchase the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result26.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Payment ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result26.Quote +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Bridge quote for completing the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Data.Sender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Data.Receiver +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Data.DeveloperFeeRecipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Meta.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of payments + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Kinds.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Network identifier in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1') and Solana chains (e.g., 'solana:mainnet'). Also accepts legacy numeric chain IDs for EVM (e.g., 1 for Ethereum). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result27.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Message to display to the user + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result27.Link +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Link to purchase the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result27.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Payment ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result27.Quote +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Bridge quote for completing the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Accepts.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Network identifier in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1') and Solana chains (e.g., 'solana:mainnet'). Also accepts legacy numeric chain IDs for EVM (e.g., 1 for Ethereum). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.accepts.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Network identifier in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1') and Solana chains (e.g., 'solana:mainnet'). Also accepts legacy numeric chain IDs for EVM (e.g., 1 for Ethereum). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination2.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination2.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination2.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination2.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Tokens.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Tokens.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Tokens.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result28.Owners +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of token owners with amounts. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result29.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The chain ID of the chain + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result29.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The name of the chain + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result29.Icon +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The URL of the chain's icon + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result29.NativeCurrency +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Information about the native currency of the chain + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result30.Routes +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Supported bridge routes that match the provided filters. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result30.Pagination +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Pagination details for the returned routes. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result31.TransactionId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Payment transaction ID that was executed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result32.Message +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Message to display to the user + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result32.Link +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Link to purchase the product + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result32.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Payment ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result32.Quote +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Bridge quote for completing the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result33.Wallets +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of Solana wallets created for your project. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result33.Pagination +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Pagination details for the wallet list. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result34.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Base58 encoded Solana address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result34.Label +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional label associated with the wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result34.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO 8601 timestamp indicating when the wallet was created. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result34.UpdatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO 8601 timestamp indicating when the wallet was last updated. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result35.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Base58 encoded Solana address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result35.Label +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional label associated with the wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result35.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO 8601 timestamp indicating when the wallet was created. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result35.UpdatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO 8601 timestamp indicating when the wallet was last updated. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result36.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Requested Solana network. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result36.Decimals +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of decimals used by the token. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result36.DisplayValue +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Human-readable balance formatted using token decimals. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result36.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Raw balance value expressed in base units (lamports). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result37.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Base58 encoded signature returned from the signer. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result38.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Base58 encoded signature for the provided transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result38.SignedTransaction +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Base64 encoded signed transaction that can be broadcast to the Solana network. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result39.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction signature returned by the Solana network. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result40.TransactionId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Idempotency key assigned to the queued transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result41.TransactionId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Idempotency key assigned to the queued transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result42.TransactionId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Idempotency key assigned to the queued transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result43.TransactionId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Idempotency key assigned to the queued transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique identifier for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Solana network identifier in CAIP-2 format. Use "solana:mainnet" or "solana:devnet" for convenience, or full CAIP-2 format. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Signer address used on submission. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Signature recorded on-chain once available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.Status +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current status of the transaction in the processing pipeline. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.ConfirmedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Timestamp when the transaction reached the reported status. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.ConfirmedAtSlot +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Slot where the transaction was confirmed, if available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.BlockTime +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unix timestamp of the processed block. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO 8601 timestamp when the transaction was queued. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.ErrorMessage +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Error message if the transaction failed. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.ExecutionParams +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Resolved execution parameters used for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.ExecutionResult +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Raw execution result payload, if present. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.TransactionParams +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Original instruction payload submitted. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Result44.ClientId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Project client identifier. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Actions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Sign a transaction + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Payload2.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The signature of the payment + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Accounts +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Account metadata required for executing an instruction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Accounts.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Public key for the account. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Accounts.IsSigner +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether this account must sign the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Accounts.IsWritable +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether this account can be modified by the instruction. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.accounts +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Account metadata required for executing an instruction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.accounts.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Public key for the account. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.accounts.IsSigner +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether this account must sign the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.accounts.IsWritable +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether this account can be modified by the instruction. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Profiles +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Authentication provider details with type-based discrimination + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination3.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination3.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination3.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination3.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets.UserId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique identifier for the user wallet within the thirdweb auth system. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The EOA (Externally Owned Wallet) address of the wallet. This is the traditional wallet address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The date and time the wallet was created + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets.Profiles +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The profiles linked to the wallet, can be email, phone, google etc, or backend for developer created wallets + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets.SmartWalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The smart wallet address with EIP-4337 support. This address enables gasless transactions and advanced wallet features. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets.PublicKey +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet's public key in hexadecimal format. Useful for peer-to-peer encryption and cryptographic operations. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.profiles +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Authentication provider details with type-based discrimination + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination4.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination4.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination4.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination4.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.wallets.UserId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique identifier for the user wallet within the thirdweb auth system. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.wallets.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The EOA (Externally Owned Wallet) address of the wallet. This is the traditional wallet address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.wallets.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The date and time the wallet was created + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.wallets.Profiles +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The profiles linked to the wallet, can be email, phone, google etc, or backend for developer created wallets + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.wallets.SmartWalletAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The smart wallet address with EIP-4337 support. This address enables gasless transactions and advanced wallet features. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.wallets.PublicKey +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet's public key in hexadecimal format. Useful for peer-to-peer encryption and cryptographic operations. + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Profiles2 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Authentication provider details with type-based discrimination + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination5.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination5.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination5.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination5.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.BlockHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The hash of the block containing this transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The block number containing this transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.BlockTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The timestamp of the block (Unix timestamp). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The chain ID where the transaction occurred. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.ContractAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Contract address created if this was a contract creation transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.CumulativeGasUsed +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total gas used by all transactions in this block up to and including this one. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction input data. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.Decoded +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Decoded transaction data (included when ABI is available). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.EffectiveGasPrice +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The effective gas price paid (in wei as string). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.FromAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The address that initiated the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.FunctionSelector +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The function selector (first 4 bytes of the transaction data). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.Gas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The gas limit for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.GasPrice +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The gas price used for the transaction (in wei as string). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.GasUsed +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount of gas used by the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.Hash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction hash. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.MaxFeePerGas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Maximum fee per gas (EIP-1559). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.MaxPriorityFeePerGas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Maximum priority fee per gas (EIP-1559). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.Nonce +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction nonce. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.Status +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction status (1 for success, 0 for failure). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.ToAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The address that received the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.TransactionIndex +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The index of the transaction within the block. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.TransactionType +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction type (0=legacy, 1=EIP-2930, 2=EIP-1559). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.transactions.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The value transferred in the transaction (in wei as string). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination6.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination6.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination6.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination6.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Balance +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token balance as a string + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Chain_id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The chain ID of the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Decimals +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The number of decimal places + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token name + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Icon_uri +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token icon URI + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Price data + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Price_data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Price data for the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Symbol +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token symbol + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.tokens.Token_address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract address of the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Animation_url +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The animation URL of the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Attributes +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The attributes/traits of the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Chain_id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The chain ID of the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Collection +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Collection information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Description +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The description of the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.External_url +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The external URL of the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Image_url +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The image URL of the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Metadata +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Additional metadata for the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The name of the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Token_address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract address of the NFT collection + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Nfts.Token_id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The token ID of the NFT + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination7.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination7.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination7.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination7.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Contracts +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Contract details enriched with additional project information from the API server. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Contracts.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Contracts.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The chain ID where the contract is deployed. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Contracts.DeployedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The date when the contract was deployed. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Contracts.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract ID. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Contracts.ImportedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The date when the contract was imported to the dashboard. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Contracts.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract name, if available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Contracts.Symbol +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract symbol, if available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Contracts.Type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract type (e.g., ERC20, ERC721, etc.). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination8.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination8.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination8.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination8.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Block number when quote was generated + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote.Intent +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote intent details + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote.Steps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of steps to complete the bridge operation + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote.Timestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote timestamp + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.BlockHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The hash of the block containing this transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The block number containing this transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.BlockTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The timestamp of the block (Unix timestamp). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The chain ID where the transaction occurred. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.ContractAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Contract address created if this was a contract creation transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.CumulativeGasUsed +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total gas used by all transactions in this block up to and including this one. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction input data. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.Decoded +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Decoded transaction data (included when ABI is available). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.EffectiveGasPrice +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The effective gas price paid (in wei as string). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.FromAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The address that initiated the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.FunctionSelector +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The function selector (first 4 bytes of the transaction data). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.Gas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The gas limit for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.GasPrice +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The gas price used for the transaction (in wei as string). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.GasUsed +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount of gas used by the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.Hash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction hash. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.MaxFeePerGas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Maximum fee per gas (EIP-1559). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.MaxPriorityFeePerGas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Maximum priority fee per gas (EIP-1559). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.Nonce +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction nonce. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.Status +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction status (1 for success, 0 for failure). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.ToAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The address that received the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.TransactionIndex +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The index of the transaction within the block. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.TransactionType +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The transaction type (0=legacy, 1=EIP-2930, 2=EIP-1559). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.data.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The value transferred in the transaction (in wei as string). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination9.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination9.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination9.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination9.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The contract address that emitted the event. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.BlockHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The hash of the block containing this event. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The block number where the event was emitted. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.BlockTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The timestamp of the block (Unix timestamp). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The chain ID where the event occurred. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The non-indexed event data as a hex string. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.Decoded +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Decoded event data (included when ABI is available). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.LogIndex +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The index of the log within the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.Topics +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of indexed event topics (including event signature). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.TransactionHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The hash of the transaction containing this event. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Events.TransactionIndex +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The index of the transaction within the block. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination10.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination10.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination10.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination10.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Compiler.Version +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Solidity compiler version used to compile the contract. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Output.Abi +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Contract ABI (Application Binary Interface) as an array of function/event/error definitions. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Output.Devdoc +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Developer documentation extracted from contract comments. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Output.Userdoc +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +User documentation extracted from contract comments. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Settings.CompilationTarget +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Compilation target mapping source file names to contract names. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Settings.EvmVersion +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +EVM version target for compilation. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Settings.Libraries +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Library addresses for linking. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Settings.Metadata +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Metadata settings for compilation. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Settings.Optimizer +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optimizer settings used during compilation. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Settings.Remappings +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Import remappings used during compilation. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination11.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination11.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination11.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination11.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.BatchIndex +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Index within transaction batch + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.CancelledAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO timestamp when transaction was cancelled, if applicable + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Blockchain network identifier as string + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.ClientId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Client identifier that initiated the transaction + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.ConfirmedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO timestamp when transaction was confirmed on-chain + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.ConfirmedAtBlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Block number where transaction was confirmed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO timestamp when transaction was created + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.EnrichedData +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Additional metadata and enriched transaction information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.ErrorMessage +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Error message if transaction failed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.ExecutionParams +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Parameters used for transaction execution + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.ExecutionResult +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Result data from transaction execution + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Sender wallet address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Unique transaction identifier + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.TransactionHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +On-chain transaction hash once confirmed + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.TransactionParams +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Original transaction parameters and data + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions2.Status +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction status + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote2.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Block number when quote was generated + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote2.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote2.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote2.Intent +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote intent details + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote2.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote2.Steps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of steps to complete the bridge operation + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote2.Timestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote timestamp + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote3.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Block number when quote was generated + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote3.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote3.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote3.Intent +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote intent details + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote3.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote3.Steps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of steps to complete the bridge operation + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote3.Timestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote timestamp + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote4.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Block number when quote was generated + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote4.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote4.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote4.Intent +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote intent details + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote4.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote4.Steps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of steps to complete the bridge operation + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote4.Timestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote timestamp + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Accepts2.Network +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Network identifier in CAIP-2 format. Supports EVM chains (e.g., 'eip155:1') and Solana chains (e.g., 'solana:mainnet'). Also accepts legacy numeric chain IDs for EVM (e.g., 1 for Ethereum). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Owners.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Owner wallet address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Owners.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token amount owned as a string + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Owners.TokenId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token ID for NFTs + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination12.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination12.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination12.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination12.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.NativeCurrency.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The name of the native currency + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.NativeCurrency.Symbol +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The symbol of the native currency + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.NativeCurrency.Decimals +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The number of decimals used by the native currency + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Routes +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a supported bridge route between an origin and destination token. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination13.HasMore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether there are more items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination13.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of items per page + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination13.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination13.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of items available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote5.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Block number when quote was generated + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote5.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote5.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote5.Intent +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote intent details + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote5.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote5.Steps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of steps to complete the bridge operation + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Quote5.Timestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Quote timestamp + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Wallets2 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Details for a Solana wallet in your project. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets2.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Base58 encoded Solana address. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets2.Label +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional label associated with the wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets2.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO 8601 timestamp indicating when the wallet was created. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Wallets2.UpdatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +ISO 8601 timestamp indicating when the wallet was last updated. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination14.TotalCount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Total number of wallets available. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination14.Page +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Current page number. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Pagination14.Limit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of wallets returned per page. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Authorization.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The from address of the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Authorization.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The to address of the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Authorization.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The value of the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Authorization.ValidAfter +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The valid after timestamp of the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Authorization.ValidBefore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The valid before timestamp of the payment + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Authorization.Nonce +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The nonce of the payment + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Profiles3 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Authentication provider details with type-based discrimination + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.Profiles4 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Authentication provider details with type-based discrimination + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded.Inputs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Object containing decoded function parameters. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The function name. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The function signature. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Price_data.Circulating_supply +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The circulating supply of the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Price_data.Market_cap_usd +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The market cap of the token in USD + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Price_data.Percent_change_24h +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The percentage change of the token in the last 24 hours + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Price_data.Price_timestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The timestamp of the latest price update + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Price_data.Price_usd +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The price of the token in USD + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Price_data.Total_supply +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The total supply of the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Price_data.Usd_value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The value of the token balance in USD + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Price_data.Volume_24h_usd +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The volume of the token in USD + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Attributes.Display_type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The display type + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Attributes.Trait_type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The trait type + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Attributes.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The trait value + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Collection.Description +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The collection description + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Collection.External_url +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The collection external URL + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Collection.Image +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The collection image URL + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Collection.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The collection name + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent.DestinationChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent.DestinationTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent.OriginChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent.OriginTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent.Receiver +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Receiver address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent.Sender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps.OriginToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps.DestinationToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps.Transactions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of transactions for this step + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded2.Inputs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Object containing decoded function parameters. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded2.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The function name. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded2.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The function signature. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded3.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The event name. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded3.Params +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Object containing decoded parameters. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Decoded3.Signature +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The event signature. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Metadata2.BytecodeHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Hash method used for bytecode metadata. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Optimizer.Enabled +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Whether optimizer is enabled. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Optimizer.Runs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of optimizer runs. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent2.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent2.DestinationChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent2.DestinationTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent2.OriginChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent2.OriginTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent2.Receiver +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Receiver address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent2.Sender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.steps.OriginToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.steps.DestinationToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.steps.Transactions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of transactions for this step + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.steps.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.steps.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.steps.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent3.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent3.DestinationChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent3.DestinationTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent3.OriginChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent3.OriginTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent3.Receiver +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Receiver address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent3.Sender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps2.OriginToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps2.DestinationToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps2.Transactions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of transactions for this step + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps2.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps2.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps2.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DefaultAsset.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.SupportedAssets.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent4.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent4.DestinationChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent4.DestinationTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent4.OriginChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent4.OriginTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent4.Receiver +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Receiver address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent4.Sender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps3.OriginToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps3.DestinationToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps3.Transactions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of transactions for this step + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps3.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps3.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps3.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Chain identifier for the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token contract address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.Symbol +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token symbol + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token name + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.Decimals +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of decimals the token uses + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.IconUri +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional icon URL for the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.MarketCapUsd +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +24h market capitalization in USD when available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.Volume24hUsd +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +24h trading volume in USD when available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken2.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price quotes keyed by fiat currency code + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Chain identifier for the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token contract address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.Symbol +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token symbol + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token name + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.Decimals +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Number of decimals the token uses + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.IconUri +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Optional icon URL for the token + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.MarketCapUsd +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +24h market capitalization in USD when available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.Volume24hUsd +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +24h trading volume in USD when available + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken2.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price quotes keyed by fiat currency code + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent5.Amount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent5.DestinationChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent5.DestinationTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent5.OriginChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin chain ID + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent5.OriginTokenAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent5.Receiver +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Receiver address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Intent5.Sender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps4.OriginToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps4.DestinationToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination token information + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps4.Transactions +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Array of transactions for this step + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps4.OriginAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Origin amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps4.DestinationAmount +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Destination amount in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Steps4.EstimatedExecutionTimeMs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Estimated execution time in milliseconds + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken3.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken3.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken3.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken3.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken3.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken3.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions4.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Blockchain network identifier + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions4.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction recipient address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions4.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction data payload + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions4.Action +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Type of action this transaction performs + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions4.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions4.Spender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Spender address for approval transactions + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions4.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction value in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken4.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken4.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken4.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken4.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken4.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken4.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions5.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Blockchain network identifier + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions5.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction recipient address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions5.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction data payload + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions5.Action +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Type of action this transaction performs + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions5.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions5.Spender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Spender address for approval transactions + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions5.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction value in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken5.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken5.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken5.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken5.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken5.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken5.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions6.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Blockchain network identifier + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions6.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction recipient address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions6.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction data payload + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions6.Action +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Type of action this transaction performs + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions6.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions6.Spender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Spender address for approval transactions + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions6.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction value in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken6.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken6.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken6.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken6.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken6.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken6.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions7.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Blockchain network identifier + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions7.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction recipient address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions7.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction data payload + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions7.Action +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Type of action this transaction performs + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions7.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions7.Spender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Spender address for approval transactions + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions7.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction value in wei + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken7.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken7.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.OriginToken7.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken7.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The blockchain network identifier. Common values include: 1 (Ethereum), 8453 (Base), 137 (Polygon), 56 (BSC), 43114 (Avalanche), 42161 (Arbitrum), 10 (Optimism). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken7.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +A valid Ethereum address (0x-prefixed hex string) or ENS name (e.g., vitalik.eth). + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.DestinationToken7.Prices +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Token price in different FIAT currencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions8.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Blockchain network identifier + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions8.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction recipient address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions8.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction data payload + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions8.Action +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Type of action this transaction performs + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions8.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction sender address + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions8.Spender +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Spender address for approval transactions + +-------------------------------------------------------------------------------- +P:Thirdweb.Api.Transactions8.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Transaction value in wei + +-------------------------------------------------------------------------------- +T:Thirdweb.Api.ThirdwebHttpClientWrapper +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Wrapper class that adapts IThirdwebHttpClient to work with System.Net.Http.HttpClient expectations + +-------------------------------------------------------------------------------- +T:Thirdweb.ThirdwebClient +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a client for interacting with the Thirdweb API. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebClient.HttpClient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets the HTTP client used by the Thirdweb client. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebClient.ClientId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets the client ID. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebClient.Api +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Low-level interaction with https://api.thirdweb.com +Used in some places to enhance the core SDK functionality, or even extend it + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebClient.Create(System.String,System.String,System.String,Thirdweb.TimeoutOptions,Thirdweb.IThirdwebHttpClient,System.String,System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.Numerics.BigInteger,System.String}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - clientId (string) + The client ID (optional). + - secretKey (string) + The secret key (optional). + - bundleId (string) + The bundle ID (optional). + - fetchTimeoutOptions (Thirdweb.TimeoutOptions) + The fetch timeout options (optional). + - httpClient (Thirdweb.IThirdwebHttpClient) + The HTTP client (optional). + - sdkName (string) + The SDK name (optional). + - sdkOs (string) + The SDK OS (optional). + - sdkPlatform (string) + The SDK platform (optional). + - sdkVersion (string) + The SDK version (optional). + - rpcOverrides (Dictionary) + The timeout for storage operations (optional). + - rpc (Nullable) + The timeout for RPC operations (optional). + - other (Nullable) + The timeout for other operations (optional). + +SUMMARY: +Represents the timeout options for different types of operations. + +REMARKS: +Initializes a new instance of the class. + +-------------------------------------------------------------------------------- +M:Thirdweb.TimeoutOptions.GetTimeout(Thirdweb.TimeoutType,System.Int32) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - type (Thirdweb.TimeoutType) + The type of operation. + - fallback (int) + The fallback timeout value if none is specified (default is ). + +SUMMARY: +Gets the timeout value for the specified operation type. + +RETURNS: +The timeout value for the specified operation type. + +-------------------------------------------------------------------------------- +T:Thirdweb.TimeoutType +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Specifies the type of timeout for various operations. + +-------------------------------------------------------------------------------- +F:Thirdweb.TimeoutType.Storage +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +Timeout for storage operations. + +-------------------------------------------------------------------------------- +F:Thirdweb.TimeoutType.Rpc +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +Timeout for RPC operations. + +-------------------------------------------------------------------------------- +F:Thirdweb.TimeoutType.Other +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +Timeout for other types of operations. + +-------------------------------------------------------------------------------- +T:Thirdweb.ThirdwebContract +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a Thirdweb contract. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebContract.Deploy(Thirdweb.ThirdwebClient,System.Numerics.BigInteger,System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - chainId (System.Numerics.BigInteger) + The chain ID. + - serverWalletAddress (string) + The server wallet address. + - bytecode (string) + The bytecode of the contract. + - abi (string) + The ABI of the contract. + - constructorParams (Dictionary) + Optional metadata override for the token. + +SUMMARY: +Generate a mint signature for ERC721 tokens. + +RETURNS: +A task representing the asynchronous operation, with a tuple containing the mint request and the generated signature. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract, wallet, or mint request is null. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebExtensions.TokenERC721_VerifyMintSignature(Thirdweb.ThirdwebContract,Thirdweb.TokenERC721_MintRequest,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - contract (Thirdweb.ThirdwebContract) + The contract to interact with. + - mintRequest (Thirdweb.TokenERC721_MintRequest) + The mint request containing the minting details. + - signature (string) + The signature to verify. + +SUMMARY: +Verify a mint signature for ERC721 tokens. + +RETURNS: +A task representing the asynchronous operation, with a VerifyResult result containing the verification details. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract or mint request is null. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signature is null or empty. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebExtensions.TokenERC1155_Burn(Thirdweb.ThirdwebContract,Thirdweb.IThirdwebWallet,System.String,System.Numerics.BigInteger,System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - contract (Thirdweb.ThirdwebContract) + The contract to interact with. + - wallet (Thirdweb.IThirdwebWallet) + The wallet to use for the transaction. + - account (string) + The address of the account to burn the tokens from. + - tokenId (System.Numerics.BigInteger) + The ID of the token to burn. + - amount (System.Numerics.BigInteger) + The amount of tokens to burn. + +SUMMARY: +Burn a specific quantity of ERC1155 tokens for a specific account with a given token ID and amount to burn. + +RETURNS: +A task representing the asynchronous operation, with a ThirdwebTransactionReceipt result. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract, wallet, or account is null. + +EXCEPTION (T:System.ArgumentException): +Thrown when the account is null or empty. + +EXCEPTION (T:System.ArgumentOutOfRangeException): +Thrown when the token ID is less than 0 or the amount is less than or equal to 0. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebExtensions.TokenERC1155_BurnBatch(Thirdweb.ThirdwebContract,Thirdweb.IThirdwebWallet,System.String,System.Numerics.BigInteger[],System.Numerics.BigInteger[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - contract (Thirdweb.ThirdwebContract) + The contract to interact with. + - wallet (Thirdweb.IThirdwebWallet) + The wallet to use for the transaction. + - account (string) + The address of the account to burn the tokens from. + - tokenIds (System.Numerics.BigInteger[]) + The IDs of the tokens to burn. + - amounts (System.Numerics.BigInteger[]) + The amounts of tokens to burn. + +SUMMARY: +Burn a specific quantity of ERC1155 tokens for a specific account with given token IDs and amounts to burn. + +RETURNS: +A task representing the asynchronous operation, with a ThirdwebTransactionReceipt result. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract, wallet, or account is null. + +EXCEPTION (T:System.ArgumentException): +Thrown when the account is null or empty, or the token IDs or amounts are null or empty, or the token IDs and amounts have different lengths. + +EXCEPTION (T:System.ArgumentOutOfRangeException): +Thrown when the token IDs or amounts have a length less than or equal to 0. + +EXCEPTION (T:System.ArgumentException): +Thrown when the token IDs and amounts have different lengths. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebExtensions.TokenERC1155_MintTo(Thirdweb.ThirdwebContract,Thirdweb.IThirdwebWallet,System.String,System.Numerics.BigInteger,System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - contract (Thirdweb.ThirdwebContract) + The contract to interact with. + - wallet (Thirdweb.IThirdwebWallet) + The wallet to use for the transaction. + - receiverAddress (string) + The address of the receiver. + - tokenId (System.Numerics.BigInteger) + The ID of the token. + - quantity (System.Numerics.BigInteger) + The quantity of tokens to mint. + - uri (string) + The URI of the token metadata. + +SUMMARY: +Mint a specific quantity of ERC1155 tokens to a receiver address with a given URI. + +RETURNS: +A task representing the asynchronous operation, with a ThirdwebTransactionReceipt result. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract, wallet, or URI is null. + +EXCEPTION (T:System.ArgumentException): +Thrown when the receiver address is null or empty. + +EXCEPTION (T:System.ArgumentOutOfRangeException): +Thrown when the token ID is less than 0 or the quantity is less than or equal to 0. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebExtensions.TokenERC1155_MintTo(Thirdweb.ThirdwebContract,Thirdweb.IThirdwebWallet,System.String,System.Numerics.BigInteger,System.Numerics.BigInteger,Thirdweb.NFTMetadata) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - contract (Thirdweb.ThirdwebContract) + The contract to interact with. + - wallet (Thirdweb.IThirdwebWallet) + The wallet to use for the transaction. + - receiverAddress (string) + The address of the receiver. + - tokenId (System.Numerics.BigInteger) + The ID of the token. + - quantity (System.Numerics.BigInteger) + The quantity of tokens to mint. + - metadata (Thirdweb.NFTMetadata) + The metadata of the token. + +SUMMARY: +Mint a specific quantity of ERC1155 tokens to a receiver address with metadata. + +RETURNS: +A task representing the asynchronous operation, with a ThirdwebTransactionReceipt result. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract or wallet is null. + +EXCEPTION (T:System.ArgumentException): +Thrown when the receiver address is null or empty. + +EXCEPTION (T:System.ArgumentOutOfRangeException): +Thrown when the token ID is less than 0 or the quantity is less than or equal to 0. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebExtensions.TokenERC1155_MintWithSignature(Thirdweb.ThirdwebContract,Thirdweb.IThirdwebWallet,Thirdweb.TokenERC1155_MintRequest,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - contract (Thirdweb.ThirdwebContract) + The contract to interact with. + - wallet (Thirdweb.IThirdwebWallet) + The wallet to use for the transaction. + - mintRequest (Thirdweb.TokenERC1155_MintRequest) + The mint request containing the minting details. + - signature (string) + The signature to authorize the minting. + +SUMMARY: +Mint ERC1155 tokens with a signature. + +RETURNS: +A task representing the asynchronous operation, with a ThirdwebTransactionReceipt result. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract, wallet, or mint request is null. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signature is null or empty. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebExtensions.TokenERC1155_GenerateMintSignature(Thirdweb.ThirdwebContract,Thirdweb.IThirdwebWallet,Thirdweb.TokenERC1155_MintRequest,System.Nullable{Thirdweb.NFTMetadata}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - contract (Thirdweb.ThirdwebContract) + The contract to interact with. + - wallet (Thirdweb.IThirdwebWallet) + The wallet to use for generating the signature. + - mintRequest (Thirdweb.TokenERC1155_MintRequest) + The mint request containing the minting details. + - metadataOverride (Nullable) + Optional metadata override for the token. + +SUMMARY: +Generate a mint signature for ERC1155 tokens. + +RETURNS: +A task representing the asynchronous operation, with a tuple containing the mint request and the generated signature. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract, wallet, or mint request is null. + +EXCEPTION (T:System.ArgumentException): +Thrown when the MintRequest URI or NFTMetadata override is not provided. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebExtensions.TokenERC1155_VerifyMintSignature(Thirdweb.ThirdwebContract,Thirdweb.TokenERC1155_MintRequest,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - contract (Thirdweb.ThirdwebContract) + The contract to interact with. + - mintRequest (Thirdweb.TokenERC1155_MintRequest) + The mint request containing the minting details. + - signature (string) + The signature to verify. + +SUMMARY: +Verify a mint signature for ERC1155 tokens. + +RETURNS: +A task representing the asynchronous operation, with a VerifyResult result containing the verification details. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the contract or mint request is null. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signature is null or empty. + +-------------------------------------------------------------------------------- +T:Thirdweb.VerifyResult +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the result of a verification operation. + +-------------------------------------------------------------------------------- +P:Thirdweb.VerifyResult.IsValid +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets a value indicating whether the verification is valid. + +-------------------------------------------------------------------------------- +P:Thirdweb.VerifyResult.Signer +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the address of the signer. + +-------------------------------------------------------------------------------- +T:Thirdweb.RoyaltyInfoResult +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the royalty information result. + +-------------------------------------------------------------------------------- +P:Thirdweb.RoyaltyInfoResult.Recipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the recipient address. + +-------------------------------------------------------------------------------- +P:Thirdweb.RoyaltyInfoResult.Bps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the basis points (bps) for royalty. + +-------------------------------------------------------------------------------- +T:Thirdweb.ContractMetadata +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the metadata of a contract. + +-------------------------------------------------------------------------------- +P:Thirdweb.ContractMetadata.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the name of the contract. + +-------------------------------------------------------------------------------- +P:Thirdweb.ContractMetadata.Symbol +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the symbol of the contract. + +-------------------------------------------------------------------------------- +P:Thirdweb.ContractMetadata.Description +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the description of the contract. + +-------------------------------------------------------------------------------- +P:Thirdweb.ContractMetadata.Image +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the image URL of the contract. + +-------------------------------------------------------------------------------- +T:Thirdweb.NFTType +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the type of an NFT. + +-------------------------------------------------------------------------------- +T:Thirdweb.NFT +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents an NFT with metadata, owner, type, and supply information. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFT.Metadata +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the metadata of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFT.Owner +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the owner address of the NFT. This is only applicable for ERC721 tokens. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFT.Type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the type of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFT.Supply +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the supply of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFT.QuantityOwned +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the quantity owned by the user. This is only applicable for ERC1155 tokens. + +-------------------------------------------------------------------------------- +T:Thirdweb.NFTMetadata +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the metadata of an NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.Id +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the ID of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.Uri +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the URI of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.Description +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the description of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.Image +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the image URL of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.Name +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the name of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.VideoUrl +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the video URL of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.AnimationUrl +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the animation URL of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.ExternalUrl +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the external URL of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.BackgroundColor +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the background color of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.Attributes +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the attributes of the NFT. + +-------------------------------------------------------------------------------- +P:Thirdweb.NFTMetadata.Properties +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the properties of the NFT. + +-------------------------------------------------------------------------------- +T:Thirdweb.Drop_ClaimCondition +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a claim condition for a drop. + +-------------------------------------------------------------------------------- +P:Thirdweb.Drop_ClaimCondition.StartTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the start timestamp of the claim condition. + +-------------------------------------------------------------------------------- +P:Thirdweb.Drop_ClaimCondition.MaxClaimableSupply +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the maximum claimable supply. + +-------------------------------------------------------------------------------- +P:Thirdweb.Drop_ClaimCondition.SupplyClaimed +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the supply claimed so far. + +-------------------------------------------------------------------------------- +P:Thirdweb.Drop_ClaimCondition.QuantityLimitPerWallet +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the quantity limit per wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.Drop_ClaimCondition.MerkleRoot +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the Merkle root for the claim condition. + +-------------------------------------------------------------------------------- +P:Thirdweb.Drop_ClaimCondition.PricePerToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the price per token for the claim condition. + +-------------------------------------------------------------------------------- +P:Thirdweb.Drop_ClaimCondition.Currency +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the currency address for the claim condition. + +-------------------------------------------------------------------------------- +P:Thirdweb.Drop_ClaimCondition.Metadata +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the metadata for the claim condition. + +-------------------------------------------------------------------------------- +T:Thirdweb.TokenERC20_MintRequest +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a mint request for an ERC20 token. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC20_MintRequest.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the address to mint the tokens to. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC20_MintRequest.PrimarySaleRecipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the primary sale recipient address. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC20_MintRequest.Quantity +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the quantity of tokens to mint. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC20_MintRequest.Price +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the price of the tokens. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC20_MintRequest.Currency +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the currency address. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC20_MintRequest.ValidityStartTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the validity start timestamp. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC20_MintRequest.ValidityEndTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the validity end timestamp. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC20_MintRequest.Uid +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the unique identifier for the mint request. + +-------------------------------------------------------------------------------- +T:Thirdweb.TokenERC721_MintRequest +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a mint request for an ERC721 token. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the address to mint the token to. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.RoyaltyRecipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the royalty recipient address. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.RoyaltyBps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the royalty basis points. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.PrimarySaleRecipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the primary sale recipient address. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.Uri +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the URI of the token. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.Price +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the price of the token. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.Currency +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the currency address. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.ValidityStartTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the validity start timestamp. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.ValidityEndTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the validity end timestamp. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC721_MintRequest.Uid +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the unique identifier for the mint request. + +-------------------------------------------------------------------------------- +T:Thirdweb.TokenERC1155_MintRequest +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a mint request for an ERC1155 token. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the address to mint the token to. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.RoyaltyRecipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the royalty recipient address. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.RoyaltyBps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the royalty basis points. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.PrimarySaleRecipient +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the primary sale recipient address. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.TokenId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the token ID. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.Uri +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the URI of the token. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.Quantity +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the quantity of tokens to mint. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.PricePerToken +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the price per token. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.Currency +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the currency address. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.ValidityStartTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the validity start timestamp. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.ValidityEndTimestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the validity end timestamp. + +-------------------------------------------------------------------------------- +P:Thirdweb.TokenERC1155_MintRequest.Uid +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the unique identifier for the mint request. + +-------------------------------------------------------------------------------- +T:Thirdweb.IThirdwebHttpClient +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Interface for a HTTP client used in the Thirdweb SDK. + +-------------------------------------------------------------------------------- +P:Thirdweb.IThirdwebHttpClient.Headers +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets the headers for the HTTP client. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebHttpClient.SetHeaders(System.Collections.Generic.Dictionary{System.String,System.String}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - headers (Dictionary) + The optional request timeout in milliseconds. + +SUMMARY: +Downloads data from the specified URI. + +TYPEPARAM (T): +The type of data to download. + +RETURNS: +The downloaded data. + +EXCEPTION (T:System.ArgumentNullException): +Thrown if the URI is null or empty. + +EXCEPTION (T:System.Exception): +Thrown if the download fails. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebStorage.UploadRaw(Thirdweb.ThirdwebClient,System.Byte[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - rawBytes (byte[]) + The raw byte data to upload. + +SUMMARY: +Uploads raw byte data to Thirdweb storage. + +RETURNS: +The result of the upload. + +EXCEPTION (T:System.ArgumentNullException): +Thrown if the raw byte data is null or empty. + +EXCEPTION (T:System.Exception): +Thrown if the upload fails. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebStorage.Upload(Thirdweb.ThirdwebClient,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - path (string) + The path to the file. + +SUMMARY: +Uploads a file to Thirdweb storage from the specified path. + +RETURNS: +The result of the upload. + +EXCEPTION (T:System.ArgumentNullException): +Thrown if the path is null or empty. + +-------------------------------------------------------------------------------- +T:Thirdweb.IPFSUploadResult +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the result of an IPFS upload. + +-------------------------------------------------------------------------------- +P:Thirdweb.IPFSUploadResult.IpfsHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the IPFS hash of the uploaded content. + +-------------------------------------------------------------------------------- +P:Thirdweb.IPFSUploadResult.PinSize +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the size of the pinned content. + +-------------------------------------------------------------------------------- +P:Thirdweb.IPFSUploadResult.Timestamp +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the timestamp of the upload. + +-------------------------------------------------------------------------------- +P:Thirdweb.IPFSUploadResult.PreviewUrl +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the preview URL of the uploaded content. + +-------------------------------------------------------------------------------- +T:Thirdweb.TotalCosts +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the total costs in ether and wei. + +-------------------------------------------------------------------------------- +P:Thirdweb.TotalCosts.Ether +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The cost in ether. + +-------------------------------------------------------------------------------- +P:Thirdweb.TotalCosts.Wei +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The cost in wei. + +-------------------------------------------------------------------------------- +T:Thirdweb.ThirdwebTransaction +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a Thirdweb transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.Create(Thirdweb.IThirdwebWallet,Thirdweb.ThirdwebTransactionInput) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - wallet (Thirdweb.IThirdwebWallet) + The wallet to use for the transaction. + - txInput (Thirdweb.ThirdwebTransactionInput) + The transaction input. + +SUMMARY: +Creates a new Thirdweb transaction. + +RETURNS: +A new Thirdweb transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.ToString +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Converts the transaction input to a JSON string. + +RETURNS: +A JSON string representation of the transaction input. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetTo(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - to (string) + The recipient address. + +SUMMARY: +Sets the recipient address of the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetData(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - data (string) + The data. + +SUMMARY: +Sets the data for the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetValue(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - weiValue (System.Numerics.BigInteger) + The value in wei. + +SUMMARY: +Sets the value to be transferred in the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetGasLimit(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - gas (System.Numerics.BigInteger) + The gas limit. + +SUMMARY: +Sets the gas limit for the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetGasPrice(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - gasPrice (System.Numerics.BigInteger) + The gas price. + +SUMMARY: +Sets the gas price for the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetNonce(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - nonce (System.Numerics.BigInteger) + The nonce. + +SUMMARY: +Sets the nonce for the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetMaxFeePerGas(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - maxFeePerGas (System.Numerics.BigInteger) + The maximum fee per gas. + +SUMMARY: +Sets the maximum fee per gas for the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetMaxPriorityFeePerGas(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - maxPriorityFeePerGas (System.Numerics.BigInteger) + The maximum priority fee per gas. + +SUMMARY: +Sets the maximum priority fee per gas for the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetChainId(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID. + +SUMMARY: +Sets the chain ID for the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SetZkSyncOptions(Thirdweb.ZkSyncOptions) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - zkSyncOptions (Thirdweb.ZkSyncOptions) + The zkSync options. + +SUMMARY: +Sets the zkSync options for the transaction. + +RETURNS: +The updated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.EstimateGasCosts(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Estimates the gas costs for the transaction. + +RETURNS: +The estimated gas costs. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.EstimateTotalCosts(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Estimates the total costs for the transaction. + +RETURNS: +The estimated total costs. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.EstimateGasPrice(Thirdweb.ThirdwebTransaction,System.Boolean) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + - withBump (bool) + Whether to include a bump in the gas price. + +SUMMARY: +Estimates the gas price for the transaction. + +RETURNS: +The estimated gas price. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.EstimateGasFees(Thirdweb.ThirdwebTransaction,System.Boolean) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + - withBump (bool) + Whether to include a bump in the gas fees. + +SUMMARY: +Estimates the gas fees for the transaction. + +RETURNS: +The estimated maximum fee per gas and maximum priority fee per gas. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.Simulate(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Simulates the transaction. + +RETURNS: +The result of the simulation. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.EstimateGasLimit(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Estimates the gas limit for the transaction. + +RETURNS: +The estimated gas limit. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.GetNonce(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Gets the nonce for the transaction. + +RETURNS: +The nonce. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.Sign(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Signs the transaction. + +RETURNS: +The signed transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.Prepare(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Populates the transaction and prepares it for sending. + +RETURNS: +The populated transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.Send(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Sends the transaction. + +RETURNS: +The transaction hash. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.SendAndWaitForTransactionReceipt(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Sends the transaction and waits for the transaction receipt. + +RETURNS: +The transaction receipt. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.WaitForTransactionReceipt(Thirdweb.ThirdwebClient,System.Numerics.BigInteger,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - chainId (System.Numerics.BigInteger) + The chain ID. + - txHash (string) + The transaction hash. + - cancellationToken (System.Threading.CancellationToken) + The cancellation token. + +SUMMARY: +Waits for the transaction receipt. + +RETURNS: +The transaction receipt. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.WaitForTransactionHash(Thirdweb.ThirdwebClient,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - txId (string) + The thirdweb transaction id. + - cancellationToken (System.Threading.CancellationToken) + The cancellation token. + +SUMMARY: +Waits for the transaction hash given a thirdweb transaction id. Use WaitForTransactionReceipt if you have a transaction hash. + +RETURNS: +The transaction hash. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTransaction.ConvertToZkSyncTransaction(Thirdweb.ThirdwebTransaction) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransaction) + The transaction. + +SUMMARY: +Converts the transaction to a zkSync transaction. + +RETURNS: +The zkSync transaction. + +-------------------------------------------------------------------------------- +T:Thirdweb.ThirdwebTransactionInput +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the input parameters for a Thirdweb transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.Nonce +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the nonce of the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the sender address of the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the recipient address of the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.Gas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the gas limit for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.GasPrice +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the gas price for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.Value +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the value to be transferred in the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.Data +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the data to be sent with the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.MaxFeePerGas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the maximum fee per gas for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.MaxPriorityFeePerGas +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the maximum priority fee per gas for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the chain ID for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionInput.ZkSync +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the zkSync options for the transaction. + +-------------------------------------------------------------------------------- +T:Thirdweb.ZkSyncOptions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the zkSync options for a transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ZkSyncOptions.GasPerPubdataByteLimit +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the gas limit per pubdata byte. + +-------------------------------------------------------------------------------- +P:Thirdweb.ZkSyncOptions.FactoryDeps +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the factory dependencies. + +-------------------------------------------------------------------------------- +P:Thirdweb.ZkSyncOptions.Paymaster +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the paymaster. + +-------------------------------------------------------------------------------- +P:Thirdweb.ZkSyncOptions.PaymasterInput +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the paymaster input data. + +-------------------------------------------------------------------------------- +M:Thirdweb.ZkSyncOptions.#ctor(System.String,System.String,System.Nullable{System.Numerics.BigInteger},System.Collections.Generic.List{System.Byte[]}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - paymaster (string) + The paymaster. + - paymasterInput (string) + The paymaster input data. + - gasPerPubdataByteLimit (Nullable) + The gas limit per pubdata byte. + - factoryDeps (List) + The factory dependencies. + +SUMMARY: +Initializes a new instance of the struct. + +-------------------------------------------------------------------------------- +T:Thirdweb.ThirdwebTransactionReceipt +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the receipt of a transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.TransactionHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the transaction hash. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.TransactionIndex +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the transaction index within the block. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.BlockHash +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the hash of the block containing the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.BlockNumber +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the number of the block containing the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.From +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the address of the sender. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.To +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the address of the recipient. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.CumulativeGasUsed +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the cumulative gas used by the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.GasUsed +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the gas used by the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.EffectiveGasPrice +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the effective gas price for the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.ContractAddress +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the contract address created by the transaction, if applicable. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.Status +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the status of the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.Logs +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the logs generated by the transaction. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.Type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the transaction type. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.LogsBloom +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the logs bloom filter. + +-------------------------------------------------------------------------------- +P:Thirdweb.ThirdwebTransactionReceipt.Root +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the root of the transaction. + +-------------------------------------------------------------------------------- +T:Thirdweb.EIP712 +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Provides methods for generating and signing EIP712 compliant messages and transactions. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GenerateSignature_SmartAccount_7702_WrappedCalls(System.String,System.String,System.Numerics.BigInteger,System.String,Thirdweb.AccountAbstraction.WrappedCalls,Thirdweb.IThirdwebWallet) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + - wrappedCalls (Thirdweb.AccountAbstraction.WrappedCalls) + The wrapped calls request. + - signer (Thirdweb.IThirdwebWallet) + The wallet signer. + +SUMMARY: +Generates a signature for a 7702 smart account wrapped calls request. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GenerateSignature_SmartAccount_7702(System.String,System.String,System.Numerics.BigInteger,System.String,Thirdweb.AccountAbstraction.SessionSpec,Thirdweb.IThirdwebWallet) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + - sessionKeyParams (Thirdweb.AccountAbstraction.SessionSpec) + The session key request. + - signer (Thirdweb.IThirdwebWallet) + The wallet signer. + +SUMMARY: +Generates a signature for a 7702 smart account session key. + +RETURNS: +The generated signature. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GenerateSignature_SmartAccount(System.String,System.String,System.Numerics.BigInteger,System.String,Thirdweb.AccountAbstraction.SignerPermissionRequest,Thirdweb.IThirdwebWallet) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + - signerPermissionRequest (Thirdweb.AccountAbstraction.SignerPermissionRequest) + The signer permission request. + - signer (Thirdweb.IThirdwebWallet) + The wallet signer. + +SUMMARY: +Generates a signature for a smart account permission request. + +RETURNS: +The generated signature. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GenerateSignature_SmartAccount_AccountMessage(System.String,System.String,System.Numerics.BigInteger,System.String,System.Byte[],Thirdweb.IThirdwebWallet) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + - message (byte[]) + The message to sign. + - signer (Thirdweb.IThirdwebWallet) + The wallet signer. + +SUMMARY: +Generates a signature for a smart account message. + +RETURNS: +The generated signature. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GenerateSignature_ZkSyncTransaction(System.String,System.String,System.Numerics.BigInteger,Thirdweb.AccountAbstraction.ZkSyncAATransaction,Thirdweb.IThirdwebWallet) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - transaction (Thirdweb.AccountAbstraction.ZkSyncAATransaction) + The zkSync transaction. + - signer (Thirdweb.IThirdwebWallet) + The wallet signer. + +SUMMARY: +Generates a signature for a zkSync transaction. + +RETURNS: +The generated signature. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GenerateSignature_TokenERC20(System.String,System.String,System.Numerics.BigInteger,System.String,Thirdweb.TokenERC20_MintRequest,Thirdweb.IThirdwebWallet) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + - mintRequest (Thirdweb.TokenERC20_MintRequest) + The mint request. + - signer (Thirdweb.IThirdwebWallet) + The wallet signer. + +SUMMARY: +Generates a signature for an ERC20 token mint request. + +RETURNS: +The generated signature. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GenerateSignature_TokenERC721(System.String,System.String,System.Numerics.BigInteger,System.String,Thirdweb.TokenERC721_MintRequest,Thirdweb.IThirdwebWallet) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + - mintRequest (Thirdweb.TokenERC721_MintRequest) + The mint request. + - signer (Thirdweb.IThirdwebWallet) + The wallet signer. + +SUMMARY: +Generates a signature for an ERC721 token mint request. + +RETURNS: +The generated signature. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GenerateSignature_TokenERC1155(System.String,System.String,System.Numerics.BigInteger,System.String,Thirdweb.TokenERC1155_MintRequest,Thirdweb.IThirdwebWallet) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + - mintRequest (Thirdweb.TokenERC1155_MintRequest) + The mint request. + - signer (Thirdweb.IThirdwebWallet) + The wallet signer. + +SUMMARY: +Generates a signature for an ERC1155 token mint request. + +RETURNS: +The generated signature. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GetTypedDefinition_SmartAccount_7702_WrappedCalls(System.String,System.String,System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + +SUMMARY: +Gets the typed data definition for a 7702 smart account wrapped calls request. + +RETURNS: +The typed data definition. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GetTypedDefinition_SmartAccount_7702(System.String,System.String,System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + +SUMMARY: +Gets the typed data definition for a 7702 smart account session key. + +RETURNS: +The typed data definition. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GetTypedDefinition_SmartAccount(System.String,System.String,System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + +SUMMARY: +Gets the typed data definition for a smart account permission request. + +RETURNS: +The typed data definition. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GetTypedDefinition_SmartAccount_AccountMessage(System.String,System.String,System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + +SUMMARY: +Gets the typed data definition for a smart account message. + +RETURNS: +The typed data definition. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GetTypedDefinition_ZkSyncTransaction(System.String,System.String,System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + +SUMMARY: +Gets the typed data definition for a zkSync transaction. + +RETURNS: +The typed data definition. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GetTypedDefinition_TokenERC20(System.String,System.String,System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + +SUMMARY: +Gets the typed data definition for a TokenERC20 mint request. + +RETURNS: +The typed data definition. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GetTypedDefinition_TokenERC721(System.String,System.String,System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + +SUMMARY: +Gets the typed data definition for a TokenERC721 mint request. + +RETURNS: +The typed data definition. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.GetTypedDefinition_TokenERC1155(System.String,System.String,System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - domainName (string) + The domain name. + - version (string) + The version. + - chainId (System.Numerics.BigInteger) + The chain ID. + - verifyingContract (string) + The verifying contract. + +SUMMARY: +Gets the typed data definition for a TokenERC1155 mint request. + +RETURNS: +The typed data definition. + +-------------------------------------------------------------------------------- +M:Thirdweb.EIP712.SerializeEip712(Thirdweb.AccountAbstraction.ZkSyncAATransaction,Nethereum.Signer.EthECDSASignature,System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.AccountAbstraction.ZkSyncAATransaction) + The transaction. + - signature (Nethereum.Signer.EthECDSASignature) + The ECDSA signature. + - chainId (System.Numerics.BigInteger) + The chain ID. + +SUMMARY: +Serializes an EIP712 zkSync transaction. + +RETURNS: +The serialized transaction. + +-------------------------------------------------------------------------------- +F:Thirdweb.RLP.SIZE_THRESHOLD +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +Reason for threshold according to Vitalik Buterin: +- 56 bytes maximizes the benefit of both options +- if we went with 60 then we would have only had 4 slots for long strings +so RLP would not have been able to store objects above 4gb +- if we went with 48 then RLP would be fine for 2^128 space, but that's way too much +- so 56 and 2^64 space seems like the right place to put the cutoff +- also, that's where Bitcoin's varint does the cutof + +-------------------------------------------------------------------------------- +F:Thirdweb.RLP.OFFSET_SHORT_ITEM +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +[0x80] +If a string is 0-55 bytes long, the RLP encoding consists of a single +byte with value 0x80 plus the length of the string followed by the +string. The range of the first byte is thus [0x80, 0xb7]. + +-------------------------------------------------------------------------------- +F:Thirdweb.RLP.OFFSET_LONG_ITEM +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +[0xb7] +If a string is more than 55 bytes long, the RLP encoding consists of a +single byte with value 0xb7 plus the length of the length of the string +in binary form, followed by the length of the string, followed by the +string. For example, a length-1024 string would be encoded as +\xb9\x04\x00 followed by the string. The range of the first byte is thus +[0xb8, 0xbf]. + +-------------------------------------------------------------------------------- +F:Thirdweb.RLP.OFFSET_SHORT_LIST +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +[0xc0] +If the total payload of a list (i.e. the combined length of all its +items) is 0-55 bytes long, the RLP encoding consists of a single byte +with value 0xc0 plus the length of the list followed by the concatenation +of the RLP encodings of the items. The range of the first byte is thus +[0xc0, 0xf7]. + +-------------------------------------------------------------------------------- +F:Thirdweb.RLP.OFFSET_LONG_LIST +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +[0xf7] +If the total payload of a list is more than 55 bytes long, the RLP +encoding consists of a single byte with value 0xf7 plus the length of the +length of the list in binary form, followed by the length of the list, +followed by the concatenation of the RLP encodings of the items. The +range of the first byte is thus [0xf8, 0xff]. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTask.Delay(System.Int32,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - millisecondsDelay (int) + The number of milliseconds to delay. + - cancellationToken (System.Threading.CancellationToken) + A cancellation token to cancel the delay. + +SUMMARY: +Simulates a delay without using Task.Delay or System.Threading.Timer, specifically designed to avoid clashing with WebGL threading. + +RETURNS: +A task that completes after the specified delay. + +-------------------------------------------------------------------------------- +M:Thirdweb.ThirdwebTask.MinimalDelay(System.Int32) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - milliseconds (int) + The number of milliseconds to delay. + +SUMMARY: +Provides a minimal delay using a manual loop with short sleeps to reduce CPU usage. + +-------------------------------------------------------------------------------- +T:Thirdweb.Utils +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Provides utility methods for various operations. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.ComputeClientIdFromSecretKey(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - secretKey (string) + The secret key. + +SUMMARY: +Computes the client ID from the given secret key. + +RETURNS: +The computed client ID. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HexConcat(System.String[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - hexStrings (string[]) + The hex strings to concatenate. + +SUMMARY: +Concatenates the given hex strings. + +RETURNS: +The concatenated hex string. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HashPrefixedMessage(System.Byte[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - messageBytes (byte[]) + The message bytes to hash. + +SUMMARY: +Hashes the given message bytes with a prefixed message. + +RETURNS: +The hashed message bytes. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HashPrefixedMessage(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - message (string) + The message to hash. + +SUMMARY: +Hashes the given message with a prefixed message. + +RETURNS: +The hashed message. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HashMessage(System.Byte[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - messageBytes (byte[]) + The message bytes to hash. + +SUMMARY: +Hashes the given message bytes. + +RETURNS: +The hashed message bytes. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HashMessage(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - message (string) + The message to hash. + +SUMMARY: +Hashes the given message. + +RETURNS: +The hashed message. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.BytesToHex(System.Byte[],System.Boolean) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - bytes (byte[]) + The bytes to convert. + - addPrefix (bool) + Whether to add the "0x" prefix. + +SUMMARY: +Converts the given bytes to a hex string. + +RETURNS: +The hex string. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HexToBytes(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - hex (string) + The hex string to convert. + +SUMMARY: +Converts the given hex string to bytes. + +RETURNS: +The bytes. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HexToBigInt(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - hex (string) + The hex string to convert. + +SUMMARY: +Converts the given hex string to a big integer. + +RETURNS: +The big integer. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HexToNumber(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - hex (string) + The hex string to convert. + +SUMMARY: +Converts the given hex string to a big integer. + +RETURNS: +The big integer. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.NumberToHex(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (System.Numerics.BigInteger) + +SUMMARY: +Converts the given big integer to a hex string. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.NumberToHex(System.Int32) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (int) + +SUMMARY: +Converts the given integer to a hex string. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.NumberToHex(System.Int64) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (long) + +SUMMARY: +Converts the given long to a hex string. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.StringToHex(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - str (string) + The string to convert. + +SUMMARY: +Converts the given string to a hex string. + +RETURNS: +The hex string. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.HexToString(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - hex (string) + The hex string to convert. + +SUMMARY: +Converts the given hex string to a regular string. + +RETURNS: +The regular string. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.GetUnixTimeStampNow +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Gets the current Unix timestamp. + +RETURNS: +The current Unix timestamp. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.GetUnixTimeStampIn10Years +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Gets the Unix timestamp for 10 years from now. + +RETURNS: +The Unix timestamp for 10 years from now. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.ReplaceIPFS(System.String,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - uri (string) + The URI to replace. + - gateway (string) + The gateway to use. + +SUMMARY: +Replaces the IPFS URI with a specified gateway. + +RETURNS: +The replaced URI. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.ToWei(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - eth (string) + The ether value to convert. + +SUMMARY: +Converts the given ether value to wei. + +RETURNS: +The wei value. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.ToEth(System.String,System.Int32,System.Boolean) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - wei (string) + The wei value to convert. + - decimalsToDisplay (int) + The number of decimals to display. + - addCommas (bool) + Whether to add commas to the output. + +SUMMARY: +Converts the given wei value to ether. + +RETURNS: +The ether value. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.FormatERC20(System.String,System.Int32,System.Int32,System.Boolean) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - wei (string) + The wei value to format. + - decimalsToDisplay (int) + The number of decimals to display. + - decimals (int) + The number of decimals of the token. + - addCommas (bool) + Whether to add commas to the output. + +SUMMARY: +Formats the given ERC20 token value. + +RETURNS: +The formatted token value. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.GenerateSIWE(Thirdweb.LoginPayloadData) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - loginPayloadData (Thirdweb.LoginPayloadData) + The login payload data. + +SUMMARY: +Generates a Sign-In With Ethereum (SIWE) message. + +RETURNS: +The generated SIWE message. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.IsZkSync(Thirdweb.ThirdwebClient,System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - chainId (System.Numerics.BigInteger) + The chain ID. + +SUMMARY: +Checks if the chain ID corresponds to zkSync. + +RETURNS: +True if it is a zkSync chain ID, otherwise false. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.ToChecksumAddress(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - address (string) + The Ethereum address. + +SUMMARY: +Converts an Ethereum address to its checksum format. + +RETURNS: +The checksummed Ethereum address. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.AdjustDecimals(System.Numerics.BigInteger,System.Int32,System.Int32) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - value (System.Numerics.BigInteger) + The value. + - fromDecimals (int) + The original number of decimals. + - toDecimals (int) + The target number of decimals. + +SUMMARY: +Adjusts the value's decimals. + +RETURNS: +The value adjusted to the new decimals. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.GetSocialProfiles(Thirdweb.ThirdwebClient,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - addressOrEns (string) + The wallet address or ENS. + +SUMMARY: +Gets the social profiles for the given address or ENS. + +RETURNS: +A object containing the social profiles. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when the address or ENS is null or empty. + +EXCEPTION (T:System.ArgumentException): +Thrown when the address or ENS is invalid. + +EXCEPTION (T:System.Exception): +Thrown when the social profiles could not be fetched. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.PreprocessTypedDataJson(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - json (string) + The typed data JSON. + +SUMMARY: +Preprocesses the typed data JSON to stringify large numbers. + +RETURNS: +The preprocessed typed data JSON. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.SerializeErc6492Signature(System.String,System.Byte[],System.Byte[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - address (string) + The ERC-4337 Account Factory address + - data (byte[]) + Account deployment calldata (if not deployed) for counterfactual verification + - signature (byte[]) + The original signature + +SUMMARY: +Serializes a signature for use with ERC-6492. The signature must be generated by a signer for an ERC-4337 Account Factory account with counterfactual deployment addresses. + +RETURNS: +The serialized signature hex string. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.TrimZeroes(System.Byte[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - param1 (byte[]) + +SUMMARY: +Removes leading zeroes from the given byte array. + +-------------------------------------------------------------------------------- +M:Thirdweb.Utils.WaitForTransactionReceipt(Thirdweb.ThirdwebClient,System.Numerics.BigInteger,System.String,System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - chainId (System.Numerics.BigInteger) + The chain ID. + - txHash (string) + The transaction hash. + - cancellationToken (System.Threading.CancellationToken) + The cancellation token. + +SUMMARY: +Waits for the transaction receipt. + +RETURNS: +The transaction receipt. + +-------------------------------------------------------------------------------- +T:Thirdweb.SocialProfiles +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +SocialProfiles object that contains all the different types of social profiles and their respective metadata. + +-------------------------------------------------------------------------------- +T:Thirdweb.EcosystemWallet +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Enclave based secure cross ecosystem wallet. + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.Create(Thirdweb.ThirdwebClient,System.String,System.String,System.String,System.String,Thirdweb.AuthProvider,System.String,Thirdweb.IThirdwebWallet,System.String,System.String,Thirdweb.ExecutionMode) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - ecosystemId (Thirdweb.ThirdwebClient) + Your ecosystem ID (see thirdweb dashboard e.g. ecosystem.the-bonfire). + - ecosystemPartnerId (string) + Your ecosystem partner ID (required if you are integrating someone else's ecosystem). + - client (string) + The Thirdweb client instance. + - email (string) + The email address for Email OTP authentication. + - phoneNumber (string) + The phone number for Phone OTP authentication. + - authProvider (Thirdweb.AuthProvider) + The authentication provider to use. + - storageDirectoryPath (string) + The path to the storage directory. + - siweSigner (Thirdweb.IThirdwebWallet) + The SIWE signer wallet for SIWE authentication. + - walletSecret (string) + The wallet secret for Backend authentication. + - twAuthTokenOverride (string) + The auth token to use for the session. This will automatically connect using a raw thirdweb auth token. + - executionMode (Thirdweb.ExecutionMode) + The execution mode for the wallet. EOA represents traditional direct calls, EIP7702 represents upgraded account self sponsored calls, and EIP7702Sponsored represents upgraded account calls with managed/sponsored execution. + +SUMMARY: +Creates a new instance of the class. + +RETURNS: +A task that represents the asynchronous operation. The task result contains the created in-app wallet. + +EXCEPTION (T:System.ArgumentException): +Thrown when required parameters are not provided. + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.GetUserDetails +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Gets the user details from the enclave wallet. For auth provider specific details use GetUserAuthDetails. + +RETURNS: +A task that represents the asynchronous operation. The task result contains the user details. + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.GetUserAuthDetails +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Gets the user auth details from the corresponding auth provider. For linked account details use GetUserDetails or GetLinkedAccounts. + +RETURNS: +The user auth details as a JObject + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.GetEcosystemDetails +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Returns Ecosystem metadata (set in thirdweb Dashboard) + +RETURNS: +Instance of containing metadata + +EXCEPTION (T:System.InvalidOperationException): +Thrown when called on an InAppWallet + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.GenerateExternalLoginLink(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - redirectUrl (string) + The URL of your thirdweb-powered website. + +SUMMARY: +Returns a link that can be used to transfer the .NET wallet session to a thirdweb powered React website for seamless integration. + +RETURNS: +The URL to redirect the user to. + +EXCEPTION (T:System.InvalidOperationException): +Thrown when no connected session is found + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.CreateSessionKey(System.Numerics.BigInteger,System.String,System.Int64,System.Boolean,System.Collections.Generic.List{Thirdweb.AccountAbstraction.CallSpec},System.Collections.Generic.List{Thirdweb.AccountAbstraction.TransferSpec},System.Byte[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID for the session key. + - signerAddress (string) + The address of the signer for the session key. + - durationInSeconds (long) + Duration in seconds for which the session key will be valid. + - grantFullPermissions (bool) + Whether to grant full permissions to the session key. If false, only the specified call and transfer policies will be applied. + - callPolicies (List) + List of call policies to apply to the session key. If null, no call policies will be applied. + - transferPolicies (List) + List of transfer policies to apply to the session key. If null, no transfer policies will be applied. + - uid (byte[]) + A unique identifier for the session key. If null, a new GUID will be generated. + +SUMMARY: +Creates a session key for the user wallet. This is only supported for EIP7702 and EIP7702Sponsored execution modes. + +RETURNS: +A task that represents the asynchronous operation. The task result contains the transaction receipt for the session key creation. + +EXCEPTION (T:System.InvalidOperationException): +Thrown when the execution mode is not EIP7702 or EIP7702Sponsored. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signer address is null or empty, or when the duration is less than or equal to zero. + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.SignerHasFullPermissions(System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID of the EIP7702 account. + - signerAddress (string) + The address of the signer to check permissions for. + +SUMMARY: +Checks if the signer has full permissions on the EIP7702 account. + +RETURNS: +A task that represents the asynchronous operation. The task result contains a boolean indicating whether the signer has full permissions. + +EXCEPTION (T:System.InvalidOperationException): +Thrown when the execution mode is not EIP7702 or EIP7702Sponsored. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signer address is null or empty. + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.GetCallPoliciesForSigner(System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID of the EIP7702 account. + - signerAddress (string) + The address of the signer to get call policies for. + +SUMMARY: +Gets the call policies for a specific signer on the EIP7702 account. + +RETURNS: +A task that represents the asynchronous operation. The task result contains a list of call policies for the signer. + +EXCEPTION (T:System.InvalidOperationException): +Thrown when the execution mode is not EIP7702 or EIP7702Sponsored. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signer address is null or empty. + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.GetTransferPoliciesForSigner(System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID of the EIP7702 account. + - signerAddress (string) + The address of the signer to get transfer policies for. + +SUMMARY: +Gets the transfer policies for a specific signer on the EIP7702 account. + +RETURNS: +A task that represents the asynchronous operation. The task result contains a list of transfer policies for the signer. + +EXCEPTION (T:System.InvalidOperationException): +Thrown when the execution mode is not EIP7702 or EIP7702Sponsored. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signer address is null or empty. + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.GetSessionExpirationForSigner(System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID of the EIP7702 account. + - signerAddress (string) + The address of the signer to get session expiration for. + +SUMMARY: +Gets the session expiration timestamp for a specific signer on the EIP7702 account. + +RETURNS: +A task that represents the asynchronous operation. The task result contains the session expiration timestamp. + +EXCEPTION (T:System.InvalidOperationException): +Thrown when the execution mode is not EIP7702 or EIP7702Sponsored. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signer address is null or empty. + +-------------------------------------------------------------------------------- +M:Thirdweb.EcosystemWallet.GetSessionStateForSigner(System.Numerics.BigInteger,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID of the EIP7702 account. + - signerAddress (string) + The address of the signer to get session state for. + +SUMMARY: +Gets the complete session state for a specific signer on the EIP7702 account, including remaining limits and usage information. + +RETURNS: +A task that represents the asynchronous operation. The task result contains the session state with transfer value limits, call value limits, and call parameter limits. + +EXCEPTION (T:System.InvalidOperationException): +Thrown when the execution mode is not EIP7702 or EIP7702Sponsored. + +EXCEPTION (T:System.ArgumentException): +Thrown when the signer address is null or empty. + +-------------------------------------------------------------------------------- +T:Thirdweb.EcosystemWallet.UserStatusResponse +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +User linked account details. + +-------------------------------------------------------------------------------- +P:Thirdweb.EcosystemWallet.UserStatusResponse.LinkedAccounts +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The user's linked accounts. + +-------------------------------------------------------------------------------- +P:Thirdweb.EcosystemWallet.UserStatusResponse.Wallets +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The user's wallets, generally only one wallet is returned. + +-------------------------------------------------------------------------------- +T:Thirdweb.EcosystemWallet.ShardedOrEnclaveWallet +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a user's embedded wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.EcosystemWallet.ShardedOrEnclaveWallet.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The public address of the wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.EcosystemWallet.ShardedOrEnclaveWallet.CreatedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The wallet's creation date. + +-------------------------------------------------------------------------------- +T:Thirdweb.InAppWallet +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents an in-app wallet that supports email, phone, social, SIWE and custom authentication. + +-------------------------------------------------------------------------------- +M:Thirdweb.InAppWallet.Create(Thirdweb.ThirdwebClient,System.String,System.String,Thirdweb.AuthProvider,System.String,Thirdweb.IThirdwebWallet,System.String,System.String,Thirdweb.ExecutionMode) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client instance. + - email (string) + The email address for Email OTP authentication. + - phoneNumber (string) + The phone number for Phone OTP authentication. + - authProvider (Thirdweb.AuthProvider) + The authentication provider to use. + - storageDirectoryPath (string) + The path to the storage directory. + - siweSigner (Thirdweb.IThirdwebWallet) + The SIWE signer wallet for SIWE authentication. + - walletSecret (string) + The wallet secret for backend authentication. + - twAuthTokenOverride (string) + The auth token to use for the session. This will automatically connect using a raw thirdweb auth token. + - executionMode (Thirdweb.ExecutionMode) + The execution mode for the wallet. EOA represents traditional direct calls, EIP7702 represents upgraded account self sponsored calls, and EIP7702Sponsored represents upgraded account calls with managed/sponsored execution. + +SUMMARY: +Creates a new instance of the class. + +RETURNS: +A task that represents the asynchronous operation. The task result contains the created in-app wallet. + +EXCEPTION (T:System.ArgumentException): +Thrown when required parameters are not provided. + +-------------------------------------------------------------------------------- +T:Thirdweb.AuthProvider +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Specifies the authentication providers available for the in-app wallet. + +-------------------------------------------------------------------------------- +T:Thirdweb.LinkedAccount +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a linked account. + +-------------------------------------------------------------------------------- +P:Thirdweb.LinkedAccount.Type +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +The auth provider method used to create or link this account. + +-------------------------------------------------------------------------------- +P:Thirdweb.LinkedAccount.Details +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Additional details about the linked account. + +-------------------------------------------------------------------------------- +T:Thirdweb.LinkedAccount.LinkedAccountDetails +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +The email, address, phone and id related to the linked account, where applicable. + +-------------------------------------------------------------------------------- +T:Thirdweb.InAppWalletBrowser +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents an in-app browser for handling wallet login. + +-------------------------------------------------------------------------------- +M:Thirdweb.InAppWalletBrowser.Login(Thirdweb.ThirdwebClient,System.String,System.String,System.Action{System.String},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client instance. + - loginUrl (string) + The URL to initiate the login process. + - redirectUrl (string) + The URL to redirect to after login. + - browserOpenAction (System.Action) + An action to open the browser with the login URL. + - cancellationToken (System.Threading.CancellationToken) + Optional cancellation token to cancel the operation. + +SUMMARY: +Initiates a login process using the in-app browser. + +RETURNS: +A task representing the asynchronous operation. The task result contains the login result. + +-------------------------------------------------------------------------------- +M:Thirdweb.InAppWalletBrowser.StopHttpListener +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Stops the HTTP listener. + +-------------------------------------------------------------------------------- +M:Thirdweb.InAppWalletBrowser.IncomingHttpRequest(System.IAsyncResult) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - result (System.IAsyncResult) + The result of the asynchronous operation. + +SUMMARY: +Handles incoming HTTP requests. + +-------------------------------------------------------------------------------- +M:Thirdweb.InAppWalletBrowser.AddForwardSlashIfNecessary(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - url (string) + The URL to check. + +SUMMARY: +Adds a forward slash to the URL if necessary. + +RETURNS: +The URL with a forward slash added if necessary. + +-------------------------------------------------------------------------------- +T:Thirdweb.IThirdwebBrowser +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Defines an interface for handling browser-based login for Thirdweb. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebBrowser.Login(Thirdweb.ThirdwebClient,System.String,System.String,System.Action{System.String},System.Threading.CancellationToken) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client instance. + - loginUrl (string) + The URL to initiate the login process. + - redirectUrl (string) + The URL to redirect to after login. + - browserOpenAction (System.Action) + An action to open the browser with the login URL. + - cancellationToken (System.Threading.CancellationToken) + Optional cancellation token to cancel the operation. + +SUMMARY: +Initiates a login process using the browser. + +RETURNS: +A task representing the asynchronous operation. The task result contains the login result. + +-------------------------------------------------------------------------------- +T:Thirdweb.BrowserStatus +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Enumerates the possible statuses of a browser operation. + +-------------------------------------------------------------------------------- +F:Thirdweb.BrowserStatus.Success +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +The operation was successful. + +-------------------------------------------------------------------------------- +F:Thirdweb.BrowserStatus.UserCanceled +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +The user canceled the operation. + +-------------------------------------------------------------------------------- +F:Thirdweb.BrowserStatus.Timeout +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +The operation timed out. + +-------------------------------------------------------------------------------- +F:Thirdweb.BrowserStatus.UnknownError +-------------------------------------------------------------------------------- + +KIND: Field + +SUMMARY: +An unknown error occurred during the operation. + +-------------------------------------------------------------------------------- +T:Thirdweb.BrowserResult +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents the result of a browser-based login operation. + +-------------------------------------------------------------------------------- +P:Thirdweb.BrowserResult.Status +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets the status of the browser operation. + +-------------------------------------------------------------------------------- +P:Thirdweb.BrowserResult.CallbackUrl +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets the callback URL returned from the browser operation. + +-------------------------------------------------------------------------------- +P:Thirdweb.BrowserResult.Error +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets the error message, if any, from the browser operation. + +-------------------------------------------------------------------------------- +M:Thirdweb.BrowserResult.#ctor(Thirdweb.BrowserStatus,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - status (Thirdweb.BrowserStatus) + The status of the browser operation. + - callbackUrl (string) + The callback URL returned from the browser operation. + +SUMMARY: +Initializes a new instance of the class with the specified status and callback URL. + +-------------------------------------------------------------------------------- +M:Thirdweb.BrowserResult.#ctor(Thirdweb.BrowserStatus,System.String,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - status (Thirdweb.BrowserStatus) + The status of the browser operation. + - callbackUrl (string) + The callback URL returned from the browser operation. + - error (string) + The error message from the browser operation. + +SUMMARY: +Initializes a new instance of the class with the specified status, callback URL, and error message. + +-------------------------------------------------------------------------------- +T:Thirdweb.IThirdwebWallet +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Interface for a Thirdweb wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.IThirdwebWallet.Client +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets the Thirdweb client associated with the wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.IThirdwebWallet.AccountType +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets the account type of the wallet. + +-------------------------------------------------------------------------------- +P:Thirdweb.IThirdwebWallet.WalletId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +String identifier for the wallet to be used in analytics. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.GetAddress +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Gets the address of the wallet. + +RETURNS: +The wallet address. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.PersonalSign(System.Byte[]) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - rawMessage (byte[]) + The raw message to sign. + +SUMMARY: +Signs a raw message using personal signing. + +RETURNS: +The signed message. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.PersonalSign(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - message (string) + The message to sign. + +SUMMARY: +Signs a message using personal signing. + +RETURNS: +The signed message. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.SignTypedDataV4(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - json (string) + The JSON representation of the typed data. + +SUMMARY: +Signs typed data (version 4). + +RETURNS: +The signed data. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.SignTypedDataV4``2(``0,Nethereum.ABI.EIP712.TypedData{``1}) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - data (``0) + The data to sign. + - typedData (Nethereum.ABI.EIP712.TypedData<``1>) + The typed data. + +SUMMARY: +Signs typed data (version 4). + +TYPEPARAM (T): +The type of the data. + +TYPEPARAM (TDomain): +The type of the domain. + +RETURNS: +The signed data. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.IsConnected +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Checks if the wallet is connected. + +RETURNS: +True if connected, otherwise false. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.SignTransaction(Thirdweb.ThirdwebTransactionInput) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransactionInput) + The transaction to sign. + +SUMMARY: +Signs a transaction. + +RETURNS: +The signed transaction. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.SendTransaction(Thirdweb.ThirdwebTransactionInput) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransactionInput) + The transaction to send. + +SUMMARY: +Sends a transaction. + +RETURNS: +The transaction hash. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.ExecuteTransaction(Thirdweb.ThirdwebTransactionInput) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransactionInput) + The transaction to execute. + +SUMMARY: +Sends a transaction and waits for its receipt. + +RETURNS: +The transaction receipt. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.Disconnect +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Disconnects the wallet (if using InAppWallet, clears session) + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.LinkAccount(Thirdweb.IThirdwebWallet,System.String,System.Nullable{System.Boolean},System.Action{System.String},System.String,Thirdweb.IThirdwebBrowser,System.Nullable{System.Numerics.BigInteger},System.String,System.String,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - walletToLink (Thirdweb.IThirdwebWallet) + The wallet to link. + - otp (string) + The OTP code if the wallet to link is an email or phone wallet. + - isMobile (Nullable) + Set to true if linking OAuth on mobile. + - browserOpenAction (System.Action) + The action to open the browser if linking OAuth. + - mobileRedirectScheme (string) + The redirect scheme if linking OAuth on mobile. + - browser (Thirdweb.IThirdwebBrowser) + The browser to use if linking OAuth. + - chainId (Nullable) + The chain ID if linking an external wallet (SIWE). + - jwt (string) + The JWT token if linking custom JWT auth. + - payload (string) + The login payload if linking custom AuthEndpoint auth. + - defaultSessionIdOverride (string) + The default session ID override if linking Guest auth. + +SUMMARY: +Links a new account (auth method) to the current wallet. The current wallet must be connected and the wallet being linked must not be fully connected ie created. + +RETURNS: +A list of objects. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.UnlinkAccount(Thirdweb.LinkedAccount) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - accountToUnlink (Thirdweb.LinkedAccount) + The linked account to unlink. Same type returned by . + +SUMMARY: +Unlinks an account (auth method) from the current wallet. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.GetLinkedAccounts +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Returns a list of linked accounts to the current wallet. + +RETURNS: +A list of objects. + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.SignAuthorization(System.Numerics.BigInteger,System.String,System.Boolean) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID of the contract. + - contractAddress (string) + The address of the contract. + - willSelfExecute (bool) + Set to true if the wallet will also be the executor of the transaction, otherwise false. + +SUMMARY: +Signs an EIP-7702 authorization to invoke contract functions to an externally owned account. + +RETURNS: +The signed authorization as an that can be used with . + +-------------------------------------------------------------------------------- +M:Thirdweb.IThirdwebWallet.SwitchNetwork(System.Numerics.BigInteger) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - chainId (System.Numerics.BigInteger) + The chain ID to switch to. + +SUMMARY: +Attempts to set the active network to the specified chain ID. + +-------------------------------------------------------------------------------- +T:Thirdweb.ThirdwebAccountType +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Enum for the types of Thirdweb accounts. + +-------------------------------------------------------------------------------- +T:Thirdweb.LoginPayload +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents a login payload. + +-------------------------------------------------------------------------------- +T:Thirdweb.LoginPayloadData +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Represents login payload data. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.Domain +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the domain of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.Address +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the address of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.Statement +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the statement of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.Uri +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the URI of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.Version +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the version of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.ChainId +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the chain ID of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.Nonce +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the nonce of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.IssuedAt +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the issued at timestamp of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.ExpirationTime +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the expiration time of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.InvalidBefore +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the invalid before timestamp of the login payload. + +-------------------------------------------------------------------------------- +P:Thirdweb.LoginPayloadData.Resources +-------------------------------------------------------------------------------- + +KIND: Property + +SUMMARY: +Gets or sets the resources of the login payload. + +-------------------------------------------------------------------------------- +M:Thirdweb.LoginPayloadData.#ctor +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Initializes a new instance of the class. + +-------------------------------------------------------------------------------- +T:Thirdweb.ServerWallet +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Interact with vault-secured server wallets created from the Thirdweb project dashboard's Transactions tab. + +-------------------------------------------------------------------------------- +M:Thirdweb.ServerWallet.Create(Thirdweb.ThirdwebClient,System.String,Thirdweb.ExecutionOptions,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - client (Thirdweb.ThirdwebClient) + The Thirdweb client. + - label (string) + The label of your created server wallet. + - executionOptions (Thirdweb.ExecutionOptions) + The execution options for the server wallet, defaults to auto if not passed. + - vaultAccessToken (string) + The vault access token for the server wallet if self-managed. + +SUMMARY: +Creates an instance of the ServerWallet. + +RETURNS: +A new instance of the ServerWallet. + +EXCEPTION (T:System.ArgumentNullException): +Thrown when client or label is null or empty. + +EXCEPTION (T:System.InvalidOperationException): +Thrown when no server wallets are found or the specified label does not match any existing server wallet. + +-------------------------------------------------------------------------------- +T:Thirdweb.ExecutionOptions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Base class for execution options + +-------------------------------------------------------------------------------- +T:Thirdweb.AutoExecutionOptions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Auto determine execution options + +-------------------------------------------------------------------------------- +T:Thirdweb.EIP7702ExecutionOptions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Externally Owned Account (EOA) execution options + +-------------------------------------------------------------------------------- +T:Thirdweb.EOAExecutionOptions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Externally Owned Account (EOA) execution options + +-------------------------------------------------------------------------------- +T:Thirdweb.ERC4337ExecutionOptions +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +ERC-4337 execution options + +-------------------------------------------------------------------------------- +T:Thirdweb.QueuedTransactionResponse +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Response wrapper for queued transactions + +-------------------------------------------------------------------------------- +T:Thirdweb.QueuedTransactionResult +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Result containing the transactions array + +-------------------------------------------------------------------------------- +T:Thirdweb.QueuedTransaction +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Queued transaction response + +-------------------------------------------------------------------------------- +T:Thirdweb.InnerTransaction +-------------------------------------------------------------------------------- + +KIND: Type + +SUMMARY: +Inner transaction data + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.Create(Thirdweb.IThirdwebWallet,System.Numerics.BigInteger,System.Nullable{System.Boolean},System.String,System.String,System.String,System.String,System.String,Thirdweb.TokenPaymaster) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - personalWallet (Thirdweb.IThirdwebWallet) + The smart wallet's signer to use. + - chainId (System.Numerics.BigInteger) + The chain ID. + - gasless (Nullable) + Whether to sponsor gas for transactions. + - factoryAddress (string) + Override the default factory address. + - accountAddressOverride (string) + Override the canonical account address that would be found deterministically based on the signer. + - entryPoint (string) + Override the default entry point address. We provide Constants for different versions. + - bundlerUrl (string) + Override the default thirdweb bundler URL. + - paymasterUrl (string) + Override the default thirdweb paymaster URL. + - tokenPaymaster (Thirdweb.TokenPaymaster) + Use an ERC20 paymaster and sponsor gas with ERC20s. If set, factoryAddress and accountAddressOverride are ignored. + +SUMMARY: +Creates a new instance of . + +RETURNS: +A new instance of . + +EXCEPTION (T:System.InvalidOperationException): +Thrown if the personal account is not connected. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.GetPersonalWallet +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Returns the signer that was used to connect to this SmartWallet. + +RETURNS: +The signer. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.IsDeployed +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Checks if the smart account is deployed on the current chain. A smart account is typically deployed when a personal message is signed or a transaction is sent. + +RETURNS: +True if deployed, otherwise false. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.ForceDeploy +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Forces the smart account to deploy on the current chain. This is typically not necessary as the account will deploy automatically when needed. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.IsValidSignature(System.String,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - message (string) + The message to verify. + - signature (string) + The signature to verify. + +SUMMARY: +Verifies if a signature is valid for a message using EIP-1271 or ERC-6492. + +RETURNS: +True if the signature is valid, otherwise false. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.GetAllAdmins +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Gets all admins for the smart account. + +RETURNS: +A list of admin addresses. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.GetAllActiveSigners +-------------------------------------------------------------------------------- + +KIND: Method + +SUMMARY: +Gets all active signers for the smart account. + +RETURNS: +A list of . + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.CreateSessionKey(System.String,System.Collections.Generic.List{System.String},System.String,System.String,System.String,System.String,System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - signerAddress (string) + The address of the signer to create a session key for. + - approvedTargets (List) + The list of approved targets for the signer. Use a list of a single Constants.ADDRESS_ZERO to enable all contracts. + - nativeTokenLimitPerTransactionInWei (string) + The maximum amount of native tokens the signer can send in a single transaction. + - permissionStartTimestamp (string) + The timestamp when the permission starts. Can be set to zero. + - permissionEndTimestamp (string) + The timestamp when the permission ends. Make use of our Utils to get UNIX timestamps. + - reqValidityStartTimestamp (string) + The timestamp when the request validity starts. Can be set to zero. + - reqValidityEndTimestamp (string) + The timestamp when the request validity ends. Make use of our Utils to get UNIX timestamps. + +SUMMARY: +Creates a new session key for a signer to use with the smart account. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.RevokeSessionKey(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - signerAddress (string) + The address of the signer to revoke. + +SUMMARY: +Revokes a session key from a signer. + +RETURNS: +The transaction receipt. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.AddAdmin(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - admin (string) + The address of the admin to add. + +SUMMARY: +Adds a new admin to the smart account. + +RETURNS: +The transaction receipt. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.RemoveAdmin(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - admin (string) + The address of the admin to remove. + +SUMMARY: +Removes an existing admin from the smart account. + +RETURNS: +The transaction receipt. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.EstimateUserOperationGas(Thirdweb.ThirdwebTransactionInput) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - transaction (Thirdweb.ThirdwebTransactionInput) + The transaction to estimate. + +SUMMARY: +Estimates the gas cost for a user operation. More accurate than ThirdwebTransaction estimation, but slower. + +RETURNS: +The estimated gas cost. + +-------------------------------------------------------------------------------- +M:Thirdweb.SmartWallet.PersonalSign(System.String) +-------------------------------------------------------------------------------- + +KIND: Method +RETURN TYPE: System.Threading.Tasks.Task + +PARAMETERS: + - message (string) + The message to sign. + +SUMMARY: +Signs a message with the personal account. The message will be verified using EIPs 1271 and 6492 if applicable. + +RETURNS: +The signature. +