[api] Support upload_code for vouchers (#1472)

api/.gitignore

@@ -11,3 +11,4 @@ test/wasm/examples/
 
 .rollup.cache
 .yarnrc.yaml
+temp/

api/CHANGELOG.md

@@ -13,6 +13,9 @@ https://github.com/gear-tech/gear-js/pull/1467
 - Support new vouchers according to https://github.com/gear-tech/gear/pull/3606
 - Bump polkadot dependencies to `10.11.2`
 
+https://github.com/gear-tech/gear-js/pull/1472
+- Support `uploadCode` call for vouchers.
+
 ## 0.35.2
 
 _10/31/2023_

api/README.md

@@ -348,7 +348,9 @@ const programs = ['0x1234...', '0x5678...'];
 const spenderAddress = '0x...';
 const validForOneHour = (60 * 60) / 3; // number of blocks in one hour
 
-const { voucherId, extrinsic } = await api.voucher.issue(spenderAddress, 100 * 10 ** 12, validForOneHour, programs);
+const { voucherId, extrinsic } = await api.voucher.issue(spenderAddress, 100 * 10 ** 12, validForOneHour, programs, true);
+
+// To allow the voucher to be used for code uploading, set the last argument of the `.issue` method to true
 
 extrinsic.signAndSend(account, (events) => {
   const voucherIssuedEvent = events.events.filter(({event: {method}}) => method === 'VoucherIssued') as VoucherIssued;
@@ -404,6 +406,16 @@ await voucherTx.signAndSend(account, (events) => {
 });
 ```
 
+#### Upload code with issued voucher
+```javascript
+const { extrinsic } = await api.code.upload(code);
+
+const tx = api.voucher.call(voucherId, { UploadCode: extrinsic })
+await tx.signAndSend(account, (events) => {
+  console.log(events.toHuman());
+});
+```
+
 #### Update voucher
 The `api.voucher.update` can be used to update the voucher. All parameters in the 3rd argument are optional, but at least one parameter must be specified.
 ```javascript

api/package.json

@@ -24,11 +24,10 @@
     "test": "jest --runInBand",
     "test:only": "jest --testPathPattern",
     "build": "rm -rf lib && rollup --config rollup.config.js",
-    "generate:defs": "ts-node --skip-project node_modules/.bin/polkadot-types-from-defs --package sample-polkadotjs-typegen/interfaces --input ./src/interfaces --endpoint ./gear.json",
-    "generate:meta": "ts-node --skip-project node_modules/.bin/polkadot-types-from-chain --package sample-polkadotjs-typegen/interfaces --endpoint ./gear.json --output ./src/interfaces",
+    "generate:defs": "ts-node --skip-project node_modules/.bin/polkadot-types-from-defs --package sample-polkadotjs-typegen/interfaces --input ./temp --endpoint ws://127.0.0.1:9944",
+    "generate:meta": "ts-node --skip-project node_modules/.bin/polkadot-types-from-chain --package sample-polkadotjs-typegen/interfaces --endpoint ws://127.0.0.1:9944 --output ./temp",
     "lint": "eslint . --ext .ts --ignore-pattern lib/ --ignore-pattern node_modules/",
-    "lint:fix": "eslint --fix . --ext .ts --ignore-pattern lib/ --ignore-pattern node_modules/",
-    "get:metadata": "curl -H \"Content-Type: application/json\" -d '{\"id\":\"1\", \"jsonrpc\":\"2.0\", \"method\": \"state_getMetadata\", \"params\":[]}' http://localhost:9944 > gear.json"
+    "lint:fix": "eslint --fix . --ext .ts --ignore-pattern lib/ --ignore-pattern node_modules/"
   },
   "exports": {
     "./cjs/package.json": "./cjs/package.json",

api/programs/Cargo.toml

@@ -5,6 +5,7 @@ members = [
   "test-gas",
   "test-waitlist",
   "test-meta",
+  "empty"
 ]
 
 [profile.release]

api/programs/empty/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "empty"
+version = "0.1.0"
+authors = ["Gear Technologies"]
+edition = "2021"
+
+[dependencies]
+gstd = { git = "https://github.com/gear-tech/gear.git" }
+
+[build-dependencies]
+gear-wasm-builder = { git = "https://github.com/gear-tech/gear.git" }

api/programs/empty/build.rs

@@ -0,0 +1,3 @@
+fn main() {
+    gear_wasm_builder::build();
+}

api/programs/empty/src/lib.rs

@@ -0,0 +1,8 @@
+#![no_std]
+
+use gstd::msg;
+
+#[no_mangle]
+unsafe extern "C" fn init() {
+    msg::reply("ok", 0).unwrap();
+}

api/src/Code.ts

@@ -1,10 +1,8 @@
 import { Bytes, Option } from '@polkadot/types';
-import { GearCommonCodeMetadata, GearCoreCodeInstrumentedCode } from './types';
 import { HexString } from '@polkadot/util/types';
-import { ISubmittableResult } from '@polkadot/types/types';
-import { SubmittableExtrinsic } from '@polkadot/api/types';
 import { u8aToHex } from '@polkadot/util';
 
+import { CodeUploadResult, GearCommonCodeMetadata, GearCoreCodeInstrumentedCode } from './types';
 import { generateCodeHash, getIdsFromKeys, validateCodeId } from './utils';
 import { CodeDoesNotExistError } from './errors';
 import { GearTransaction } from './Transaction';
@@ -16,15 +14,13 @@ export class GearCode extends GearTransaction {
    * @param code
    * @returns Code hash
    */
-  async upload(
-    code: Buffer | Uint8Array,
-  ): Promise<{ codeHash: HexString; submitted: SubmittableExtrinsic<'promise', ISubmittableResult> }> {
+  async upload(code: Buffer | Uint8Array): Promise<CodeUploadResult> {
     const codeHash = generateCodeHash(code);
     await validateCodeId(codeHash, this._api);
 
     const codeBytes = this._api.createType('Bytes', Array.from(code)) as Bytes;
     this.extrinsic = this._api.tx.gear.uploadCode(codeBytes);
-    return { codeHash, submitted: this.extrinsic };
+    return { codeHash, submitted: this.extrinsic, extrinsic: this.extrinsic };
   }
 
   /**

api/src/Message.ts

@@ -201,7 +201,7 @@ export class GearMessage extends GearTransaction {
    * @param args Message parameters
    * @param metaOrHexRegistry (optional) Registry in hex format or ProgramMetadata
    * @param typeName payload type (one of the default rust types if metadata or registry don't specified)
-   * @returns Submitable result
+   * @returns Submitable extrinsic
    *
    * _Note that parameter `prepaid` is not supported starting from `1010` runtime version._
    * @example
@@ -231,7 +231,7 @@ export class GearMessage extends GearTransaction {
    * @param args Message parameters
    * @param metaOrHexRegistry Metadata
    * @param typeIndexOrTypeName type index in registry or type name
-   * @returns Submitted result
+   * @returns Submittable result
    */
 
   async sendReply(

api/src/Voucher.ts

@@ -15,8 +15,9 @@ export class GearVoucher extends GearTransaction {
    * ### Issue a new voucher for a `user` to be used to pay for sending messages to `program_id` program.
    * @param spender The voucher holder account id.
    * @param value The voucher amount.
-   * @param validity The number of the block until which the voucher is valid.
+   * @param duration (optional) The number of the block until which the voucher is valid. If not specified, the voucher is valid in `api.voucher.minDuration` blocks.
    * @param programs (optional) The list of programs that the voucher can be used for. If not specified, the voucher can be used for any program.
+   * @param codeUploading (optional) Whether the voucher can be used for uploading code.
    * @returns The voucher id and the extrinsic to submit.
    *
    * @example
@@ -32,15 +33,22 @@ export class GearVoucher extends GearTransaction {
   async issue(
     spender: HexString,
     value: number | bigint | BalanceOf,
-    validity: number,
+    duration?: number,
     programs?: HexString[],
+    codeUploading = false,
   ): Promise<{ extrinsic: SubmittableExtrinsic<'promise', ISubmittableResult>; voucherId: HexString }> {
     const nonce = await this._api.query.gearVoucher.issued();
 
     const nextNonce = nonce.unwrapOrDefault().addn(1).toArray('le', 8);
     const voucherId = generateVoucherId(nextNonce);
 
-    this.extrinsic = this._api.tx.gearVoucher.issue(spender, value, programs || null, validity);
+    this.extrinsic = this._api.tx.gearVoucher.issue(
+      spender,
+      value,
+      programs || null,
+      codeUploading,
+      duration || this.minDuration,
+    );
     return { extrinsic: this.extrinsic, voucherId };
   }
 
@@ -101,6 +109,16 @@ export class GearVoucher extends GearTransaction {
       return this._api.tx.gearVoucher.call(voucherId, {
         SendReply: { replyToId, payload, gasLimit, value, keepAlive },
       });
+    } else if ('UploadCode' in params) {
+      if (params.UploadCode.method.method !== 'uploadCode') {
+        throw new Error(`Invalid method name. Expected 'UploadCode' but actual is ${params.UploadCode.method.method}`);
+      }
+
+      const [code] = params.UploadCode.args;
+
+      return this._api.tx.gearVoucher.call(voucherId, {
+        UploadCode: { code },
+      });
     }
 
     throw new Error('Invalid call params');
@@ -173,7 +191,13 @@ export class GearVoucher extends GearTransaction {
     voucherId: string,
     params: IUpdateVoucherParams,
   ): SubmittableExtrinsic<'promise', ISubmittableResult> {
-    if (!params.moveOwnership && !params.balanceTopUp && !params.appendPrograms && !params.prolongValidity) {
+    if (
+      !params.moveOwnership &&
+      !params.balanceTopUp &&
+      !params.appendPrograms &&
+      !params.prolongDuration &&
+      (params.codeUploading === undefined || params.codeUploading === null)
+    ) {
       throw new Error('At least one of the parameters must be specified');
     }
     return this._api.tx.gearVoucher.update(
@@ -182,7 +206,8 @@ export class GearVoucher extends GearTransaction {
       params.moveOwnership || null,
       params.balanceTopUp || null,
       params.appendPrograms || null,
-      params.prolongValidity || null,
+      params.codeUploading || null,
+      params.prolongDuration || null,
     );
   }
 

api/src/types/augment/augment-api-errors.ts

@@ -279,6 +279,14 @@ declare module '@polkadot/api-base/types/errors' {
        * Error trying transfer balance to/from voucher account.
        **/
       BalanceTransfer: AugmentedError<ApiType>;
+      /**
+       * Voucher is disabled for code uploading, but requested.
+       **/
+      CodeUploadingDisabled: AugmentedError<ApiType>;
+      /**
+       * Voucher update function tries to cut voucher ability of code upload.
+       **/
+      CodeUploadingEnabled: AugmentedError<ApiType>;
       /**
        * Voucher issue/prolongation duration out of [min; max] constants.
        **/

api/src/types/augment/augment-api-tx.ts

@@ -1,6 +1,6 @@
 import '@polkadot/api-base/types/submittable';
 
-import type { AnyNumber, ITuple } from '@polkadot/types-codec/types';
+import type { AnyNumber, Codec, ITuple } from '@polkadot/types-codec/types';
 import type { ApiTypes, AugmentedSubmittable } from '@polkadot/api-base/types';
 import type { BTreeSet, Bytes, Option, Vec, bool, u128, u32, u64 } from '@polkadot/types-codec';
 import {
@@ -270,7 +270,33 @@ declare module '@polkadot/api-base/types/submittable' {
       call: AugmentedSubmittable<
         (
           voucherId: PalletGearVoucherInternalVoucherId | string | Uint8Array,
-          call: PalletGearVoucherInternalPrepaidCall | { SendMessage: any } | { SendReply: any } | string | Uint8Array,
+          call:
+            | PalletGearVoucherInternalPrepaidCall
+            | {
+                SendMessage: {
+                  destination: string | Codec;
+                  payload: string | Uint8Array | Codec;
+                  gasLimit: number | bigint | Uint8Array | Codec;
+                  value: number | bigint | Uint8Array | Codec;
+                  keepAlive: boolean | Uint8Array | Codec;
+                };
+              }
+            | {
+                SendReply: {
+                  replyToId: string | Codec;
+                  payload: string | Uint8Array | Codec;
+                  gasLimit: number | bigint | Uint8Array | Codec;
+                  value: number | bigint | Uint8Array | Codec;
+                  keepAlive: boolean | Uint8Array | Codec;
+                };
+              }
+            | {
+                UploadCode: {
+                  code: string | Uint8Array | Codec;
+                };
+              }
+            | string
+            | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
         [PalletGearVoucherInternalVoucherId, PalletGearVoucherInternalPrepaidCall]
       >;
@@ -288,14 +314,15 @@ declare module '@polkadot/api-base/types/submittable' {
           spender: AccountId32 | string | Uint8Array,
           balance: u128 | AnyNumber | Uint8Array,
           programs:
-            | Option<Vec<GearCoreIdsProgramId>>
+            | Option<BTreeSet<GearCoreIdsProgramId>>
             | null
             | Uint8Array
-            | Vec<GearCoreIdsProgramId>
-            | (GearCoreIdsProgramId | string | Uint8Array)[],
-          validity: u32 | AnyNumber | Uint8Array,
+            | BTreeSet<GearCoreIdsProgramId>
+            | string[],
+          codeUploading: bool | boolean | Uint8Array,
+          duration: u32 | AnyNumber | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
-        [AccountId32, u128, Option<Vec<GearCoreIdsProgramId>>, u32]
+        [AccountId32, u128, Option<BTreeSet<GearCoreIdsProgramId>>, bool, u32]
       >;
       revoke: AugmentedSubmittable<
         (
@@ -311,19 +338,22 @@ declare module '@polkadot/api-base/types/submittable' {
           moveOwnership: Option<AccountId32> | null | Uint8Array | AccountId32 | string,
           balanceTopUp: Option<u128> | null | Uint8Array | u128 | AnyNumber,
           appendPrograms:
-            | Option<Vec<GearCoreIdsProgramId>>
+            | Option<Option<BTreeSet<GearCoreIdsProgramId>>>
             | null
             | Uint8Array
-            | Vec<GearCoreIdsProgramId>
-            | (GearCoreIdsProgramId | string | Uint8Array)[],
-          prolongValidity: Option<u32> | null | Uint8Array | u32 | AnyNumber,
+            | Option<BTreeSet<GearCoreIdsProgramId>>
+            | BTreeSet<GearCoreIdsProgramId>
+            | (string | Uint8Array)[],
+          codeUploading: Option<bool> | null | Uint8Array | bool | boolean,
+          prolongDuration: Option<u32> | null | Uint8Array | u32 | AnyNumber,
         ) => SubmittableExtrinsic<ApiType>,
         [
           AccountId32,
           PalletGearVoucherInternalVoucherId,
           Option<AccountId32>,
           Option<u128>,
-          Option<Vec<GearCoreIdsProgramId>>,
+          Option<Option<BTreeSet<GearCoreIdsProgramId>>>,
+          Option<bool>,
           Option<u32>,
         ]
       >;

api/src/types/interfaces/program/code.ts

@@ -0,0 +1,19 @@
+import { ISubmittableResult } from '@polkadot/types/types';
+import { SubmittableExtrinsic } from '@polkadot/api/types';
+
+import { HexString } from '../../index';
+
+export interface CodeUploadResult {
+  /**
+   * Code hash
+   */
+  codeHash: HexString;
+  /**
+   * Submittable extrinsic
+   */
+  extrinsic: SubmittableExtrinsic<'promise', ISubmittableResult>;
+  /**
+   * @deprecated will be removed in next major version
+   */
+  submitted: SubmittableExtrinsic<'promise', ISubmittableResult>;
+}

api/src/types/interfaces/program/index.ts

@@ -2,3 +2,4 @@ export * from './pages';
 export * from './extrinsic';
 export * from './storage';
 export * from './state';
+export * from './code';

api/src/types/interfaces/voucher.ts

@@ -5,7 +5,8 @@ import { SubmittableExtrinsic } from '@polkadot/api/types';
 
 export type ICallOptions =
   | { SendMessage: SubmittableExtrinsic<'promise', ISubmittableResult> }
-  | { SendReply: SubmittableExtrinsic<'promise', ISubmittableResult> };
+  | { SendReply: SubmittableExtrinsic<'promise', ISubmittableResult> }
+  | { UploadCode: SubmittableExtrinsic<'promise', ISubmittableResult> };
 
 export interface IUpdateVoucherParams {
   /**
@@ -21,9 +22,13 @@ export interface IUpdateVoucherParams {
    */
   appendPrograms?: string[];
   /**
-   * Prolong the voucher validity.
+   * Enable or disable code uploading.
    */
-  prolongValidity?: number;
+  codeUploading?: boolean;
+  /**
+   * Prolong the duration of th voucher validity.
+   */
+  prolongDuration?: number;
 }
 
 export interface IVoucherDetails {