Niwa Docs Open Niwa

Contracts

Deployment status, planned operations, and design requirements for the Niwa contracts.

Status: No Niwa contract is deployed. This page will list the official addresses.

Addresses#

ContractNetworkAddressAudit
$NIWATo be announcedNot deployedNot started
NiwaTreesTo be announcedNot deployedNot started
OrchardTo be announcedNot deployedNot started
Fee splitterTo be announcedNot deployedNot started

Architecture#

Planned contract relationships
$NIWAERC-20NiwaTreesERC-721Owner walletFee splitterlaunchpadOrchardfee accountingburnstate and weight80% of feesharvest

Planned operations#

The following names describe behavior. They are not a final ABI.

ContractOperationCallerEffect
NiwaTreesawakenTree ownerBurns 20,000 $NIWA and sets the state to awake
NiwaTreesupgradeTree ownerBurns the cost difference and sets the level
NiwaTreestransferFromOwner or approved operatorTransfers the tree and sets the state to dormant
OrchardcollectFeesAnyonePulls the Orchard share from the splitter
OrchardharvestTree ownerPays the accrued share to the owner

Design requirements#

The implementation is intended to meet the following requirements. They are not verified until the contracts are published and audited.

RequirementReason
No administrator withdrawal of accrued tree feesThe accrued share remains available to tree owners.
Fixed 80/20 splitThe fee route cannot change after launch.
Fixed token and contract referencesAn administrator cannot replace the payout destination.
Fees are accounted for before a state changeA new participant does not receive earlier fees.
Changes apply from the next periodAn upgrade cannot claim the current period.
Accrual settles to the seller on transferOwnership of accrued fees is unambiguous.
Accounting does not depend on a Niwa serverOwners can harvest if the website is unavailable.

Verify an address#

  1. Copy the address from this page.
  2. Check that the URL of this page belongs to playniwa.com.
  3. Open the address in the block explorer of the announced network.
  4. Confirm that the source code is verified.