You can see the deployment address of the smart contracts in the addresses.json file. For every deployed smart contract you will find a <network>.<contract>
value.
The admin
is allowed to set configuration variables in the smart contracts.
BASE_URI
: https://beta.metadata.masa.finance/v1.0The base url for the Metadata url that is being generated from the contract
deployer
: Deploys the contract, has no rights after everything has properly handed over to other rolesadmin
: Delegated to the Masa Service account inside the Masa API. It has the rights to administrate the smart
contractsminter
: Minter role. It has the rights to mint tokens to customer's wallets.DEPLOYER_PRIVATE_KEY
to the deployers private key in .env.{network}.secret
COINMARKETCAP_API_KEY
to the CoinMarketCap API key in .env
, if neededANKR_API_KEY
to the Ankr API key in .env
, if neededETHERSCAN_API_KEY
to the Etherscan API key in .env
, if neededBSCSCAN_API_KEY
to the Etherscan API key in .env
, if neededPOLYGONSCAN_API_KEY
to the Etherscan API key in .env
, if neededCELOSCAN_API_KEY
to the Etherscan API key in .env
, if neededBASESCAN_API_KEY
to the Etherscan API key in .env
, if neededRun: yarn deploy --network {network}
to deploy.
Installing via npm
package:
npm i @masa-finance/masa-contracts-identity
Import in your project:
import {
SoulboundIdentity,
SoulboundIdentity__factory
} from "@masa-finance/masa-contracts-identity";
const soulboundIdentity: SoulboundIdentity = SoulboundIdentity__factory.connect(
<address>, // address of the deployed contract
<provider> // web3 provider
);
console.log(await soulboundIdentity.symbol());
From a clean main
branch you can run the release task bumping the version accordingly based on semantic versioning:
yarn release
The task does the following:
package.json
npm
releaseFor the GitHub releases steps a GitHub personal access token, exported as GITHUB_TOKEN
is required. You can add this
environment variable to the .env
file. Setup