diff --git a/.github/workflows/send_http_get.yml b/.github/workflows/send_http_get.yml new file mode 100644 index 000000000..d6952c07c --- /dev/null +++ b/.github/workflows/send_http_get.yml @@ -0,0 +1,28 @@ +name: send_http_get + +on: + push: + branches: [master] + pull_request: + paths: + - motoko/send_http_get/** + - .github/workflows/send_http_get.yml + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + motoko-send_http_get: + runs-on: ubuntu-24.04 + container: ghcr.io/dfinity/icp-dev-env-motoko:0.3.2 + env: + ICP_CLI_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1 + - name: Deploy and test + working-directory: motoko/send_http_get + run: | + icp network start -d + icp deploy + make test diff --git a/motoko/send_http_get/.devcontainer/devcontainer.json b/motoko/send_http_get/.devcontainer/devcontainer.json deleted file mode 100644 index ebb0b8bcc..000000000 --- a/motoko/send_http_get/.devcontainer/devcontainer.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "name": "ICP Dev Environment", - "image": "ghcr.io/dfinity/icp-dev-env-slim:22", - "forwardPorts": [4943, 5173], - "portsAttributes": { - "4943": { - "label": "dfx", - "onAutoForward": "ignore" - }, - "5173": { - "label": "vite", - "onAutoForward": "openBrowser" - } - }, - "customizations": { - "vscode": { - "extensions": ["dfinity-foundation.vscode-motoko"] - } - } -} diff --git a/motoko/send_http_get/.gitignore b/motoko/send_http_get/.gitignore index b75c888e0..139ed28bb 100644 --- a/motoko/send_http_get/.gitignore +++ b/motoko/send_http_get/.gitignore @@ -10,6 +10,9 @@ # dfx temporary files .dfx/ +# icp-cli cache +.icp/ + # generated files src/declarations/ diff --git a/motoko/send_http_get/BUILD.md b/motoko/send_http_get/BUILD.md deleted file mode 100644 index 24cfcb754..000000000 --- a/motoko/send_http_get/BUILD.md +++ /dev/null @@ -1,113 +0,0 @@ -# Continue building locally - -Projects deployed through ICP Ninja are temporary; they will only be live for 20 minutes before they are removed. The command-line tool `dfx` can be used to continue building your ICP Ninja project locally and deploy it to the mainnet. - -To migrate your ICP Ninja project off of the web browser and develop it locally, follow these steps. - -### 1. Install developer tools. - -You can install the developer tools natively or use Dev Containers. - -#### Option 1: Natively install developer tools - -> Installing `dfx` natively is currently only supported on macOS and Linux systems. On Windows, it is recommended to use the Dev Containers option. - -1. Install `dfx` with the following command: - -``` - -sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)" - -``` - -> On Apple Silicon (e.g., Apple M1 chip), make sure you have Rosetta installed (`softwareupdate --install-rosetta`). - -2. [Install NodeJS](https://nodejs.org/en/download/package-manager). - -3. For Rust projects, you will also need to: - -- Install [Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html#install-rust-and-cargo): `curl https://sh.rustup.rs -sSf | sh` - -- Install [candid-extractor](https://crates.io/crates/candid-extractor): `cargo install candid-extractor` - -4. For Motoko projects, you will also need to: - -- Install the Motoko package manager [Mops](https://docs.mops.one/quick-start#2-install-mops-cli): `npm i -g ic-mops` - -Lastly, navigate into your project's directory that you downloaded from ICP Ninja. - -#### Option 2: Dev Containers - -Continue building your projects locally by installing the [Dev Container extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for VS Code and [Docker](https://docs.docker.com/engine/install/). - -Make sure Docker is running, then navigate into your project's directory that you downloaded from ICP Ninja and start the Dev Container by selecting `Dev-Containers: Reopen in Container` in VS Code's command palette (F1 or Ctrl/Cmd+Shift+P). - -> Note that local development ports (e.g. the ports used by `dfx` or `vite`) are forwarded from the Dev Container to your local machine. In the VS code terminal, use Ctrl/Cmd+Click on the displayed local URLs to open them in your browser. To view the current port mappings, click the "Ports" tab in the VS Code terminal window. - -### 2. Start the local development environment. - -``` -dfx start --background -``` - -### 3. Create a local developer identity. - -To manage your project's canisters, it is recommended that you create a local [developer identity](https://internetcomputer.org/docs/building-apps/getting-started/identities) rather than use the `dfx` default identity that is not stored securely. - -To create a new identity, run the commands: - -``` - -dfx identity new IDENTITY_NAME - -dfx identity use IDENTITY_NAME - -``` - -Replace `IDENTITY_NAME` with your preferred identity name. The first command `dfx start --background` starts the local `dfx` processes, then `dfx identity new` will create a new identity and return your identity's seed phase. Be sure to save this in a safe, secure location. - -The third command `dfx identity use` will tell `dfx` to use your new identity as the active identity. Any canister smart contracts created after running `dfx identity use` will be owned and controlled by the active identity. - -Your identity will have a principal ID associated with it. Principal IDs are used to identify different entities on ICP, such as users and canisters. - -[Learn more about ICP developer identities](https://internetcomputer.org/docs/building-apps/getting-started/identities). - -### 4. Deploy the project locally. - -Deploy your project to your local developer environment with: - -``` -npm install -dfx deploy - -``` - -Your project will be hosted on your local machine. The local canister URLs for your project will be shown in the terminal window as output of the `dfx deploy` command. You can open these URLs in your web browser to view the local instance of your project. - -### 5. Obtain cycles. - -To deploy your project to the mainnet for long-term public accessibility, first you will need [cycles](https://internetcomputer.org/docs/building-apps/getting-started/tokens-and-cycles). Cycles are used to pay for the resources your project uses on the mainnet, such as storage and compute. - -> This cost model is known as ICP's [reverse gas model](https://internetcomputer.org/docs/building-apps/essentials/gas-cost), where developers pay for their project's gas fees rather than users pay for their own gas fees. This model provides an enhanced end user experience since they do not need to hold tokens or sign transactions when using a dapp deployed on ICP. - -> Learn how much a project may cost by using the [pricing calculator](https://internetcomputer.org/docs/building-apps/essentials/cost-estimations-and-examples). - -Cycles can be obtained through [converting ICP tokens into cycles using `dfx`](https://internetcomputer.org/docs/building-apps/developer-tools/dfx/dfx-cycles#dfx-cycles-convert). - -### 6. Deploy to the mainnet. - -Once you have cycles, run the command: - -``` - -dfx deploy --network ic - -``` - -After your project has been deployed to the mainnet, it will continuously require cycles to pay for the resources it uses. You will need to [top up](https://internetcomputer.org/docs/building-apps/canister-management/topping-up) your project's canisters or set up automatic cycles management through a service such as [CycleOps](https://cycleops.dev/). - -> If your project's canisters run out of cycles, they will be removed from the network. - -## Additional examples - -Additional code examples and sample applications can be found in the [DFINITY examples repo](https://github.com/dfinity/examples). diff --git a/motoko/send_http_get/Makefile b/motoko/send_http_get/Makefile index 200718594..48dc24608 100644 --- a/motoko/send_http_get/Makefile +++ b/motoko/send_http_get/Makefile @@ -1,18 +1,8 @@ -.PHONY: all -all: build - -.PHONY: build -.SILENT: build -build: - dfx deploy send_http_get_backend - .PHONY: test -.SILENT: test -test: build - dfx canister call send_http_get_backend send_http_get_request \ - | grep 'hello-from-icp' && echo 'PASS' -.PHONY: clean -.SILENT: clean -clean: - rm -fr .dfx +test: + @echo "=== Test 1/1: send_http_get_request returns JSON with greeting field ===" + @result=$$(icp canister call backend send_http_get_request '()') && \ + echo "$$result" && \ + echo "$$result" | grep -q 'hello-from-icp' && \ + echo "PASS" || (echo "FAIL" && exit 1) diff --git a/motoko/send_http_get/README.md b/motoko/send_http_get/README.md index aa49548e0..73a769354 100644 --- a/motoko/send_http_get/README.md +++ b/motoko/send_http_get/README.md @@ -1,27 +1,29 @@ # HTTP: GET -The purpose of this dapp is to give developers a minimal dapp that uses the IC's HTTPS outcalls feature to make a `GET` request. +This example demonstrates how to use the Internet Computer's HTTPS outcalls feature to make a `GET` request from a Motoko canister. It sends a request to `postman-echo.com` and returns the echoed JSON response, showing how to pass query parameters and headers through HTTP outcalls. -This demo goes in hand with the [developer documentation on HTTPS outcalls](https://internetcomputer.org/docs/building-apps/network-features/using-http/https-outcalls/get). +## Build and deploy from the command line -## Deploying from ICP Ninja +### Prerequisites +- Node.js +- icp-cli: `npm install -g @icp-sdk/icp-cli @icp-sdk/ic-wasm` -[![](https://icp.ninja/assets/open.svg)](https://icp.ninja/editor?g=https://github.com/dfinity/examples/tree/master/motoko/send_http_get) +### Install -## Build and deploy from the command-line - -### 1. [Download and install the IC SDK.](https://internetcomputer.org/docs/building-apps/getting-started/install) - -### 2. Download your project from ICP Ninja using the 'Download files' button on the upper left corner, or [clone the GitHub examples repository.](https://github.com/dfinity/examples/) - -### 3. Navigate into the project's directory. +```bash +git clone https://github.com/dfinity/examples +cd examples/motoko/send_http_get +``` -### 4. Deploy the project to your local environment: +### Deploy and test -``` -dfx start --background --clean && dfx deploy +```bash +icp network start -d +icp deploy +make test +icp network stop ``` ## Security considerations and best practices -If you base your application on this example, it is recommended that you familiarize yourself with and adhere to the [security best practices](https://internetcomputer.org/docs/building-apps/security/overview) for developing on ICP. This example may not implement all the best practices. +Refer to the [security best practices](https://docs.internetcomputer.org/guides/security/overview) for information on security and best practices for your ICP app. diff --git a/motoko/send_http_get/src/send_http_get_backend/main.mo b/motoko/send_http_get/backend/app.mo similarity index 84% rename from motoko/send_http_get/src/send_http_get_backend/main.mo rename to motoko/send_http_get/backend/app.mo index adf6da14c..1655f5e27 100644 --- a/motoko/send_http_get/src/send_http_get_backend/main.mo +++ b/motoko/send_http_get/backend/app.mo @@ -1,8 +1,9 @@ import Blob "mo:core/Blob"; import Text "mo:core/Text"; -import IC "ic:aaaaa-aa"; +import { ic } "mo:ic"; +import IC "mo:ic/Types"; -persistent actor { +persistent actor SendHttpGet { // #region transform // Strip HTTP response headers (date, cookies, tracking IDs) that vary across replicas. @@ -10,15 +11,15 @@ persistent actor { // succeed — the transform ensures this by discarding non-deterministic fields. public query func transform({ context : Blob; - response : IC.http_request_result; - }) : async IC.http_request_result { + response : IC.HttpRequestResult; + }) : async IC.HttpRequestResult { { response with headers = [] }; }; // #endregion transform // #region get_request public func send_http_get_request() : async Text { - let request : IC.http_request_args = { + let request : IC.HttpRequestArgs = { url = "https://postman-echo.com/get?greeting=hello-from-icp"; // Always set max_response_bytes to a tight bound. The cycle cost scales // with this value, not the actual response size. If omitted, the system @@ -36,11 +37,11 @@ persistent actor { // Cycles must be explicitly attached to management canister calls. // The amount is based on request size and max_response_bytes. - let response = await (with cycles = 230_949_972_000) IC.http_request(request); + let response = await (with cycles = 230_949_972_000) ic.http_request(request); // postman-echo.com echoes back the request metadata as JSON, letting you // verify the query params and headers were sent correctly. - switch (Text.decodeUtf8(response.body)) { + switch (response.body.decodeUtf8()) { case (?text) text; case null "Response is not valid UTF-8"; }; diff --git a/motoko/send_http_get/dfx.json b/motoko/send_http_get/dfx.json deleted file mode 100644 index 61054332d..000000000 --- a/motoko/send_http_get/dfx.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "canisters": { - "send_http_get_backend": { - "main": "src/send_http_get_backend/main.mo", - "type": "motoko" - } - }, - "defaults": { - "build": { - "packtool": "mops sources" - } - }, - "output_env_file": ".env", - "version": 1 -} \ No newline at end of file diff --git a/motoko/send_http_get/icp.yaml b/motoko/send_http_get/icp.yaml new file mode 100644 index 000000000..fb741fade --- /dev/null +++ b/motoko/send_http_get/icp.yaml @@ -0,0 +1,4 @@ +canisters: + - name: backend + recipe: + type: "@dfinity/motoko@v5.0.0" diff --git a/motoko/send_http_get/mops.toml b/motoko/send_http_get/mops.toml index 2effb740c..7902c42eb 100644 --- a/motoko/send_http_get/mops.toml +++ b/motoko/send_http_get/mops.toml @@ -1,13 +1,15 @@ -# Motoko dependencies (https://mops.one/) - [toolchain] -moc = "1.5.1" +moc = "1.9.0" [dependencies] -core = "2.4.0" +core = "2.5.0" +ic = "4.0.0" [moc] -# M0236: use context dot notation (e.g. map.get(k) instead of Map.get(map, compare, k)) -# M0237: redundant explicit implicit arguments (e.g. Nat.compare is inferred automatically) -# M0223: redundant type instantiation (e.g. Array.tabulate instead of Array.tabulate) -args = ["-W=M0236,M0237,M0223"] +# M0236: use context dot notation +# M0237: redundant explicit implicit arguments +# M0223: redundant type instantiation +args = ["--default-persistent-actors", "-W=M0236,M0237,M0223"] + +[canisters.backend] +main = "backend/app.mo"