feat: implement getContractMapEntry function

[zone117x]

This PR was published to npm with the version 6.2.2-pr.3c85dab.0
e.g. npm install @stacks/common@6.2.2-pr.3c85dab.0 --save-exact

Implement getContractMapEntry function for the POST /v2/map_entry/[Stacks Address]/[Contract Name]/[Map Name] RPC endpoint

This makes the endpoint less cumbersome to use by handling the POST body clarity serialization.

Example usage (untyped):

import { getContractMapEntry, principalCV } from '@stacks/transactions';

const result = await getContractMapEntry({
  contractAddress: 'SPSCWDV3RKV5ZRN1FQD84YE1NQFEDJ9R1F4DYQ11',
  contractName: 'newyorkcitycoin-core-v2',
  mapName: 'UserIds',
  mapKey: principalCV('SP25V8V2QQ2K8N3JAS15Z14W4YW7ABFDZHK5ZPGW7'),
});

console.log(result);
// > {type: 1, value: 60n}

Example usage (typed):

import { getContractMapEntry, principalCV, UIntCV, ClarityType } from '@stacks/transactions';

const result = await getContractMapEntry<UIntCV>({
  contractAddress: 'SPSCWDV3RKV5ZRN1FQD84YE1NQFEDJ9R1F4DYQ11',
  contractName: 'newyorkcitycoin-core-v2',
  mapName: 'UserIds',
  mapKey: principalCV('SP25V8V2QQ2K8N3JAS15Z14W4YW7ABFDZHK5ZPGW7'),
});

if (result.type === ClarityType.OptionalNone) {
  throw new Error('Not found!');
}

// Type is narrowed to `UIntCV`
console.log(result.value);
// > 60n

This function can be improved later on with a flag to enable more checking. For example, it could validate the contract principal and map name are valid with an ABI fetch, then validate that the map Clarity value type matches the type from the ABI. Right now, the RPC endpoint returns none for most of these conditions.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
stacksjs-docs	✅ Ready (Inspect)	Visit Preview	Mar 17, 2023 at 3:51PM (UTC)

[codecov]

Codecov Report

Merging #1461 (3c85dab) into master (9d5b7fb) will increase coverage by 0.03%.
The diff coverage is 79.16%.

@@            Coverage Diff             @@
##           master    #1461      +/-   ##
==========================================
+ Coverage   65.68%   65.72%   +0.03%     
==========================================
  Files         116      116              
  Lines        8509     8533      +24     
  Branches     1892     1872      -20     
==========================================
+ Hits         5589     5608      +19     
- Misses       2792     2797       +5     
  Partials      128      128              

Impacted Files	Coverage Δ
packages/network/src/network.ts	57.14% <50.00%> (-0.15%)	⬇️
packages/transactions/src/builders.ts	77.88% <81.81%> (+0.22%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[janniks]

Looks great!