- Objects
- ActivateWalletDepositResult
- AddressDetail
- AddressDetails
- ApproveSignatureRequestResult
- ApproveTransactionRequestResult
- AssetPricePercentChange
- Balance
- BatchFlushWalletDepositAddressesResult
- CipherBlobObject
- ContractDeploymentInfo
- CreateSignatureRequestResult
- CreateWalletDepositAddressResult
- DeployWalletDepositAddressResult
- Digest
- FlushWalletDepositAddressResult
- FlushWalletDepositAddressV2Result
- GasTank
- GasTankKey
- Key
- KeyEdge
- Network
- NetworkAsset
- NetworkAssetEdge
- NetworkAssetPrice
- NetworkEdge
- Organization
- OrganizationEdge
- OrganizationInvitation
- OrganizationInvitationEdge
- OrganizationMember
- OrganizationMemberEdge
- OrganizationNetwork
- OrganizationNetworkEdge
- OrganizationPlan
- OrganizationTransactionRequestEdge
- OrganizationWebhook
- OrganizationWebhookEdge
- OrganizationWebhookSignatureKey
- OrganizationWebhookSignatureKeyEdge
- PageInfo
- PaginatedKey
- PaginatedNetwork
- PaginatedNetworkAsset
- PaginatedOrganization
- PaginatedOrganizationInvitation
- PaginatedOrganizationMember
- PaginatedOrganizationNetwork
- PaginatedOrganizationTransactionRequest
- PaginatedOrganizationWebhook
- PaginatedOrganizationWebhookSignatureKey
- PaginatedTransactionRequest
- PaginatedTransactionRequestApproval
- PaginatedUserPreference
- PaginatedWallet
- PaginatedWalletAccess
- PaginatedWalletDepositAddress
- PaginatedWalletFinalApprover
- PaginatedWalletKey
- PaginatedWalletPolicyWhitelist
- PaginatedYieldProduct
- Password
- PolicyWhitelist
- Prices
- ReportingError
- RequestOwnerSignaturesResult
- ResolveEIP1271SignatureResult
- TokenBalanceMetadata
- TokenBalanceResponse
- TokenBalanceWithPrice
- TokenomicsMetadata
- TokenTransferInfo
- Transaction
- TransactionIntentSummary
- TransactionListResult
- TransactionRequest
- TransactionRequestApproval
- TransactionRequestApprovalEdge
- TransactionRequestDataSummaryEvm
- TransactionRequestEdge
- TransactionRequestSignature
- TransactionRequestWarning
- User
- UserPreference
- UserPreferenceEdge
- Wallet
- WalletAccess
- WalletAccessEdge
- WalletDepositAddress
- WalletDepositAddressEdge
- WalletEdge
- WalletFinalApprover
- WalletFinalApproverEdge
- WalletKey
- WalletKeyEdge
- WalletPolicy
- WalletPolicyWhitelistEdge
- WalletTransaction
- YieldProduct
- YieldProductEdge
- YieldProtocol
Objects
An object is a type that contains fields. Objects can be queried and mutated. Objects can also be defined as arguments that can be passed to a query or mutation. Objects can be scalar or object types.
ActivateWalletDepositResult
The result of the activate wallet deposit mutation.
Name | Description |
---|---|
| The wallet deposit address status |
AddressDetail
Details of the address.
Name | Description |
---|---|
| The type of account identified by the address. E.g. "EvmContractSimpleMultiSig", "TronNativeMultiSig", etc. |
| The state of the account. E.g. |
| The CAIP-2 URI of the network the account is associated with. |
| The CAIP-10 URI of the account. |
| The hash of the deployment transaction. Only applicable if the account requires on-chain deployment. |
AddressDetails
Additional details of an address on the blockchain.
Name | Description |
---|---|
| The address on the blockchain. |
| The label of the address, if available. Otherwise, the value will be null. |
ApproveSignatureRequestResult
The result of approving a signature request.
Name | Description |
---|---|
| The system-generated unique ID of the signature request. |
ApproveTransactionRequestResult
The transaction request approval with latest status
Name | Description |
---|---|
| The system-generated unique ID of the transaction request approval. |
| The system-generated unique ID of the approver. |
| The type of approval action. |
| The date and time when the transaction request approval was created. |
| The date and time when the transaction request approval was last updated. |
| The approver of the transaction request. |
| Status of approved transaction. |
AssetPricePercentChange
Price change in percentage, if available.
Name | Description |
---|---|
| Price change in percentage over the last 24 hours. |
Balance
The balance of an address / account, for a specific asset on the blockchain. Balances can be expressed in various denominations and units.
Name | Description |
---|---|
| The balance of the asset denominated in the smallest unit. |
| The number of decimal places to use when formatting the balance. For example, |
| The symbol of the asset, if available. |
| The balance of the asset represented in a human-readable string. Computed as |
BatchFlushWalletDepositAddressesResult
The result of the batch flush wallet deposit address mutation operation.
Name | Description |
---|---|
| The system-generated request ID of the batch flush transaction. Deprecated Use |
| The system-generated request ID of the batch flush transaction. |
| The hash of the batch flush transaction. |
CipherBlobObject
Represents the encrypted data structure that holds the wallet key.
Name | Description |
---|---|
| The algorithm used to encrypt the private key. Currently supports only AES with a 256-bit key in CBC mode. |
| The method used to derive a cryptographic key from a password. Currently only supports Password-Based Key Derivation Function 2 (PBKDF2). |
| The cryptographic hash function used. Currently supports only SHA-256. |
| The number of iterations for the key derivation function. Typically, a higher number means stronger security at the cost of longer computation time. |
| The salt value used in the key derivation function. Helps in preventing rainbow table attacks. |
| Initialization Vector (IV) used for the encryption process in CBC mode. Ensures that the encryption is unique even with the same data and key. |
| The encrypted version of the private key. |
| Hash value of the encrypted data, ensuring its integrity and authenticity. |
ContractDeploymentInfo
Name | Description |
---|---|
| The number of confirmations that the contract deployment transaction has received. |
| The minimum number of confirmations for a deployment transaction to be regarded as "safe" for the network. |
CreateSignatureRequestResult
The result of creating a signature request.
Name | Description |
---|---|
| The system-generated unique ID of the signature request. |
| The system-generated unique ID of the wallet. |
| The date and time the signature request was created. |
| The state of the signature request. |
CreateWalletDepositAddressResult
The result of the create wallet deposit address mutation operation.
Name | Description |
---|---|
| The system-generated unique ID of the created deposit address. |
| The label of the deposit address. |
| The deposit address for the wallet. |
DeployWalletDepositAddressResult
The result of the deploy wallet deposit address mutation operation.
Name | Description |
---|---|
| Transaction hash of the contract deployment transaction. |
Digest
Stores the relations between the digest, the key, and the transaction request.
Name | Description |
---|---|
| The system-generated unique ID of the digest. Deprecated Use |
| The system-generated unique ID of the digest. |
| The system-generated unique ID of the wallet key. |
| The system-generated unique ID of the transaction request. |
| The message digest to sign that generates the corresponding signature. |
| Signature of the digest. A signature on a digest is produced by a Key in Levain's Key Vault Service(KVS).A signature is undefined if the state is PENDING. |
| The state of the digest. |
FlushWalletDepositAddressResult
The result of the flush wallet deposit address mutation operation.
Name | Description |
---|---|
| The transaction hash of the forwarder contract deployment. |
| The forwarder address. |
| The CAIP-10 Account URI of the deployer forwarder contract. |
| The forwarder ID. |
FlushWalletDepositAddressV2Result
The result of the version 2 flush wallet deposit address mutation operation.
Name | Description |
---|---|
|
|
GasTank
A Gas Tank is a hot wallet that is used to fund the execution of transactions (i.e. pays for network fees) on the blockchain, including:
- Creating wallets
- Executing smart contract wallet transactions
- Funding other automations for speed and user experience
Since the hot wallet is controlled by a single key that is managed by Levain, it's advisable to keep only a minimal operational balance in it at all times.
Name | Description |
---|---|
| The ID of the OrganizationNetwork on which the gas tank has been deployed. |
| The ID of the OrganizationNetwork that the gas tank is confined to operate on. This is only set for single-chain gas tanks. Deprecated Gas tanks are no longer confined to a single chain, and this can be null for newer gas tanks. Use |
| The system-generated unique ID of the gas tank. |
| The address of the gas tank on the blockchain. Arguments for
|
| The creation date of the gas tank in ISO 8601 format. |
| The flag indicating whether the gas tank is the primary one for the organization. |
| Retrieve details of the key associated with the gas tank. |
| Retrieve the native crypto balance of the gas tank for a specified network. Arguments for
|
| Retrieve details of the key associated with the gas tank. |
GasTankKey
A gas tank key.
Name | Description |
---|---|
| The system-generated unique ID of the gas tank. |
| The system-generated unique ID of the key associated with the gas tank. |
| The details of the Gas Tank's underlying Key |
Key
Name | Description |
---|---|
| The system-generated unique ID of the key. |
| The unique 12-digit identifier of an organization. |
| The system-generated unique ID of the organization member who created the key. |
| The type of key. Refer to |
| Public key of an asymmetrical key pair. |
| The human-readable name of the key. |
| Whether the key has been used for a particular reason. For example, if the key has been used as a signatory for a wallet, or used to encrypt a wallet password. |
| The datetime the key was created. |
| The datetime the key was last updated. |
| The organization member who created the key. |
| The type of wallet key. Refer to |
| The wallets that the key is a signatory of. |
KeyEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
Network
A blockchain network.
Name | Description |
---|---|
| A system-generated unique ID of the network. |
| The name of the protocol (e.g. Ethereum). |
| The type of the protocol (e.g. EVM). |
| The name of the network. |
| The family of the network (Main or Test). |
| The symbol of the native cryptocurrency. |
| The name of the native cryptocurrency. |
| The chain-agnostic CAIP-2 identifier of the network. E.g. |
| The minimum number of block confirmations required for a transaction to be considered confirmed. |
| Whether the network is available for use. |
| The date and time when the network was created. |
| The timestamp of when the network was soft-deleted. Will be null if the network has not been soft-deleted, or if it has been recovered. |
| Retrieves a paginated list of assets supported by the network. |
| Retrieves the native asset of the network. |
| The cost of creating a wallet of a specific type on the network. If null, the cost is unknown. Arguments for
|
NetworkAsset
A network asset is a cryptocurrency or token of a blockchain network stored in Levain's database.
Name | Description |
---|---|
| The system-generated unique ID of the network asset. |
| The system-generated unique ID of the network. |
| The name of the network asset. |
| The asset or token symbol of the network asset (e.g. ETH, USDT). |
| The number of decimals for the network asset. |
| The unique identifier of the token, formatted as a CAIP-19 compliant chain-agnostic URI. |
| Indicates if the asset is the primary cryptocurrency or token originally created for and by the blockchain network. |
| The current cached price of the network asset. Cache refreshes every minute. |
NetworkAssetEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
NetworkAssetPrice
The price details of a network asset in USD.
Name | Description |
---|---|
| The system-generated unique ID of the network asset. |
| The price of the network asset in USD. |
| Price change in percentage over the last 24 hours. |
| The database record creation timestamp. |
| The database record update timestamp. |
NetworkEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
Organization
Name | Description |
---|---|
| A system-generated 12-digit number that is unique to the organization. |
| The name of the organization. |
| The country of incorporation of the organization. |
| The business type of the organization. |
| The date the organization was created. |
| The date the organization was last updated. |
| Lists all the members of an organization. Arguments for
|->|->|->
<-|<-|<-|
|
| Retrieve information about a member of the organization. Arguments for
|
| Retrieve organization membership details of the authenticated user. |
| Lists all the networks enabled for the organization. |
| Retrieve information about the network the organization has access to. Arguments for
|
| Get gas tank information associated with the Organization |
| Lists the wallets that an organization member has access to. |
| Retrieve information about a wallet. Arguments for
|
| Lists all the active invitations to join an organization. Arguments for
|->|->|->
<-|<-|<-|
|
| Retrieve details about an organization invite. Arguments for
|
| Get the plan of the organization. Only owners and admins can fetch the plan. |
| Retrieve information about a key in an organization. Arguments for
|
| List all the keys in an organization. |
| Lists all the webhooks of an organization. |
| Retrieve details of an organization webhook. Arguments for
|
| Lists all the webhook signature keys of an organization. |
| Retrieve details of an organization webhook signature key. Arguments for
|
| List all supported networks for webhook service in your organization. |
| List all wallet transaction requests for wallets in an organization that the user has approver access to. Arguments for
|->|->|->
<-|<-|<-|
|
OrganizationEdge
Name | Description |
---|---|
| A cursor for use in pagination. |
| The item at the end of the edge in the connection. |
OrganizationInvitation
Name | Description |
---|---|
| The system-generated unique ID of the organization invitation. |
| A unique 12-digit identifier of an organization. |
The role of the member in the organization. | |
| The email address of the invited user. |
The status of the organization invitation. | |
| The datetime that the organization invitation expires. |
| Indicates whether the organization invitation is currently active. |
| The datetime that the organization invitation was created. |
| Retrieve details of the organization. |
OrganizationInvitationEdge
Name | Description |
---|---|
The item at the end of the edge in the connection. | |
| A cursor for use in pagination. |
OrganizationMember
A member of an organization.
Name | Description |
---|---|
| The system-generated unique ID of the organization member. |
| The system-generated unique ID of the user. |
| A unique 12-digit identifier of an organization. |
The role of the member in the organization. | |
| The status of a member of an organization. |
| The datetime the organization member was created. |
| The datetime the organization member was last updated. |
| Retrieve user details of the organization member. |
| Lists the wallets that an organization member has access to. You must be an |
| Lists the wallets accesses of an organization member. You must be an |
OrganizationMemberEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
OrganizationNetwork
Name | Description |
---|---|
| The system-generated unique ID of an organization network. |
| A unique 12-digit identifier of an organization. |
| The system-generated unique ID of the network. |
| The timestamp of when the OrganizationNetwork was soft-deleted. Will be null if the OrganizationNetwork has not been soft-deleted, or if it has been restored. |
| Retrieve information about a network. |
| Retrieve information of the Gas Tank that is confined to operate on the specified Network. For modern wallets, the Gas Tank is not confined to a single Network. Deprecated Gas tanks are no longer confined to a single chain. Use the org-level gas tank instead. |
OrganizationNetworkEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
OrganizationPlan
Name | Description |
---|---|
| The system-generated unique ID of the organization plan. |
| The unique 12-digit identifier of an organization. |
| The datetime of the organization plan starts. |
| The datetime of the organization plan ends. |
| Indicates whether the organization plan is currently active. |
| The datetime the organization plan was created. |
| The datetime the organization plan was last updated. |
OrganizationTransactionRequestEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
OrganizationWebhook
Name | Description |
---|---|
| The system-generated unique ID of the webhook. |
| The unique ID of the LWS client webhook |
| The unique 12-digit identifier of an organization. |
| The system-generated unique ID of the organization member who created the webhook. |
| The URL of the clients webhook endpoint. |
| The CAIP2URI of networks which the webhook is subscribed to. |
| The status of the client webhook. |
| The datetime the key was created. |
| The datetime the key was last updated. |
| The organization member who created the webhook. |
OrganizationWebhookEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
OrganizationWebhookSignatureKey
Name | Description |
---|---|
| The system-generated unique ID of the webhook signature key. |
| The unique 12-digit identifier of an organization. |
| The system-generated unique ID of the organization member who created the webhook signature key. |
| The datetime the key was created. |
| The datetime the key was last updated. |
| The organization member who created the webhook signature key. |
OrganizationWebhookSignatureKeyEdge
Name | Description |
---|---|
The item at the end of the edge in the connection. | |
| A cursor for use in pagination. |
PageInfo
Information about pagination in a connection.
Name | Description |
---|---|
| When paginating forwards, the cursor to continue. |
| When paginating forwards, indicates if there is a next page. |
| When paginating backwards, the cursor to continue. |
| When paginating backwards, indicates if there is a next page. |
PaginatedKey
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
PaginatedNetwork
Paginated list of networks.
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
PaginatedNetworkAsset
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
PaginatedOrganization
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
PaginatedOrganizationInvitation
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedOrganizationMember
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedOrganizationNetwork
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedOrganizationTransactionRequest
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedOrganizationWebhook
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedOrganizationWebhookSignatureKey
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedTransactionRequest
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedTransactionRequestApproval
The paginated transaction request approval.
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedUserPreference
A paginated list of user preferences.
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
PaginatedWallet
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
PaginatedWalletAccess
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
PaginatedWalletDepositAddress
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedWalletFinalApprover
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedWalletKey
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
PaginatedWalletPolicyWhitelist
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
A list of edges. | |
| Information to aid in pagination. |
PaginatedYieldProduct
Paginated list of yield products
Name | Description |
---|---|
| Identifies the total count of items in the connection. |
| A list of edges. |
| Information to aid in pagination. |
Password
Holds information related to the encrypted wallet key password.
Name | Description |
---|---|
| The system-generated unique ID of the wallet key password. |
| The system-generated unique ID of the wallet key password. |
| The system-generated unique ID of the associated wallet key. |
| The encrypted private key of the wallet. The private key is encrypted using a password generated on the client-side. Therefore, Levain will never have access to the raw private key. Deprecated Use |
| The encrypted private key of the wallet. The private key is encrypted using a password generated on the client-side. Therefore, Levain will never have access to the raw private key. |
| Unique identifier for the password recovery key. Can be null if no recovery key is set. |
| The status of the wallet key password. |
| Required for wallet password recovery. This resolver retrieves the asymmetric private key and is used to decrypt the encrypted wallet password found on the Key Card. |
PolicyWhitelist
The whitelist policy.
Name | Description |
---|---|
| The system-generated unique ID of the whitelist policy. |
| The blockchain address to be whitelisted. |
| The system-generated unique ID of the wallet. |
| The label of the policy whitelist. |
| The datetime the whitelist policy was created. |
| The datetime the whitelist policy was last updated. |
Prices
ReportingError
Error response.
RequestOwnerSignaturesResult
The result of requesting owner signatures.
Name | Description |
---|---|
| The system-generated unique ID of the signature request. |
| The system-generated unique ID of the wallet. |
| The date and time the signature request was created. |
| The digest. |
ResolveEIP1271SignatureResult
The result of resolving an EIP1271 signature.
Name | Description |
---|---|
| The system-generated unique ID of the signature request. |
| The system-generated unique ID of the wallet. |
| The state of the signature request. |
| The date and time the signature request was created. |
| The digest. |
| The signature. |
TokenBalanceMetadata
Optional metadata.
Name | Description |
---|---|
| URL to the token logo, if available. |
TokenBalanceResponse
Token balance response. Includes price data.
Name | Description |
---|---|
The token balances. | |
| Error response, if any. |
TokenBalanceWithPrice
Token balance with price data.
Name | Description |
---|---|
| The balance of the token in the smallest denomination of the respective token. Also known as balance in Base Units. |
| The number of decimal places of the token. To obtain the logical amount of the token, divide the smallest denomination (balance in Base Units) by 10 raised to the power of decimals. For instance, if the balance is 1,000,000 and decimals is 6, the Token Value or Logical Balance is calculated as 1,000,000 / (10^6) = 1.0. |
| The unique identifier of the token, formatted as a CAIP-19 compliant chain-agnostic URI. |
| The token contract address. Will be null for assets that have no contract address. |
| The human-readable name of the token. |
| The abbreviated representation of the token (e.g. ETH, USDT). |
| Optional metadata. |
| The fiat currency representation (e.g. USD). |
| The fiat currency price of the token. |
| Price change in percentage. |
TokenomicsMetadata
Tokenomics metadata of the yield product.
Name | Description |
---|---|
| |
| |
| |
|
TokenTransferInfo
Token transfer information of a transaction.
Name | Description |
---|---|
| The blockchain address from which the token transfer originated. |
| The blockchain address targeted by the token transfer. |
| The value of the token transfer expressed in the smallest denomination of the respective token. Also known as amount in Base Units. |
| The blockchain address of the token contract. |
| The abbreviated representation of the token (e.g. ETH, USDT). This is optional as some tokens might not have a defined symbol. |
| The number of decimal places of the token. To obtain the logical amount of the token, divide the smallest denomination (amount in Base Units) by 10 raised to the power of decimals. For example, if an amount is 1,000,000 and decimals is 6, the Token Value or Logical Amount is calculated as 1,000,000 / (10^6) = 1.0. |
Transaction
A transaction on the blockchain.
Name | Description |
---|---|
| The unique hash identifier of the transaction on the blockchain. |
| The timestamp of when the transaction was mined. |
| The block height of when the transaction was mined. |
| Specifies the kind of activity performed in a transaction. |
| The blockchain address from which the transaction originated. |
| The blockchain address targeted by the transaction. |
| The value of the transaction expressed in the smallest denomination of the respective token. Also known as amount in Base Units. |
| The number of decimal places of the token. To obtain the logical amount of the token, divide the smallest denomination (amount in Base Units) by 10 raised to the power of decimals. For instance, if an amount is 1,000,000 and decimals is 6, the Token Value / Logical Amount is calculated as 1,000,000 / (10^6) = 1.0. |
| The abbreviated representation of the token (e.g. ETH, USDT). |
| The status of transaction. |
| The cost per unit of gas, indicating how much the sender is willing to pay for each unit of work. Typically denominated in wei for EVM-based chains. Deprecated We no longer use gasFee, use |
| The total amount of gas units consumed by the transaction. It represents the computational work required for the transaction or contract execution. Deprecated We no longer use gasUsed, use |
| The network cost, indicating how much the sender is willing to pay for each unit of work. Typically denominated in wei for EVM-based chains. |
| The total fee consumed by the transaction. It represents the computational work required for the transaction or contract execution. |
| An array of one or multiple token transfer information of the transaction. |
| The transaction request associated with this transaction. |
TransactionIntentSummary
A wallet-agnostic interpretation of a given Transaction Request. This object aims to provide a common interface for representing the data of a given Transaction Request, for the client's convenience.
Name | Description |
---|---|
| The request ID that is summarized |
| The transaction intention |
| Source of the involved fund if applicable |
| Destination of involved fund if applicable |
| Involved fund amount |
| Contract call data |
| The identifier of the asset associated with the transaction. |
| The Asset associated with the transaction. |
|
TransactionListResult
List of transactions.
Name | Description |
---|---|
The list of transactions. | |
| Limit of rows of current query. |
| Cursor value to query for next page. This value will be null after the last page, when |
| The error code, if any. |
| The error message, if any. |
TransactionRequest
Details of a transaction request.
Name | Description |
---|---|
| The system-generated unique ID of the transaction request. |
| The client-specified unique ID of the transaction request, if provided at request time. |
| The system-generated unique ID of the wallet initiating the request. |
| The system-generated unique ID of the NetworkAsset associated with the transaction request, or |
| The system-generated unique ID of the member initiating the transaction. |
| Current status of the transaction request. |
| The blockchain hash of the processed transaction. |
| The raw transaction data to be processed on chain. The value is |
| The signed version of the transaction data. |
| Signature of the transaction request. |
| Remarks of the transaction request. |
| The timestamp of when the transaction request was created. |
| The timestamp of the last update to the transaction request. |
| The wallet that this transaction request belongs to. |
| The summary of the transaction request data (for EVM). Deprecated Use |
| The summary of the transaction request data. |
| The digests of the transaction request. Arguments for
|
| The asset / token associated with the transaction request. |
| Perform gas estimation for a transaction request. |
| The detailed approvals of the transaction request. |
| Retrieve the cryptographic signature for the transaction request. This signature from the final approver confirms consent to broadcast the transaction to the network. Deprecated Replaced with |
| The member who initiated the transaction request. |
| An array of warnings for the given transaction request. A warning contains details describing a potential issue with the transaction request when it is executed on-chain. For example, the account |
TransactionRequestApproval
The transaction request approval.
Name | Description |
---|---|
| The system-generated unique ID of the transaction request approval. |
| The system-generated unique ID of the approver. |
| The type of approval action. |
| The date and time when the transaction request approval was created. |
| The date and time when the transaction request approval was last updated. |
| The approver of the transaction request. |
TransactionRequestApprovalEdge
Name | Description |
---|---|
The item at the end of the edge in the connection. | |
| A cursor for use in pagination. |
TransactionRequestDataSummaryEvm
A wallet-agnostic interpretation of a given Transaction Request on EVM blockchains. This object aims to provide a common interface for representing the data of a given Transaction Request, for the client's convenience. A good use-case for this object is for "list" operations.
Name | Description |
---|---|
| The address of the recipient of the transaction. |
| The (smart contract call) data of the transaction. |
| The value to be transferred to the recipient of the transaction. |
TransactionRequestEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
TransactionRequestSignature
A signature request.
Name | Description |
---|---|
| The system-generated unique ID of the transaction request. |
| The system-generated unique ID of the signer. |
| The type of signature action. |
| The date and time the signature request was created. |
| The wallet access that signed the transaction request. |
TransactionRequestWarning
An object describing a potential issue with the transaction request.
Name | Description |
---|---|
A short phrase summarizing the warning. | |
| The description of the warning. |
| Whether the transaction request will fail on-chain if executed. If |
User
A user.
Name | Description |
---|---|
| The unique identifier provided by the authentication service. |
| User's email address. |
| User's first name. |
| User's last name. |
| User's marketing opt-in. |
| User's product updates opt-in. |
| Fetches a paginated list of organizations the user is a member of. |
| Get a user preference by key. Only the viewer can fetch its own preferences. Arguments for
|
| Fetches a paginated list of user preferences. Only the viewer can fetch its own preferences. |
UserPreference
A user preference.
Name | Description |
---|---|
| The system-generated unique ID of the user preference. |
| The key of the preference. A user can have only one preference per key. |
| The value of the preference. |
| The datetime the preference was created. |
| The datetime the preference was last updated. |
UserPreferenceEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
Wallet
A 2-of-3 multi-sig wallet.
Name | Description |
---|---|
| The ID of the OrganizationNetwork on which the wallet was created. |
| The system-generated unique ID of the wallet. |
| The wallet's type. |
| The human-readable name of the wallet. |
| A description of the wallet. |
| The wallet's on-chain address. |
| The CAIP-10 identifier of the wallet. |
The status of the wallet, indicating whether or not it is ready for use. | |
| The hash of the wallet contract deployment transaction. |
| A unique 12-digit identifier of an organization. |
| (EVM chains only) The ID of the associated gas tank that will execute transactions for the wallet. |
| The timestamp of when the wallet was soft-deleted. Will be null if the wallet has not been soft-deleted, or if it has been recovered. |
| CAIP-2 identifier of the network the wallet belongs to. |
| List all the transactions for the given wallet. Arguments for
cursor value. |
| Retrieve information about the OrganizationNetwork the wallet belongs to. |
| List all the WalletAccess entries for the given wallet. |
| Get the WalletAccess entry for the current viewer. |
| List all the approvers of the given wallet. |
| The details of the signing key for the wallet. |
| Get the details of a Key that is a signatory of the given wallet. Arguments for
|
| Get the details of a transaction request for the given wallet. |
| List all the transaction requests for the given wallet. Arguments for
|->|->|->
<-|<-|<-|
|
| List the asset balances of the wallet. |
| Get the policy of the wallet. |
| Get the wallet keys for the given wallet. |
| Get the deployment status of the wallet. Arguments for
true , returns the deployment status for inactive wallets only. |
| Get the details of a single transaction for the parent wallet. Arguments for
|
| The list of deposit addresses for the wallet. |
| Retrieve the details of a deposit address. Arguments for
|
| Retrieve the detail of a main address. |
| Build a transaction for the given wallet. Arguments for
|
| (EVM chains only) Retrieve the details of the associated gas tank for the given wallet. |
| Indicates whether the wallet requires the organization gas tank to execute transactions. For EVM chains, this is always true, given that the organization gas tank acts as a co-signer and pay-master for the contract-based wallet. For Tron, this is true since the gas tank can activate deposit addresses on chain.For UTXO chains, this is false, given that the wallet pays for its own transactions. |
| Retrieve information about the organization that the wallet belongs to. |
WalletAccess
Describes an organization member's access to an organization wallet.
Name | Description |
---|---|
| The system-generated unique ID of the wallet. |
| The system-generated unique ID of the organization member's wallet access. |
| The system-generated unique ID of the organization member. |
| The wallet role of the organization member. |
| The datetime the organization member's wallet access was created. |
| The datetime the organization member's wallet access was last updated. |
| The wallet the member has access to. |
| Details of an organization member. |
WalletAccessEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
WalletDepositAddress
The fields of a wallet deposit address.
Name | Description |
---|---|
| The system-generated unique ID of the created deposit address. |
| The system-generated unique ID of the wallet. |
| The label of the deposit address. |
| The deposit address for the wallet. |
| The created datetime for the deposit address. |
| The status of the deposit address. |
| The datetime the deposit address was last updated. |
| Get the details of a single transaction for a deposit address. Arguments for
|
| List all the transactions for the given deposit address. Arguments for
cursor value. |
| List the asset balances of the deposit address. |
WalletDepositAddressEdge
Name | Description |
---|---|
The item at the end of the edge in the connection. | |
| A cursor for use in pagination. |
WalletEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
WalletFinalApprover
The wallet final approver.
Name | Description |
---|---|
| The system-generated unique ID of the wallet's final approver. |
| The system-generated unique ID of the organization member's wallet access. |
| The status of the wallet signer to indicate if the signer is active or disabled. |
| The datetime the wallet's final approver was created. |
| The datetime the wallet's final approver was last updated. |
| Details of an organization member's access to an organization wallet. |
WalletFinalApproverEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
WalletKey
Name | Description |
---|---|
| The system-generated unique ID of the WalletKey entity. |
| The system-generated unique ID of the wallet. |
| The system-generated unique ID of the key. |
| The type of wallet key. Refer to |
| The datetime the key was created. |
| The wallet associated with the given wallet ID. |
| The key associated with the given key ID. |
| The encrypted private key associated with the viewer. If not found, the first wallet key password is returned. |
| Returns the primary password associated with the wallet key. |
WalletKeyEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
WalletPolicy
The wallet policy.
Name | Description |
---|---|
| The system-generated unique ID of the wallet policy. |
| The system-generated unique ID of the wallet. |
| Minimum number of approvals required to approve a transaction. |
| The datetime the wallet policy was created. |
| The datetime the wallet policy was last updated. |
| Details of the whitelist policies of a wallet. Arguments for
|
| Details of the whitelist policies of a wallet. |
| Details of the final approvers of a wallet. |
WalletPolicyWhitelistEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
WalletTransaction
A transaction on the wallet.
Name | Description |
---|---|
| The hash of the transaction. |
| The type of transaction. |
| The timestamp of the transaction. |
| The initator of the transaction. |
| The recipient of the transaction. |
| The amount of the transaction in wei / the smallest unit of the network's currency. |
| The status of the transaction. |
| Asset movements incurred by this transaction. |
YieldProduct
A yield product.
Name | Description |
---|---|
| A system-generated unique ID of the network. |
| The token identifier of the yield protocol token. |
| The name of the yield product. |
| The yield protocol of this product. |
| Metadata of the yield product. |
| The date and time when the network was created. |
| The timestamp of when the network was soft-deleted. Will be null if the network has not been soft-deleted, or if it has been recovered. |
| Lookup yield product's protocol. |
|
|
YieldProductEdge
Name | Description |
---|---|
| The item at the end of the edge in the connection. |
| A cursor for use in pagination. |
YieldProtocol
A yield protocol.
Name | Description |
---|---|
| |
| The name of the yield protocol (e.g. Compound V2). |
| Metadata of the yield protocol. |
| The date and time when the network was created. |