Merge pull request #328 from polywrap/create-wraps-tutorial

New "Create Wraps" Tutorial

package.json

@@ -53,7 +53,8 @@
     "npm-run-all": "^4.1.5",
     "onchange": "^7.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^4.7.4",
+    "polywrap": "0.12.1"
   },
   "browserslist": {
     "production": [

sidebars.js

@@ -70,20 +70,30 @@ const sidebars = {
           type: 'category',
           label: 'Create Wraps',
           items: [
+            'tutorials/create-wraps/introduction',
             {
               type: 'category',
-              label: 'Tutorial',
+              label: 'Part One',
               items: [
-                'tutorials/create-wraps/tutorial/project-setup',
-                'tutorials/create-wraps/tutorial/project-folder',
-                'tutorials/create-wraps/tutorial/build-deploy-test',
-                'tutorials/create-wraps/tutorial/adding-new-methods',
-                'tutorials/create-wraps/tutorial/writing-tests-with-workflows',
-                'tutorials/create-wraps/tutorial/deploy-locally-and-test',
+                'tutorials/create-wraps/part-one/project-setup',
+                'tutorials/create-wraps/part-one/project-manifest',
+                'tutorials/create-wraps/part-one/schema-and-codegen',
+                'tutorials/create-wraps/part-one/first-method',
+                'tutorials/create-wraps/part-one/import-and-subinvoke',
+                'tutorials/create-wraps/part-one/interfaces-and-plugins',
+                'tutorials/create-wraps/part-one/integration-testing',
+                'tutorials/create-wraps/part-one/deployment'
               ]
             },
-            'tutorials/create-wraps/polywrap-manifest',
-            'tutorials/create-wraps/default-plugins'
+            {
+              type: 'category',
+              label: 'Part Two',
+              items: [
+                'tutorials/create-wraps/part-two/polywrap-manifest',
+                'tutorials/create-wraps/part-two/default-plugins',
+                'tutorials/create-wraps/part-two/writing-tests-with-workflows'
+              ]
+            }
           ],
         },
         {

snippets/create-wraps-tutorial/assemblyscript/.gitignore

@@ -0,0 +1,5 @@
+build
+node_modules
+wrap
+.polywrap
+workflows/output.json

snippets/create-wraps-tutorial/assemblyscript/.nvmrc

@@ -0,0 +1 @@
+v18.15.0

snippets/create-wraps-tutorial/assemblyscript/README.md

@@ -0,0 +1,16 @@
+# Polywrap Wasm Wrapper Template
+A simple starter template for an AssemblyScript Wasm wrapper. For more information on how this project works, and a step by step on how to extend its behavior, see the documentation [here](https://docs.polywrap.io/).
+
+# How To Run
+
+## Install Dependencies
+`nvm install && nvm use`  
+`yarn`  
+
+## Codegen & Build
+`yarn codegen`  
+`yarn build`  
+
+## Test
+`yarn test:e2e`  
+`yarn test:workflow`  

snippets/create-wraps-tutorial/assemblyscript/jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+  collectCoverage: false,
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: ["**/__tests__/**/?(*.)+(spec|test).[jt]s?(x)"],
+  globals: {
+    "ts-jest": {
+      tsconfig: "tsconfig.json",
+      diagnostics: false,
+    },
+  },
+  testPathIgnorePatterns: [
+    "/.polywrap/"
+  ],
+};

snippets/create-wraps-tutorial/assemblyscript/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "template-wasm-as",
+  "description": "Polywrap AssemblyScript Wrapper Template",
+  "private": true,
+  "version": "0.12.1",
+  "scripts": {
+    "codegen": "npx polywrap codegen",
+    "build": "npx polywrap build",
+    "test:env:up": "npx polywrap infra up --modules=eth-ens-ipfs",
+    "test:env:down": "npx polywrap infra down --modules=eth-ens-ipfs",
+    "deploy": "npx polywrap deploy",
+    "test": "yarn test:e2e && yarn test:workflow",
+    "test:e2e": "yarn test:e2e:codegen && jest --passWithNoTests --runInBand --verbose",
+    "test:e2e:codegen": "npx polywrap codegen -m ./src/__tests__/types/polywrap.app.yaml -g ./src/__tests__/types/wrap",
+    "test:workflow": "npx polywrap test -o ./workflows/output.json"
+  },
+  "devDependencies": {
+    "@types/jest": "26.0.8",
+    "jest": "26.6.3",
+    "polywrap": "0.12.1",
+    "ts-jest": "26.5.4",
+    "typescript": "4.9.5"
+  },
+  "dependencies": {
+    "@polywrap/wasm-as": "0.12.1",
+    "assemblyscript": "0.19.23"
+  }
+}

snippets/create-wraps-tutorial/assemblyscript/polywrap.deploy.yaml

@@ -0,0 +1,7 @@
+format: "0.1"
+stages:
+  ipfs_deploy:
+    package: ipfs
+    uri: fs/./build
+    config:
+      gatewayUri: "https://ipfs.wrappers.io"

snippets/create-wraps-tutorial/assemblyscript/polywrap.docs.yaml

@@ -0,0 +1,2 @@
+format: 0.1.0
+readme: ./README.md

snippets/create-wraps-tutorial/assemblyscript/polywrap.graphql

@@ -0,0 +1,7 @@
+#import { Module } into Sha3 from "wrapscan.io/polywrap/sha3@1.0.0"
+#import { Module } into Http from "wrapscan.io/polywrap/http@1.0"
+
+type Module {
+    obscure(data: [String!]!, chaosLevel: Int): String!
+    enlighten(question: String!, apiKey: String!): String!
+}

snippets/create-wraps-tutorial/assemblyscript/polywrap.test.yaml

@@ -0,0 +1,10 @@
+name: template-wasm-rs
+format: 0.1.0
+validation: "./workflows/validator.cue"
+jobs:
+  sampleMethod:
+    steps:
+      - uri: fs/build
+        method: sampleMethod
+        args:
+          arg: "polywrap"

snippets/create-wraps-tutorial/assemblyscript/polywrap.yaml

@@ -0,0 +1,9 @@
+format: 0.3.0
+project:
+  name: template-wasm-as
+  type: wasm/assemblyscript
+source:
+  module: ./src/index.ts
+  schema: ./polywrap.graphql
+extensions:
+  docs: ./polywrap.docs.yaml

snippets/create-wraps-tutorial/assemblyscript/src/__tests__/e2e/integration.spec.ts

@@ -0,0 +1,37 @@
+import * as App from "../types/wrap";
+import path from "path";
+
+jest.setTimeout(60000);
+
+describe("Oracle Wrap End to End Tests", () => {
+
+  let oracle: App.Oracle;
+  let wrapperUri: string;
+  let apiKey: string = process.env.PPLX_API_KEY || "";
+
+  beforeAll(() => {
+    const wrapperPath: string = path.join(__dirname, "..", "..", "..");
+    wrapperUri = `fs/${wrapperPath}/build`;
+    oracle = new App.Oracle(undefined, undefined, wrapperUri)
+  })
+
+  it("calls obscure", async () => {
+    const result = await oracle.obscure({
+      data: ["Hello", "World"],
+      chaosLevel: 3
+    });
+
+    if (!result.ok) throw result.error;
+    expect(typeof result.value === "string").toBeTruthy();
+    expect(result.value.length).toEqual(128);
+  });
+
+  it("calls enlighten", async () => {
+    const question = "What is the meaning of life?";
+    const result = await oracle.enlighten({ question, apiKey });
+
+    if (!result.ok) throw result.error;
+    expect(typeof result.value === "string").toBeTruthy();
+  });
+});
+

snippets/create-wraps-tutorial/assemblyscript/src/__tests__/types/polywrap.app.yaml

@@ -0,0 +1,9 @@
+format: 0.3.0
+project:
+  name: sample-typescript-type-generation
+  type: app/typescript
+source:
+  schema: ./schema.graphql
+  import_abis:
+    - uri: "wrap://ens/sample.eth"
+      abi: "../../../build/wrap.info"

snippets/create-wraps-tutorial/assemblyscript/src/__tests__/types/schema.graphql

@@ -0,0 +1 @@
+#import * into Oracle from "wrap://ens/sample.eth"

snippets/create-wraps-tutorial/assemblyscript/src/index.ts

@@ -0,0 +1,71 @@
+import {
+  Args_enlighten,
+  Args_obscure,
+  Http_Module,
+  Http_Request,
+  Http_Response,
+  Http_ResponseType,
+  ModuleBase,
+  Sha3_Module
+} from './wrap';
+
+export class Module extends ModuleBase {
+  obscure(args: Args_obscure): string {
+    // handle default values
+    const chaosLevel: i32 = (args.chaosLevel == null || args.chaosLevel!!.unwrap() < 1)
+      ? 1
+      : args.chaosLevel!!.unwrap();
+
+    let obscured: string = "";
+    for (let i = 0; i < args.data.length; ++i) {
+      let data = args.data[i];
+      for (let j = 0; j < chaosLevel; ++j) {
+        data = Sha3_Module.keccak_256({ message: data }).expect("hash failed");
+      }
+      obscured += data;
+    }
+    return obscured;
+  }
+
+  enlighten(args: Args_enlighten): string {
+    const request: Http_Request = {
+      headers: new Map<string, string>()
+        .set('accept', 'application/json')
+        .set('content-type', 'application/json')
+        .set("Authorization", `Bearer ${args.apiKey}`),
+      responseType: Http_ResponseType.TEXT,
+      body: `{
+  "model": "mistral-7b-instruct",
+  "messages": [
+    {
+      "role": "system",
+      "content": "Be precise and concise."
+    },
+    {
+      "role": "user",
+      "content": "${args.question}"
+    }
+  ]
+}`
+    };
+
+    const response: Http_Response | null = Http_Module.post({
+      url: "https://api.perplexity.ai/chat/completions",
+      request,
+    }).unwrap();
+
+    if (response == null) {
+      throw new Error("request failed with null response");
+    }
+
+    if (response.status != 200) {
+      throw new Error(`request failed with status ${response.status}`);
+    }
+
+    if (response.body == null) {
+      throw new Error("request failed with null body");
+    }
+
+    return response.body!!;
+  }
+}

snippets/create-wraps-tutorial/assemblyscript/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": "assemblyscript/std/assembly.json",
+  "compilerOptions": {
+    "outDir": "build"
+  },
+  "include": [
+    "./src/**/*.ts",
+  ],
+  "exclude": [
+    "./src/__tests__/e2e/**/*.ts"
+  ]
+}

snippets/create-wraps-tutorial/assemblyscript/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "es2020",
+      "es2015",
+      "es5",
+      "dom"
+    ],
+    "esModuleInterop": true,
+    "outDir": "build",
+    "moduleResolution": "node",
+    "declaration": true,
+    "preserveSymlinks": true,
+    "preserveWatchOutput": true,
+    "pretty": false,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "module": "commonjs",
+    "sourceMap": true,
+    "target": "es5",
+    "resolveJsonModule": true,
+    "strictNullChecks": true
+  },
+  "typeAcquisition": { "include": ["jest"] },
+}

snippets/create-wraps-tutorial/assemblyscript/workflows/validator.cue

@@ -0,0 +1,11 @@
+package e2e
+
+sampleMethod: {
+		$0: {
+			data: {
+				value: "polywrap"
+			},
+			error?: _|_,
+		}
+}
+