Class EcosystemWallet

Namespace

Thirdweb

Assembly

Thirdweb.dll

Enclave based secure cross ecosystem wallet.

public class EcosystemWallet : IThirdwebWallet

Inheritance

object

EcosystemWallet

Implements

IThirdwebWallet

Derived

InAppWallet

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ThirdwebExtensions.Authenticate<T>(IThirdwebWallet, string, BigInteger, string, string, string, string, bool, IThirdwebHttpClient)

ThirdwebExtensions.GetBalance(IThirdwebWallet, BigInteger, string)

ThirdwebExtensions.GetTransactionCount(IThirdwebWallet, BigInteger, string)

ThirdwebExtensions.Transfer(IThirdwebWallet, BigInteger, string, BigInteger, string)

Properties

AccountType

Gets the account type of the wallet.

public ThirdwebAccountType AccountType { get; }

Property Value

ThirdwebAccountType

Client

Gets the Thirdweb client associated with the wallet.

public ThirdwebClient Client { get; }

Property Value

ThirdwebClient

WalletId

String identifier for the wallet to be used in analytics.

public virtual string WalletId { get; }

Property Value

string

Methods

Create(ThirdwebClient, string, string, string, string, AuthProvider, string, IThirdwebWallet, string, string, ExecutionMode)

Creates a new instance of the EcosystemWallet class.

public static Task<EcosystemWallet> Create(ThirdwebClient client, string ecosystemId = null, string ecosystemPartnerId = null, string email = null, string phoneNumber = null, AuthProvider authProvider = AuthProvider.Default, string storageDirectoryPath = null, IThirdwebWallet siweSigner = null, string walletSecret = null, string twAuthTokenOverride = null, ExecutionMode executionMode = ExecutionMode.EOA)

Parameters

client ThirdwebClient

The Thirdweb client instance.

ecosystemId string

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).

email string

The email address for Email OTP authentication.

phoneNumber string

The phone number for Phone OTP authentication.

authProvider AuthProvider

The authentication provider to use.

storageDirectoryPath string

The path to the storage directory.

siweSigner 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 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.

Returns

Task<EcosystemWallet>

A task that represents the asynchronous operation. The task result contains the created in-app wallet.

Exceptions

ArgumentException

Thrown when required parameters are not provided.

CreateSessionKey(BigInteger, string, long, bool, List<CallSpec>, List<TransferSpec>, byte[])

Creates a session key for the user wallet. This is only supported for EIP7702 and EIP7702Sponsored execution modes.

public Task<ThirdwebTransactionReceipt> CreateSessionKey(BigInteger chainId, string signerAddress, long durationInSeconds, bool grantFullPermissions = true, List<CallSpec> callPolicies = null, List<TransferSpec> transferPolicies = null, byte[] uid = null)

Parameters

chainId 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<CallSpec>

List of call policies to apply to the session key. If null, no call policies will be applied.

transferPolicies List<TransferSpec>

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.

Returns

Task<ThirdwebTransactionReceipt>

A task that represents the asynchronous operation. The task result contains the transaction receipt for the session key creation.

Exceptions

InvalidOperationException

Thrown when the execution mode is not EIP7702 or EIP7702Sponsored.

ArgumentException

Thrown when the signer address is null or empty, or when the duration is less than or equal to zero.

Disconnect()

Disconnects the wallet (if using InAppWallet, clears session)

public Task Disconnect()

Returns

Task

ExecuteTransaction(ThirdwebTransactionInput)

Sends a transaction and waits for its receipt.

public Task<ThirdwebTransactionReceipt> ExecuteTransaction(ThirdwebTransactionInput transactionInput)

Parameters

transactionInput ThirdwebTransactionInput

Returns

Task<ThirdwebTransactionReceipt>

The transaction receipt.

GenerateExternalLoginLink(string)

Returns a link that can be used to transfer the .NET wallet session to a thirdweb powered React website for seamless integration.

public string GenerateExternalLoginLink(string redirectUrl)

Parameters

redirectUrl string

The URL of your thirdweb-powered website.

Returns

string

The URL to redirect the user to.

Exceptions

InvalidOperationException

Thrown when no connected session is found

GetAddress()

Gets the address of the wallet.

public Task<string> GetAddress()

Returns

Task<string>

The wallet address.

GetCallPoliciesForSigner(BigInteger, string)

Gets the call policies for a specific signer on the EIP7702 account.

public Task<List<CallSpec>> GetCallPoliciesForSigner(BigInteger chainId, string signerAddress)

Parameters

chainId BigInteger

The chain ID of the EIP7702 account.

signerAddress string

The address of the signer to get call policies for.

Returns

Task<List<CallSpec>>

A task that represents the asynchronous operation. The task result contains a list of call policies for the signer.

Exceptions

InvalidOperationException

Thrown when the execution mode is not EIP7702 or EIP7702Sponsored.

ArgumentException

Thrown when the signer address is null or empty.

GetEcosystemDetails()

Returns Ecosystem metadata (set in thirdweb Dashboard)

public Task<EcosystemWallet.EcosystemDetails> GetEcosystemDetails()

Returns

Task<EcosystemWallet.EcosystemDetails>

Instance of EcosystemWallet.EcosystemDetails containing metadata

Exceptions

InvalidOperationException

Thrown when called on an InAppWallet

GetEmail()

[Obsolete("Use GetUserDetails instead.")]
public string GetEmail()

Returns

string

GetLinkedAccounts()

Returns a list of linked accounts to the current wallet.

public Task<List<LinkedAccount>> GetLinkedAccounts()

Returns

Task<List<LinkedAccount>>

A list of LinkedAccount objects.

GetPhoneNumber()

[Obsolete("Use GetUserDetails instead.")]
public string GetPhoneNumber()

Returns

string

GetSessionExpirationForSigner(BigInteger, string)

Gets the session expiration timestamp for a specific signer on the EIP7702 account.

public Task<BigInteger> GetSessionExpirationForSigner(BigInteger chainId, string signerAddress)

Parameters

chainId BigInteger

The chain ID of the EIP7702 account.

signerAddress string

The address of the signer to get session expiration for.

Returns

Task<BigInteger>

A task that represents the asynchronous operation. The task result contains the session expiration timestamp.

Exceptions

InvalidOperationException

Thrown when the execution mode is not EIP7702 or EIP7702Sponsored.

ArgumentException

Thrown when the signer address is null or empty.

GetSessionStateForSigner(BigInteger, string)

Gets the complete session state for a specific signer on the EIP7702 account, including remaining limits and usage information.

public Task<SessionState> GetSessionStateForSigner(BigInteger chainId, string signerAddress)

Parameters

chainId BigInteger

The chain ID of the EIP7702 account.

signerAddress string

The address of the signer to get session state for.

Returns

Task<SessionState>

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.

Exceptions

InvalidOperationException

Thrown when the execution mode is not EIP7702 or EIP7702Sponsored.

ArgumentException

Thrown when the signer address is null or empty.

GetTransferPoliciesForSigner(BigInteger, string)

Gets the transfer policies for a specific signer on the EIP7702 account.

public Task<List<TransferSpec>> GetTransferPoliciesForSigner(BigInteger chainId, string signerAddress)

Parameters

chainId BigInteger

The chain ID of the EIP7702 account.

signerAddress string

The address of the signer to get transfer policies for.

Returns

Task<List<TransferSpec>>

A task that represents the asynchronous operation. The task result contains a list of transfer policies for the signer.

Exceptions

InvalidOperationException

Thrown when the execution mode is not EIP7702 or EIP7702Sponsored.

ArgumentException

Thrown when the signer address is null or empty.

GetUserAuthDetails()

Gets the user auth details from the corresponding auth provider. For linked account details use GetUserDetails or GetLinkedAccounts.

public JObject GetUserAuthDetails()

Returns

JObject

The user auth details as a JObject

GetUserDetails()

Gets the user details from the enclave wallet. For auth provider specific details use GetUserAuthDetails.

public Task<EcosystemWallet.UserStatusResponse> GetUserDetails()

Returns

Task<EcosystemWallet.UserStatusResponse>

A task that represents the asynchronous operation. The task result contains the user details.

IsConnected()

Checks if the wallet is connected.

public Task<bool> IsConnected()

Returns

Task<bool>

True if connected, otherwise false.

LinkAccount(IThirdwebWallet, string, bool?, Action<string>, string, IThirdwebBrowser, BigInteger?, string, string, string)

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.

public Task<List<LinkedAccount>> LinkAccount(IThirdwebWallet walletToLink, string otp = null, bool? isMobile = null, Action<string> browserOpenAction = null, string mobileRedirectScheme = "thirdweb://", IThirdwebBrowser browser = null, BigInteger? chainId = null, string jwt = null, string payload = null, string defaultSessionIdOverride = null)

Parameters

walletToLink IThirdwebWallet

The wallet to link.

otp string

The OTP code if the wallet to link is an email or phone wallet.

isMobile bool?

Set to true if linking OAuth on mobile.

browserOpenAction Action<string>

The action to open the browser if linking OAuth.

mobileRedirectScheme string

The redirect scheme if linking OAuth on mobile.

browser IThirdwebBrowser

The browser to use if linking OAuth.

chainId BigInteger?

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.

Returns

Task<List<LinkedAccount>>

A list of LinkedAccount objects.

LoginWithAuthEndpoint(string)

public Task<string> LoginWithAuthEndpoint(string payload)

Parameters

payload string

Returns

Task<string>

LoginWithBackend()

public Task<string> LoginWithBackend()

Returns

Task<string>

LoginWithGuest(string)

public Task<string> LoginWithGuest(string defaultSessionIdOverride = null)

Parameters

defaultSessionIdOverride string

Returns

Task<string>

LoginWithJWT(string)

public Task<string> LoginWithJWT(string jwt)

Parameters

jwt string

Returns

Task<string>

LoginWithOauth(bool, Action<string>, string, IThirdwebBrowser, CancellationToken)

public Task<string> LoginWithOauth(bool isMobile, Action<string> browserOpenAction, string mobileRedirectScheme = "thirdweb://", IThirdwebBrowser browser = null, CancellationToken cancellationToken = default)

Parameters

isMobile bool

browserOpenAction Action<string>

mobileRedirectScheme string

browser IThirdwebBrowser

cancellationToken CancellationToken

Returns

Task<string>

LoginWithOtp(string)

public Task<string> LoginWithOtp(string otp)

Parameters

otp string

Returns

Task<string>

LoginWithSiwe(BigInteger)

public Task<string> LoginWithSiwe(BigInteger chainId)

Parameters

chainId BigInteger

Returns

Task<string>

PersonalSign(byte[])

Signs a raw message using personal signing.

public Task<string> PersonalSign(byte[] rawMessage)

Parameters

rawMessage byte[]

The raw message to sign.

Returns

Task<string>

The signed message.

PersonalSign(string)

Signs a message using personal signing.

public Task<string> PersonalSign(string message)

Parameters

message string

The message to sign.

Returns

Task<string>

The signed message.

SendOTP()

public Task SendOTP()

Returns

Task

SendTransaction(ThirdwebTransactionInput)

Sends a transaction.

public Task<string> SendTransaction(ThirdwebTransactionInput transaction)

Parameters

transaction ThirdwebTransactionInput

The transaction to send.

Returns

Task<string>

The transaction hash.

SignAuthorization(BigInteger, string, bool)

Signs an EIP-7702 authorization to invoke contract functions to an externally owned account.

public Task<EIP7702Authorization> SignAuthorization(BigInteger chainId, string contractAddress, bool willSelfExecute)

Parameters

chainId 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.

Returns

Task<EIP7702Authorization>

The signed authorization as an EIP7702Authorization that can be used with AuthorizationList.

SignTransaction(ThirdwebTransactionInput)

Signs a transaction.

public Task<string> SignTransaction(ThirdwebTransactionInput transaction)

Parameters

transaction ThirdwebTransactionInput

The transaction to sign.

Returns

Task<string>

The signed transaction.

SignTypedDataV4(string)

Signs typed data (version 4).

public Task<string> SignTypedDataV4(string json)

Parameters

json string

The JSON representation of the typed data.

Returns

Task<string>

The signed data.

SignTypedDataV4<T, TDomain>(T, TypedData<TDomain>)

Signs typed data (version 4).

public Task<string> SignTypedDataV4<T, TDomain>(T data, TypedData<TDomain> typedData) where TDomain : IDomain

Parameters

data T

The data to sign.

typedData TypedData<TDomain>

The typed data.

Returns

Task<string>

The signed data.

Type Parameters

T

The type of the data.

TDomain

The type of the domain.

SignerHasFullPermissions(BigInteger, string)

Checks if the signer has full permissions on the EIP7702 account.

public Task<bool> SignerHasFullPermissions(BigInteger chainId, string signerAddress)

Parameters

chainId BigInteger

The chain ID of the EIP7702 account.

signerAddress string

The address of the signer to check permissions for.

Returns

Task<bool>

A task that represents the asynchronous operation. The task result contains a boolean indicating whether the signer has full permissions.

Exceptions

InvalidOperationException

Thrown when the execution mode is not EIP7702 or EIP7702Sponsored.

ArgumentException

Thrown when the signer address is null or empty.

SwitchNetwork(BigInteger)

Attempts to set the active network to the specified chain ID.

public Task SwitchNetwork(BigInteger chainId)

Parameters

chainId BigInteger

The chain ID to switch to.

Returns

Task

UnlinkAccount(LinkedAccount)

Unlinks an account (auth method) from the current wallet.

public Task<List<LinkedAccount>> UnlinkAccount(LinkedAccount accountToUnlink)

Parameters

accountToUnlink LinkedAccount

The linked account to unlink. Same type returned by GetLinkedAccounts().

Returns

Task<List<LinkedAccount>>