API
paramsChargedConstructor Charged parameter object.
const charged = new Charged({providers: window.ethereum});
const allStateAddresses = await charged.utils.getStateAddress();
const polygonProvider = [
{
network: 137,
service: {alchemy: process.env.ALCHEMY_POLYGON_KEY}
}
];
const charged = new Charged({providers: polygonProvider})
Charged class constructor object parameter.
Properties
providers(Array<NetworkProvider> | providers.Provider | providers.ExternalProvider)? Provider for connection to the Ethereum network.signerSigner? Needed to send signed transactions to the Ethereum Network to execute state changing operations.configConfigurationParameters
const charged = new Charged({providers: window.ethereum});
const creatorAnnuities = await charged.utils.getStateAddress();
Returns UtilsService
Get the address of the chargedState contract.
Get the address of the chargedSettings contract.
Get the address of the chargedManagers contract.
Get the deposit fee of the protocol.
const charged = new Charged({providers: window.ethereum});
const nft = charged.NFT( '0xd1bce91a13089b1f3178487ab8d0d2ae191c1963', 43);
const creatorAnnuities = await nft.getCreatorAnnuities();
Returns NftService Instance of the NFT connected to the charged particle protocol
Gets the amount of asset tokens that have been deposited into the Particle.
Parameters
walletManagerIdWalletManagerId The ID of the wallet manager to check.
Returns BigNumber The Amount of underlying assets held within the token.
Gets the amount of interest that the particle has generated.
Parameters
walletManagerIdWalletManagerId The ID of the Wallet Manager.
Returns BigNumber The amount of interest generated.
Gets the amount of LP Tokens that the Particle has generated.
Parameters
walletManagerIdWalletManagerId The ID of the Wallet Manager.
Returns BigNumber The amount of LP tokens that have been generated.
Gets the total amount of ERC721 tokens that the Particle holds.
Parameters
Returns BigNumber The total amount of ERC721 tokens that are held within the Particle.
Gets the amount of creator annuities reserved for the creator for the specified NFT.
Returns address The address of the creator.
Get the address that receives creator annuities for a given Particle/ Defaults to creator address if it has not been redirected.
Returns address The address of the creator.
Gets the tokenUri using the tokenId and contractAddress of the Particle.
Gets the Discharge timelock state of the Particle.
Parameters
Gets the Discharge timelock state of the Particle.
Parameters
Gets the Bonds Timelock state of the Particle.
Parameters
Returns BigNumber timelock
Returns BigNumber tempLockExpiry
Fund particle with asset token Must be called by the account providing the asset. Account must also approve THIS contract as operator as asset.
If you are getting gas limit errors this may be because you forgot to approve the contract as operator of asset
Parameters
walletManagerIdWalletManagerId The Asset-Pair to Energize the Token withassetAmountBigNumberish The Amount of Asset Token to Energize the Token with
Examples
// Asset amount expects a big numberish type. If you do not supply a
// big number object, ethers will assume you are working in wei.
// Deposits 20 USDC tokens into our particle that will accrue interest.
const USDCoinAddress = '0xUSDC';
const result = await nft.energize(
'aave.B',
USDCoinAddress,
ethers.utils.parseUnits("20", 6),
);
// Or, deposit assets that will not accrue interest
// or assets that are not supported by our yield generating protocols (e.g. aave)
// For example, we will energize our particle with 20 monkey coins
// This will not generate interest.
const monkeyCoinAddress = '0xMONKEY';
const result = await nft.energize(
'generic.B',
monkeyCoinAddress,
ethers.utils.parseUnits("20")
);
Allows the owner or operator of the token to collect or transfer the interest generated from the token without removing the underlying asset that is held within the token.
Parameters
walletManagerIdWalletManagerId The wallet manager of that assets to discharge from the token.
Examples
const myWallet = '0xWALLET';
const rocketPoolAddress = '0xRPL';
const result = await nft.discharge(
myWallet,
'aave.B',
rocketPoolAddress,
);
// You can also discharge to any arbitrary wallet!
// Let's send all of our interest accrued by our DAI to Vitalik.
const vitaliksWallet = '0xCOOLGUY';
const daiAddress = '0xDAI';
const result = await nft.discharge(
vitaliksWallet,
'aave.B',
daiAddress,
)
Allows the owner or operator of the Token to collect or transfer a specific amount of the interest generated from the token without removing the underlying Asset that is held within the token.
Parameters
walletManagerIdWalletManagerId The wallet manager of the assets to discharge from the token.assetAmountBigNumberish The specific amount of asset token to discharge from the particle.
Allows the Creator of the Token to collect or transfer a their portion of the interest (if any) generated from the token without removing the underlying Asset that is held within the token.
Parameters
walletManagerIdWalletManagerId The wallet manager of the assets to discharge from the tokenassetAmountBigNumberish The specific amount of asset token to discharge from the particle
Releases the full amount of asset + interest held within the particle by LP of the assets. To release NFT assets from your particle, see break bond.
Parameters
walletManagerIdWalletManagerId The wallet manager of the assets to release from the token.
Examples
// Release the DAI from our particle. Withdraws the interest (if any) as well!
const receiver = '0xMYWALLET';
const daiAddress = '0xDAI';
const result = nft.release(
receiver,
'aave.B',
daiAddress,
);
Releases a partial amount of asset + interest held within the particle by LP of the assets.
Parameters
walletManagerIdWalletManagerId The wallet manager of the assets to release from the tokenassetAmountBigNumberish The specific amount of asset token to release from the particle
Deposit other NFT assets into the particle. Must be called by the account providing the asset. Account must approve THIS contract as operator of asset.
Parameters
Examples
const nftTokenAddress = '0xMOONBIRDS';
const tokenId = '12';
const result = await nft.bond(
'generic.B',
nftTokenAddress,
tokenId,
1,
);
// We have 12 erc-1155 nfts that we want to bond to the particle.
const nftTokenAddress = '0xCOOLGAME';
const tokenId = '78';
const result = await nft.bond(
'generic.B',
nftTokenAddress,
tokenId,
12
);
Release NFT assets from the particle.
Parameters
Examples
// We bonded 14 erc-1155 nfts to our particle. We want to release 3.
// When working with erc-721 use 1 for nftTokenAmount.
const receiver = '0xMYWALLET';
const nftTokenAddress = '0xNFTS';
const tokenId = '35';
const result = await nft.breakBond(
receiver,
'generic.B',
nftTokenAddress,
tokenId,
3
);
Sets a timelock on the ability to release the assets of a particle.
Parameters
Sets a timelock on the ability to discharge the assets of a particle
Parameters
Sets a timelock on the ability to break the covalent bond of a particle
Parameters
Sets the custom configuration for creators of proton-based NFTs Must be called by account that created and owns the particle
Parameters
annuityPercentBigNumberish The percentage of interest-annuities to reserve for the creator. In decimal this can range from 0 - 10000. 5712 would be 57.12%..
Sets a custom receiver address for the creator annuities Must be called by account that created and owns the particle
Parameters
Last modified 10mo ago