Entities

• AudiusNetwork
• ServiceType
• ServiceTypeVersion
• ServiceNode
• User
• Delegate
• DecreaseStakeEvent
• UpdateDeployerCutEvent
• RemoveDelegatorEvent
• UndelegateStakeEvent
• IncreasedStakeEvent
• IncreaseDelegatedStakeEvent
• ClaimEvent
• SlashEvent
• ClaimRound
• ClaimProcessedEvent
• RegisteredServiceProviderEvent
• DeregisteredServiceProviderEvent
• Proposal
• Vote
• ProposalSubmittedEvent
• ProposalVoteSubmittedEvent
• ProposalVoteUpdatedEvent
• ProposalOutcomeEvaluatedEvent
• ProposalTransactionExecutedEvent
• GuardianTransactionExecutedEvent
• ProposalVetoedEvent

AudiusNetwork

Description:

Field	Type	Description
id	ID!	ID is set to 1
audiusTokenAddress	Bytes	audiusToken address
claimsManagerAddress	Bytes	claimsManager address
delegateManagerAddress	Bytes	delegateManager address
governanceAddress	Bytes	governance address
registry	Bytes	registry address
serviceProviderFactoryAddress	Bytes	serviceProviderFactory address
serviceTypeManagerAddress	Bytes	serviceTypeManager address
stakingAddress	Bytes	staking address
registryAddress	Bytes	registry address
totalSupply	BigInt!	Total supply of $AUDIO
totalAUDIOMinted	BigInt!	Total amount of $AUDIO minted
totalAUDIOBurned	BigInt!	Total amount of $AUDIO burned
totalTokensStaked	BigInt	Total amount of $AUDIO staked
totalTokensClaimable	BigInt	Total tokens that are settled and claimable
totalTokensLocked	BigInt	Total tokens that are currently locked or withdrawable in the network from unstaking/undelegating
totalTokensDelegated	BigInt	Total delegated tokens in the protocol
maxDelegators	BigInt	The max number of delegators per service provider
inDelegationAmount	BigInt	The minimum amount needed to delegate
undelegateLockupDuration	BigInt	The minimum number of blocks the user must wait from requesting undelegation to evaluating
removeDelegatorLockupDuration	BigInt	The minimum number of blocks the user must wait from requesting remove delegator to evaluating
removeDelegatorEvalDuration	BigInt	Evaluation period for a remove delegator request
decreaseStakeLockupDuration	BigInt	Number of blocks a decrease stake request is in lockup before evaluation is allowed
updateDeployerCutLockupDuration	BigInt	Number of blocks an update deployer cut request is in lockup before evaluation is allowed
fundingRoundBlockDiff	BigInt
fundingAmount	BigInt
recurringCommunityFundingAmount	BigInt
communityPoolAddress	Bytes	address
votingQuorumPercent	BigInt
votingPeriod	BigInt
executionDelay	BigInt
maxInProgressProposals	Int
guardianAddress	Bytes
requestCount	BigInt!
totalStaked	BigInt!

ServiceType

Description:

Field	Type	Description
id	ID	The type of the service ie. creator-node
isValid	Boolean!	If the service is removed of not
minStake	BigInt!	Minimum Token Stake to run the service
maxStake	BigInt!	Max Token Stake to run the service
versions	[ServiceTypeVersion!]! @derivedFrom(field: serviceType")

ServiceTypeVersion

Description:

Field	Type	Description
id	ID!
serviceType	ServiceType!
serviceVersion	String!
blockNumber	BigInt!

ServiceNode

Description:

Field	Type	Description
id	ID!	ID - generated from service-type and spID
spId	BigInt!	Service provider ID - autoincrementing id created for each new service node
owner	User!	Reference to user that registered this service
type	ServiceType!	Reference to the service type
endpoint	String!	URI to access the service node
delegateOwnerWallet	Bytes!	Address used to confirm the ownership of the service node
createdAt	Int!	When the service node was created
isRegistered	Boolean!	Boolean if th service is registered/deregistered

User

Description:

Field	Type	Description
id	ID!	Eth address of User
balance	BigInt!	Token balance
totalClaimableAmount	BigInt!	The total staked/delegated minus pending decrease stake/delegation
claimableStakeAmount	BigInt!	The total staked minus pending decrease stake
claimableDelegationReceivedAmount	BigInt!	The total delegation received from other users minus their pending decrease delegation
claimableDelegationSentAmount	BigInt!	The total delegation sent to other users minus my own pending decrease delegation
stakeAmount	BigInt!	The total staked
delegationReceivedAmount	BigInt!	The total delegated
delegationSentAmount	BigInt!	The total delegation sent
hasStakeOrDelegation	Boolean!	Boolean set to true if the user has stake or delegation
validBounds	Boolean	If the user's stake is between the min/max stake
deployerCut	BigInt	The percentage of the claim from the delegator that the the deployer takes
services	[ServiceNode!] @derivedFrom(field: "owner")	List of services operated by the user
minAccountStake	BigInt	Max stake of the user as determined by number of services and service types
maxAccountStake	BigInt	Min 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
pendingDecreaseStake	DecreaseStakeEvent	Reference to request to pending decrease stake
pendingRemoveDelegator	RemoveDelegatorEvent	DEPRECATED: Use event with service operator and delegator id
pendingUpdateDeployerCut	UpdateDeployerCutEvent	Reference to request to update deployer cut
pendingUndelegateStake	UndelegateStakeEvent	Reference to request to update undelegate stake
votes	[Vote!] @derivedFrom(field: "voter")	Reference to votes by the user
createdAt	BigInt!

Delegate

Description:

Field	Type	Description
id	ID!	ID - generated w/ the service provider's & delegator's addresses
id	ID!	ID - generated w/ the service provider's & delegator's addresses
claimableAmount	BigInt!	The amount delegated minus the pending decrease delegation
amount	BigInt!	The amount delegated
fromUser	User!	Reference to the user sending/delegating tokens
toUser	User!	Reference to the user receiving delegation

DecreaseStakeEvent

Description:

Field	Type	Description
id	ID!
status	LockupStatus!
owner	User!
expiryBlock	BigInt!
createdBlockNumber	BigInt!
endedBlockNumber	BigInt
decreaseAmount	BigInt!
newStakeAmount	BigInt

UpdateDeployerCutEvent

Description: implements LockupEvent

Field	Type	Description
id	ID!
status	LockupStatus!
owner	User!
expiryBlock	BigInt!
createdBlockNumber	BigInt!
endedBlockNumber	BigInt
updatedCut	BigInt!

RemoveDelegatorEvent

Description:

Field	Type	Description
id	ID!
status	LockupStatus!
owner	User!
expiryBlock	BigInt!
createdBlockNumber	BigInt!
endedBlockNumber	BigInt
updatedCut	BigInt!
delegator	User!

UndelegateStakeEvent

Description:

Field	Type	Description
id	ID!
status	LockupStatus!
owner	User!
expiryBlock	BigInt!
createdBlockNumber	BigInt!
endedBlockNumber	BigInt
serviceProvider	User!
amount	BigInt!

IncreasedStakeEvent

Description:

Field	Type	Description
id	ID!
owner	User!
newStakeAmount	BigInt!
increaseAmount	BigInt!
blockNumber	BigInt!

IncreasedDelegatedStakeEvent

Description:

Field	Type	Description
id	ID!
delegator	User!
serviceProvider	User!
increaseAmount	BigInt!
blockNumber	BigInt!

ClaimEvent

Description:

Field	Type	Description
id	ID!
claimer	User!
rewards	BigInt!
newTotal	BigInt!
blockNumber	BigInt!

SlashEvent

Description:

Field	Type	Description
id	ID!
target	User!
amount	BigInt!
newTotal	BigInt!
blockNumber	BigInt!

ClaimRound

Description:

Field	Type	Description
id	ID!	The round number
fundAmount	BigInt!
blockNumber	BigInt!

ClaimProcessedEvent

Description:

Field	Type	Description
id	ID!
rewards	BigInt!
claimer	User!
oldTotal	BigInt!
newTotal	BigInt!
blockNumber	BigInt!

RegisterProviderServicerEvent

Description:

Field	Type	Description
id	ID!
type	ServiceType!
spId	BigInt!
node	ServiceNode!
owner	User!
endpoint	String!
stakeAmount	BigInt!
blockNumber	BigInt!

DeregisterProviderServicerEvent

Description:

Field	Type	Description
id	ID!
type	ServiceType!
spId	BigInt!
node	ServiceNode!
owner	User!
endpoint	String!
unstakeAmount	BigInt!
blockNumber	BigInt!

Proposal

Description:

Field	Type	Description
id	ID!	Proposal ID from the event (auto-incrementing)
name	String!	Proposal name
description	String!	Proposal description
proposer	User!	Reference to the user submitting the proposal
submissionBlockNumber	BigInt!
targetContractRegistryKey	Bytes!
targetContractAddress	Bytes!
callValue	BigInt!
functionSignature	String!
callData	Bytes!
outcome	Outcome	TODO: convert int to enum - Outcome
voteMagnitudeYes	BigInt!	Total vote weight for 'Yes'
voteMagnitudeNo	BigInt!	Total vote weight for 'No'
numVotes	BigInt!	Number of votes
votes	[Vote!]! @derivedFrom(field: "proposal")	Reference to the votes - user & vote weight

Vote

Description:

Field	Type	Description
id	ID!	ID - generated from proposal id and user address
proposal	Proposal!	Reference to the proposal
vote	VoteType	TODO: update to enum - the voter's vote
magnitude	BigInt!	The vote weight - the voter's claimable stake
voter	User!	Reference the the user submitting the voter
createdBlockNumber	BigInt!	The block number the vote was created
updatedBlockNumber	BigInt	The block number the vote was updated

PropotalSubmittedEvent

Description:

Field	Type	Description
id	ID!
proposal	Proposal!
proposer	User!
name	String!
description	String!

PropotalVoteSubmittedEvent

Description:

Field	Type	Description
id	ID!
proposal	Proposal!
voter	User!
vote	Vote!
currentVote	VoteType!
voterStake	BigInt!
blockNumber	BigInt!

PropotalVoteUpdatedEvent

Description:

Field	Type	Description
id	ID!
proposal	Proposal!
voter	User!
vote	Vote!
voterStake	BigInt!
currentVote	VoteType!
previousVote	VoteType!
blockNumber	BigInt!

PropotalOutcomeEvaluatedEvent

Description:

Field	Type	Description
id:	ID!
proposal:	Proposal!
outcome:	Outcome
voteMagnitueYes	BigInt!
voteMagnitudeNo:	BigInt!
numVotes:	BigInt!
blockNumber	BigInt!

ProposalTransactionExecutedEvent

Description:

Field	Type	Description
id	ID!
proposal	Proposal!
success	Boolean!
returnData	Bytes
blockNumber	BigInt!

GuardianTransactionExecutedEvent

Description:

Field	Type	Description
id	ID!
targetContractAddress:	Bytes!
callValue	BigInt!
functionSignature:	String!
callData	Bytes!
returnData	Bytes!
blockNumber	BigInt!

ProposalVetoedEvent

Description:

Field	Type	Description
id	ID!
proposal	Proposal!
blockNumber	BigInt!