Types
Profile
Refers to the user's account information and preferences within the system. It's the overarching entity that owns the Wallet(s). A single Profile can have multiple Wallets, typically one for each supported blockchain network (e.g., one for BTC, one for ETH, etc.).
| property | description | type |
|---|---|---|
reference | the identifier for the user. | string |
addresses | the addresses associated with this wallet. | Address[] |
type | the type of the profile that you want to create. |
|
Wallet
It has a collection of addresses/assets/transactions related to a user. An easy way to view all of the interactions. it is referred to by the "miniwallet" in our system which can have upward of millions of addresses related to it. Each miniwallet has a network type, such as BTC, ETH, etc. And each user can have one wallet per network.
| property | description | type |
|---|---|---|
reference | the reference of the owner of this wallet. | string |
addresses | the addresses associated with this wallet. | Address[] |
user type | the type of the user who has this wallet |
|
network type | The type of network for the wallet. |
|
organizationId | the organization Id | string |
index | the index of this wallet | number |
currentDeepIndex | the number of children that this wallet has | number |
Address
Unique identifier within a specific blockchain network (like BTC, ETH, etc.) that represents a location where digital assets can be sent to or received. In the context of a Wallet, multiple addresses can be associated with a single user's Wallet. These addresses are like individual accounts within the larger Wallet structure, allowing users to manage and organize their digital assets more effectively.
| property | description | type |
|---|---|---|
reference | the reference of the owner of this wallet. | string |
date | date of the creation | Date |
address | the receiving address | string |
label | the label for this address, can be null | string | Null |
balance | the balance of this address | number |
Transaction
Represents any movement of digital assets or interaction with a blockchain. In the context of a Wallet, transactions show the history of incoming and outgoing transfers, as well as other blockchain interactions (like smart contract calls in networks that support them). Transactions are recorded for each address within the Wallet, allowing users to track all their activities across their numerous addresses.
| property | description | type |
|---|---|---|
date | date of the creation | Date |
amount | the amount that you want to send. | number |
id | the transaction id (Txid) | string |
address | the sender/receiver address | string |
isSpent | is this transaction spent or not | boolean |
isMempool | is this transaction in memory pool of the network | boolean |
status | the status of the transaction | |
transaction type | the type of the transaction |
|
totalElements | The number of transactions | number |
network type | The type of network for the wallet. |
|
Last updated