add storage deposit support

packages/api-contract/src/base/Blueprint.ts

@@ -52,11 +52,12 @@ export class Blueprint<ApiType extends ApiTypes> extends Base<ApiType> {
     return this.#tx;
   }
 
-  #deploy = (constructorOrId: AbiConstructor | string | number, { gasLimit = BN_ZERO, salt, value = BN_ZERO }: BlueprintOptions, params: unknown[]): SubmittableExtrinsic<ApiType, BlueprintSubmittableResult<ApiType>> => {
+  #deploy = (constructorOrId: AbiConstructor | string | number, { gasLimit = BN_ZERO, storageDepositLimit = BN_ZERO, salt, value = BN_ZERO }: BlueprintOptions, params: unknown[]): SubmittableExtrinsic<ApiType, BlueprintSubmittableResult<ApiType>> => {
     return this.api.tx.contracts
       .instantiate(
         value,
         gasLimit,
+        storageDepositLimit,
         this.codeHash,
         this.abi.findConstructor(constructorOrId).toU8a(params),
         encodeSalt(salt)

packages/api-contract/src/base/Code.ts

@@ -56,11 +56,12 @@ export class Code<ApiType extends ApiTypes> extends Base<ApiType> {
     return this.#tx;
   }
 
-  #instantiate = (constructorOrId: AbiConstructor | string | number, { gasLimit = BN_ZERO, salt, value = BN_ZERO }: BlueprintOptions, params: unknown[]): SubmittableExtrinsic<ApiType, CodeSubmittableResult<ApiType>> => {
+  #instantiate = (constructorOrId: AbiConstructor | string | number, { gasLimit = BN_ZERO, storageDepositLimit = BN_ZERO, salt, value = BN_ZERO }: BlueprintOptions, params: unknown[]): SubmittableExtrinsic<ApiType, CodeSubmittableResult<ApiType>> => {
     return this.api.tx.contracts
       .instantiateWithCode(
         value,
         gasLimit,
+        storageDepositLimit,
         compactAddLength(this.code),
         this.abi.findConstructor(constructorOrId).toU8a(params),
         encodeSalt(salt)

packages/api-contract/src/base/Contract.ts

@@ -102,12 +102,17 @@ export class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
       : gasLimit;
   };
 
-  #exec = (messageOrId: AbiMessage | string | number, { gasLimit = BN_ZERO, value = BN_ZERO }: ContractOptions, params: unknown[]): SubmittableExtrinsic<ApiType> => {
+  #getStorageDepositLimitBN = (storageDepositLimit: bigint | BN | string | number): BN => {
+    return bnToBn(storageDepositLimit);
+  };
+
+  #exec = (messageOrId: AbiMessage | string | number, { gasLimit = BN_ZERO, storageDepositLimit = BN_ZERO, value = BN_ZERO }: ContractOptions, params: unknown[]): SubmittableExtrinsic<ApiType> => {
     return this.api.tx.contracts
       .call(
         this.address,
         value,
         this.#getGas(gasLimit),
+        this.#getStorageDepositLimitBN(storageDepositLimit),
         this.abi.findMessage(messageOrId).toU8a(params)
       )
       .withResultTransform((result: ISubmittableResult) =>
@@ -128,7 +133,7 @@ export class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
       );
   };
 
-  #read = (messageOrId: AbiMessage | string | number, { gasLimit = BN_ZERO, value = BN_ZERO }: ContractOptions, params: unknown[]): ContractCallSend<ApiType> => {
+  #read = (messageOrId: AbiMessage | string | number, { gasLimit = BN_ZERO, storageDepositLimit = BN_ZERO, value = BN_ZERO }: ContractOptions, params: unknown[]): ContractCallSend<ApiType> => {
     assert(this.hasRpcContractsCall, ERROR_NO_CALL);
 
     const message = this.abi.findMessage(messageOrId);
@@ -142,10 +147,11 @@ export class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
             gasLimit: this.#getGas(gasLimit, true),
             inputData: message.toU8a(params),
             origin,
+            storageDepositLimit: this.#getStorageDepositLimitBN(storageDepositLimit),
             value
           })
           .pipe(
-            map(({ debugMessage, gasConsumed, gasRequired, result }): ContractCallOutcome => ({
+            map(({ debugMessage, gasConsumed, gasRequired, result, storageDeposit }): ContractCallOutcome => ({
               debugMessage,
               gasConsumed,
               gasRequired: gasRequired && !gasRequired.isZero()
@@ -154,7 +160,8 @@ export class Contract<ApiType extends ApiTypes> extends Base<ApiType> {
               output: result.isOk && message.returnType
                 ? this.abi.registry.createTypeUnsafe(message.returnType.lookupName || message.returnType.type, [result.asOk.data.toU8a(true)], { isPedantic: true })
                 : null,
-              result
+              result,
+              storageDeposit
             }))
           )
       )

packages/api-contract/src/base/types.ts

@@ -10,22 +10,22 @@ import type { AbiMessage, BlueprintOptions, ContractCallOutcome, ContractOptions
 
 export interface BlueprintDeploy<ApiType extends ApiTypes> {
   (options: BlueprintOptions, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
-  (value: bigint | string | number | BN, gasLimit: bigint | string | number | BN, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
+  (value: bigint | string | number | BN, gasLimit: bigint | string | number | BN, storageDepositLimit: bigint | BN | string | number, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
 }
 
 export interface ContractQuery<ApiType extends ApiTypes> {
   (origin: AccountId | string | Uint8Array, options: ContractOptions, ...params: unknown[]): ContractCallResult<ApiType, ContractCallOutcome>;
-  (origin: AccountId | string | Uint8Array, value: bigint | BN | string | number, gasLimit: bigint | BN | string | number, ...params: unknown[]): ContractCallResult<ApiType, ContractCallOutcome>;
+  (origin: AccountId | string | Uint8Array, value: bigint | BN | string | number, gasLimit: bigint | BN | string | number, storageDepositLimit: bigint | BN | string | number, ...params: unknown[]): ContractCallResult<ApiType, ContractCallOutcome>;
 }
 
 export interface ContractTx<ApiType extends ApiTypes> {
   (options: ContractOptions, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
-  (value: bigint | BN | string | number, gasLimit: bigint | BN | string | number, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
+  (value: bigint | BN | string | number, gasLimit: bigint | BN | string | number, storageDepositLimit: bigint | BN | string | number, ...params: unknown[]): SubmittableExtrinsic<ApiType>;
 }
 
 export interface ContractGeneric<O, T> {
   (messageOrId: AbiMessage | string | number, options: O, ...params: unknown[]): T;
-  (messageOrId: AbiMessage | string | number, value: bigint | BN | string | number, gasLimit: bigint | BN | string | number, ...params: unknown[]): T;
+  (messageOrId: AbiMessage | string | number, value: bigint | BN | string | number, gasLimit: bigint | BN | string | number, storageDepositLimit: bigint | BN | string | number, ...params: unknown[]): T;
 }
 
 export type ContractCallResult<ApiType extends ApiTypes, T> = ApiType extends 'rxjs'

packages/api-contract/src/types.ts

@@ -4,7 +4,7 @@
 import type { ApiBase } from '@polkadot/api/base';
 import type { ApiTypes } from '@polkadot/api/types';
 import type { Text, u64 } from '@polkadot/types';
-import type { ContractExecResultResult, ContractSelector } from '@polkadot/types/interfaces';
+import type { Balance, ContractExecResultResult, ContractSelector } from '@polkadot/types/interfaces';
 import type { Codec, TypeDef } from '@polkadot/types/types';
 import type { BN } from '@polkadot/util';
 import type { Abi } from '.';
@@ -56,6 +56,7 @@ export interface ContractCallOutcome {
   debugMessage: Text;
   gasConsumed: u64;
   gasRequired: u64;
+  storageDeposit: Balance;
   output: Codec | null;
   result: ContractExecResultResult;
 }
@@ -72,11 +73,13 @@ export interface DecodedMessage {
 
 export interface BlueprintOptions {
   gasLimit?: bigint | string | number | BN;
+  storageDepositLimit?: bigint | BN | string | number;
   salt?: Uint8Array | string | null;
   value?: bigint | string | number | BN;
 }
 
 export interface ContractOptions {
   gasLimit?: bigint | BN | string | number;
+  storageDepositLimit?: bigint | BN | string | number;
   value?: bigint | BN | string | number;
 }

packages/api-contract/src/util.ts

@@ -30,6 +30,7 @@ export function isOptions <T> (options: bigint | string | number | BN | T): opti
 
 export function extractOptions <T extends TOptions> (value: bigint | string | number | BN, params: unknown[]): [T, unknown[]] {
   const gasLimit = params.shift() as BN;
+  const storageDepositLimit = params.shift() as BN;
 
-  return [{ gasLimit, value } as T, params];
+  return [{ gasLimit, storageDepositLimit, value } as T, params];
 }

packages/api/src/augment/rpc.ts

@@ -131,15 +131,15 @@ declare module '@polkadot/rpc-core/types.jsonrpc' {
       /**
        * Executes a call to a contract
        **/
-      call: AugmentedRpc<(callRequest: ContractCallRequest | { origin?: any; dest?: any; value?: any; gasLimit?: any; inputData?: any } | string | Uint8Array, at?: BlockHash | string | Uint8Array) => Observable<ContractExecResult>>;
+      call: AugmentedRpc<(callRequest: ContractCallRequest | { origin?: any; dest?: any; value?: any; gasLimit?: any; storageDepositLimit?: any ,inputData?: any } | string | Uint8Array, at?: BlockHash | string | Uint8Array) => Observable<ContractExecResult>>;
       /**
        * Returns the value under a specified storage key in a contract
        **/
       getStorage: AugmentedRpc<(address: AccountId | string | Uint8Array, key: H256 | string | Uint8Array, at?: BlockHash | string | Uint8Array) => Observable<Option<Bytes>>>;
       /**
        * Instantiate a new contract
        **/
-      instantiate: AugmentedRpc<(request: InstantiateRequest | { origin?: any; endowment?: any; gasLimit?: any; code?: any; data?: any; salt?: any } | string | Uint8Array, at?: BlockHash | string | Uint8Array) => Observable<ContractInstantiateResult>>;
+      instantiate: AugmentedRpc<(request: InstantiateRequest | { origin?: any; endowment?: any; gasLimit?: any; storageDepositLimit?: any; code?: any; data?: any; salt?: any } | string | Uint8Array, at?: BlockHash | string | Uint8Array) => Observable<ContractInstantiateResult>>;
       /**
        * Returns the projected time a given contract will be able to sustain paying its rent
        **/

packages/api/src/augment/tx.ts

@@ -705,15 +705,15 @@ declare module '@polkadot/api/types/submittable' {
        * * If no account exists and the call value is not less than `existential_deposit`,
        * a regular account will be created and any value will be transferred.
        **/
-      call: AugmentedSubmittable<(dest: MultiAddress | { Id: any } | { Index: any } | { Raw: any } | { Address32: any } | { Address20: any } | string | Uint8Array, value: Compact<u128> | AnyNumber | Uint8Array, gasLimit: Compact<u64> | AnyNumber | Uint8Array, data: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, Compact<u128>, Compact<u64>, Bytes]>;
+      call: AugmentedSubmittable<(dest: MultiAddress | { Id: any } | { Index: any } | { Raw: any } | { Address32: any } | { Address20: any } | string | Uint8Array, value: Compact<u128> | AnyNumber | Uint8Array, gasLimit: Compact<u64> | AnyNumber | Uint8Array, storageDepositLimit: Option<Compact<u64>> | AnyNumber | Uint8Array, data: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [MultiAddress, Compact<u128>, Compact<u64>, Bytes]>;
       /**
        * Instantiates a contract from a previously deployed wasm binary.
        * 
        * This function is identical to [`Self::instantiate_with_code`] but without the
        * code deployment step. Instead, the `code_hash` of an on-chain deployed wasm binary
        * must be supplied.
        **/
-      instantiate: AugmentedSubmittable<(endowment: Compact<u128> | AnyNumber | Uint8Array, gasLimit: Compact<u64> | AnyNumber | Uint8Array, codeHash: H256 | string | Uint8Array, data: Bytes | string | Uint8Array, salt: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u128>, Compact<u64>, H256, Bytes, Bytes]>;
+      instantiate: AugmentedSubmittable<(endowment: Compact<u128> | AnyNumber | Uint8Array, gasLimit: Compact<u64> | AnyNumber | Uint8Array, storageDepositLimit: Option<Compact<u64>> | AnyNumber | Uint8Array, codeHash: H256 | string | Uint8Array, data: Bytes | string | Uint8Array, salt: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u128>, Compact<u64>, H256, Bytes, Bytes]>;
       /**
        * Instantiates a new contract from the supplied `code` optionally transferring
        * some balance.
@@ -738,7 +738,7 @@ declare module '@polkadot/api/types/submittable' {
        * - The `endowment` is transferred to the new account.
        * - The `deploy` function is executed in the context of the newly-created account.
        **/
-      instantiateWithCode: AugmentedSubmittable<(endowment: Compact<u128> | AnyNumber | Uint8Array, gasLimit: Compact<u64> | AnyNumber | Uint8Array, code: Bytes | string | Uint8Array, data: Bytes | string | Uint8Array, salt: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u128>, Compact<u64>, Bytes, Bytes, Bytes]>;
+      instantiateWithCode: AugmentedSubmittable<(endowment: Compact<u128> | AnyNumber | Uint8Array, gasLimit: Compact<u64> | AnyNumber | Uint8Array, storageDepositLimit: Option<Compact<u64>> | AnyNumber | Uint8Array, code: Bytes | string | Uint8Array, data: Bytes | string | Uint8Array, salt: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u128>, Compact<u64>, Bytes, Bytes, Bytes]>;
       /**
        * Generic tx
        **/

packages/types/src/augment/lookup/substrate.ts

@@ -1975,18 +1975,21 @@ export default {
         dest: 'MultiAddress',
         value: 'Compact<u128>',
         gasLimit: 'Compact<u64>',
+        storageDepositLimit: 'Option<Compact<u64>>',
         data: 'Bytes',
       },
       instantiate_with_code: {
         endowment: 'Compact<u128>',
         gasLimit: 'Compact<u64>',
+        storageDepositLimit: 'Option<Compact<u64>>',
         code: 'Bytes',
         data: 'Bytes',
         salt: 'Bytes',
       },
       instantiate: {
         endowment: 'Compact<u128>',
         gasLimit: 'Compact<u64>',
+        storageDepositLimit: 'Option<Compact<u64>>',
         codeHash: 'H256',
         data: 'Bytes',
         salt: 'Bytes'

packages/types/src/augment/lookup/types-substrate.ts

@@ -2149,12 +2149,14 @@ declare module '@polkadot/types/lookup' {
       readonly dest: MultiAddress;
       readonly value: Compact<u128>;
       readonly gasLimit: Compact<u64>;
+      readonly storageDepositLimit: Option<Compact<u64>>;
       readonly data: Bytes;
     } & Struct;
     readonly isInstantiateWithCode: boolean;
     readonly asInstantiateWithCode: {
       readonly endowment: Compact<u128>;
       readonly gasLimit: Compact<u64>;
+      readonly storageDepositLimit: Option<Compact<u64>>;
       readonly code: Bytes;
       readonly data: Bytes;
       readonly salt: Bytes;
@@ -2163,6 +2165,7 @@ declare module '@polkadot/types/lookup' {
     readonly asInstantiate: {
       readonly endowment: Compact<u128>;
       readonly gasLimit: Compact<u64>;
+      readonly storageDepositLimit: Option<Compact<u64>>;
       readonly codeHash: H256;
       readonly data: Bytes;
       readonly salt: Bytes;

packages/types/src/interfaces/contracts/definitions.ts

@@ -95,6 +95,7 @@ export default {
       dest: 'AccountId',
       value: 'Balance',
       gasLimit: 'u64',
+      storageDepositLimit: 'Option<Compact<u64>>',
       inputData: 'Bytes'
     },
     ContractExecResultSuccessTo255: {
@@ -273,7 +274,7 @@ export default {
       origin: 'AccountId',
       endowment: 'Balance',
       gasLimit: 'Gas',
-      code: 'Bytes',
+      storageDepositLimit: 'Option<Compact<u64>>',
       data: 'Bytes',
       salt: 'Bytes'
     },

packages/types/src/interfaces/contracts/types.ts

@@ -26,13 +26,15 @@ export interface ContractCallRequest extends Struct {
   readonly dest: AccountId;
   readonly value: Balance;
   readonly gasLimit: u64;
+  readonly storageDepositLimit: Option<Compact<u64>>;
   readonly inputData: Bytes;
 }
 
 /** @name ContractExecResult */
 export interface ContractExecResult extends Struct {
   readonly gasConsumed: u64;
   readonly gasRequired: u64;
+  readonly storageDeposit: Balance;
   readonly debugMessage: Text;
   readonly result: ContractExecResultResult;
 }
@@ -259,6 +261,7 @@ export interface InstantiateRequest extends Struct {
   readonly origin: AccountId;
   readonly endowment: Balance;
   readonly gasLimit: Gas;
+  readonly storageDepositLimit: Option<Compact<u64>>;
   readonly code: Bytes;
   readonly data: Bytes;
   readonly salt: Bytes;