Qredo API
Web3 API Wallet
Supported in | Prerequisites |
---|---|
v1 | Requirements |
TL;DR
- The Web3 API Wallet is a Connected Wallet service providing custody over your assets
- You can create transactions from Layer 1 Wallets on any supported network
- You can use endpoints that support creating transactions and viewing a transaction's status
- Use the Signing Agent to automate the approval flow
- Learn how to add a Connected Wallet
- Learn how to add a Web3 API Wallet
Prerequisites
Further to the basic requirements, you need the following to use the Web3 API Wallet service:
An Organization with the Connected Wallet feature enabled. To enable a Connected Wallet, contact [email protected].
A Fund with an associated Web3 API Wallet and credits within your Qredo Fee Station. It's recommended that the Web3 API Wallet custody is set up with multiple approvers. Such approvers may be active at the level of Organization or Wallet. They may be trusted parties or automated Signing Agents.
Service overview
The Web3 API Wallet is a Connected Wallet service that allows Qredo customers to create transactions from Layer 1 Wallets on any supported network while benefiting from Qredo's secure custody suite.
Transaction support
Qredo API v1 supports Type 0, 1, and 2 (EIP-1559) transactions. Learn more in the Knowledge Base.
Integrations
Whitelisting
The Web3 API Wallet supports the allowlisting of addresses to control where assets may be sent.
- Learn more in the help center.
Read-only
Fulfill your compliance and audit reporting requirements using the Read-only reporting service.
Signing Agent
The Web3 transaction service works together with the Signing Agent to automate the approval flow according to your customized ruleset.
Web3 API services
The Web3 API Wallet service provides endpoints that support creating transactions and viewing a transaction's status. Transactions submitted via this Web3 API Wallet are available from the Qredo Web App interface.
Endpoint | Description | Permission |
---|---|---|
POST /transaction | Submit a transaction for signing and approval | Write access |
GET /transactions/{tx_id}/approvals | Get approvals' status for a specific transaction | Read only |
GET /transactions/{tx_id}/status | Get status of a specific transaction | Read only |
Get /transactions/feed | WebSocket feed of status of transactions. | Read only |
See the Qredo API v1 specification for detailed information on how to use these endpoints.
Service use cases
1. Sign transactions for asset transfers
POST /transaction
allows trusted parties to create a new transaction, send it for approval, and receive it back, broadcast-ready.
- Learn more about transactions
2. Sign smart contract interactions
POST/transaction
allows trusted parties to create a new instruction to a smart contract, send it for approval, and receive it back broadcast-ready.
- Set
value
to "0" if the request doesn't transfer assets.
3. View approval status of a transaction
Two endpoints provide approval status:
Get /transactions/feed
provides a summary of the approval status for a transactionGET /transactions/{tx_id}/approvals
provides the details of a specific transaction based on the transaction ID.
Create a Web3 API Wallet
Once you have Connected Wallet permission enabled, you may add the Web3 API Wallet from within an Organization account via the Qredo Web App.
Personal accounts don't support Web3 API Wallets.
Follow the instructions to add a Connected Wallet.
Follow the instructions to select a Web3 API Wallet.
Select an approval policy
Setting an approval policy is a key step in creating secure custody over your assets.
Top up your Qredo Station.
Learn more about managing fees with Qredo Station
More information about fees is available in the help center.
Programmatic control
Remember to create API keys and customize their access over your Web3 API Wallet.