Skip to main content

Argument

Namespace: IotaSdk

An argument to a programmable transaction command

BCS

The BCS serialized form for this type is defined by the following ABNF:

argument = argument-gas
=/ argument-input
=/ argument-result
=/ argument-nested-result

argument-gas = %d00
argument-input = %d01 u16
argument-result = %d02 u16
argument-nested-result = %d03 u16 u16
public class Argument : IArgument, System.IEquatable`1[[IotaSdk.Argument, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.IDisposable

Inheritance ObjectArgument
Implements IArgument, IEquatable<Argument>, IDisposable
Attributes NullableContextAttribute, NullableAttribute

Constructors

Argument(UInt64)

public Argument(ulong pointer)

Parameters

pointer UInt64

Methods

Destroy()

public void Destroy()

Dispose()

public void Dispose()

GetNestedResult(UInt16)

Get the nested result for this result at the given index. Returns None if this is not a Result.

public Argument? GetNestedResult(ushort ix)

Parameters

ix UInt16

Returns

Argument?

Equals(Argument)

public bool Equals(Argument? other)

Parameters

other Argument?

Returns

Boolean

Equals(Object)

public override bool Equals(object? obj)

Parameters

obj Object?

Returns

Boolean

NewGas()

The gas coin. The gas coin can only be used by-ref, except for with TransferObjects, which can use it by-value.

public static Argument NewGas()

Returns

Argument

NewInput(UInt16)

One of the input objects or primitive values (from ProgrammableTransaction inputs)

public static Argument NewInput(ushort input)

Parameters

input UInt16

Returns

Argument

NewNestedResult(UInt16, UInt16)

Like a Result but it accesses a nested result. Currently, the only usage of this is to access a value from a Move call with multiple return values.

public static Argument NewNestedResult(ushort commandIndex, ushort subresultIndex)

Parameters

commandIndex UInt16

subresultIndex UInt16

Returns

Argument

NewResult(UInt16)

The result of another command (from ProgrammableTransaction commands)

public static Argument NewResult(ushort result)

Parameters

result UInt16

Returns

Argument