docs(chain): add low/high level api examples

examples/node/_api-high-level.js

@@ -0,0 +1,18 @@
+import { AeSdk, Node, MemoryAccount, encode, Encoding } from '@aeternity/aepp-sdk';
+
+const aeSdk = new AeSdk({
+  nodes: [
+    {
+      name: 'testnet',
+      instance: new Node('https://testnet.aeternity.io'), // host your node for better decentralization
+    },
+  ],
+  accounts: [new MemoryAccount('sk_2CuofqWZHrABCrM7GY95YSQn8PyFvKQadnvFnpwhjUnDCFAWmf')],
+});
+
+const transactionInfo = await aeSdk.spend(
+  100, // aettos
+  'ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E',
+  { payload: encode(Buffer.from('spend tx payload'), Encoding.Bytearray) },
+);
+console.log(transactionInfo);

examples/node/_api-low-level.js

@@ -0,0 +1,19 @@
+import { Node, MemoryAccount, buildTxAsync, Tag, encode, Encoding } from '@aeternity/aepp-sdk';
+
+const onNode = new Node('https://testnet.aeternity.io'); // host your node for better decentralization
+const account = new MemoryAccount('sk_2CuofqWZHrABCrM7GY95YSQn8PyFvKQadnvFnpwhjUnDCFAWmf');
+
+const spendTx = await buildTxAsync({
+  tag: Tag.SpendTx,
+  senderId: account.address,
+  recipientId: 'ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E',
+  amount: 100, // aettos
+  payload: encode(Buffer.from('spend tx payload'), Encoding.Bytearray),
+  onNode,
+});
+
+const signedTx = await account.signTransaction(spendTx, { networkId: await onNode.getNetworkId() });
+
+// broadcast the signed tx to the node
+const { txHash } = await onNode.postTransaction({ tx: signedTx });
+console.log(txHash);

package.json

@@ -32,7 +32,7 @@
     "build:api:middleware": "autorest tooling/autorest/middleware.yaml && node tooling/autorest/postprocessing.js middleware",
     "build:generate": "tsx tooling/generate-schema.ts",
     "build": "run-p build:api:* build:assets build:generate && run-p build:dist build:es build:types",
-    "docs:examples": "node tooling/docs/examples-to-md.js examples/node/*.js",
+    "docs:examples": "node tooling/docs/examples-to-md.js examples/node/[^_]*.js",
     "docs:api": "typedoc",
     "commitlint": "commitlint --from develop",
     "lint": "run-p lint:*",

test/examples.sh

@@ -29,6 +29,8 @@ run_node_example paying-for-spend-tx.js
 run_node_example transfer-ae.js
 run_node_example dry-run-using-debug-endpoint.js
 run_node_example oracle.js
+run_node_example _api-high-level.js
+run_node_example _api-low-level.js
 
 # TODO: revisit --ignore-scripts after solving https://github.com/npm/cli/issues/4202
 perl -i -pe 's/"prepare"/"rem-prepare"/g' package.json