View Source API Reference TurnkeyEx v0.0.1-alpha2

Modules

Turnkey interactions that are a little higher level than api client

Contextualized interfaces to Turnkey API.

Turnkey mutating actions create an "Activity", with a status that indicates whether the endpoint should be polled until the status is "Completed"

Our organization api key can initiate an email recovery process for a user.

Turnkey client for signing data

Generates an api key stamp header for turnkey api requests, which is built by signing the entire body of a post request with the api key.

Turnkey Sub Organizations allow for a permissioning model where our users have control over their keys and our api key has read access only.

A struct for shaping the turnkey result + request towards our needs, since the activity is too hefty but the Result doesn't have everything we need.

Just some simple structs to give a little more flavor and confidence to the api interactions

The root of a creation payload

The wrapper for a turnkey activity requests result e.g. %{ "subOrganizationId" => "5d0ef3dc-e8f9-4d51-bc90-76bf24599c9a", "wallet" => %{ "addresses" => ["0xC63C30d1227fD5568a99807D285e3ffFFa246c8d"], "walletId" => "c384284a-849c-5158-934c-4f497bcff731" }

The wrapper for initializing user email recovery intent e.g. %{ "email" => "example@example.com", "targetPublicKey" => "abc123def456...", "expirationSeconds" => "3600" }

The wrapper for the result of an init user email recovery action e.g. %{ "userId" => "a1b2c3d4-e5f6-7890-g1h2-i3j4k5l6m7n8" }

Represents a request for user activity.

The Intent or recovering a user. Sent by the user when recovering. We have it for parsing the intent when reading bach the activity. e.g. %{ "authenticator": { "authenticatorName": "string", "challenge": "string", "attestation": {} }, "userId": "string" }

Put maps into structs and return error tuple while enforcing keys. struct/2 fails to enforce keys and struct!/2 crashes, so this module wraps struct!/2 with try rescue.

Mix Tasks

Starts an insecure Turnkey server. This can be used to enable testing of the Turnkey API.