NexusFi Protocol

Overview

Lender Entity

• Apple Lender Co: a lender company
  • Staff:
    • Alice: a signer holding a private key
    • Brain: a signer holding a private key
    • Clark: a signer holding a private key
  • Wallet:
    • Multisig: 3 signers in total and 1 aggregated signature from all signers required
• Grape Invest Co: an investment company
  • Staff:
    • David: a signer holding a private key and on-chain ID
    • Frank: a signer holding a private key and on-chain ID
    • Emily: a signer holding a private key and on-chain ID
  • Wallet:
    • Threshold: 3 signers in total and 1 aggregated signature from at least 2 signers required

Personal Borrower

• Bob: A sample borrower profile used for testing long-term fund allocation.
• Mos: A sample borrower profile used for testing short-term fund allocation.

Contracts

• MultisigWallet
  This is an n-of-n wallet where n means the total signers. Multisig wallet contract holds an aggregated public key built from all signers' public keys. Multisig wallet contract is built on BLS algorithm and supports two modes:
  • Public key on G1 and Private key on G2:
    Public key is a point on G1 which has two coordinates. Each coordinate is 48 bytes (uint384) stored in two words (bytes32).
    Signature is a point on G2 which has two complex coordinates. Each complex coordinate consists of a real part and imaginary part. Both real part and imaginary part are 48 bytes (uint384) stored in two words (bytes32).
  • Public key on G2 and Private key on G1:
    Public key is a point on G2 which has two complex coordinates. Each complex coordinate consists of a real part and imaginary part. Both real part and imaginary part are 48 bytes (uint384) stored in two words (bytes32).
    Signature is a point on G1 which has two coordinates. Each coordinate is 48 bytes (uint384) stored in two words (bytes32).
    The following two pictures show the prototype design of multisig wallet:
    

  Note: EVM version should be Prague or later, as the BLS algorithm in Multisig Wallet contract depends on precompiled contracts:

  1. 0x0b BLS12_G1ADD
  2. 0x0c BLS12_G1MSM
  3. 0x0d BLS12_G2ADD
  4. 0x0e BLS12_G2MSM
  5. 0x0f BLS12_PAIRING_CHECK
  6. 0x10 BLS12_MAP_FP_TO_G1
  7. 0x11 BLS12_MAP_FP2_TO_G2

• ThresholdWallet
  This is an m of n wallet where n means the total signers and where m represents the required threshold. Threshold wallet contract holds all signers' public keys and on-chain IDs. Each on-chain ID is signed by all signers. In other words, each signer’s membership is agreed upon by all participants through consensus. Threshold wallet contract is built on BLS algorithm and supports two modes:
  • Public key on G1 and Private key on G2 :
    Public key is a point on G1 which has two coordinates. Each coordinate is 48 bytes (uint384) stored in two words (bytes32).
    Signature and on-chain ID are points on G2 which has two complex coordinates. Each complex coordinate consists of a real part and imaginary part. Both real part and imaginary part are 48 bytes (uint384) stored in two words (bytes32).
  • Public key on G2 and Private key on G1 :
    Public key is a point on G2 which has two complex coordinates. Each complex coordinate consists of a real part and imaginary part. Both real part and imaginary part are 48 bytes (uint384) stored in two words (bytes32).
    Signature and on-chain ID are points on G1 which has two coordinates. Each coordinate is 48 bytes (uint384) stored in two words (bytes32).
    The following two pictures show the prototype design of threshold wallet:
    

  Note: EVM version should be Prague or later, as the BLS algorithm in Threshold Wallet contract depends on precompiled contracts:

  1. 0x0b BLS12_G1ADD
  2. 0x0c BLS12_G1MSM
  3. 0x0d BLS12_G2ADD
  4. 0x0e BLS12_G2MSM
  5. 0x0f BLS12_PAIRING_CHECK
  6. 0x10 BLS12_MAP_FP_TO_G1
  7. 0x11 BLS12_MAP_FP2_TO_G2

• UnderlyingToken
  This is an ERC20 token that is used for circulation inside protocol (e.g. referred to as nfiUSD). Different participants may hold nfiUSD for different purposes. For example, a lender earns interest by staking nfiUSD into fixed term or open term staking protocols. All accepted assets by NexusFi protocol, such as USDC or USDT, can be used to exchange for nfiUSD.
• UnderlyingTokenExchanger
  This is an exchanger between underlying asset (e.g. USDC or USDT) and underlying token (e.g. nfiUSD). But this is not an AMM protocol that DEXs often use. AMM support is on the long-term roadmap but is not currently implemented. It usually has a fixed rate between underlying asset and underlying token.
  We are planning to implement an oracle to support volatile assets.
• FixedTermStaking
  Fixed term staking protocol is used for a long term investment, such as 30 or 180 or 360 days. It is suitable for professional investors who have significant idle funds and are willing to lock funds to gain high yields.
  Investors will get NFT tokens (e.g. referred to as nfiFTT) as receipts after they stake nfiUSD. Each nfiFTT token is unique because of the different start dates, maturity dates and principals.
  Fixed term staking contract stores daily accumulated interest rates for calculation of any nfiFTT token's interest amount at any day before or at or after maturity date. Daily accumulated interest rates make on-chain interest calculations more efficient.
  The following picture shows the basic mathematical formula. FixedTermStaking will deposit funds into one or more vaults based on the investment strategy to earn profits and distribute them to investors upon token redemption. However, the performance of each vault is totally unpredictable. Some vaults may suffer huge losses and others may make great profits. The problem is how to automatically and safely calculate the reasonable interests collected from each vault when any investors redeem their tokens after maturity date.
  Here is our solution:
• FixedTermToken
  This is an ERC721 token that is used to represent a fixed term staking (e.g. referred to as nfiFTT). Investor will get a specific token id of nfiFTT after staking nfiUSD into the fixed-term staking protocol. Each nfiFTT token is unique because of the different start dates, maturity dates and principals.
  We know that NFT is not friendly to DeFi or vault protocol. So we are working on the wrapper functions of nfiFTT and will upgrade protocol soon.
• OpenTermStaking
  Open term staking protocol is used for a short term investment, such as overnight stake and unstake. It is suitable for retail investors with smaller, distributed capital and prefer high liquidity and flexibility. Investors will get ERC20 tokens (e.g. referred to as nfiOTT) as receipts after they stake nfiUSD. All nfiOTT tokens are rebasing tokens and investors can see the growth of balance in their self-hosted wallets after the oracle feeds interest to the protocol. Open term staking contract stores total supply of nfiOTT and total reserve of nfiUSD (sum of all principal and interest). It works similarly to a vault (ERC4626) but accompanied with an oracle to distribute interest.
• OpenTermToken
  This is an ERC20 token that is used to represent shares of open term staking protocol. All nfiOTT tokens are rebasing tokens and investors can see the growth of balance in their self-hosted wallets after the oracle feeds interest to the protocol.
• ValueInflationVault
  This is a vault following to ERC4626 standard. It's a bridge between lender protocols (FixedTermStaking & OpenTermStaking) and borrower protocols (TimeLinearLoan & TimePowerLoan). Value inflation vault collects funds from lender protocols and releases funds to borrower protocols on demand. Conversely, the value inflation vault earns profits from borrower protocols and distributes bonus to lender protocols. The funding strategy of value inflation vault can be dynamically adjusted during the lifetime of protocol. The following picture shows the relationship among ValueInflationVault, FixedTermStaking, OpenTermStaking, TimeLinearLoan and TimePowerLoan.
• TimeLinearLoan
  Time linear loan protocol is used for a long term loan because the interest is linearly increasing as time passes. Compared to the time power loan protocol, accrued interest is lower given the same annual interest rate, repayment strategy and more than one year loan period.
  Borrowers should request a loan first and draw funds after the loan is approved. Borrowers will receive underlying assets, such as USDC or USDT, which are offered from one or multiple value inflation vaults. These vaults own some tranches of net asset value from borrowers' debts and earn profits when borrowers repay.
• TimePowerLoan
  Time power loan protocol is used for a short term loan because the interest is exponentially increasing as time passes. It's uneconomic for borrowers when they borrow a long term loan, especially over one year if we use annual interest rates.
  Borrowers should request a loan first and draw funds after the loan is approved. Borrowers will receive underlying assets, such as USDC or USDT, which are offered from one or multiple value inflation vaults. These vaults own some tranches of net asset value from borrowers' debts and earn profits when borrowers repay.
• Whitelist
  Shared whitelist controller for the whole protocol.
• Blacklist
  Shared blacklist controller for the whole protocol.

Usage

Build

You can run this command to build all contracts.

$ make buildAll

Test

You can run these commands to test each contract.
Some contracts may take thousands of seconds because they contain fuzz test cases.

$ make testMultisigWallet
$ make testThresholdWallet
$ make testFixedTermStaking
$ make testOpenTermStaking
$ make testUnderlyingTokenExchanger
$ make testWhitelist
$ make testBlacklist
$ make testTimePowerLoan
$ make testTimeLinearLoan
$ make testValueInflationVault

You can run this command to do all invariant test cases in all contracts.
This test may fail because the conditions are different in each time you trigger it.
But it works well in most cases based on previous runs.
Invariant test cases take a very long time to get result (maybe hours).

$ make testInvariant

You can run this command to run all test cases of all contracts, including normal test cases, fuzz test cases and invariant test cases.

$ make testAll

Deploy

Local Network

1. Start local network

$ anvil --fork-url https://api.zan.top/node/v1/eth/mainnet/Your-API-Key --disable-code-size-limit --hardfork prague

2. Configure .env file

$ export NEXUSFI_OWNER=0xF265639351621C68867d089d95c14a1f0edBfB48 # replace with your own address
$ export NEXUSFI_UNDERLYING_TOKEN_NAME="NexusFi USD" # replace with your own token name
$ export NEXUSFI_UNDERLYING_TOKEN_SYMBOL="nfiUSD" # replace with your own token symbol
$ export NEXUSFI_ENABLE_WHITELIST=true # set to false to disable whitelist
$ export NEXUSFI_ENABLE_BLACKLIST=true # set to false to disable blacklist
$ export NEXUSFI_UNDERLYING_ASSET=0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238 # USDC 
$ export NEXUSFI_VAULT_1_NAME="NexusFi RWA Vault" # replace with your own vault name
$ export NEXUSFI_VAULT_1_SYMBOL="nfiRWA" # replace with your own vault symbol
$ export NEXUSFI_VAULT_1_MINIMUM_PERCENTAGE_IN_A_LOAN=300000 # 30% (6 decimals)
$ export NEXUSFI_VAULT_1_MAXIMUM_PERCENTAGE_IN_A_LOAN=600000 # 60% (6 decimals)
$ export NEXUSFI_VAULT_1_WEIGHT_IN_A_STAKE=350000 # 35% (6 decimals)
$ export NEXUSFI_VAULT_1_ALLOWANCE_FOR_TIME_LINEAR_LOAN=1000000000000 # 1 million USDC (6 decimals)
$ export NEXUSFI_VAULT_1_ALLOWANCE_FOR_TIME_POWER_LOAN=1000000000000 # 1 million USDC (6 decimals)
$ export NEXUSFI_VAULT_2_NAME="NexusFi MMF Vault" # replace with your own vault name
$ export NEXUSFI_VAULT_2_SYMBOL="nfiMMF" # replace with your own vault symbol
$ export NEXUSFI_VAULT_2_MINIMUM_PERCENTAGE_IN_A_LOAN=400000 # 40% (6 decimals)
$ export NEXUSFI_VAULT_2_MAXIMUM_PERCENTAGE_IN_A_LOAN=700000 # 70% (6 decimals)
$ export NEXUSFI_VAULT_2_WEIGHT_IN_A_STAKE=450000 # 45% (6 decimals)
$ export NEXUSFI_VAULT_2_ALLOWANCE_FOR_TIME_LINEAR_LOAN=1000000000000 # 1 million USDC (6 decimals)
$ export NEXUSFI_VAULT_2_ALLOWANCE_FOR_TIME_POWER_LOAN=1000000000000 # 1 million USDC (6 decimals)
$ export NEXUSFI_TIME_POWER_LOAN_ALLOWANCE=1000000000000000 # 1 billion USDC (6 decimals)
$ export NEXUSFI_TIME_LINEAR_LOAN_ALLOWANCE=2000000000000000 # 2 billion USDC (6 decimals)
$ export NEXUSFI_TIME_POWER_LOAN_INTEREST_RATES=1000000000937300000,1000000002732680000,1000000004431820000,1000000006044530000 # 3%, 9%, 15%, 21% APR FIXED18
$ export NEXUSFI_TIME_LINEAR_LOAN_INTEREST_RATES=951293760,2853881279,4756468798,6659056317 # 3%, 9%, 15%, 21% APR FIXED18
$ export NEXUSFI_FIXED_TERM_LOCK_PERIOD=3 # days
$ export NEXUSFI_FIXED_TERM_STAKE_FEE_RATE=1000 # 0.1%
$ export NEXUSFI_FIXED_TERM_UNSTAKE_FEE_RATE=1000 # 0.1%
$ export NEXUSFI_FIXED_TERM_START_FEED_TIME=1774508396 # 2026-03-26 14:59:56
$ export NEXUSFI_FIXED_TERM_DUST_BALANCE=1000000000 # 1,000 USDC (6 decimals)
$ export NEXUSFI_FIXED_TERM_MAX_SUPPLY=1000000000000000 # 1 billion underlying tokens (6 decimals)
$ export NEXUSFI_FIXED_TERM_TOKEN_NAME="NexusFi Fixed Term Token" # replace with your own token name
$ export NEXUSFI_FIXED_TERM_TOKEN_SYMBOL="nfiFTT" # replace with your own token symbol
$ export NEXUSFI_OPEN_TERM_STAKE_FEE_RATE=1000 # 0.1%
$ export NEXUSFI_OPEN_TERM_UNSTAKE_FEE_RATE=1000 # 0.1%
$ export NEXUSFI_OPEN_TERM_START_FEED_TIME=1774508396 # 2026-03-26 14:59:56
$ export NEXUSFI_OPEN_TERM_DUST_BALANCE=1000000000 # 1,000 USDC (6 decimals)
$ export NEXUSFI_OPEN_TERM_MAX_SUPPLY=1000000000000000 # 1 billion underlying tokens (6 decimals)
$ export NEXUSFI_OPEN_TERM_TOKEN_NAME="NexusFi Open Term Token" # replace with your own token name
$ export NEXUSFI_OPEN_TERM_TOKEN_SYMBOL="nfiOTT" # replace with your own token symbol
$ export NEXUSFI_MULTISIG_WALLET_PK_ON_G=1 # set to 1 for PUBLIC_KEY_ON_G1, 2 for PUBLIC_KEY_ON_G2
$ export NEXUSFI_MULTISIG_WALLET_PUBLIC_KEY=0x0000000000000000000000000000000008a582ebbbb02e16a25937515dbdaa4b3923c1da08efc4bc7166beb8960e650e6cf50797293e3ee314fbb5b768167663000000000000000000000000000000000fcd3f839507df1fd035e1a3158e2001e30f9091e1ae3711717e15fd0af6ce0697b52c03c39fe1bf88dafbfe7a02bb61 # replace with your own aggregated public key
$ export NEXUSFI_THRESHOLD_WALLET_PK_ON_G=2 # set to 1 for PUBLIC_KEY_ON_G1, 2 for PUBLIC_KEY_ON_G2
$ export NEXUSFI_THRESHOLD_WALLET_PUBLIC_KEYS=0x000000000000000000000000000000000e66653e8d970484318957e1a2aa0600369db04de526863582ca3a0359392338ab2f4c698797cf913b839999d0b204c4000000000000000000000000000000000c42dfce7fbf9fb3e7f137854829e25a3e71bebd7e339f71539e6b98b8b8cfef7a7399517e308aec1b10401a150d97dd00000000000000000000000000000000112bd209171ef4715c17240ba4820023885c24585c352c2a8d69c84abb2a6cbf2e0fbbde51a6b10c023bdb1d3fc67e9700000000000000000000000000000000087334853998796b65601176e24cc3f439f136c706d623d781356ceddb584540a2c3f32628f2cfa01caa1cc39682ed70,0x00000000000000000000000000000000020d7314fcb279e9807d6e113d939b50e582152a9cab9d3535298af70adc0f374fd657ae7a1d0270bb761b595b99868d0000000000000000000000000000000017ebb3ef4991c6a95a25ed52502cbd441db40c78f68c732ef25b7c65400aaf88f952a218c84cc27d3ebb8d40e853e6190000000000000000000000000000000019089dea96a95fa1bbe60ca41d8fb123e8538d9522252c08d12907980655cab0ddcec75e8a73d3a07d74d1362310af1100000000000000000000000000000000054d606b04144a8837ac6e403791a34b4820366beb539ba919c7a081d0b1b5fe06adbbe5b4252089fe9ab71ca8cd8222,0x00000000000000000000000000000000053d46730cbbf7c4bb257068ab6951e1fa651092f1783afb9123e357b9e03b38d72fb2a653608a48281f6dc6d3a9001f0000000000000000000000000000000008bd0d5644986653041a89fb1e0a6d00624d6f786b642ab530eb7a6111c7b3f4300c3606ee74c66c8fc13160486f0583000000000000000000000000000000000768c9dc5f031e7034eb601071c5837a1d410f09573fc78727d6dca3732c6a009c8883da1b5b11060bb674e20c878245000000000000000000000000000000001348ab206da3e7e631e7e961167347fb23949d1e05ab42a746d124ffd6f15473611c2fd05e3ea138025a7b49c048916c # replace with your own public keys
$ export NEXUSFI_THRESHOLD_WALLET_MEMBER_IDS=0x000000000000000000000000000000000d7636e4b84c309cfb0f928c6af91af95c12b97de8f722d7382966ff561f62fbd027eda3e5b15ba533238b628fa747a20000000000000000000000000000000001c4e1712b4ed71b14e7efb7ab738201138910289abc3594b6b3dc49b92d013f9e670ba370c9fc2dad368315d90a4eba,0x000000000000000000000000000000000cbf9f328f92db7cb326d2e59dfa27880a2361f1fcd52a39964debf305ed44c2370df0523032904cf7a9d96d1fe42a7100000000000000000000000000000000196433ba2768ffb360db3d9e3352bd97e73c8c7af3f6add9db344dc460d3f98140d21aca316ffb13fe84e69fb3391c54,0x000000000000000000000000000000000f0b3db7418e50a882828457a6ef7a7e83bf38ac5fc6e5165ee13ddd0d17cde37fc40dad83782a428485d5e0a0031ef200000000000000000000000000000000107c2e484318e669452dc5fefaf851584619f3e3f5b94e99bb96fd1381f711ccae7ba4f11d4a0b0b3acf78904c68a36c # replace with your own member ids
$ export NEXUSFI_THRESHOLD_WALLET_N=3 # m-n parameters
$ export NEXUSFI_THRESHOLD_WALLET_M=2 # m-n parameters

3. Run deployment script

$ forge script script/DeployContractSuite.s.sol:DeployContractSuite --via-ir --rpc-url http://localhost:8545 --broadcast --interactives 1 --optimize  

4. Input the owner's private key

[⠊] Compiling...
No files changed, compilation skipped
Enter private key:

Test Network

1. Configure .env file

$ export NEXUSFI_OWNER=0xF265639351621C68867d089d95c14a1f0edBfB48 # replace with your own address
$ export NEXUSFI_UNDERLYING_TOKEN_NAME="NexusFi USD" # replace with your own token name
$ export NEXUSFI_UNDERLYING_TOKEN_SYMBOL="nfiUSD" # replace with your own token symbol
$ export NEXUSFI_ENABLE_WHITELIST=true # set to false to disable whitelist
$ export NEXUSFI_ENABLE_BLACKLIST=true # set to false to disable blacklist
$ export NEXUSFI_UNDERLYING_ASSET=0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238 # USDC 
$ export NEXUSFI_VAULT_1_NAME="NexusFi RWA Vault" # replace with your own vault name
$ export NEXUSFI_VAULT_1_SYMBOL="nfiRWA" # replace with your own vault symbol
$ export NEXUSFI_VAULT_1_MINIMUM_PERCENTAGE_IN_A_LOAN=300000 # 30% (6 decimals)
$ export NEXUSFI_VAULT_1_MAXIMUM_PERCENTAGE_IN_A_LOAN=600000 # 60% (6 decimals)
$ export NEXUSFI_VAULT_1_WEIGHT_IN_A_STAKE=350000 # 35% (6 decimals)
$ export NEXUSFI_VAULT_1_ALLOWANCE_FOR_TIME_LINEAR_LOAN=1000000000000 # 1 million USDC (6 decimals)
$ export NEXUSFI_VAULT_1_ALLOWANCE_FOR_TIME_POWER_LOAN=1000000000000 # 1 million USDC (6 decimals)
$ export NEXUSFI_VAULT_2_NAME="NexusFi MMF Vault" # replace with your own vault name
$ export NEXUSFI_VAULT_2_SYMBOL="nfiMMF" # replace with your own vault symbol
$ export NEXUSFI_VAULT_2_MINIMUM_PERCENTAGE_IN_A_LOAN=400000 # 40% (6 decimals)
$ export NEXUSFI_VAULT_2_MAXIMUM_PERCENTAGE_IN_A_LOAN=700000 # 70% (6 decimals)
$ export NEXUSFI_VAULT_2_WEIGHT_IN_A_STAKE=450000 # 45% (6 decimals)
$ export NEXUSFI_VAULT_2_ALLOWANCE_FOR_TIME_LINEAR_LOAN=1000000000000 # 1 million USDC (6 decimals)
$ export NEXUSFI_VAULT_2_ALLOWANCE_FOR_TIME_POWER_LOAN=1000000000000 # 1 million USDC (6 decimals)
$ export NEXUSFI_TIME_POWER_LOAN_ALLOWANCE=1000000000000000 # 1 billion USDC (6 decimals)
$ export NEXUSFI_TIME_LINEAR_LOAN_ALLOWANCE=2000000000000000 # 2 billion USDC (6 decimals)
$ export NEXUSFI_TIME_POWER_LOAN_INTEREST_RATES=1000000000937300000,1000000002732680000,1000000004431820000,1000000006044530000 # 3%, 9%, 15%, 21% APR FIXED18
$ export NEXUSFI_TIME_LINEAR_LOAN_INTEREST_RATES=951293760,2853881279,4756468798,6659056317 # 3%, 9%, 15%, 21% APR FIXED18
$ export NEXUSFI_FIXED_TERM_LOCK_PERIOD=3 # days
$ export NEXUSFI_FIXED_TERM_STAKE_FEE_RATE=1000 # 0.1%
$ export NEXUSFI_FIXED_TERM_UNSTAKE_FEE_RATE=1000 # 0.1%
$ export NEXUSFI_FIXED_TERM_START_FEED_TIME=1774508396 # 2026-03-26 14:59:56
$ export NEXUSFI_FIXED_TERM_DUST_BALANCE=1000000000 # 1,000 USDC (6 decimals)
$ export NEXUSFI_FIXED_TERM_MAX_SUPPLY=1000000000000000 # 1 billion underlying tokens (6 decimals)
$ export NEXUSFI_FIXED_TERM_TOKEN_NAME="NexusFi Fixed Term Token" # replace with your own token name
$ export NEXUSFI_FIXED_TERM_TOKEN_SYMBOL="nfiFTT" # replace with your own token symbol
$ export NEXUSFI_OPEN_TERM_STAKE_FEE_RATE=1000 # 0.1%
$ export NEXUSFI_OPEN_TERM_UNSTAKE_FEE_RATE=1000 # 0.1%
$ export NEXUSFI_OPEN_TERM_START_FEED_TIME=1774508396 # 2026-03-26 14:59:56
$ export NEXUSFI_OPEN_TERM_DUST_BALANCE=1000000000 # 1,000 USDC (6 decimals)
$ export NEXUSFI_OPEN_TERM_MAX_SUPPLY=1000000000000000 # 1 billion underlying tokens (6 decimals)
$ export NEXUSFI_OPEN_TERM_TOKEN_NAME="NexusFi Open Term Token" # replace with your own token name
$ export NEXUSFI_OPEN_TERM_TOKEN_SYMBOL="nfiOTT" # replace with your own token symbol
$ export NEXUSFI_MULTISIG_WALLET_PK_ON_G=1 # set to 1 for PUBLIC_KEY_ON_G1, 2 for PUBLIC_KEY_ON_G2
$ export NEXUSFI_MULTISIG_WALLET_PUBLIC_KEY=0x0000000000000000000000000000000008a582ebbbb02e16a25937515dbdaa4b3923c1da08efc4bc7166beb8960e650e6cf50797293e3ee314fbb5b768167663000000000000000000000000000000000fcd3f839507df1fd035e1a3158e2001e30f9091e1ae3711717e15fd0af6ce0697b52c03c39fe1bf88dafbfe7a02bb61 # replace with your own aggregated public key
$ export NEXUSFI_THRESHOLD_WALLET_PK_ON_G=2 # set to 1 for PUBLIC_KEY_ON_G1, 2 for PUBLIC_KEY_ON_G2
$ export NEXUSFI_THRESHOLD_WALLET_PUBLIC_KEYS=0x000000000000000000000000000000000e66653e8d970484318957e1a2aa0600369db04de526863582ca3a0359392338ab2f4c698797cf913b839999d0b204c4000000000000000000000000000000000c42dfce7fbf9fb3e7f137854829e25a3e71bebd7e339f71539e6b98b8b8cfef7a7399517e308aec1b10401a150d97dd00000000000000000000000000000000112bd209171ef4715c17240ba4820023885c24585c352c2a8d69c84abb2a6cbf2e0fbbde51a6b10c023bdb1d3fc67e9700000000000000000000000000000000087334853998796b65601176e24cc3f439f136c706d623d781356ceddb584540a2c3f32628f2cfa01caa1cc39682ed70,0x00000000000000000000000000000000020d7314fcb279e9807d6e113d939b50e582152a9cab9d3535298af70adc0f374fd657ae7a1d0270bb761b595b99868d0000000000000000000000000000000017ebb3ef4991c6a95a25ed52502cbd441db40c78f68c732ef25b7c65400aaf88f952a218c84cc27d3ebb8d40e853e6190000000000000000000000000000000019089dea96a95fa1bbe60ca41d8fb123e8538d9522252c08d12907980655cab0ddcec75e8a73d3a07d74d1362310af1100000000000000000000000000000000054d606b04144a8837ac6e403791a34b4820366beb539ba919c7a081d0b1b5fe06adbbe5b4252089fe9ab71ca8cd8222,0x00000000000000000000000000000000053d46730cbbf7c4bb257068ab6951e1fa651092f1783afb9123e357b9e03b38d72fb2a653608a48281f6dc6d3a9001f0000000000000000000000000000000008bd0d5644986653041a89fb1e0a6d00624d6f786b642ab530eb7a6111c7b3f4300c3606ee74c66c8fc13160486f0583000000000000000000000000000000000768c9dc5f031e7034eb601071c5837a1d410f09573fc78727d6dca3732c6a009c8883da1b5b11060bb674e20c878245000000000000000000000000000000001348ab206da3e7e631e7e961167347fb23949d1e05ab42a746d124ffd6f15473611c2fd05e3ea138025a7b49c048916c # replace with your own public keys
$ export NEXUSFI_THRESHOLD_WALLET_MEMBER_IDS=0x000000000000000000000000000000000d7636e4b84c309cfb0f928c6af91af95c12b97de8f722d7382966ff561f62fbd027eda3e5b15ba533238b628fa747a20000000000000000000000000000000001c4e1712b4ed71b14e7efb7ab738201138910289abc3594b6b3dc49b92d013f9e670ba370c9fc2dad368315d90a4eba,0x000000000000000000000000000000000cbf9f328f92db7cb326d2e59dfa27880a2361f1fcd52a39964debf305ed44c2370df0523032904cf7a9d96d1fe42a7100000000000000000000000000000000196433ba2768ffb360db3d9e3352bd97e73c8c7af3f6add9db344dc460d3f98140d21aca316ffb13fe84e69fb3391c54,0x000000000000000000000000000000000f0b3db7418e50a882828457a6ef7a7e83bf38ac5fc6e5165ee13ddd0d17cde37fc40dad83782a428485d5e0a0031ef200000000000000000000000000000000107c2e484318e669452dc5fefaf851584619f3e3f5b94e99bb96fd1381f711ccae7ba4f11d4a0b0b3acf78904c68a36c # replace with your own member ids
$ export NEXUSFI_THRESHOLD_WALLET_N=3 # m-n parameters
$ export NEXUSFI_THRESHOLD_WALLET_M=2 # m-n parameters

2. Run deployment script

$ forge script script/DeployContractSuite.s.sol:DeployContractSuite --via-ir --rpc-url https://api.zan.top/node/v1/eth/sepolia/YourAPIKey --broadcast --interactives 1 --optimize  

If you don't have an API key, you can visit ZAN and get a free one.
If you want to verify your contracts during the deployment process, you can run the following script.

forge script script/DeployContractSuite.s.sol:DeployContractSuite --via-ir --rpc-url https://api.zan.top/node/v1/eth/sepolia/YourAPIKey --broadcast --interactives 1 --optimize --verify --etherscan-api-key YourEtherscanAPIKey  

If you don't have an etherscan API key, you can visit Etherscan and get a free one.
3. Configure .env file.

Note: all contract addresses are proxy addresses (not logic or proxy admin). You can find them in the outputs of deployment script.

$ export WHITELIST=0x85FFEaB7650b8a08BD757780b4D2A0b0878408Da # replace with your own whitelist proxy address
$ export BLACKLIST=0xF41639623C4d0fEa2A01997AC71C05150456B43a # replace with your own blacklist proxy address
$ export UNDERLYING_TOKEN=0xabD7E811aeE89DB1C130b78f7aC6eB978b2aDA83 # replace with your own underlying token proxy address
$ export UNDERLYING_TOKEN_EXCHANGER=0x36319D75a32F84CD6dfd7cEFfa0C4Bf315a327c5 # replace with your own underlying token exchanger proxy address
$ export VAULT_1=0x03C798D8E3C765d42dFcAFc215267Ff6bEbEa5aa # replace with your own vault1 proxy address
$ export VAULT_2=0x937509401620a0EC70E9A0d6BbE5aaf9aBe524A2 # replace with your own vault2 proxy address
$ export FIXED_TERM_STAKING=0x9444aD139De6F70661be02Dda5982A19f670fd86 # replace with your own fixed term staking proxy address
$ export OPEN_TERM_STAKING=0x936Ffb31eB2964ce67c40864CA4838F9dA727293 # replace with your own open term staking proxy address
$ export TIME_POWER_LOAN=0x47f51EF51B7aa23Ff031898C67Fbb6eCa3609b73 # replace with your own time power loan proxy address
$ export TIME_LINEAR_LOAN=0x5848aC0b92583292C314Fe1f3A4A78b5de304df5 # replace with your own time linear loan proxy address
$ export MULTISIG_WALLET=0x036dA3104C47075fe6d7CE2843B510103837b305 # replace with your own multisig wallet proxy address
$ export THRESHOLD_WALLET=0xb952E1e0FF7869d38eD778717b7A91D97ac89F39 # replace with your own threshold wallet proxy address
$ export NEXUSFI_BORROWER=0x622F1e8492ffFc31A58b686AbF01ac60598D6303 # replace with your own borrower address

4. Run contract dependency script

$ forge script script/ContractDependency.s.sol:ContractDependencyScript --via-ir --rpc-url https://api.zan.top/node/v1/eth/sepolia/YourAPIKey --broadcast --interactives 1 --optimize  

5. Following are test contracts already deployed on sepolia network.

• Whitelist
  0x85FFEaB7650b8a08BD757780b4D2A0b0878408Da
• Blacklist
  0xF41639623C4d0fEa2A01997AC71C05150456B43a
• UnderlyingToken
  0xabD7E811aeE89DB1C130b78f7aC6eB978b2aDA83
• UnderlyingTokenExchanger
  0x36319D75a32F84CD6dfd7cEFfa0C4Bf315a327c5
• MultisigWallet
  0x036dA3104C47075fe6d7CE2843B510103837b305
• ThresholdWallet
  0xb952E1e0FF7869d38eD778717b7A91D97ac89F39
• ValueInflationVault(RWA)
  0x03C798D8E3C765d42dFcAFc215267Ff6bEbEa5aa
• ValueInflationVault(MMF)
  0x937509401620a0EC70E9A0d6BbE5aaf9aBe524A2
• FixedTermStaking
  0x9444aD139De6F70661be02Dda5982A19f670fd86
• OpenTermStaking
  0x936Ffb31eB2964ce67c40864CA4838F9dA727293
• TimePowerLoan
  0x47f51EF51B7aa23Ff031898C67Fbb6eCa3609b73
• TimeLinearLoan
  0x5848aC0b92583292C314Fe1f3A4A78b5de304df5

Main Network

Note: the same as test network.

Upgrade

1. Configure .env file

$ export LOGIC_INDEX=4 # set the logic index to deploy

Following list is logic contract indexes.

• 1 - Whitelist
• 2 - Blacklist
• 3 - UnderlyingToken
• 4 - UnderlyingTokenExchanger
• 5 - FixedTermStaking
• 6 - OpenTermStaking
• 7 - ValueInflationVault
• 8 - TimePowerLoan
• 9 - TimeLinearLoan
• 10 - MultisigWallet
• 11 - ThresholdWallet

2. Run logic contract deployment script

$ forge script script/DeployContractLogic.s.sol:DeployContractLogic --rpc-url https://api.zan.top/node/v1/eth/sepolia/YourAPIKey --broadcast --interactives 1 --verify --etherscan-api-key YourEtherscanAPIKey --optimize

If you don't have an API key, you can visit ZAN and get a free one.
If you don't have an etherscan API key, you can visit Etherscan and get a free one.
3. Open the XXX proxy admin contract on sepolia etherscan.
For example, XXX = UnderlyingTokenExchanger Proxy Admin.
Then you should connect your proxy admin owner's wallet and call upgradeAndCall function.