Entities and Capabilities

Entities
​NdaoEntity​
​PortfolioPosition​
​Registry​
​AuthorityUser​
​RoleUser​
​Role​
​RoleCapability​
​Capability​
​NdaoEntityFirstIndexedBlock​
NdaoEntity
An entity that is part of the Endaoment protocol
Field
Type
Description
id
Bytes!
Contract address of the entity
entityType
EntityType!
The type of the entity
ein
String
The EIN of the entity. Only applicable to Org
entityManager
Bytes!
Manager of the entity
recognizedUsdcBalance
BigInt!
USDC Balance that has been formally recognized by the entity
totalEthReceived
BigInt!
Total amount of native ETH that was transferred to the entity
totalUsdcDonationsReceived
BigInt!
Amount USDC that has been donated to this entity, after fees. Any recognized inbound asset transfer from addresses outside the Endaoment protocol is considered a Donation
totalUsdcDonationFees
BigInt!
Amount of fees that have been collected from donations to this entity
totalUsdcGrantsReceived
BigInt!
Amount of USDC that has been granted to this entity, after fees. Any Fund -> Org transfer is considered a grant
totalUsdcGrantInFees
BigInt!
Amount of fees that have been paid by grantors for grants to this entity
totalUsdcContributionsReceived
BigInt!
Amount of USDC that has been donated or granted to this entity, after fees
totalUsdcContributionFees
BigInt!
Amount of fees that have been collected from donations or grants to this entity
totalUsdcTransfersReceived
BigInt!
Amount of USDC that has been transferred to this entity. This includes only transfers that are not considered grants. Example: (Org -> Org, Fund -> Fund, Org -> Fund)
totalUsdcTransferInFees
BigInt!
Amount of USDC that has been paid in fees for transfers to this entity
totalUsdcMigrated
BigInt!
Amount of USDC that has been migrated to this entity from Endaoment V1
totalUsdcReceived
BigInt!
Amount of USDC that has been received by this entity using any Endaoment V2 Entity method, including V1 migration
totalUsdcReceivedFees
BigInt!
Amount of USDC that has been paid in fee for all inbound USDC transactions to this entity
totalUsdcGrantedOut
BigInt!
Amount of USDC that has been granted out to other Endaoment entities by this entity, net of fees. Any Fund -> Org transfer is considered a grant.
totalUsdcGrantedOutFees
BigInt!
Amount of fees that have been paid by this entity for grants to other Endaoment entities
totalUsdcTransferredOut
BigInt!
Amount of USDC that has been transferred out of this entity, net of fees. This includes only transfers that are not considered grants. Example: (Org -> Org, Fund -> Fund, Org -> Fund)
totalUsdcTransferredOutFees
BigInt!
Amount of USDC that has been paid in fees for transfers out of this entity
totalUsdcPaidOut
BigInt!
Amount of USDC that has been paid out to accounts or wallets owned by the entity outside the Endaoment Protocol
totalUsdcPaidOutFees
BigInt!
Amount of USDC that has been paid in fees for payouts from this entity
initialized
Boolean!
Flag indicating whether the entity has been fully initialized with V1 migration data. For this to occur, the entity must have emitted at least 1 event in 2 separate blocks. Entities that are not fully initialized will account for migrated funds in its balance but not include them in the following fields: > * totalUsdcMigrated > * totalUsdcReceived
investedUsdc
BigInt!
USDC Balance that the entity has invested in Portfolios belonging to the Endaoment protocol.> * This is the sum of all USDC invested in all portfolios and NOT the current USDC value of the portfolio shares. > * Fees are included in the amount, since it tracks the entire sum sent to portfolio contracts. > * Whenshares are redeemed, this amount is reduced proportionally to the amount of shares redeemed
positions
​PortfolioPosition!​
Positions owned by the entity in various portfolios
PortfolioPosition
A position taken by an Endaoment entity in a portfolio approved by Endaoment
Field
Type
Description
id
ID!
Id of the position, which is a concatenation of the portfolio address and the entity address. Format: <0xPortfolio_address> : <0xEntity_address>
entity
NdaoEntity!
Address of the entity that owns this position
portfolio
Bytes!
Address of the portfolio that invested by the entity
shares
BigInt!
Shares of the portfolio that are owned by the entity
investedUsdc
BigInt!
Amount of USDC invested by the entity in the portfolio
Registry
Description: Entity representing the Endaoment Protocol Registry
Field
Type
Description
id
String!
ID of the registry, which is the constant string '1'
address
Bytes!
Address of the Endaoment Registry contract
owner
Bytes!
Owner of the Endaoment Registry contract
entityFactories
[Bytes!]!
Address of the Entity Factories approved on the registry
swapWrappers
[Bytes!]!
Address of the swap wrappers approved on the registry
portfolios
[Bytes!]!
Address of the portfolios approved on the registry
AuthorityUser
Description: Address that has a special authority in the Endaoment protocol
Field
Type
Description
id
Bytes!
Address of the authority user
roles
​[RoleUser!]!​
Roles of the authority user
RoleUser
Role assigned to an authority user
Field
Type
Description
id
ID!
Address of the role user. Format: <user_address>:<role_id>
user
AuthorityUser!
User that has the role
role
Role!
Role assigned to the user
Role
Role that can invoke capabilities
Field
Type
Description
id
String!
ID of the role - String representation of the role's integer id
users
​[RoleUser!]!​
Users associated with the role
capabilities
​[RoleCapability!]!​
Capabilities of the role
RoleCapability
Capability that can be invoked by a role
Field
Type
Description
id
ID!
ID of the role capability. Format: <role_id>:<capability_id>
role
Role!
Role that can invoke the capability
capability
Capability!
Capability that can be invoked by the role
Capability
Capability that can be invoked publicly or via a role.
Field
Type
Description
id
ID!
ID of the capability. Format: <target>:<signature>
target
Bytes!
Target of the capability
signature
Bytes!
Signature that can be invoked on the target of the capability
isPublic
Boolean!
Indicates if the capability can be invoked by any address publicly
roles
​[RoleCapability!]!​
Roles that can invoke the capability
NdaoEntityFirstIndexedBlock
Helper metadata entity to track migration information of an NdaoEntity. Not meant to be queried directly, as the information here only useful for internal indexing logic. As soon as an entity is fully initialized, this entityis not longer updated
Field
Type
Description
id
Bytes!
Contract address of the entity
endOfBlockBalance
BigInt!
Balance of the entity at the end of the first block it emitted and event
blockNumber
BigInt!
Number of the initial block that was processed
eventBalanceDelta
BigInt!
Balance delta due to events emitted in the initial block

Field	Type	Description
id	Bytes!	Contract address of the entity
entityType	EntityType!	The type of the entity
ein	String	The EIN of the entity. Only applicable to Org
entityManager	Bytes!	Manager of the entity
recognizedUsdcBalance	BigInt!	USDC Balance that has been formally recognized by the entity
totalEthReceived	BigInt!	Total amount of native ETH that was transferred to the entity
totalUsdcDonationsReceived	BigInt!	Amount USDC that has been donated to this entity, after fees. Any recognized inbound asset transfer from addresses outside the Endaoment protocol is considered a Donation
totalUsdcDonationFees	BigInt!	Amount of fees that have been collected from donations to this entity
totalUsdcGrantsReceived	BigInt!	Amount of USDC that has been granted to this entity, after fees. Any Fund -> Org transfer is considered a grant
totalUsdcGrantInFees	BigInt!	Amount of fees that have been paid by grantors for grants to this entity
totalUsdcContributionsReceived	BigInt!	Amount of USDC that has been donated or granted to this entity, after fees
totalUsdcContributionFees	BigInt!	Amount of fees that have been collected from donations or grants to this entity
totalUsdcTransfersReceived	BigInt!	Amount of USDC that has been transferred to this entity. This includes only transfers that are not considered grants. Example: (Org -> Org, Fund -> Fund, Org -> Fund)
totalUsdcTransferInFees	BigInt!	Amount of USDC that has been paid in fees for transfers to this entity
totalUsdcMigrated	BigInt!	Amount of USDC that has been migrated to this entity from Endaoment V1
totalUsdcReceived	BigInt!	Amount of USDC that has been received by this entity using any Endaoment V2 Entity method, including V1 migration
totalUsdcReceivedFees	BigInt!	Amount of USDC that has been paid in fee for all inbound USDC transactions to this entity
totalUsdcGrantedOut	BigInt!	Amount of USDC that has been granted out to other Endaoment entities by this entity, net of fees. Any Fund -> Org transfer is considered a grant.
totalUsdcGrantedOutFees	BigInt!	Amount of fees that have been paid by this entity for grants to other Endaoment entities
totalUsdcTransferredOut	BigInt!	Amount of USDC that has been transferred out of this entity, net of fees. This includes only transfers that are not considered grants. Example: (Org -> Org, Fund -> Fund, Org -> Fund)
totalUsdcTransferredOutFees	BigInt!	Amount of USDC that has been paid in fees for transfers out of this entity
totalUsdcPaidOut	BigInt!	Amount of USDC that has been paid out to accounts or wallets owned by the entity outside the Endaoment Protocol
totalUsdcPaidOutFees	BigInt!	Amount of USDC that has been paid in fees for payouts from this entity
initialized	Boolean!	Flag indicating whether the entity has been fully initialized with V1 migration data. For this to occur, the entity must have emitted at least 1 event in 2 separate blocks. Entities that are not fully initialized will account for migrated funds in its balance but not include them in the following fields: `> * totalUsdcMigrated` `> * totalUsdcReceived`
investedUsdc	BigInt!	USDC Balance that the entity has invested in Portfolios belonging to the Endaoment protocol.`> * This is the sum of all USDC invested in all portfolios and NOT the current USDC value of the portfolio shares.` `> * Fees are included in the amount, since it tracks the entire sum sent to portfolio contracts.` `> * Whenshares are redeemed, this amount is reduced proportionally to the amount of shares redeemed`
positions	PortfolioPosition!	Positions owned by the entity in various portfolios

Field	Type	Description
id	ID!	Id of the position, which is a concatenation of the portfolio address and the entity address. Format: `<0xPortfolio_address>` `:` `<0xEntity_address>`
entity	NdaoEntity!	Address of the entity that owns this position
portfolio	Bytes!	Address of the portfolio that invested by the entity
shares	BigInt!	Shares of the portfolio that are owned by the entity
investedUsdc	BigInt!	Amount of USDC invested by the entity in the portfolio

Field	Type	Description
id	String!	ID of the registry, which is the constant string '1'
address	Bytes!	Address of the Endaoment Registry contract
owner	Bytes!	Owner of the Endaoment Registry contract
entityFactories	[Bytes!]!	Address of the Entity Factories approved on the registry
swapWrappers	[Bytes!]!	Address of the swap wrappers approved on the registry
portfolios	[Bytes!]!	Address of the portfolios approved on the registry

Field	Type	Description
id	Bytes!	Address of the authority user
roles	`[RoleUser!]!`	Roles of the authority user

Field	Type	Description
id	ID!	Address of the role user. Format: `<user_address>:<role_id>`
user	AuthorityUser!	User that has the role
role	Role!	Role assigned to the user

Field	Type	Description
id	String!	ID of the role - String representation of the role's integer id
users	`[RoleUser!]!`	Users associated with the role
capabilities	`[RoleCapability!]!`	Capabilities of the role

Field	Type	Description
id	ID!	ID of the role capability. Format: `<role_id>:<capability_id>`
role	Role!	Role that can invoke the capability
capability	Capability!	Capability that can be invoked by the role

Field	Type	Description
id	ID!	ID of the capability. Format: `<target>:<signature>`
target	Bytes!	Target of the capability
signature	Bytes!	Signature that can be invoked on the target of the capability
isPublic	Boolean!	Indicates if the capability can be invoked by any address publicly
roles	`[RoleCapability!]!`	Roles that can invoke the capability

Field	Type	Description
id	Bytes!	Contract address of the entity
endOfBlockBalance	BigInt!	Balance of the entity at the end of the first block it emitted and event
blockNumber	BigInt!	Number of the initial block that was processed
eventBalanceDelta	BigInt!	Balance delta due to events emitted in the initial block

Last modified 3mo ago