Make options for `.signAsync` optional

[xlc]

Goal:

Update signAsync to make the second argument optional, and default to {}

Background:

Currently this code will crash:

const signed = await api.system.remark().signAsync(pair, options); when options is undefined, it gives this error

(node:78914) UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'nonce' of undefined
    at Submittable.value (/Users/xiliangchen/projects/playground/node_modules/@polkadot/api/submittable/createClass.js:59:42)
    at Submittable.value (/Users/xiliangchen/projects/playground/node_modules/@polkadot/api/submittable/createClass.js:129:99)
    at /Users/xiliangchen/projects/playground/node_modules/@polkadot/api/submittable/createClass.js:251:110
    at /Users/xiliangchen/projects/playground/node_modules/@polkadot/api/promise/Api.js:78:14
    at Submittable.signAsync (/Users/xiliangchen/projects/playground/node_modules/@polkadot/api/submittable/createClass.js:251:170)
    at /Users/xiliangchen/projects/playground/index.ts:28:33
    at step (/Users/xiliangchen/projects/playground/index.ts:33:23)
    at Object.next (/Users/xiliangchen/projects/playground/index.ts:14:53)
    at /Users/xiliangchen/projects/playground/index.ts:8:71
    at new Promise (<anonymous>)

Actions:

Make second argument optional

api/packages/api/src/submittable/createClass.ts

Line 72 in e77050b

public signAsync (account: AddressOrPair, optionsOrNonce: Partial<SignerOptions>): SubmittableThis<ApiType, this> {

Update interface

api/packages/api/src/submittable/types.ts

Line 55 in e77050b

signAsync(account: AddressOrPair, _options: Partial<SignatureOptions>): SubmittableThis<ApiType, this>;

Provide appropriate unit tests.

---

@jacogr please tag this if you are happy about this.

Tags:
bounty-awaiting-approval
bounty-XS

[jacogr]

Small one, it is one of those "don't do that", which crashy, it does indicate how to fix so no immediately critical..

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 50.0 DAI (50.0 USD @ $1.0/DAI) attached to it as part of the web3foundation fund.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $90,206.67 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work has been started.

These users each claimed they can complete the work by 266 years, 6 months from now.
Please review their action plans below:

1) sebastiantf has applied to start work (Funders only: approve worker | reject worker).

Seems a simple task. Can turn around as possible.
2) shenqisoft has applied to start work (Funders only: approve worker | reject worker).

Make the second argument default to {} in the function signature

Question:
Is nonce option not a required option?
3) vporton has applied to start work (Funders only: approve worker | reject worker).

It looks like a simple task that I could do.
4) citrudev has applied to start work (Funders only: approve worker | reject worker).

I could get it done. The task looks easy
5) kichjang has been approved to start work.

Defaulting the 2nd argument to the empty object would indeed make the code work in JS, but the TypeScript compiler may complain about it because it knows that the empty object does not contain the nonce field, which is accessed in #observeSign. A better solution would make it so that #optionsOrNonce accepts an undefinedparameter type and also returnundefined, so that the undefinedvalue may freely pass through tosigningInfo` and be handled there.
6) koredefashokun has applied to start work (Funders only: approve worker | reject worker).

This can be fixed easily. I can work on it.
7) developerfred has applied to start work (Funders only: approve worker | reject worker).

I will add the optional parameter as requested, https://github.com/developerfred/api/tree/issue/2012
8) ariesjia has applied to start work (Funders only: approve worker | reject worker).

This task is clear. make options parameter is optionial
9) surajsingla333 has applied to start work (Funders only: approve worker | reject worker).

I have worked on Polkadot and have expertise in JS and TS. Allow me to contribute to the project and I will surely be able make an impactful contribution to the problem.

Learn more on the Gitcoin Issue Details page.

[Web3Foundation]

@developerfred as you've been asked on another issue this week, please do not start working before you're approved for an issue.

Submitting a PR before you are approved is not only discourteous to other bounty hunters but possibly could waste time if the code in question isn't up to par.

Please, in the future, do not start working on Pull Requests before you're approved to start work, as it disrupts everyone's time involved.

We're happy to see your involvement and excitement to work on issues in the ecosystem and we'd love to have your contributions, but please follow the protocol before submitting any further pull requests.

Thanks, if you have any other questions feel free to reach out to me directly - chris@web3.foundation