Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example contracts showcase #294

Closed
wants to merge 21 commits into from
Closed

Add example contracts showcase #294

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
6d9e2af
Add example contracts showcase
AurelienFT Apr 2, 2024
1180f9d
try ci
AurelienFT Apr 2, 2024
de64386
Add new job
AurelienFT Apr 2, 2024
316ad21
try trigger
AurelienFT Apr 2, 2024
7b6bf7b
try trigger 2
AurelienFT Apr 2, 2024
22ea37d
try new version
AurelienFT Apr 2, 2024
79f00b8
fix ident
AurelienFT Apr 2, 2024
97ea038
fix ident 2
AurelienFT Apr 2, 2024
89c93dc
try new ci
AurelienFT Apr 2, 2024
60ca992
contracts change
AurelienFT Apr 2, 2024
c0d737b
try to fix ci
AurelienFT Apr 2, 2024
609ab2b
try final ci with debug
AurelienFT Apr 2, 2024
248fcf9
fix ident
AurelienFT Apr 2, 2024
12c5e41
remove caching
AurelienFT Apr 2, 2024
fea3242
fix env variable name
AurelienFT Apr 2, 2024
56bc57c
try a failed test
AurelienFT Apr 2, 2024
e6622b3
Remove all debug
AurelienFT Apr 2, 2024
4b03534
Update massa-as-sdk version
AurelienFT Apr 30, 2024
731e8ec
update fee minimal
AurelienFT Apr 30, 2024
c34a3f8
update fees deployment
AurelienFT Apr 30, 2024
c3cd256
Use new version web3 for the test interactions
AurelienFT Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
298 changes: 85 additions & 213 deletions contracts_showcase/accesscontrol/interaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,11 @@
import {
IDeploymentInfo,
ISCData,
deploySC,
} from "@massalabs/massa-sc-deployer";
import {
CHAIN_ID,
MAX_GAS_DEPLOYMENT,
WalletClient,
fromMAS,
Account,
AccountOperation,
Args,
EventPoller,
Client,
ClientFactory,
ProviderType,
IProvider,
IEventFilter,
MAX_GAS_CALL,
JsonRPCClient,
OperationStatus,
SmartContract,
bytesToStr,
IEvent,
EOperationStatus,
} from "@massalabs/massa-web3";
import path from "path";
import { fileURLToPath } from "url";
Expand All @@ -28,227 +15,112 @@ import * as dotenv from "dotenv";
// Load environment variables from .env file
dotenv.config();

// Helper function to get environment variable from env
function getEnvVariable(key: string): string {
const value = process.env[key];
if (!value) {
throw new Error(`Missing ${key} in .env file`);
}
return value;
}

// Helper function to read bytecode from file
// // Helper function to read bytecode from file
function getByteCode(folderName: string, fileName: string): Buffer {
// Obtain the current file name and directory paths
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
return readFileSync(path.join(__dirname, folderName, fileName));
}

// Helper function to get the address from the deployment result
async function getEventsFromOp(opId: string): Promise<IEvent[]> {
// Wait for the operation to be speculative success or Speculative failure
// First promise that resolves stops the execution
await web3Client
.smartContracts()
.awaitMultipleRequiredOperationStatus(opId, [
EOperationStatus.SPECULATIVE_SUCCESS,
EOperationStatus.SPECULATIVE_ERROR,
]);

// Filter to get the deployment event
const eventsFilter = {
start: null,
end: null,
original_caller_address: null,
original_operation_id: opId,
emitter_address: null,
is_final: false,
} as IEventFilter;

// Get the deployment event
const deploymentEvents = await EventPoller.getEventsOnce(
eventsFilter,
web3Client
);
return deploymentEvents;
}
// // Helper function to get the address from the deployment result
// async function getEventsFromOp(opId: string): Promise<IEvent[]> {
// // Wait for the operation to be speculative success or Speculative failure
// // First promise that resolves stops the execution
// await web3Client
// .smartContracts()
// .awaitMultipleRequiredOperationStatus(opId, [
// EOperationStatus.SPECULATIVE_SUCCESS,
// EOperationStatus.SPECULATIVE_ERROR,
// ]);

// // Filter to get the deployment event
// const eventsFilter = {
// start: null,
// end: null,
// original_caller_address: null,
// original_operation_id: opId,
// emitter_address: null,
// is_final: false,
// } as IEventFilter;

// // Get the deployment event
// const deploymentEvents = await EventPoller.getEventsOnce(
// eventsFilter,
// web3Client
// );
// return deploymentEvents;
// }

// Get environment variables
const publicApi = getEnvVariable("JSON_RPC_URL_PUBLIC");
const secretKey = getEnvVariable("WALLET_SECRET_KEY");

// Define deployment parameters
const chainId = CHAIN_ID.BuildNet; // Choose the chain ID corresponding to the network you want to deploy to
const maxGas = 2980167295n; // Gas for deployment Default is the maximum gas allowed for deployment
const fees = fromMAS(0.01); // Fees to be paid for deployment. Default is 0

// Create an account using the secret key
const deployerAccount = await WalletClient.getAccountFromSecretKey(secretKey);

// Create a random account for the user
const userAccount = await WalletClient.walletGenerateNewAccount();

// Create a web3 client
const web3Client: Client = await ClientFactory.createCustomClient(
[
{ url: publicApi, type: ProviderType.PUBLIC } as IProvider,
// Using a placeholder IP since the script doesn't require a real one, though massa-web3 does.
{ url: publicApi, type: ProviderType.PRIVATE } as IProvider,
],
chainId,
true,
deployerAccount
);

// Send some coins to the user account
web3Client.wallet().sendTransaction({
fee: fromMAS(0.01),
amount: fromMAS(1),
recipientAddress: userAccount.address!,
});

// Deploy the smart contract
const deploymentResult = await deploySC(
publicApi, // JSON RPC URL
deployerAccount, // account deploying the smart contract(s)
[
{
data: getByteCode("build", "main.wasm"), // smart contract bytecode
coins: fromMAS(0.1), // coins for deployment
args: new Args()
.addString(deployerAccount.address!)
.addString(userAccount.address!), // arguments for deployment
} as ISCData,
// Additional smart contracts can be added here for deployment
],
chainId, // chain ID
fees, // fees for deployment
maxGas, // maximum gas for deployment
false // wait for the deployment finality
const decimals = 10 ** 9;
const apiUrl = "https://buildnet.massa.net/api/v2";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is exported by massa web3


const adminAccount = await Account.fromEnv();
const adminAddress = adminAccount.address.toString();
const userAccount = await Account.generate();
const client = new JsonRPCClient(apiUrl);
const adminAccountOperation = await new AccountOperation(adminAccount, client);

adminAccountOperation.transfer(userAccount.address, BigInt(10 * decimals));

const contract = await SmartContract.deploy(
client,
adminAccount,
{
byteCode: getByteCode("build", "main.wasm"),
coins: BigInt(10 * decimals),
parameter: new Args()
.addString(adminAddress)
.addString(userAccount.address.toString())
.serialize(),
},
{
waitFinalExecution: false,
}
);

// Get the address of the deployed smart contract
const deploymentEvents = await getEventsFromOp(deploymentResult.opId);
// Get the smart contract address from the deployment event
if (deploymentEvents.length === 0) {
throw new Error("No events found for the deployment");
}
const scAddress = deploymentEvents[0].data.split(": ")[1];
console.log(`Smart contract deployed at address: ${scAddress}`);

// Get the adminAddress
const adminAddress = bytesToStr(
(
await web3Client.smartContracts().readSmartContract({
targetAddress: scAddress,
targetFunction: "getAdmin",
parameter: new Args(),
maxGas: MAX_GAS_CALL,
callerAddress: deployerAccount.address!,
})
).returnValue
const adminAddressSC = bytesToStr(
(await contract.read("getAdmin", new Args().serialize())).value
);

// Check if the admin address is the expected one
if (adminAddress !== deployerAccount.address) {
if (adminAddressSC !== adminAddress) {
throw new Error("Admin address is not the expected one");
}

// Use the user account to interact with the smart contract
const web3ClientUser: Client = await ClientFactory.createCustomClient(
[
{ url: publicApi, type: ProviderType.PUBLIC } as IProvider,
// Using a placeholder IP since the script doesn't require a real one, though massa-web3 does.
{ url: publicApi, type: ProviderType.PRIVATE } as IProvider,
],
chainId,
true,
userAccount
);
console.log("Admin address is the expected one");

console.log(
"Trying to change the admin address with the user account (not allowed)..."
);

// Try to change the admin address with the user account that is not the admin (should fail)
const opId = await web3ClientUser.smartContracts().callSmartContract({
targetAddress: scAddress,
functionName: "changeAdmin",
parameter: new Args().addString(userAccount.address!),
maxGas: MAX_GAS_CALL,
fee: fromMAS(0.01),
});

const callEvents = await getEventsFromOp(opId);
if (callEvents.length === 0) {
throw new Error("No events found for the call");
}
if (
!callEvents[0].data.includes(
"VM execution error: RuntimeError: Runtime error: error: User does not have 'admin' permission."
)
) {
throw new Error("The call should have failed");
} else {
console.log("The call to change admin from user failed as expected");
}

// Get the adminAddress
const adminAddress2 = bytesToStr(
(
await web3Client.smartContracts().readSmartContract({
targetAddress: scAddress,
targetFunction: "getAdmin",
parameter: new Args(),
maxGas: MAX_GAS_CALL,
callerAddress: deployerAccount.address!,
})
).returnValue
);

// Check if the admin address is the expected one
if (adminAddress2 !== deployerAccount.address) {
throw new Error("Admin address is not the expected one");
try {
await contract.call(
"changeAdmin",
new Args().addString(userAccount.address.toString()).serialize(),
{
account: userAccount,
}
);
} catch {
console.log("Admin address change failed as expected");
}

console.log(
"Trying to change the admin address with the deployer account (allowed)..."
);

// Change the admin address with the deployer account
const opId2 = await web3Client.smartContracts().callSmartContract({
targetAddress: scAddress,
functionName: "changeAdmin",
parameter: new Args().addString(userAccount.address!),
maxGas: MAX_GAS_CALL,
fee: fromMAS(0.01),
});

// Get the event for the call
const callEvents2 = await getEventsFromOp(opId2);
if (callEvents2.length !== 0) {
throw new Error("No events is expected for the call");
}

const op = await contract.call(
"changeAdmin",
new Args().addString(userAccount.address.toString()).serialize(),
{
account: adminAccount,
}
);
await op.waitSpeculativeExecution();
console.log("Admin address changed successfully");

// Get the adminAddress
const adminAddress3 = bytesToStr(
(
await web3Client.smartContracts().readSmartContract({
targetAddress: scAddress,
targetFunction: "getAdmin",
parameter: new Args(),
maxGas: MAX_GAS_CALL,
callerAddress: deployerAccount.address!,
})
).returnValue
const adminAddressSC2 = bytesToStr(
(await contract.read("getAdmin", new Args().serialize())).value
);

// Check if the admin address is the expected one
if (adminAddress3 !== userAccount.address) {
if (adminAddressSC2 !== userAccount.address.toString()) {
throw new Error("Admin address is not the expected one");
}

process.exit(0);
process.exit(0);
Loading
Loading