repository·master·Indexed 41 days ago
https://github.com/dfinity/sdkA comprehensive toolkit for creating, deploying, and managing canister smart contracts on the Internet Computer (ICP) blockchain. It includes the dfx CLI, dfxvm version manager, and language-specific Canister Development Kits (CDK) for Rust, Python, and TypeScript.
The dfx sns command suite is used to simulate handing a dapp off to the community for decentralized governance via a Service Nervous System (SNS).
Subcommands:
create: Creates an SNS configuration template.validate: Checks whether the SNS configuration file is valid.deploy: Deploys SNS canisters according to the local configuration.help: Displays usage information for a specified subcommand.dfx command-line execution environment is the primary tool for creating, deploying, and managing decentralized applications (dapps) on the Internet Computer platform. It uses a parent command structure where subcommands and flags are used to perform specific operations like canister management, deployment, and identity handling.ic-asset is a library designed for manipulating assets within an asset canister on the Internet Computer.The dfx cycles command is used to manage cycles associated with an identity's principal via the cycles ledger.
Basic syntax:
dfx cycles [subcommand] [options]Available subcommands:
approve: Approves a principal to spend cycles on your behalf.balance: Prints the account balance of the current principal.convert: Converts ICP balance into cycles.redeem-faucet-coupon: Redeems a code at the cycles faucet.top-up: Deposits cycles into a canister.transfer: Sends cycles to another account.help: Displays usage information for a subcommand.icx-asset is a command line tool designed to manage assets within an asset storage canister. It provides capabilities for synchronizing directories, listing existing assets, and uploading individual files or entire directories.The playground_backend asset is used to build a local Motoko playground for testing playground interactions without relying on the mainnet. To ensure quick deployments, the frontend and other non-essential parts are stripped out.
It includes two primary canisters:
wasm-utils: Performs instrumentation on deployed WASM (e.g., injecting profiling and stripping forbidden function calls like add_cycles).backend: Manages playground canisters and handles lending them to users.The dfx wallet command is used to manage the cycles wallets of your identities. You can use it to modify wallet settings, send cycles to other canisters (including other cycles wallets), and manage controllers and custodians.
Note: Before using these commands, you must have created a cycles wallet canister tied to an identity using dfx identity deploy-wallet.
The dfx ledger command allows you to interact with the ICP token's ledger canister. You can use it to perform ICP utility token transactions between canisters, top up canisters with cycles by converting ICP, check balances, and manage approvals for spending.
Basic syntax:
dfx ledger [subcommand] [options]Available subcommands:
account-id: Prints the selected identity's account identifier.approve: Approves a principal to spend ICP on your behalf (ICRC-2).balance: Prints the account balance of a user.create-canister: Creates a canister using ICP.fabricate-cycles: (Local development only) Generates cycles and deposits them into specified canisters.help: Displays usage information for a subcommand.notify: Notifies the ledger of a send transaction to the cycles minting canister.top-up: Tops up a canister with cycles minted from ICP.transfer: Transfers ICP to a destination account identifier or principal.transfer-from: Transfers ICP from an approved spender to another principal.To see help for a specific subcommand, use --help (e.g., dfx ledger transfer --help).
The dfx identity command is used to manage the identities that execute commands and communicate with the mainnet or local development environment. Creating multiple identities allows you to test user-based access controls.
Basic Syntax:
dfx identity [subcommand] [flag]Available Subcommands:
| Command | Description |
|---|---|
deploy-wallet | Installs the cycles wallet Wasm to the provided canister id. |
get-principal | Shows the textual representation of the principal associated with the current identity. |
get-wallet | Shows the canister identifier for the wallet associated with your current identity principal. |
help | Displays usage information for the command or subcommand. |
export | Exports the PEM definition for an identity. |
import | Creates a new identity by importing a PEM file or security certificate. |
list | Lists existing identities. |
new | Creates a new identity. |
remove | Removes an existing identity. |
rename | Renames an existing identity. |
set-wallet | Sets the wallet canister identifier to use for your current identity principal. |
use | Specifies the identity to use. |
whoami | Displays the name of the current identity user context. |
The dfx command-line execution environment is the primary tool for creating, deploying, and managing dapps on the Internet Computer (ICP). It follows a parent command structure where you use subcommands and flags to perform specific operations.
Basic usage:
dfx [subcommand] [flag]When defining a canister type in an extension, dfx performs Handlebars string replacement on every string field. This allows you to create dynamic paths and commands based on the canister's configuration.
Available Handlebar variables:
{{canister_name}}: The name of the canister.{{canister.<field>}}: Any field from the canister definition in dfx.json, or from canister_type.defaults in the extension's extension.json.