4.9.1Get the last activities of a user.
(Object)
web3 account instance
(Object)
options
| Name | Description |
|---|---|
userOptions.safeAddress string
|
Safe address of user |
userOptions.limit number
|
pagination page size |
userOptions.offset number
|
pagination start index |
userOptions.timestamp number
|
show only messages after this time |
userOptions.filter symbol
|
optional filter for message types |
Object:
List of latest activities
Upload an avatar image to storage.
object:
Returns url, file name and file type of the uploaded image
Delete from storage an avatar image whose url is not connected to any user entry.
(Object)
web3 account instance
boolean:
Returns true when successful
Base class of CirclesCore.
(Web3)
instance of Web3
(Object)
global core options
Type: Web3
Get the last news activities.
Object:
List of latest activities
Returns true if there are enough balance on this Safe address to create an organization account.
(Object)
web3 account instance
boolean:
has enough funds
Create a new organization account
(Object)
web3 account instance
string:
transaction hash
Find out if address is an organization
(Object)
web3 account instance
boolean:
True if organization
Organizations do not hold their own Token and need to be prefunded with a Circles Token to be functional from the beginning (in case transactions are going through the relayer). This method is a special workaround to create a trust connection to a regular user to then transfer Tokens from that user to the organization.
This method only works if the user and the organization owner are the same as transactions are signed with the same private key.
(Object)
web3 account instance
string:
transaction hash
Returns a list of organization members.
(Object)
web3 account instance
Array:
list of members with connected safes and owner address
Predict Safe address.
(Object)
web3 account instance
string:
Predicted Gnosis Safe address
Returns status of a Safe in the system. Is it created or already deployed?
(Object)
web3 account instance
Object:
Safe status
Register a to-be-created Safe in the Relayer and receive a predicted Safe address.
(Object)
web3 account instance
string:
Predicted Gnosis Safe address
Returns true if there are enough balance on this address to deploy a Safe.
(Object)
web3 account instance
boolean:
has enough funds
Requests the relayer to not wait for the Safe deployment task. This might still fail when the Safe is not funded or does not have enough trust connections yet.
(Object)
web3 account instance
boolean:
returns true when successful
Requests the relayer to deploy a Safe for an organization. The relayer funds the deployment of this Safe when the account is already known and verified / already has a deployed Safe from before.
(Object)
web3 account instance
boolean:
returns true when successful
Finds the Safe addresses of an owner.
(Object)
web3 account instance
string:
Safe address
Returns a list of all owners of the given Gnosis Safe.
(Object)
web3 account instance
Array<string>:
array of owner addresses
Add an address as an owner of a given Gnosis Safe.
(Object)
web3 account instance
string:
transaction hash
Remove owner of a given Gnosis Safe.
(Object)
web3 account instance
string:
transaction hash
Get Safe version.
(Object)
web3 account instance
string:
transaction hash
Update Safe version to the last version (v1.3.0) by changing the the Master Copy.
(Object)
web3 account instance
string:
transaction hash
Returns true if there are enough balance on this Safe address to deploy a Token contract.
(Object)
web3 account instance
boolean:
has enough funds
Returns the direct send limit to a user.
(Object)
web3 account instance
BN:
send limit
Deploy new Circles Token for a user.
(Object)
web3 account instance
string:
transaction hash
Get Token address by passing owner address.
(Object)
web3 account instance
string:
Token address (when not deployed returns zero address)
List all available tokens of this user.
(Object)
web3 account instance
Array:
list of all tokens with ownerAddress, address and amount
Get summarized balance of all or one Token owned by a user.
(Object)
web3 account instance
BN:
current balance
Find Transitive Transfer Steps using either the cli or the server version of the pathfinder2. The algorithms compute the maximum flow in a trust network between two users. It returns the maximum flow and the transfer steps in the graph for a value (when possible).
This method does not execute any real transactions.
(Object)
web3 account instance
(Object)
search arguments
| Name | Description |
|---|---|
userOptions.from string
|
sender Safe address |
userOptions.to string
|
receiver Safe address |
userOptions.value BN
|
value for transactions path |
userOptions.hops number
|
max number of trust hops away from 'from' to find transfer steps. Ignored if pathfinderType is 'server' |
userOptions.maxTransfers number
|
limit of steps returned by the pathfinder service. Ignored if pathfinderType is 'cli' |
Object:
maximum possible Circles value and transactions path
Update the transitive transfer steps from someone to someone for an amount of Circles.
This method does not execute any real transactions.
(Object)
web3 account instance
(Object)
search arguments
| Name | Description |
|---|---|
userOptions.from string
|
sender Safe address |
userOptions.to string
|
receiver Safe address |
userOptions.value BN
|
value for transactions path |
userOptions.hops number
|
maximum number of trust hops away from them sending user inside the trust network for finding transaction steps |
boolean:
steps are updated
Transfer Circles from one user to another.
(Object)
web3 account instance
(Object)
options
| Name | Description |
|---|---|
userOptions.from string
|
sender address |
userOptions.to string
|
receiver address |
userOptions.value BN
|
value |
userOptions.paymentNote string
|
optional payment note stored in API |
userOptions.hops number
|
maximum number of trust hops away from them sending user inside the trust network for finding transaction steps |
userOptions.maxTransfers number
|
limit of steps returned by the pathfinder service. Ignored if pathfinderType is 'cli' |
string:
transaction hash
Return the payment Note of an transaction from or to the user.
(Object)
web3 account instance
string:
Payment note, null when not given or not allowed
Return the current value of the pending UBI payout.
(Object)
web3 account instance
BN:
payout value
Request a UBI payout.
(Object)
web3 account instance
string:
Transaction hash
Find out if safe address has enough incoming trust connections.
(Object)
web3 account instance
Object:
Trust state and number of connections
Get a Safe trust network with mutual trusts connections. The network is created based on the people the safe trusts (incoming) and the people that trust this Safe (outgoing)
(Object)
web3 account instance
Object:
Safe trust network
Give other users possibility to send their Circles to you by giving them your trust.
(Object)
web3 account instance
string:
transaction hash
Revoke a trust connection with a user. You don't allow this user to transfer their Token to or through you.
(Object)
web3 account instance
string:
transaction hash
Makes a dry-run registration to check if the username and email are valid.
(Object)
web3 account instance
boolean:
Returns true when successful, otherwise throws error
Register a new username and email address and connect it to a Safe address.
(Object)
web3 account instance
boolean:
Returns true when successful
Update username, email address, and/or image url, connected to a deployed Safe address.
(Object)
web3 account instance
boolean:
Returns true when successful
Delete user entry connected to a deployed Safe address.
(Object)
web3 account instance
boolean:
Returns true when successful
Find multiple user entries by Safe address and username.
(Object)
web3 account instance
Array<Object>:
List of users
Search for users by username.
(Object)
web3 account instance
Array<Object>:
List of users
Get email of user.
(Object)
web3 account instance
email:
Email of the user
Iterate on a request until a response condition is met and then, returns the response.
(function)
request to iterate on
(function)
condition function that checks if request will be call again
any:
response of the target request
Detect an Ethereum address in any string.
(string)
string
string:
Ethereum address or null
Convert to fractional monetary unit of Circles named Freckles.
string:
value in Freckles
Convert from Freckles to Circles number.
number:
value in Circles
Send an API request to the Gnosis Relayer.
Query the Graph Node with GraphQL.
Query the Graph Node or Land Graph Node with GraphQL.
Get a list of all tokens and their current balance a user owns. This can be used to find the right token for a transaction.
Array:
List of tokens with current balance and address
Send Transaction to Relayer and pay with Circles Token.
(Object)
web3 account instance
string:
transaction hash
Send a transaction to the relayer which will be executed by it. The gas costs will be estimated by the relayer before.
(Object)
web3 account instance
(Object)
query options
| Name | Description |
|---|---|
userOptions.safeAddress string
|
address of Safe |
userOptions.to string
|
forwarded address (from is the relayer) |
userOptions.gasToken string
|
address of ERC20 token |
userOptions.txData Object
|
encoded transaction data |
userOptions.value number
|
value in Wei |
userOptions.isCRCVersion boolean
|
is the Safe v1.1.1+Cirlces, false by default |
string:
transaction hash
Make a request to the Circles server API.
Object:
API response
Make a request to the Circles server API.
Object:
API response
Estimates the total gas fees for a relayer transaction.
(Object)
web3 account instance
(Object)
transaction options
| Name | Description |
|---|---|
userOptions.safeAddress string
|
address of Safe |
userOptions.to string
|
forwarded address (from is the relayer) |
userOptions.gasToken string
|
address of ERC20 token |
userOptions.txData Object
|
encoded transaction data |
userOptions.value number
|
value in Wei |
BN:
estimated gas fees