NRE Reference

Here you can find a complete reference of the functions provided by the Nile Runtime Environment.

Functions

compile(contracts, cairo_path=None) → None

Compile a list of contracts.

Arguments

  • contracts

    List of contracts to compile.

  • cairo_path

    Specify a set of directories for the Cairo compiler to resolve imports.

deploy(contract, arguments=None, alias=None, overriding_path=None, abi=None, mainnet_token=None, watch_mode=None) → (address, abi)

Deploy a smart contract.

Deprecated in favor of deployments through accounts.
Arguments

  • contract

    Contract to deploy.

  • arguments

    List of arguments for the constructor (calldata).

  • alias

    Alias for deployment registration.

  • overriding_path

    Override for the path to artifacts and abis.

  • abi

    Use a different abi for registration (useful for proxies).

  • mainnet_token

    Token for mainnet deployments.

  • watch_mode

    Either track or debug (check status command).

Return values

  • address

    Address of the new contract.

  • abi

    Abi registered in deployments.

call(address_or_alias, method, params=None, abi=None) → output

Call a view function in a smart contract.

Arguments

  • address_or_alias

    Identifier for the contract to call (alias needs to be registered in deployments).

  • method

    Method to call.

  • params

    Arguments for the call.

  • abi

    Override for the abi if necessary.

Return values

  • output

    Output from the underlaying starknet cli call.

get_deployment(address_or_alias) → (address, abi)

Get a deployment by its identifier.

Arguments

  • address_or_alias

    Contract identifier.

Return values

  • address

    Registered contract address.

  • abi

    Registered contract abi.

get_declaration(hash_or_alias) → class_hash

Get a declared class by its identifier.

Arguments

  • hash_or_alias

    Contract identifier.

Return values

  • class_hash

    Declared contract class hash.

get_or_deploy_account(signer, watch_mode=None) → account

Get or deploy an Account contract.

Arguments

  • signer

    Alias representing the private key associated.

  • watch_mode

    Either None, track or debug. Block the execution to query the status of the deployment transaction if needed.

Return values

  • account

    Account matching the signer.

get_accounts(predeployed=False) → accounts

Retrieve and manage deployed accounts.

Arguments

  • predeployed

    Get predeployed accounts from a starknet-devnet node.

Return values

  • accounts

    Registered accounts.

get_nonce(contract_address) → current_nonce

Retrieve the nonce for a contract.

Arguments

  • contract_address

    Address of the contract to query.

Return values

  • current_nonce

    Nonce of the contract.

get_balance(contract_address) → balance

Get the Ether balance of an address.

Arguments

  • contract_address

    Address of the contract to query.

Return values

  • balance

    Balance of the contract.

← CLI Reference
Extending Nile →