Skip to main content

Entities

AudiusNetwork

Description:

FieldTypeDescription
idIDID is set to 1
audiusTokenAddressBytesaudiusToken address
claimsManagerAddressBytesclaimsManager address
delegateManagerAddressBytesdelegateManager address
governanceAddressBytesgovernance address
registryBytesregistry address
serviceProviderFactoryAddressBytesserviceProviderFactory address
serviceTypeManagerAddressBytesserviceTypeManager address
stakingAddressBytesstaking address
registryAddressBytesregistry address
totalSupplyBigIntTotal supply of $AUDIO
totalAUDIOMintedBigIntTotal amount of $AUDIO minted
totalAUDIOBurnedBigIntTotal 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

ClaimEvent

Description:

FieldTypeDescription
idID
claimerUser
rewardsBigInt
newTotalBigInt
blockNumberBigInt

ClaimProcessedEvent

Description:

FieldTypeDescription
idID
rewardsBigInt
claimerUser
oldTotalBigInt
newTotalBigInt
blockNumberBigInt

ClaimRound

Description:

FieldTypeDescription
idIDThe round number
fundAmountBigInt
blockNumberBigInt

DecreaseStakeEvent

Description:

FieldTypeDescription
idID
statusLockupStatus
ownerUser
expiryBlockBigInt
createdBlockNumberBigInt
endedBlockNumberBigInt
decreaseAmountBigInt
newStakeAmountBigInt

Delegate

Description:

FieldTypeDescription
idIDID - generated w/ the service provider's & delegator's addresses
idIDID - generated w/ the service provider's & delegator's addresses
claimableAmountBigIntThe amount delegated minus the pending decrease delegation
amountBigIntThe amount delegated
fromUserUserReference to the user sending/delegating tokens
toUserUserReference to the user receiving delegation

DeregisterProviderServicerEvent

Description:

FieldTypeDescription
idID
typeServiceType
spIdBigInt
nodeServiceNode
ownerUser
endpointString
unstakeAmountBigInt
blockNumberBigInt

GuardianTransactionExecutedEvent

Description:

FieldTypeDescription
idID
targetContractAddressBytes
callValueBigInt
functionSignatureString
callDataBytes
returnDataBytes
blockNumberBigInt

IncreasedDelegatedStakeEvent

Description:

FieldTypeDescription
idID
delegatorUser
serviceProviderUser
increaseAmountBigInt
blockNumberBigInt

IncreasedStakeEvent

Description:

FieldTypeDescription
idID
ownerUser
newStakeAmountBigInt
increaseAmountBigInt
blockNumberBigInt

Proposal

Description:

FieldTypeDescription
idIDProposal ID from the event (auto-incrementing)
nameStringProposal name
descriptionStringProposal description
proposerUserReference to the user submitting the proposal
submissionBlockNumberBigInt
targetContractRegistryKeyBytes
targetContractAddressBytes
callValueBigInt
functionSignatureString
callDataBytes
outcomeOutcomeTODO: convert int to enum - Outcome
voteMagnitudeYesBigIntTotal vote weight for 'Yes'
voteMagnitudeNoBigIntTotal vote weight for 'No'
numVotesBigIntNumber of votes
votesVoteDerived from field: "proposal" - Reference to the votes - user & vote weight

ProposalOutcomeEvaluatedEvent

Description:

FieldTypeDescription
idID
proposalProposal
outcomeOutcome
voteMagnitueYesBigInt
voteMagnitudeNoBigInt
numVotesBigInt
blockNumberBigInt

ProposalSubmittedEvent

Description:

FieldTypeDescription
idID
proposalProposal
proposerUser
nameString
descriptionString

ProposalTransactionExecutedEvent

Description:

FieldTypeDescription
idID
proposalProposal
successBoolean
returnDataBytes
blockNumberBigInt

ProposalVoteSubmittedEvent

Description:

FieldTypeDescription
idID
proposalProposal
voterUser
voteVote
currentVoteVoteType
voterStakeBigInt
blockNumberBigInt

ProposalVoteUpdatedEvent

Description:

FieldTypeDescription
idID
proposalProposal
voterUser
voteVote
voterStakeBigInt
currentVoteVoteType
previousVoteVoteType
blockNumberBigInt

ProposalVetoedEvent

Description:

FieldTypeDescription
idID
proposalProposal
blockNumberBigInt

RegisterProviderServicerEvent

Description:

FieldTypeDescription
idID
typeServiceType
spIdBigInt
nodeServiceNode
ownerUser
endpointString
stakeAmountBigInt
blockNumberBigInt

RemoveDelegatorEvent

Description:

FieldTypeDescription
idID
statusLockupStatus
ownerUser
expiryBlockBigInt
createdBlockNumberBigInt
endedBlockNumberBigInt
updatedCutBigInt
delegatorUser

ServiceNode

Description:

FieldTypeDescription
idIDID - generated from service-type and spID
spIdBigIntService provider ID - autoincrementing id created for each new service node
ownerUserReference to user that registered this service
typeServiceTypeReference to the service type
endpointStringURI to access the service node
delegateOwnerWalletBytesAddress used to confirm the ownership of the service node
createdAtIntWhen the service node was created
isRegisteredBooleanBoolean if th service is registered/deregistered

ServiceType

Description:

FieldTypeDescription
idIDThe type of the service ie. creator-node
isValidBooleanIf the service is removed of not
minStakeBigIntMinimum Token Stake to run the service
maxStakeBigIntMax Token Stake to run the service
versionsServiceTypeVersionDerived from field: "serviceType"

ServiceTypeVersion

Description:

FieldTypeDescription
idID
serviceTypeServiceType
serviceVersionString
blockNumberBigInt

SlashEvent

Description:

FieldTypeDescription
idID
targetUser
amountBigInt
newTotalBigInt
blockNumberBigInt

UndelegateStakeEvent

Description:

FieldTypeDescription
idID
statusLockupStatus
ownerUser
expiryBlockBigInt
createdBlockNumberBigInt
endedBlockNumberBigInt
serviceProviderUser
amountBigInt

UpdateDeployerCutEvent

Description: implements LockupEvent

FieldTypeDescription
idID
statusLockupStatus
ownerUser
expiryBlockBigInt
createdBlockNumberBigInt
endedBlockNumberBigInt
updatedCutBigInt

User

Description:

FieldTypeDescription
idIDEth address of User
balanceBigIntToken balance
totalClaimableAmountBigIntThe total staked/delegated minus pending decrease stake/delegation
claimableStakeAmountBigIntThe total staked minus pending decrease stake
claimableDelegationReceivedAmountBigIntThe total delegation received from other users minus their pending decrease delegation
claimableDelegationSentAmountBigIntThe total delegation sent to other users minus my own pending decrease delegation
stakeAmountBigIntThe total staked
delegationReceivedAmountBigIntThe total delegated
delegationSentAmountBigIntThe total delegation sent
hasStakeOrDelegationBooleanBoolean 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
servicesServiceNodeDerived from 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
delegateToDelegateDerived from field: "fromUser" - Reference to delegations (user & amount) sent by user
delegateFromDelegateDerived from 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
votesVoteDerived from field: "voter" - Reference to votes by the user
createdAtBigInt

Vote

Description:

FieldTypeDescription
idIDID - generated from proposal id and user address
proposalProposalReference to the proposal
voteVoteTypeTODO: update to enum - the voter's vote
magnitudeBigIntThe vote weight - the voter's claimable stake
voterUserReference the the user submitting the voter
createdBlockNumberBigIntThe block number the vote was created
updatedBlockNumberBigIntThe block number the vote was updated