Skip to main content

Entities

AudiusNetwork​

Description:

FieldTypeDescription
idID!ID is set to 1
audiusTokenAddressBytesaudiusToken address
claimsManagerAddressBytesclaimsManager address
delegateManagerAddressBytesdelegateManager address
governanceAddressBytesgovernance address
registryBytesregistry address
serviceProviderFactoryAddressBytesserviceProviderFactory address
serviceTypeManagerAddressBytesserviceTypeManager address
stakingAddressBytesstaking address
registryAddressBytesregistry address
totalSupplyBigInt!Total supply of $AUDIO
totalAUDIOMintedBigInt!Total amount of $AUDIO minted
totalAUDIOBurnedBigInt!Total amount of $AUDIO burned
totalTokensStakedBigIntTotal amount of $AUDIO staked
totalTokensClaimableBigIntTotal tokens that are settled and claimable
totalTokensLockedBigIntTotal tokens that are currently locked or withdrawable in the network from unstaking/undelegating
totalTokensDelegatedBigIntTotal delegated tokens in the protocol
maxDelegatorsBigIntThe max number of delegators per service provider
inDelegationAmountBigIntThe minimum amount needed to delegate
undelegateLockupDurationBigIntThe minimum number of blocks the user must wait from requesting undelegation to evaluating
removeDelegatorLockupDurationBigIntThe minimum number of blocks the user must wait from requesting remove delegator to evaluating
removeDelegatorEvalDurationBigIntEvaluation period for a remove delegator request
decreaseStakeLockupDurationBigIntNumber of blocks a decrease stake request is in lockup before evaluation is allowed
updateDeployerCutLockupDurationBigIntNumber of blocks an update deployer cut request is in lockup before evaluation is allowed
fundingRoundBlockDiffBigInt
fundingAmountBigInt
recurringCommunityFundingAmountBigInt
communityPoolAddressBytesaddress
votingQuorumPercentBigInt
votingPeriodBigInt
executionDelayBigInt
maxInProgressProposalsInt
guardianAddressBytes
requestCountBigInt!
totalStakedBigInt!

ServiceType​

Description:

FieldTypeDescription
idIDThe type of the service ie. creator-node
isValidBoolean!If the service is removed of not
minStakeBigInt!Minimum Token Stake to run the service
maxStakeBigInt!Max Token Stake to run the service
versions[ServiceTypeVersion!]! @derivedFrom(field: serviceType")

ServiceTypeVersion​

Description:

FieldTypeDescription
idID!
serviceTypeServiceType!
serviceVersionString!
blockNumberBigInt!

ServiceNode​

Description:

FieldTypeDescription
idID!ID - generated from service-type and spID
spIdBigInt!Service provider ID - autoincrementing id created for each new service node
ownerUser!Reference to user that registered this service
typeServiceType!Reference to the service type
endpointString!URI to access the service node
delegateOwnerWalletBytes!Address used to confirm the ownership of the service node
createdAtInt!When the service node was created
isRegisteredBoolean!Boolean if th service is registered/deregistered

User​

Description:

FieldTypeDescription
idID!Eth address of User
balanceBigInt!Token balance
totalClaimableAmountBigInt!The total staked/delegated minus pending decrease stake/delegation
claimableStakeAmountBigInt!The total staked minus pending decrease stake
claimableDelegationReceivedAmountBigInt!The total delegation received from other users minus their pending decrease delegation
claimableDelegationSentAmountBigInt!The total delegation sent to other users minus my own pending decrease delegation
stakeAmountBigInt!The total staked
delegationReceivedAmountBigInt!The total delegated
delegationSentAmountBigInt!The total delegation sent
hasStakeOrDelegationBoolean!Boolean set to true if the user has stake or delegation
validBoundsBooleanIf the user's stake is between the min/max stake
deployerCutBigIntThe percentage of the claim from the delegator that the deployer takes
services[ServiceNode!] @derivedFrom(field: "owner")List of services operated by the user
minAccountStakeBigIntMax stake of the user as determined by number of services and service types
maxAccountStakeBigIntMin stake of the user as determined by number of services and service types
delegateTo[Delegate!] @derivedFrom(field: "fromUser")Reference to delegations (user & amount) sent by user
delegateFrom[Delegate!] @derivedFrom(field: "toUser")Reference to delegations (user & amount) received by user
pendingDecreaseStakeDecreaseStakeEventReference to request to pending decrease stake
pendingRemoveDelegatorRemoveDelegatorEventDEPRECATED: Use event with service operator and delegator id
pendingUpdateDeployerCutUpdateDeployerCutEventReference to request to update deployer cut
pendingUndelegateStakeUndelegateStakeEventReference to request to update undelegate stake
votes[Vote!] @derivedFrom(field: "voter")Reference to votes by the user
createdAtBigInt!

Delegate​

Description:

FieldTypeDescription
idID!ID - generated w/ the service provider's & delegator's addresses
idID!ID - generated w/ the service provider's & delegator's addresses
claimableAmountBigInt!The amount delegated minus the pending decrease delegation
amountBigInt!The amount delegated
fromUserUser!Reference to the user sending/delegating tokens
toUserUser!Reference to the user receiving delegation

DecreaseStakeEvent​

Description:

FieldTypeDescription
idID!
statusLockupStatus!
ownerUser!
expiryBlockBigInt!
createdBlockNumberBigInt!
endedBlockNumberBigInt
decreaseAmountBigInt!
newStakeAmountBigInt

UpdateDeployerCutEvent​

Description: implements LockupEvent

FieldTypeDescription
idID!
statusLockupStatus!
ownerUser!
expiryBlockBigInt!
createdBlockNumberBigInt!
endedBlockNumberBigInt
updatedCutBigInt!

RemoveDelegatorEvent​

Description:

FieldTypeDescription
idID!
statusLockupStatus!
ownerUser!
expiryBlockBigInt!
createdBlockNumberBigInt!
endedBlockNumberBigInt
updatedCutBigInt!
delegatorUser!

UndelegateStakeEvent​

Description:

FieldTypeDescription
idID!
statusLockupStatus!
ownerUser!
expiryBlockBigInt!
createdBlockNumberBigInt!
endedBlockNumberBigInt
serviceProviderUser!
amountBigInt!

IncreasedStakeEvent​

Description:

FieldTypeDescription
idID!
ownerUser!
newStakeAmountBigInt!
increaseAmountBigInt!
blockNumberBigInt!

IncreasedDelegatedStakeEvent​

Description:

FieldTypeDescription
idID!
delegatorUser!
serviceProviderUser!
increaseAmountBigInt!
blockNumberBigInt!

ClaimEvent​

Description:

FieldTypeDescription
idID!
claimerUser!
rewardsBigInt!
newTotalBigInt!
blockNumberBigInt!

SlashEvent​

Description:

FieldTypeDescription
idID!
targetUser!
amountBigInt!
newTotalBigInt!
blockNumberBigInt!

ClaimRound​

Description:

FieldTypeDescription
idID!The round number
fundAmountBigInt!
blockNumberBigInt!

ClaimProcessedEvent​

Description:

FieldTypeDescription
idID!
rewardsBigInt!
claimerUser!
oldTotalBigInt!
newTotalBigInt!
blockNumberBigInt!

RegisterProviderServicerEvent​

Description:

FieldTypeDescription
idID!
typeServiceType!
spIdBigInt!
nodeServiceNode!
ownerUser!
endpointString!
stakeAmountBigInt!
blockNumberBigInt!

DeregisterProviderServicerEvent​

Description:

FieldTypeDescription
idID!
typeServiceType!
spIdBigInt!
nodeServiceNode!
ownerUser!
endpointString!
unstakeAmountBigInt!
blockNumberBigInt!

Proposal​

Description:

FieldTypeDescription
idID!Proposal ID from the event (auto-incrementing)
nameString!Proposal name
descriptionString!Proposal description
proposerUser!Reference to the user submitting the proposal
submissionBlockNumberBigInt!
targetContractRegistryKeyBytes!
targetContractAddressBytes!
callValueBigInt!
functionSignatureString!
callDataBytes!
outcomeOutcomeTODO: convert int to enum - Outcome
voteMagnitudeYesBigInt!Total vote weight for 'Yes'
voteMagnitudeNoBigInt!Total vote weight for 'No'
numVotesBigInt!Number of votes
votes[Vote!]! @derivedFrom(field: "proposal")Reference to the votes - user & vote weight

Vote​

Description:

FieldTypeDescription
idID!ID - generated from proposal id and user address
proposalProposal!Reference to the proposal
voteVoteTypeTODO: update to enum - the voter's vote
magnitudeBigInt!The vote weight - the voter's claimable stake
voterUser!Reference the the user submitting the voter
createdBlockNumberBigInt!The block number the vote was created
updatedBlockNumberBigIntThe block number the vote was updated

ProposalSubmittedEvent​

Description:

FieldTypeDescription
idID!
proposalProposal!
proposerUser!
nameString!
descriptionString!

ProposalVoteSubmittedEvent​

Description:

FieldTypeDescription
idID!
proposalProposal!
voterUser!
voteVote!
currentVoteVoteType!
voterStakeBigInt!
blockNumberBigInt!

ProposalVoteUpdatedEvent​

Description:

FieldTypeDescription
idID!
proposalProposal!
voterUser!
voteVote!
voterStakeBigInt!
currentVoteVoteType!
previousVoteVoteType!
blockNumberBigInt!

ProposalOutcomeEvaluatedEvent​

Description:

FieldTypeDescription
id:ID!
proposal:Proposal!
outcome:Outcome
voteMagnitueYesBigInt!
voteMagnitudeNo:BigInt!
numVotes:BigInt!
blockNumberBigInt!

ProposalTransactionExecutedEvent​

Description:

FieldTypeDescription
idID!
proposalProposal!
successBoolean!
returnDataBytes
blockNumberBigInt!

GuardianTransactionExecutedEvent​

Description:

FieldTypeDescription
idID!
targetContractAddress:Bytes!
callValueBigInt!
functionSignature:String!
callDataBytes!
returnDataBytes!
blockNumberBigInt!

ProposalVetoedEvent​

Description:

FieldTypeDescription
idID!
proposalProposal!
blockNumberBigInt!