Interface: ISnowconeProjects

The number of projects that have been created using this contract.

The count is incremented with each new project created. The resulting ERC-721 token ID for each project is the newly incremented count value.

Definition

/**
  @notice
  The number of projects that have been created using this contract.

  @dev
  The count is incremented with each new project created.
  The resulting ERC-721 token ID for each project is the newly incremented count value.
*/
uint256 public override count = 0;

The resulting view function can be accessed externally by anyone. The resulting function overrides a function definition from the ISnowconeProjects interface.

Interfaces

Inheritance

Constructor

constructor(ISnowconeOperatorStore _operatorStore)
  ERC721('Snowcone Projects', 'SNOWCONE')
  EIP712('Snowcone Projects', '1')
  SnowconeOperatable(_operatorStore)
{}

_operatorStore is an ISnowconeOperatorStore contract storing operator assignments.

Events

Properties

Read

Write

Emitted from:

createFor Definition

event Create(
  uint256 indexed projectId,
  address indexed owner,
  SnowconeProjectMetadata metadata,
  address caller
);

projectId is the token ID of the NFT (ERC-721) that was created to represent the project. owner is the address that owns the NFT (ERC-721) token representing the project. metadata is the metadata that was associated with the project upon its creation. It can be found using the metadataContentOf property. caller is the address that issued the transaction within which the event was emitted.

Contract: SnowconeProjects

Interface: ISnowconeProjects

The metadata for each project, which can be used across several domains.

Definition

Arguments: _projectId is the ID of the project to which the metadata belongs. _domain is the domain within which the metadata applies. The resulting view function can be accessed externally by anyone. The resulting function overrides a function definition from the ISnowconeProjects interface.

Emitted from:

setMetadataOf Definition

projectId is the token ID of the NFT (ERC-721) that represents the project whose URI was set. metadata is the metadata that was associated with the project upon its creation. It can be found using the metadataContentOf property. caller is the address that issued the transaction within which the event was emitted.

Emitted from:

setTokenUriResolver Definition

newResolver is the new URI resolver contract. caller is the address that issued the transaction within which the event was emitted.

Contract: SnowconeProjects

Interface: ISnowconeProjects

The contract resolving each project ID to its ERC721 URI.

Definition

The resulting view function can be accessed externally by anyone. The resulting function overrides a function definition from the ISnowconeProjects interface.

Contract: SnowconeProjects

Interface: IERC165

Allows a project owner to set the project's metadata content for a particular domain namespace.

Only a project's owner or operator can set its metadata.

Applications can use the domain namespace as they wish.

Definition

function setMetadataOf(uint256 _projectId, SNWProjectMetadata calldata _metadata)
  external
  override
  requirePermission(ownerOf(_projectId), _projectId, SNOWperations.SET_METADATA) { ... }

Arguments:

• _projectId is the ID of the project whose metadata is being changed.

• _metadata is the struct containing metadata content, and domain within which the metadata applies.

Through the requirePermission modifier, the function is only accessible by the project's owner, or from an operator that has been given the SNWOperations.SET_METADATA permission by the project owner for the provided _projectId.

The function overrides a function definition from the ISNWProjects interface. The function doesn't return anything.

Body

// Store the project's new metadata content within the specified domain.
metadataContentOf[_projectId][_metadata.domain] = _metadata.content;

Internal references:

• metadataContentOf

Emit a SetMetadataCid event with the relevant parameters.

emit SetMetadata(_projectId, _metadata, msg.sender);

Event references:

• SetMetadata

Sets the address of the resolver used to retrieve the tokenURI of projects.

Definition

function setTokenUriResolver(ISNWTokenUriResolver _newResolver) external override onlyOwner { ... }

Arguments:

• _newResolver is the address of the new resolver.

Through the onlyOwner modifier, this function can only be accessed by the address that owns this contract.

The function overrides a function definition from the ISNWProjects interface. The function doesn't return anything.

Body

/// Store the new resolver.
tokenUriResolver = _newResolver;

Internal references:

• tokenUriResolver

Emit a SetTokenUriResolver event with the relevant parameters.

emit SetTokenUriResolver(_newResolver, msg.sender);

Event references:

• SetTokenUriResolver

Create a new project for the specified owner, which mints an NFT (ERC-721) into their wallet.

Anyone can create a project on an owner's behalf.

Definition

function createFor(address _owner, SNWProjectMetadata calldata _metadata)
external
override
returns (uint256 projectId) { ... }

Arguments:

owner is the address that will be the owner of the project.

metadata is a struct containing metadata content about the project, and domain within which the metadata applies. The function can be accessed externally by anyone. The function overrides a function definition from the ISNWProjects interface. The function returns the token ID of the newly created project.