Proton Contract

Charged Particles
Search…
Charged Particles
EN-US (Language)
Proton Contract
Proton contract, the standard ERC721 token of the protocol. All Protons are Particles.
Get Proton Info
Get a Proton's creator, sale price, etc.
creatorOf
Gets the creator of a Proton.
1
function creatorOf(
2
  uint256 tokenId
3
) external view virtual override returns (address);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton
return
address of token creator
getSalePrice
Gets current sale price of a Proton in Ether.
1
function getSalePrice(uint256 tokenId) 
2
  external 
3
  view
4
  virtual
5
  override
6
  returns (uint256);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton
return
sale price in Ether
getLastSellPrice
Gets most recent price that Proton sold for in Ether.
1
function creatorOf(uint256 tokenId) 
2
  external
3
  view
4
  virtual
5
  override
6
  returns (address);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton
return
sale price in Ether
getCreatorRoyalties
Gets creator royalties for a given creator address. Royalties are how much of the sale price will be directed to the Proton's creator whenever a Proton is sold.
1
function getCreatorRoyalties(
2
  address account
3
) external view virtual override returns (uint256);
Copied!
Parameter / Return Value
Description
address
creator account
return
royalties earned by creator (in ETH)
getCreatorRoyaltiesPct
Gets creator royalties for a given tokenId. Royalties are how much of the sale price will be directed to the Proton's creator whenever a Proton is sold.
1
function getCreatorRoyaltiesPct(
2
  uint256 tokenId
3
) external view virtual override returns (uint256);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton
return
royalty percentage on Proton sale
getCreatorRoyaltiesReceiver
Gets creator royalties receiver. Can be either the creator or a 3rd-party, such as a charity, relative, or any other account of choice.
1
function getCreatorRoyaltiesReceiver(
2
  uint256 tokenId
3
) external view virtual override returns (address);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton
return
address of royalties receiver
Create & Interact with Proton(s)
Create various types of Protons, buy a Proton, claim royalties, etc.
claimCreatorRoyalties
Sends royalties to creator or delegated receiver.
1
function claimCreatorRoyalties() 
2
  external 
3
  virtual
4
  override
5
  nonReentrant
6
  whenNotPaused
7
  returns (uint256)
Copied!
Parameter / Return Value
Description
Parameter / Return Value
Description
amount
amount claimed in ETH
createChargedParticle
Create a new Charged Particle (a Proton with interest-bearing assets deposited into its wallet).
1
function createChargedParticle(
2
  address creator,
3
  address receiver,
4
  address referrer,
5
  string tokenMetaUri,
6
  string walletManagerId,
7
  address assetToken,
8
  uint256 assetAmount, 
9
  uint256 annuityPercent
10
) external virtual override nonReentrant whenNotPaused returns (uint256 newTokenId);
Copied!
Parameter / Return Value
Description
creator
id of Charged Particle
receiver
receiver of new Charged Particle
referrer
*used for an internal feature that has yet to be implemented -- ignore 
tokenMetaUri
URI of tokenmetadata
walletManagerId
id of wallet manager for ERC20 being deposited upon mint
assetToken
asset to create token with
assetAmount
amount of asset token to deposit
annuityPercent
percentage of charge (interest) directed to creator, in basis points​
​
e.g. '10000' = 100%
newTokenId
id of new Charged Particle
createBasicProton
Create a basic Proton without charge, and with annuityPercent, royaltiesPercent, and salePrice set to 0.
1
function createBasicProton(
2
  address creator,
3
  address receiver,
4
  string tokenMetaUri
5
) external virtual override whenNotPaused returns (uint256 newTokenId);
Copied!
Parameter / Return Value
Description
creator
id of Proton
receiver
receiver of new Proton
tokenMetaUri
URI of token's metadata
newTokenId
id of new Proton
createProton
Create a Proton, set its annuity percentage to a custom amount, and set royalties percentage and salePrice to 0.
1
function createProton(
2
  address creator,
3
  address receiver,
4
  string tokenMetaUri,
5
  uint256 annuityPercent
6
) external virtual override whenNotPaused returns (uint256 newTokenId);
Copied!
Parameter / Return Value
Description
creator
address of creator
receiver
receiver of new Proton
tokenMetaUri
URI of tokenmetadata
annuity percent
percentage of interest that goes to creator
newTokenId
id of new Proton
createProtonForSale
1
function createProtonForSale(
2
  address creator,
3
  address receiver,
4
  string tokenMetaUri,
5
  uint256 annuityPercent,
6
  uint256 royaltiesPercent,
7
  uint256 salePrice
8
) external virtual override whenNotPaused returns (uint256 newTokenId);
Copied!
Parameter / Return Value
Description
creator
address of creator
receiver
receiver of new Proton
tokenMetaUri
URI of tokenmetadata
annuityPercent
percentage of charge (interest) that goes to creator
royaltiesPercent
percentage of Proton sale that goes to creator
salePrice
sale price of Proton
newTokenId
id of new Proton
batchProtonsForSale
1
function batchProtonsForSale(
2
  address creator,
3
  uint256 annuityPercent,
4
  uint256 royaltiesPercent,
5
  string[] calldata tokenMetaUris,
6
  uint256[] calldata salePrices
7
) external virtual override whenNotPaused;
Copied!
Parameter / Return Value
Description
creator
address of creator
annuityPercent
percentage of charge (interest) that goes to creator
royaltiesPercent
percentage of Proton sale that goes to creator
tokenMetaUris
array of token metadata URIs for Protons
salePrices
array of sale prices for Protons
buyProton
Buy a Proton.
1
function buyProton(
2
  uint256 tokenId
3
) external payable virutal override nonReentrant whenNotPaused returns (bool);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton to purchase
return
true if purchase successful, false if not
Update Proton Settings (Only for Creator/Owner)
Set a Protons Price, Royalties, or Royalties Receiver.
setSalePrice
Set the sale price for a Proton.
1
function setSalePrice(
2
  uint256 tokenId, 
3
  uint256 salePrice
4
) external virtual override whenNotPaused onlyTokenOwnerOrApproved(tokenId);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton to set price for
salePrice
sale price in Ether
setRoyaltiesPct
Set royalties percentage for a Proton.
1
function setRoyaltiesPct(
2
  uint256 tokenId,
3
  uint256 royaltiesPct
4
) external virtual override whenNotPaused onlyTokenCreator(tokenId) onlyTokenOwnerOrApproved(tokenId);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton to set price for
royaltiesPct
percentage of sale directed to creator
setCreatorRoyaltiesReceiver
Set a receiver for Proton royalties.
1
function setCreatorRoyaltiesReceiver(
2
  uint256 tokenId, 
3
  address receiver
4
) external virtual override whenNotPaused onlyTokenCreator(tokenId);
Copied!
Parameter / Return Value
Description
tokenId
id of Proton to set recever for
receiver
address of receiver
Other
Events
UniverseSet
1
event UniverseSet(address indexed universe);
Copied!
ChargedStateSet
1
event ChargedStateSet(address indexed chargedState);
Copied!
ChargedSettingsSet
1
event ChargedSettingsSet(address indexed chargedSettings);
Copied!
ChargedParticlesSet
1
event ChargedParticlesSet(address indexed chargedParticles);
Copied!
PausedStateSet
1
event PausedStateSet(bool isPaused);
Copied!
SalePriceSet
1
event SalePriceSet(uint256 indexed tokenId, uint256 salePrice);
Copied!
CreatorRoyaltiesSet
1
event CreatorRoyaltiesSet(uint256 indexed tokenId, uint256 royaltiesPct);
Copied!
FeesWithdrawn
1
event FeesWithdrawn(address indexed receiver, uint256 amount);
Copied!
ProtonSold
1
event ProtonSold(
2
  uint256 indexed tokenId,
3
  address indexed oldOwner,
4
  address indexed newOwner,
5
  uint256 salePrice,
6
  address creator, 
7
  uint256 creatorRoyalties
8
);
Copied!
RoyaltiesClaimed
1
event RoyaltiesClaimed(address indexed receiver, uint256 amountClaimed);
Copied!
Charged State Contract
Error Codes
Last modified 3mo ago